---
title: "List sales orders"
method: GET
path: "/companies/{companyId}/data/salesOrders"
tags: ["Sales orders"]
---

# List sales orders

`GET /companies/{companyId}/data/salesOrders`

The *List sales orders* endpoint returns a list of [sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) for a given company's connection.

[Sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) represent a customer's intention to purchase goods or services from the SMB.

Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).

## Query parameters

- `page` integer
- `pageSize` integer
- `query` string
- `orderBy` string

## Response `200`

Success

- SalesOrders
  - `results` SalesOrder[]
    - `id` string — Identifier for the sales order, unique for the company in the accounting software.
    - `salesOrderNumber` string, nullable — Friendly reference for the sales order, commonly generated by the accounting software.
    - `customerPurchaseOrderNumber` string, nullable — A customer-supplied identifier for the purchase order in the customer's system.
    - `issueDate` string — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
    - `expectedDeliveryDate` string — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
    - `note` string, nullable — Any additional information associated with the sales order.
    - `shipTo` object — Delivery details for any goods that have been ordered.
      - `contact` object — Details of the named contact at the delivery address.
        - `name` string, nullable — Name of the contact at the delivery address.
        - `email` string, nullable — Email address of the contact at the delivery address.
        - `phone` string, nullable — Phone number of the contact at the delivery address.
      - `address` Items — unresolved $ref
    - `customerRef` AccountingCustomerRef — unresolved $ref
    - `status` SalesOrderStatus — unresolved $ref
    - `invoicingStatus` SalesOrderInvoiceStatus — unresolved $ref
    - `currency` Currency — unresolved $ref
    - `currencyRate` CurrencyRate — unresolved $ref
    - `lineItems` SalesOrderLineItem[], nullable — An array of line items. — unresolved $ref
    - `totalDiscount` number — Total value of any discounts applied to the sales order.
    - `subTotal` number — Total amount of the sales order, including discounts but excluding tax.
    - `totalTaxAmount` number — Total amount of tax included in the sales order.
    - `totalAmount` number — Total amount of the sales order, including discounts and tax.
    - `metadata` Metadata
      - `isDeleted` boolean, nullable — Indicates whether the record has been deleted in the third-party system this record originated from.
    - `modifiedDate` string — The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. Use it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today. This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)). In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.
    - `sourceModifiedDate` string — The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: - Pulling attachments - The accounting software does not provide modification dates for a data type - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.
  - `pageNumber` integer, required — Current page number.
  - `pageSize` integer, required — Number of items to return in results array.
  - `totalResults` integer, required — Total number of items.
  - `_links` Links, required — unresolved $ref

## Other responses

- `400` — Your `query` parameter was not correctly formed
- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `409` — The data type's dataset has not been requested or is still syncing.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.net/codatio/apis/accounting-api.md) · [All operations](https://skmtc.net/codatio/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/accounting-api/revisions/21d41189c461/schema)