---
title: "Get a sales order"
method: GET
path: "/sales_orders/{id}"
tags: ["Sales Orders"]
---

# Get a sales order

`GET /sales_orders/{id}`

**Plan: Paid API.**

May also be looked up by `txn_number` query param instead of the id.

## Query parameters

- `txn_number` string

## Response `200`

OK

- SalesOrder — Full sales order (internally a WorkOrder). Includes charges, line items, addresses, related transactions and payments. Only the most-used fields are listed; the response may include additional nested detail.
  - `className` string
  - `active` boolean
  - `id` string, uuid
  - `title` string
  - `description` string, nullable
  - `txnDate` string, date, nullable
  - `txnNumber` string
  - `totalPriceInDollars` number, nullable — US dollars.
  - `totalTaxInDollars` number, nullable — US dollars.
  - `totalPriceWithTaxInDollars` number, nullable — US dollars.
  - `totalPaymentsInDollars` number, nullable — US dollars.
  - `balanceInDollars` number, nullable — US dollars.
  - `workflowState` string, nullable
  - `dueDate` string, date, nullable
  - `inHandDate` string, date, nullable
  - `shippingDate` string, date, nullable
  - `customerPoNumber` string, nullable
  - `customerPoDate` string, date, nullable
  - `downpaymentPercent` number, nullable
  - `invoiced` boolean, nullable
  - `fullyInvoiced` boolean, nullable
  - `setupChargesInDollars` number, nullable — US dollars.
  - `setupChargesTaxable` boolean
  - `miscChargesInDollars` number, nullable — US dollars.
  - `miscChargesTaxable` boolean
  - `miscChargesLabel` string, nullable
  - `shippingChargesInDollars` number, nullable — US dollars.
  - `shippingChargesTaxable` boolean
  - `financeChargesInDollars` number, nullable — US dollars.
  - `financeChargesTaxable` boolean
  - `companyId` string, uuid, nullable
  - `primarySalesRepId` string, uuid, nullable
  - `primaryContactId` string, uuid, nullable
  - `billingAddressId` string, uuid, nullable
  - `shippingAddressId` string, uuid, nullable
  - `termCodeId` string, uuid, nullable
  - `salesTaxId` string, uuid, nullable
  - `shippingMethodId` string, uuid, nullable
  - `productionManagerId` string, uuid, nullable
  - `projectManagerId` string, uuid, nullable
  - `designerId` string, uuid, nullable
  - `paymentMethodId` string, uuid, nullable
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `company` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `primaryContact` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `primarySalesRep` Party — A person reference (sales rep, PM, designer) with initials.
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `productionManager` Party — A person reference (sales rep, PM, designer) with initials.
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `projectManager` Party — A person reference (sales rep, PM, designer) with initials.
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `designer` Party — A person reference (sales rep, PM, designer) with initials.
    - `id` string, uuid
    - `name` string, nullable
    - `initials` string, nullable
  - `project` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `createdBy` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `updatedBy` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `billingAddress` Address
    - `id` string
    - `addressType` string, nullable
    - `name` string, nullable
    - `nameStreet` string, nullable
    - `nameStreetCity` string, nullable
    - `street` string, nullable
    - `street1` string, nullable
    - `suburb` string, nullable
    - `city` string, nullable
    - `zip` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `attentionTo` string, nullable
    - `coordinates` object
      - `latitude` number, nullable
      - `longitude` number, nullable
  - `shippingAddress` Address
    - `id` string
    - `addressType` string, nullable
    - `name` string, nullable
    - `nameStreet` string, nullable
    - `nameStreetCity` string, nullable
    - `street` string, nullable
    - `street1` string, nullable
    - `suburb` string, nullable
    - `city` string, nullable
    - `zip` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `attentionTo` string, nullable
    - `coordinates` object
      - `latitude` number, nullable
      - `longitude` number, nullable
  - `shippingMethod` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `paymentMethod` NamedRef — Lightweight reference to a related record.
    - `id` string, uuid
    - `name` string
  - `tax` object
    - `id` string, uuid
    - `name` string, nullable
    - `rate` number, nullable
    - `rateInPercent` string, nullable
  - `termCode` object
    - `id` string, uuid
    - `name` string, nullable
    - `type` string, nullable
    - `days` integer, nullable
  - `lineItems` SalesOrderLineItem[]
    - `id` string, uuid
    - `workOrderId` string, uuid
    - `companyId` string, uuid, nullable
    - `position` integer
    - `name` string, nullable
    - `description` string, nullable
    - `fullDescription` string, nullable
    - `quantity` number
    - `uom` string, nullable
    - `volumeDiscountPercent` number, nullable
    - `volumeDiscountInDollars` number, nullable
    - `rangeDiscountPercent` number, nullable
    - `rangeDiscountInDollars` number, nullable
    - `costInDollars` number, nullable — US dollars.
    - `suggestedPriceInDollars` number, nullable — US dollars.
    - `priceInDollars` number, nullable — US dollars.
    - `totalCostInDollars` number, nullable — US dollars.
    - `totalPriceInDollars` number, nullable — US dollars.
    - `totalTaxInDollars` number, nullable — US dollars.
    - `workflowState` string, nullable
    - `productId` string, uuid, nullable
    - `productType` string, nullable
    - `productName` string, nullable
    - `saleType` string, nullable
    - `jobId` string, uuid, nullable
    - `taxable` boolean
    - `taxName` string, nullable
    - `taxRate` number, nullable
    - `priceOverride` boolean, nullable
    - `parentLineItemId` string, uuid, nullable
    - `customFields` object[]
      - `name` string
      - `type` string, nullable
      - `value` string, nullable
    - `job` object
      - `id` string, uuid
      - `name` string, nullable
      - `workflowState` string, nullable
  - `relatedTransactions` object[]
    - `txnId` string, uuid
    - `txnNumber` string
    - `txnDate` string, date, nullable
    - `txnName` string, nullable
    - `txnType` string, nullable
    - `txnTotal` number, nullable
  - `orderPayments` object[]
    - `orderPaymentId` string, uuid
    - `orderPaymentTxnNumber` string
    - `orderPaymentPaidOn` string, date, nullable
    - `orderPaymentAmount` number, nullable
  - `signatures` Signature[]
    - `name` string
    - `location` string, nullable
    - `signatureUrl` string, nullable
    - `createdAt` string, date-time

## Other responses

- `401` — Missing/expired credentials, an index request without a required filter, or the plan does not include this endpoint.
- `404` — Not found.

---

[API](https://skmtc.net/shopvox/apis/shopvox-public-api.md) · [All operations](https://skmtc.net/shopvox/apis/shopvox-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopvox/shopvox-public-api/versions/7ac1ff5d444a/schema)