Update a quote

PUT/accounting/{connection_id}/quote/{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 Quote

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
quote_numberstring
External identifier for this quote (Xero QuoteNumber, QBO DocNumber, NetSuite tranId)
referencestring
customer-side reference / PO number
titlestring
short title (Xero Title, max 100)
summarystring
longer summary (Xero Summary, max 3000)
payment_terms enum
Valid values:
"ON_RECEIPT"
"NET_7"
"NET_10"
"NET_15"
"NET_20"
unified payment terms enum, as on accounting_invoice / accounting_bill
customer_messagestring
customer-visible message
memostring
internal note, not customer-visible
contact_idstring
(reference to AccountingContact)
contacts array
denormalized parties, reusing the transaction contact shape
issued_atdate-time
Xero Date, QBO TxnDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atdate-time
Xero ExpiryDate, QBO ExpirationDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sent_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
accepted_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
declined_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
status enum
Valid values:
"DRAFT"
"SENT"
"ACCEPTED"
"DECLINED"
"INVOICED"
where EXPIRED is derived (expires_at < now), the source status is preserved in raw
currencystring
currency_ratenumber
exchange rate to the organization's base currency
sub_total_amountnumber
tax_amountnumber
discount_amountnumber
total_amountnumber
tax_mode enum
Valid values:
"INCLUSIVE"
"EXCLUSIVE"
"NONE"
INCLUSIVE / EXCLUSIVE / NONE; maps Xero LineAmountTypes (a boolean cannot represent NoTax)
lineitems array
invoice_idstring
populated once the quote is converted to an invoice; left null when the source cannot supply it (reference to AccountingInvoice)
project_idstring
points to an AccountingProject (accounting costing project) (reference to TaskProject)
group_idstring
points to a HRIS Group (reference to HrisGroup)
category_idsstring array
tracking categories / classes (AccountingCategory dimensions)
urlstring
public online-quote link where exposed
organization_idstring
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
quote_numberstringNoExternal identifier for this quote (Xero QuoteNumber, QBO DocNumber, NetSuite tranId)
referencestringNocustomer-side reference / PO number
titlestringNoshort title (Xero Title, max 100)
summarystringNolonger summary (Xero Summary, max 3000)
payment_termsenumNounified payment terms enum, as on accounting_invoice / accounting_bill Values: ON_RECEIPT, NET_7, NET_10, NET_15, NET_20, NET_25, NET_30, NET_45, NET_60, NET_90, OTHER
customer_messagestringNocustomer-visible message
memostringNointernal note, not customer-visible
contact_idstringNo(reference to AccountingContact)
contactsAccountingTransactionContact[]Nodenormalized parties, reusing the transaction contact shape
contacts[].idstringYes
contacts[].is_customerbooleanNo
contacts[].is_supplierbooleanNo
issued_atstring (date-time)NoXero Date, QBO TxnDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atstring (date-time)NoXero ExpiryDate, QBO ExpirationDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sent_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
accepted_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
declined_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
statusenumNowhere EXPIRED is derived (expires_at < now), the source status is preserved in raw Values: DRAFT, SENT, ACCEPTED, DECLINED, INVOICED, EXPIRED, VOIDED, DELETED
currencystringNo
currency_ratenumberNoexchange rate to the organization's base currency
sub_total_amountnumberNo
tax_amountnumberNo
discount_amountnumberNo
total_amountnumberNo
tax_modeenumNoINCLUSIVE / EXCLUSIVE / NONE; maps Xero LineAmountTypes (a boolean cannot represent NoTax) Values: INCLUSIVE, EXCLUSIVE, NONE
lineitemsAccountingLineitem[]No
lineitems[].idstringNo
lineitems[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].refunded_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].total_amountnumberNounit_quantity * unit_amount + tax_amount
lineitems[].refund_amountnumberNo
lineitems[].discount_amountnumberNo
lineitems[].tax_amountnumberNo
lineitems[].item_idstringNo(reference to CommerceItem)
lineitems[].unit_amountnumberNo
lineitems[].unit_quantitynumberNo
lineitems[].item_skustringNo
lineitems[].item_namestringNo
lineitems[].item_descriptionstringNo
lineitems[].notesstringNo
lineitems[].taxrate_idstringNo
lineitems[].account_idstringNo(reference to AccountingAccount)
lineitems[].category_idsstring[]No(reference to AccountingCategory)
lineitems[].locationsAccountingReference[]No
lineitems[].locations[].idstringNo
lineitems[].locations[].namestringNo
lineitems[].item_variantsAccountingReference[]No
lineitems[].item_variants[].idstringNo
lineitems[].item_variants[].namestringNo
lineitems[].feesAccountingFee[]No
lineitems[].fees[].typeenumYesUnified fee category Values: TAX, DISCOUNT, PROMOTION, SHIPPING, GIFT_WRAP, COD, SURCHARGE, TIP, SERVICE_CHARGE, OTHER
lineitems[].fees[].original_typestringNoThe provider's original fee label, e.g. "VAT" or a shipping carrier name
lineitems[].fees[].amountnumberYes
lineitems[].fees[].currencystringNoISO 4217 currency code, e.g. USD
lineitems[].contact_idstringNo(reference to AccountingContact)
lineitems[].project_idstringNoref -> AccountingProject; the project this line is coded to (reference to TaskProject)
lineitems[].exchange_ratenumberNoThe exchange rate applied to this line, for multi-currency documents
lineitems[].is_billablebooleanNoTrue when the line is rebillable to a customer
invoice_idstringNopopulated once the quote is converted to an invoice; left null when the source cannot supply it (reference to AccountingInvoice)
project_idstringNopoints to an AccountingProject (accounting costing project) (reference to TaskProject)
group_idstringNopoints to a HRIS Group (reference to HrisGroup)
category_idsstring[]Notracking categories / classes (AccountingCategory dimensions)
urlstringNopublic online-quote link where exposed
organization_idstringNo
metadataAccountingMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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/quote/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?