A Sales Order represents a customer's committed order for goods or services, including line items with product references, quantities, prices, delivery date, shipping details and fulfilment status, before it is invoiced.
The Sales Orders model
A unique identifier for an object.
The third-party API ID of original entity
Sales order number, as assigned by the accounting system.
The customer this entity is linked to.
The unique identifier for the quote.
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.
List Sales Orders
List Sales Orders
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
Responses
Mapping coverage per connector
Request example
Response example
Create Sales Order
Create Sales Order
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
Sales order number, as assigned by the accounting system.
The customer this entity is linked to.
The unique identifier for the quote.
The company ID the transaction belongs to
The ID of the department
The ID of the location
The unique identifier for the linked project.
The ID of the subsidiary
Date the sales order was placed - YYYY-MM-DD.
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.
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.
Payment terms of the sales order.
The ID of the payment terms
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.
Optional reference identifier for the transaction.
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.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Sub-total amount, normally before tax.
Total tax amount applied to this sales order.
Applicable tax id/code override if tax is not supplied on a line item basis.
Discount percentage applied to this sales order.
Discount amount applied to this sales order.
Total amount of the sales order, including tax.
Shipping method or carrier code for the order.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Message to the customer, shown on the sales order.
Internal notes for the sales order, not shown to the customer.
A list of linked tracking categories.
Optional sales order template
URL link to a source document - shown as 'Go to [appName]' in the downstream app.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Get Sales Order
Get Sales Order
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Update Sales Order
Update Sales Order
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
Sales order number, as assigned by the accounting system.
The customer this entity is linked to.
The unique identifier for the quote.
The company ID the transaction belongs to
The ID of the department
The ID of the location
The unique identifier for the linked project.
The ID of the subsidiary
Date the sales order was placed - YYYY-MM-DD.
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.
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.
Payment terms of the sales order.
The ID of the payment terms
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.
Optional reference identifier for the transaction.
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.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Currency Exchange Rate at the time entity was recorded/generated.
Amounts are including tax
Sub-total amount, normally before tax.
Total tax amount applied to this sales order.
Applicable tax id/code override if tax is not supplied on a line item basis.
Discount percentage applied to this sales order.
Discount amount applied to this sales order.
Total amount of the sales order, including tax.
Shipping method or carrier code for the order.
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
Message to the customer, shown on the sales order.
Internal notes for the sales order, not shown to the customer.
A list of linked tracking categories.
Optional sales order template
URL link to a source document - shown as 'Go to [appName]' in the downstream app.
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.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
Request example
Response example
Delete Sales Order
Delete Sales Order
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example