--- title: "Get Sales Order" method: GET path: "/accounting/sales-orders/{id}" tags: ["Sales Orders"] --- # Get Sales Order `GET /accounting/sales-orders/{id}` ## Request - Base URL: `https://unify.apideck.com` - URL: `https://unify.apideck.com/accounting/sales-orders/{id}` - Auth: API key in header `Authorization` Get Sales Order ## Path parameters - `id` string, required ## Query parameters - `raw` boolean ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string - `x-apideck-company-id` string ## Response `200` Sales Orders - GetSalesOrderResponse - `status_code` integer, required: HTTP Response Status Code - `status` string, required: HTTP Response Status - `service` string, required: Apideck ID of service provider - `resource` string, required: Unified API resource name - `operation` string, required: Operation performed - `data` SalesOrder, required - `id` string: A unique identifier for an object. - `downstream_id` string, nullable: The third-party API ID of original entity - `number` string, nullable: Sales order number, as assigned by the accounting system. - `customer` LinkedCustomer, nullable: The customer this entity is linked to. - `id` string: The ID of the customer this entity is linked to. - `display_id` string, nullable: The display ID of the customer. - `display_name` string, nullable: The display name of the customer. - `name` string: The name of the customer. Deprecated, use display_name instead. - `company_name` string, nullable: The company name of the customer. - `email` string: The email address of the customer. - `quote_id` string, nullable: The unique identifier for the quote. - `invoice_id` string, nullable: ID of the invoice created from this sales order. Populated when the accounting system records a single invoice on the order (see the connector gotchas); null when the order has not been invoiced, or when it was invoiced in parts and the system keeps no single link. - `company_id` string, nullable: The company ID the transaction belongs to - `department_id` string, nullable: The ID of the department - `location_id` string, nullable: The ID of the location - `project_id` string: The unique identifier for the linked project. - `subsidiary_id` string, nullable: The ID of the subsidiary - `order_date` string, date, nullable: Date the sales order was placed - YYYY-MM-DD. - `delivery_date` string, date, nullable: The requested delivery date: the date the customer asked to receive the goods or services - YYYY-MM-DD. Promised ship dates and payment due dates are not mapped here. - `order_type` string, nullable: The order or transaction type of the sales order, as configured in the accounting system. On create, selects the type to create when the system supports several; omit to use the connection default. See the connector gotchas for the values each system accepts. - `terms` string, nullable: Payment terms of the sales order. - `terms_id` string, nullable: The ID of the payment terms - `po_number` string, nullable: A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. - `reference` string, nullable: Optional reference identifier for the transaction. - `status` 'draft' | 'open' | 'on_hold' | 'back_ordered' | 'invoiced' | 'closed' | 'cancelled' | 'other', nullable: Sales order status, in order of precedence: `cancelled`; `closed` (the order is closed or completed, whether or not it was billed); `invoiced` (fully billed but not yet closed); `back_ordered`; `on_hold` (including credit hold); `draft` (including pending approval); `open` (every other active state, including partially shipped and partially invoiced); `other` for states that fit none of these. - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | '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' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | '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' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `currency_rate` number, nullable: Currency Exchange Rate at the time entity was recorded/generated. - `tax_inclusive` boolean, nullable: Amounts are including tax - `sub_total` number, nullable: Sub-total amount, normally before tax. - `total_tax` number, nullable: Total tax amount applied to this sales order. - `tax_code` string, nullable: Applicable tax id/code override if tax is not supplied on a line item basis. - `discount_percentage` number, nullable: Discount percentage applied to this sales order. - `discount_amount` number, nullable: Discount amount applied to this sales order. - `total` number, nullable: Total amount of the sales order, including tax. - `unbilled_amount` number, nullable: Amount of the sales order not yet invoiced. Not the amount owed: see `balance` on the invoices created from the order for that. - `shipping_method` string, nullable: Shipping method or carrier code for the order. - `payment_method` string, nullable: Payment method used for the transaction, such as cash, credit card, bank transfer, or check - `customer_memo` string, nullable: Message to the customer, shown on the sales order. - `notes` string, nullable: Internal notes for the sales order, not shown to the customer. - `line_items` InvoiceLineItem[] - `id` string, nullable: A unique identifier for an object. - `row_id` string: Row ID - `code` string, nullable: User defined item code - `line_number` integer, nullable: Line number of the resource - `description` string, nullable: User defined description - `type` 'sales_item' | 'discount' | 'info' | 'sub_total' | 'service' | 'other', nullable: Item type - `tax_amount` number, nullable: Tax amount - `total_amount` number, nullable: Total amount of the line item - `quantity` number, nullable - `unit_price` number, nullable - `unit_of_measure` string, nullable: Description of the unit type the item is sold as, ie: kg, hour. - `discount_percentage` number, nullable: Discount percentage applied to the line item when supported downstream. - `discount_amount` number, nullable: Discount amount applied to the line item when supported downstream. - `service_date` string, date, nullable: Date on which the service was provided or performed - YYYY-MM-DD. - `category_id` string, nullable: ID of the category of the line item - `location_id` string, nullable: The ID of the location - `department_id` string, nullable: The ID of the department - `subsidiary_id` string, nullable: The ID of the subsidiary - `shipping_id` string, nullable: ID of the shipping of the line item - `memo` string, nullable: Memo - `prepaid` boolean, nullable: Whether the line item is prepaid - `item` LinkedInvoiceItem - `id` string, nullable: ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item - `code` string, nullable: User defined item code - `name` string, nullable: User defined item name - `taxable` boolean, nullable: If true, this line item is subject to tax. Read-only, and only populated by connectors that record taxability on the line itself. - `tax_applicable_on` string, nullable: Tax applicable on - `tax_recoverability` string, nullable: Tax recoverability - `tax_method` string, nullable: Method of tax calculation - `worktags` LinkedWorktag[]: Worktags of the line item. This is currently only supported in Workday. - `id` string: The unique identifier for the worktag. - `value` string, nullable: The value of the worktag. - `tax_rate` LinkedTaxRate - `id` string, nullable: The ID of the object. - `code` string, nullable: Tax rate code - `name` string, nullable: Name of the tax rate - `rate` number, nullable: Rate of the tax rate - `tracking_categories` LinkedTrackingCategory[], nullable: A list of linked tracking categories. - `id` string: The unique identifier for the tracking category. - `code` string, nullable: The code of the tracking category. - `name` string, nullable: The name of the tracking category. - `parent_id` string: The unique identifier for the parent tracking category. - `parent_name` string, nullable: The name of the parent tracking category. - `ledger_account` LinkedLedgerAccount, nullable - `id` string: The unique identifier for the account. - `name` string, nullable: The name of the account. - `nominal_code` string, nullable: The nominal code of the account. - `code` string, nullable: The code assigned to the account. - `parent_id` string, nullable: The parent ID of the account. - `display_id` string, nullable: The display ID of the account. - `custom_fields` CustomField[] - union - object - `id` string, nullable, required: Unique identifier for the custom field. - `name` string, nullable: Name of the custom field. - `ref_name` string, nullable: Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it. - `description` string, nullable: More information about the custom field - `value` union - … - object - `id` string, nullable: Unique identifier for the custom field. - `name` string, nullable, required: Name of the custom field. - `ref_name` string, nullable: Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it. - `description` string, nullable: More information about the custom field - `value` union - … - `row_version` string, nullable: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `updated_by` string, nullable: The user who last updated the object. - `created_by` string, nullable: The user who created the object. - `created_at` string, date-time, nullable: The date and time when the object was created. - `updated_at` string, date-time, nullable: The date and time when the object was last updated. - `billing_address` Address - `id` string, nullable: Unique identifier for the address. - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable: The type of address. - `string` string, nullable: The address string. Some APIs don't provide structured address data. - `name` string, nullable: The name of the address. - `line1` string, nullable: Line 1 of the address e.g. number, street, suite, apt #, etc. - `line2` string, nullable: Line 2 of the address - `line3` string, nullable: Line 3 of the address - `line4` string, nullable: Line 4 of the address - `line5` string, nullable: Line 5 of the address - `street_number` string, nullable: Street number - `city` string, nullable: Name of city. - `state` string, nullable: Name of state - `postal_code` string, nullable: Zip code or equivalent. - `country` string, nullable: country code according to ISO 3166-1 alpha-2. - `latitude` string, nullable: Latitude of the address - `longitude` string, nullable: Longitude of the address - `county` string, nullable: Address field that holds a sublocality, such as a county - `contact_name` string, nullable: Name of the contact person at the address - `salutation` string, nullable: Salutation of the contact person at the address - `phone_number` string, nullable: Phone number of the address - `fax` string, nullable: Fax number of the address - `email` string, nullable: Email address of the address - `website` string, nullable: Website of the address - `notes` string, nullable: Additional notes - `row_version` string, nullable: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `shipping_address` Address - `id` string, nullable: Unique identifier for the address. - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable: The type of address. - `string` string, nullable: The address string. Some APIs don't provide structured address data. - `name` string, nullable: The name of the address. - `line1` string, nullable: Line 1 of the address e.g. number, street, suite, apt #, etc. - `line2` string, nullable: Line 2 of the address - `line3` string, nullable: Line 3 of the address - `line4` string, nullable: Line 4 of the address - `line5` string, nullable: Line 5 of the address - `street_number` string, nullable: Street number - `city` string, nullable: Name of city. - `state` string, nullable: Name of state - `postal_code` string, nullable: Zip code or equivalent. - `country` string, nullable: country code according to ISO 3166-1 alpha-2. - `latitude` string, nullable: Latitude of the address - `longitude` string, nullable: Longitude of the address - `county` string, nullable: Address field that holds a sublocality, such as a county - `contact_name` string, nullable: Name of the contact person at the address - `salutation` string, nullable: Salutation of the contact person at the address - `phone_number` string, nullable: Phone number of the address - `fax` string, nullable: Fax number of the address - `email` string, nullable: Email address of the address - `website` string, nullable: Website of the address - `notes` string, nullable: Additional notes - `row_version` string, nullable: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `tracking_categories` LinkedTrackingCategory[], nullable: A list of linked tracking categories. - `id` string: The unique identifier for the tracking category. - `code` string, nullable: The code of the tracking category. - `name` string, nullable: The name of the tracking category. - `parent_id` string: The unique identifier for the parent tracking category. - `parent_name` string, nullable: The name of the parent tracking category. - `template_id` string, nullable: Optional sales order template - `source_document_url` string, nullable: URL link to a source document - shown as 'Go to [appName]' in the downstream app. - `custom_mappings` CustomMappings, nullable: When custom mappings are configured on the resource, the result is included here. - `custom_fields` CustomField[] - union - object - `id` string, nullable, required: Unique identifier for the custom field. - `name` string, nullable: Name of the custom field. - `ref_name` string, nullable: Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it. - `description` string, nullable: More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - object - `id` string, nullable: Unique identifier for the custom field. - `name` string, nullable, required: Name of the custom field. - `ref_name` string, nullable: Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it. - `description` string, nullable: More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - `row_version` string, nullable: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `updated_by` string, nullable: The user who last updated the object. - `created_by` string, nullable: The user who created the object. - `updated_at` string, date-time, nullable: The date and time when the object was last updated. - `created_at` string, date-time, nullable: The date and time when the object was created. - `pass_through` object[]: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` string, required: Identifier for the service to which this pass_through should be applied. - `operation_id` string: Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` object: Simple object allowing any properties for direct extension. - `extend_paths` object[]: Array of objects for structured data modifications via paths. - `path` string, required: JSONPath string specifying where to apply the value. - `value` unknown, required - `meta` Meta: Response metadata - `items_on_page` integer: Number of items returned in the data property of the response - `cursors` object: Cursors to navigate to previous or next pages through the API - `previous` string, nullable: Cursor to navigate to the previous page of results through the API - `current` string, nullable: Cursor to navigate to the current page of results through the API - `next` string, nullable: Cursor to navigate to the next page of results through the API - `total_count` integer: Number of records available in total for this resource - `warnings` object[], nullable: Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string: Discriminator for the warning kind. - `status_code` integer, nullable: HTTP status code returned by the failed downstream request, when available. - `error` string, nullable: Short error description from the downstream provider, when available. - `operation` string, nullable: Identifier of the workflow step that failed. - `message` string, nullable: Detailed message from the downstream provider, when available. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `402`: Payment Required - `404`: The specified resource was not found - `422`: Unprocessable - `default`: Unexpected error ## Changes - **2026-10-08** `7ff953bdfe65`: 1 info - endpoint added [Operation history](https://skmtc.dev/apideck-libraries/apis/accounting-api/changes/accounting/sales-orders/:id/get.md) --- [API](https://skmtc.dev/apideck-libraries/apis/accounting-api.md) · [All operations](https://skmtc.dev/apideck-libraries/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc.dev/apideck-libraries/apis/accounting-api/revisions/d02fc67b26ca?raw)