accounting
quote

Retrieve a quote

Changed on
get/accounting/{connection_id}/quote/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/accounting/{connection_id}/quote/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Quote

Query parameters

fieldsstring[]

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

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-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'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'

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)

issued_atstring date-time

Xero Date, QBO TxnDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

expires_atstring date-time

Xero ExpiryDate, QBO ExpirationDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sent_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

accepted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

declined_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status'DRAFT' | 'SENT' | 'ACCEPTED' | 'DECLINED' | 'INVOICED' | 'EXPIRED' | 'VOIDED' | 'DELETED'

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'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'

INCLUSIVE / EXCLUSIVE / NONE; maps Xero LineAmountTypes (a boolean cannot represent NoTax)

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[]

tracking categories / classes (AccountingCategory dimensions)

urlstring

public online-quote link where exposed

organization_idstring
rawobject

Changes

  • 669f9277e173Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 1c744a7590b4Revision changes
    • warning

      added the new SERVICE_CHARGE enum value to the //// response property for the response status

    • warning

      added the new TIP enum value to the //// response property for the response status

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status