Sign in
Sales Orders

Get SalesOrder record

Retrieve a specific SalesOrder record by its record number with all related data.

get/public/v2/sales-orders/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

The number attribute of the record.

Query parameters

searchstring nullable
company_idinteger[] nullable
numberinteger[] nullable
customer_idinteger[] nullable
start_datestring date nullable
end_datestring date nullable
record_statusRecordStatus[] nullable
invoiced_statusSalesOrderInvoicedStatus[] nullable
approval_statusstring[] nullable
approval_status_scopeRecordStatus[] nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable

Response

OK

bill_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

invoiced_status'invoiced' | 'uninvoiced' | 'partially_invoiced' required
term_idinteger nullable required
term_namestring required
approval_statusstring nullable
internal_idinteger required
numberinteger required
company_idinteger required
company_namestring required
company_currencystring required
customer_idinteger required
customer_namestring required
currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required
exchange_ratestring required
amountstring required

Total amount of ordered items

invoiced_totalstring required

Total quantity of items that were already invoiced

due_totalstring required

Total quantity of items yet to be invoiced

memostring required
datestring date required
record_status'draft' | 'posted' | 'archived' required
recurring_record_numberinteger nullable
reference_numberstring required
created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

Changes

Changed in 4 of the 14 revisions of this API.2218

  • 48edcb3acb7423See the full diff
    • ●

      removed the optional property has_more_lines from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lines_count from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id get_SalesOrderV2_record removed and replaced with get_SalesOrder_record

      api-operation-id-removed

    • ○

      the response property items became required for the status 200

      response-property-became-required

    • ○

      the items response's property default value was removed for the status 200

      response-property-default-value-removed

    This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dcb8297898a219See the full diff
    • ▲

      the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      added GstComponentType TaxFamily to the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed the CESS enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the GST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the HST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the QST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the SGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

  • 525a590a98f82See the full diff
    • ○

      added the new optional query request parameter approval_status_scope

      new-optional-request-parameter

    • ○

      added the optional property items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_metadata to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 506e6073d19114See the full diff
    • ▲

      the response property items became optional for the status 200

      response-property-became-optional

    • ○

      api operation id get_SalesOrder_record removed and replaced with get_SalesOrderV2_record

      api-operation-id-removed

    • ○

      added the optional property has_more_lines to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property lines_count to the response with the 200 status

      response-optional-property-added

    • ○

      the items response's property default value was added for the status 200

      response-property-default-value-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog