Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
SalesOrder

Retrieves the collection of SalesOrder resources.

Retrieves the collection of SalesOrder resources.

get/sales_orders

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

SalesOrder collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier of the source 3rd party integration eg. "460000000039129"

customerIdstring nullable

ID of the customer to whom the sales order has to be created eg. "460000000017138"

Identifierstring nullable

Unique number generated (starts with SO) which will be displayed in the interface and sales orders eg. "SO-00001"

referenceNumberstring nullable

Reference number to sales-order eg. "REF-001"

txnDatestring nullable

The date, the sales order is created.

txnStatusstring nullable

Status of sales-order eg. "open"

customerNamestring nullable

Name of the customer associated with the Sales Order eg. "Bowman Furniture"

currencystring nullable

Code of the Currency involved in the Sales Order eg. "USD"

subtotalinteger nullable

Subtotal of sales order eg. 90

totalAmountinteger nullable

Total of sales order eg. 100

createdstring date-time nullable

Creation Time of the Sales Order eg. 2014-07-28T08:29:07+0530

modifiedstring date-time nullable

Last modified time of the Sales Order eg. 2014-07-28T08:29:07+0530

billingCitystring nullable

Billing city eg. Beijing

billingCountrystring nullable

Billing country eg. China

billingPostalcodestring nullable

Billing postal code eg. 1000881

shippingCitystring nullable

Shipping city eg Beijing

shippingCountrystring nullable

Shipping country eg China

shippingPostalcodestring nullable

Shipping postal code eg. 1000881

identifierstring nullable

Example response

[
  {
    "integration": "quickbooks"
  }
]