Staff price lists capture rate adjustments for expense items (finance items). When a price list adjustment is defined, it takes precedence over the default rate, which is defined on the expense item itself.
Listing Staff Price List Adjustments
Returns a collection of staff price list adjustments, optionally filtered by the available request parameters.
GET /api/v1/staff/pricelist
Available Request Parameters:
| Name | Type | Required | Description |
| user | integer | no | ID of the staff member. |
| account_code | string | no | User account code, defined on the staff profile. |
| item | integer | no | ID of the finance item associated with the price list. |
| reference_id | string | no | Expense item reference ID, entered in settings. |
Note: All timestamp parameters are queried and returned in UTC.
Getting a Staff Price List Adjustment
Returns a single staff price list adjustment, based on the numeric User ID and Expense Item ID.
GET /api/v1/staff/pricelist/{user_id}/{item_id}
Creating, Updating & Deleting a Staff Price List Adjustment
Creates, updates, or deletes a single staff price list adjustment, based on the numeric User ID and Finance Item ID.
POST /api/v1/staff/pricelist
Available Parameters
| Name | Type | Required | Description |
| user_id | integer | yes | ID of the staff member. API Reference - Staff |
| finance_item_id | integer | yes | ID of the finance (expense) item (Settings > Invoice & Expense Items). |
| expense_unit_rate | decimal | yes |
The rate adjustment to apply to the associated staff member. Set this value to |
Example New Staff Price List Adjustment
A new staff price list adjustment is created by POSTing a JSON object to the specified end point using the above criteria. The JSON object must contain the required fields (as shown above) and must be nested under the staff_price_list object. See the following example request:
{
"staff_price_list": {
"user_id": 1,
"finance_item_id": 1,
"expense_unit_rate": 55.123
}
}Note: The above request is for demonstration purposes only, your implementation will require unique data provided by your account.