---
title: "Retrieves the collection of SalesOrder resources."
method: GET
path: "/sales_orders"
tags: ["SalesOrder"]
---

# Retrieves the collection of SalesOrder resources.

`GET /sales_orders`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/sales_orders`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/sales_orders/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of SalesOrder resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

SalesOrder collection

- SalesOrder[]
  - `id` string
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string: Unique identifier of the source 3rd party integration eg. "460000000039129"
  - `customerId` string, nullable: ID of the customer to whom the sales order has to be created eg. "460000000017138"
  - `Identifier` string, nullable: Unique number generated (starts with SO) which will be displayed in the interface and sales orders eg. "SO-00001"
  - `referenceNumber` string, nullable: Reference number to sales-order eg. "REF-001"
  - `txnDate` string, nullable: The date, the sales order is created.
  - `txnStatus` string, nullable: Status of sales-order eg. "open"
  - `customerName` string, nullable: Name of the customer associated with the Sales Order eg. "Bowman Furniture"
  - `currency` string, nullable: Code of the Currency involved in the Sales Order eg. "USD"
  - `subtotal` integer, nullable: Subtotal of sales order eg. 90
  - `totalAmount` integer, nullable: Total of sales order eg. 100
  - `created` string, date-time, nullable: Creation Time of the Sales Order eg. 2014-07-28T08:29:07+0530
  - `modified` string, date-time, nullable: Last modified time of the Sales Order eg. 2014-07-28T08:29:07+0530
  - `billingCity` string, nullable: Billing city eg. Beijing
  - `billingCountry` string, nullable: Billing country eg. China
  - `billingPostalcode` string, nullable: Billing postal code eg. 1000881
  - `shippingCity` string, nullable: Shipping city eg Beijing
  - `shippingCountry` string, nullable: Shipping country eg China
  - `shippingPostalcode` string, nullable: Shipping postal code eg. 1000881
  - `identifier` string, nullable

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)