Update an expense
PUT/accounting/{connection_id}/expense/{id}
Updates the AccountingExpense identified by `id`. Provide the unified AccountingExpense fields to change in the request body.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Expense
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstring
references a HR employee/user (reference to HrisEmployee)
contact_idstring
(reference to AccountingContact)
account_idstring
(reference to AccountingAccount)
namestring
payment_methodstring
posted_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumber
currencystring
tax_amountnumber
reimbursed_amountnumber
reimbursed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
approved_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
approver_user_idstring
references HR employee/user (reference to HrisEmployee)
organization_idstring
external_numberstring
category_idsstring array
(reference to AccountingCategory)
project_idstring
(reference to TaskProject)
taxrate_idstring
ref -> AccountingTaxrate applied to the expense
exchange_ratenumber
Exchange rate to the base/home currency at the expense date
type enum
Valid values:
"USER"
"COMPANY"
USER = employee spend; COMPANY = books/purchase expense
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
user_id | string | No | references a HR employee/user (reference to HrisEmployee) |
contact_id | string | No | (reference to AccountingContact) |
account_id | string | No | (reference to AccountingAccount) |
name | string | No | |
payment_method | string | No | |
posted_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
total_amount | number | No | |
currency | string | No | |
tax_amount | number | No | |
reimbursed_amount | number | No | |
reimbursed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
approved_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
approver_user_id | string | No | references HR employee/user (reference to HrisEmployee) |
lineitems | AccountingLineitem[] | No | |
lineitems[].id | string | No | |
lineitems[].created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lineitems[].updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lineitems[].refunded_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lineitems[].total_amount | number | No | unit_quantity * unit_amount + tax_amount |
lineitems[].refund_amount | number | No | |
lineitems[].discount_amount | number | No | |
lineitems[].tax_amount | number | No | |
lineitems[].item_id | string | No | (reference to CommerceItem) |
lineitems[].unit_amount | number | No | |
lineitems[].unit_quantity | number | No | |
lineitems[].item_sku | string | No | |
lineitems[].item_name | string | No | |
lineitems[].item_description | string | No | |
lineitems[].notes | string | No | |
lineitems[].taxrate_id | string | No | |
lineitems[].account_id | string | No | (reference to AccountingAccount) |
lineitems[].category_ids | string[] | No | (reference to AccountingCategory) |
lineitems[].locations | AccountingReference[] | No | |
lineitems[].locations[].id | string | No | |
lineitems[].locations[].name | string | No | |
lineitems[].item_variants | AccountingReference[] | No | |
lineitems[].item_variants[].id | string | No | |
lineitems[].item_variants[].name | string | No | |
lineitems[].fees | AccountingFee[] | No | |
lineitems[].fees[].type | enum | Yes | Unified fee category Values: TAX, DISCOUNT, PROMOTION, SHIPPING, GIFT_WRAP, COD, SURCHARGE, TIP, SERVICE_CHARGE, OTHER |
lineitems[].fees[].original_type | string | No | The provider's original fee label, e.g. "VAT" or a shipping carrier name |
lineitems[].fees[].amount | number | Yes | |
lineitems[].fees[].currency | string | No | ISO 4217 currency code, e.g. USD |
lineitems[].contact_id | string | No | (reference to AccountingContact) |
lineitems[].project_id | string | No | ref -> AccountingProject; the project this line is coded to (reference to TaskProject) |
lineitems[].exchange_rate | number | No | The exchange rate applied to this line, for multi-currency documents |
lineitems[].is_billable | boolean | No | True when the line is rebillable to a customer |
attachments | AccountingAttachment[] | No | |
attachments[].id | string | No | |
attachments[].download_url | string | No | |
attachments[].name | string | No | |
attachments[].mime_type | string | No | |
organization_id | string | No | |
users | AccountingReference[] | No | |
users[].id | string | No | |
users[].name | string | No | |
approver_users | AccountingReference[] | No | expense approver(s); id is HR employee/user when resolved |
approver_users[].id | string | No | |
approver_users[].name | string | No | |
status | enum | No | Values: DRAFT, SUBMITTED, PENDING, APPROVED, REJECTED, PAID |
external_number | string | No | |
category_ids | string[] | No | (reference to AccountingCategory) |
project_id | string | No | (reference to TaskProject) |
metadata | AccountingMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by `format`: DATE as ISO-8601 (`YYYY-MM-DD`, or `YYYY-MM-DDTHH:MM:SSZ` for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how `value` is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
taxrate_id | string | No | ref -> AccountingTaxrate applied to the expense |
exchange_rate | number | No | Exchange rate to the base/home currency at the expense date |
type | enum | No | USER = employee spend; COMPANY = books/purchase expense Values: USER, COMPANY |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'PUT',
url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/expense/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know