List pricing headers
Operation ID: pricing
Group: Accounting › Products › Product Lines
Open in the interactive reference
GET /accounting/pricing
Read-only: Reads and returns; changes nothing.
Lists pricing headers. Each item is the pricing header without its price book entries. To get the entries, with their rate-card entries and external identifiers, use GET accounting/pricing/:id or POST accounting/pricing/search. To filter by free text, header number, or an entry's external identifier, use POST accounting/pricing/search.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeproductLineId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeproductId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likepriceBookId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecurrency— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likevalidFrom— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenvalidTo— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweendataSource— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likehasBeenUsed— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweencreatedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenlastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between- Orderable: id, productLineId, productLineName, productId, productName, priceBookId, priceBookName, currency, dataSource, hasBeenUsed, validFrom, validTo, createdDate, lastModifiedDate
- Selectable: id, headerNumber, productLineId, productLineName, productLineNumber, productId, productName, priceBookId, priceBookName, currency, validFrom, validTo, dataSource, hasBeenUsed, createdDate, lastModifiedDate
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of pricingRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The unique identifier for the pricing header. |
headerNumber |
string | null | no | no | no | The pricing header number, assigned by the system and unique within the tenant. Absent while none has been assigned. |
productLineId |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The product line this pricing header prices. See id on GET accounting/product-lines/:id. |
productLineName |
string | null | no | no | yes | The name of the product line. See name on GET accounting/product-lines/:id. |
productLineNumber |
string | null | no | no | no | The product line number. See productLineNumber on GET accounting/product-lines/:id. |
productId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The product the product line belongs to. See id on GET accounting/products/:id. |
productName |
string | null | no | no | yes | The display name of the product. See productName on GET accounting/products/:id. |
priceBookId |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The price book this header belongs to. See id on GET accounting/price-books/:id. |
priceBookName |
string | null | no | no | yes | The display name of the price book. See priceBookName on GET accounting/price-books/:id. |
currency |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The currency the header's prices are in. Format ISO 4217, for example 'USD'. |
validFrom |
date | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The first date the header's prices are effective, inclusive. Format YYYY-MM-DD. |
validTo |
date | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The last date the header's prices are effective, inclusive. Format YYYY-MM-DD. Absent for a header with no end date. |
dataSource |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The source system or import job that produced the pricing header. Examples: 'Salesforce', 'NetSuite', 'Stripe'. |
hasBeenUsed |
boolean | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | Whether at least one sales order line uses this pricing header. |
createdDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the pricing header was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
lastModifiedDate |
date-time | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the pricing header last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"headerNumber": "<headerNumber>",
"productLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"productLineName": "<productLineName>",
"productLineNumber": "<productLineNumber>",
"productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"productName": "<productName>",
"priceBookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priceBookName": "<priceBookName>",
"currency": "<currency>",
"validFrom": "2026-01-15",
"validTo": "2026-01-15",
"dataSource": "<dataSource>",
"hasBeenUsed": true,
"createdDate": "2026-01-15T09:30:00.000Z",
"lastModifiedDate": "2026-01-15T09:30:00.000Z"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error