Update a salesorder
PUT/accounting/{connection_id}/salesorder/{id}
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 Salesorder
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
posted_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contact_idstring
Customer, Supplier (reference to AccountingContact)
account_idstring
(reference to AccountingAccount)
currencystring
total_amountnumber
sales_channelstring
organization_idstring
category_idsstring array
(reference to AccountingCategory)
order_numberstring
human-facing receipt/ticket/check number, distinct from id
location_idstring
store/site; reference to a commerce_location or hris_location
employee_user_idstring
selling/serving HR employee (server, cashier) (reference to HrisEmployee)
device_idstring
POS register/terminal/device (HRIS Device)
guest_countnumber
subtotal_amountnumber
pre-tax, pre-tip amount
tax_amountnumber
discount_amountnumber
tip_amountnumber
service_charge_amountnumber
refunded_amountnumber
closed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
subscription_idstring
payment_subscription that generated this order, if recurring
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) |
posted_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
contact_id | string | No | Customer, Supplier (reference to AccountingContact) |
account_id | string | No | (reference to AccountingAccount) |
currency | string | No | |
total_amount | number | No | |
shipping_address | object | No | |
shipping_address.address1 | string | No | |
shipping_address.address2 | string | No | |
shipping_address.city | string | No | |
shipping_address.region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
shipping_address.region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
shipping_address.postal_code | string | No | |
shipping_address.country | string | No | |
shipping_address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
billing_address | object | No | |
billing_address.address1 | string | No | |
billing_address.address2 | string | No | |
billing_address.city | string | No | |
billing_address.region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
billing_address.region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
billing_address.postal_code | string | No | |
billing_address.country | string | No | |
billing_address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
status | enum | No | Values: DRAFT, VOIDED, AUTHORIZED, PAID, PARTIALLY_PAID, PARTIALLY_REFUNDED, REFUNDED, SUBMITTED, DELETED, OPEN, COMPLETED, CANCELED |
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 |
sales_channel | string | No | |
organization_id | string | No | |
fees | AccountingFee[] | No | |
fees[].type | enum | Yes | Unified fee category Values: TAX, DISCOUNT, PROMOTION, SHIPPING, GIFT_WRAP, COD, SURCHARGE, TIP, SERVICE_CHARGE, OTHER |
fees[].original_type | string | No | The provider's original fee label, e.g. "VAT" or a shipping carrier name |
fees[].amount | number | Yes | |
fees[].currency | string | No | ISO 4217 currency code, e.g. USD |
category_ids | string[] | No | (reference to AccountingCategory) |
metadata | AccountingMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
order_number | string | No | human-facing receipt/ticket/check number, distinct from id |
location_id | string | No | store/site; reference to a commerce_location or hris_location |
employee_user_id | string | No | selling/serving HR employee (server, cashier) (reference to HrisEmployee) |
device_id | string | No | POS register/terminal/device (HRIS Device) |
fulfillment_type | enum | No | Values: DINE_IN, TAKEOUT, DELIVERY, PICKUP, CURBSIDE, SHIPPING, DIGITAL, OTHER |
guest_count | number | No | |
subtotal_amount | number | No | pre-tax, pre-tip amount |
tax_amount | number | No | |
discount_amount | number | No | |
tip_amount | number | No | |
service_charge_amount | number | No | |
refunded_amount | number | No | |
closed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
subscription_id | string | No | payment_subscription that generated this order, if recurring |
payments | AccountingPaymentReference[] | No | read-only reciprocal of PaymentPayment.allocations; payments applied to this sales order |
payments[].payment_id | string | No | references a PaymentPayment that was applied to this object (reference to PaymentPayment) |
payments[].amount | number | No | amount of the payment applied to this object |
payments[].allocated_at | string (date-time) | No | Date and time when the payment was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
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/salesorder/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know