Get Accounting Pricing

GET /accounting/pricing/{id}

Group: Accounting › Products › Product Lines · Operation ID: getAccountingPricing

Fetch a single pricing header by its id (a UUID), bound from the :id path segment. Returns the header with its price-book entries, rate cards and entry external identifiers — the same item schema as POST accounting/pricing/search. Read-only. Raises NOT_FOUND when no pricing header has that id (should map to 404). Every request must carry the Api-Version header.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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.
id path string yes Id of the pricing header to fetch (a UUID); bound from the :id path segment.

Response

200 Success

Under data (getAccountingPricingOutput):

Field Type Required Description
id string yes Id of the pricing header (a UUID) — the public identifier used by this route.
headerNumber string no System-generated pricing header number. Absent until one has been assigned.
productLineId string yes Id of the product line this header prices (a UUID) — GET accounting/product-lines/:id.
productLineName string no Display name of that product line.
productLineNumber string no System-generated number of that product line.
productId string no Id of the product the line belongs to (a UUID) — GET accounting/products/:id.
productName string no Display name of that product.
priceBookId string yes Id of the price book this header belongs to (a UUID) — GET accounting/price-books/:id.
priceBookName string no Name of that price book.
currency string yes ISO 4217 currency code governing every amount in this header.
validFrom string (date) yes First date the header's prices are effective (YYYY-MM-DD, inclusive).
validTo string (date) no Last effective date (YYYY-MM-DD, inclusive). Absent when open-ended.
dataSource string no Upstream system or import job that produced this header, e.g. 'Everest', 'Salesforce'. Tenant-configurable, not exhaustively enumerable.
hasBeenUsed boolean no True once the header has priced at least one sales order line. Computed; never settable.
createdDate string (date-time) no Instant the record was created, as ISO 8601 UTC (YYYY-MM-DDTHH:mm:ss.sssZ), when recorded.
lastModifiedDate string (date-time) yes Instant the record last changed, as ISO 8601 UTC (YYYY-MM-DDTHH:mm:ss.sssZ). Poll on this to sync incrementally.
priceBookEntries array of object yes Price-book entries of the header: one for flat pricing, one per tier for tiered models, one per rate card for rate-card pricing. Empty when the header has none.
priceBookEntries[].id string yes Id of the entry (a UUID).
priceBookEntries[].priceBookEntryNumber string no System-generated entry number.
priceBookEntries[].listPrice string (decimal) no List price, or the rate for a rate-card entry, as a decimal in the header currency (see currency).
priceBookEntries[].fromQuantity string (decimal) no Inclusive lower bound of this tier's quantity range. Tiered models only.
priceBookEntries[].toQuantity string (decimal) no Inclusive upper bound of this tier's quantity range. Absent on the open-ended top tier.
priceBookEntries[].priceModel string no How this tier prices quantity. One of 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'. Tiered and rate-card models only.
priceBookEntries[].rateCardEntry object no Rate card priced by this entry. Rate-card pricing only.
priceBookEntries[].rateCardEntry.id string yes Id of the rate-card entry (a UUID).
priceBookEntries[].rateCardEntry.billableComponentId string no Id of the billable component this rate prices (a UUID).
priceBookEntries[].rateCardEntry.unitOfMeasure string yes Unit of measure of the rate card. One of 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'.
priceBookEntries[].rateCardEntry.description string no Rate-card description.
priceBookEntries[].rateCardEntry.usageType string no Usage type the rate applies to. One of 'consumption', 'overage', 'thresholdCounter', 'payg'.
priceBookEntries[].rateCardEntry.billableUnitOfMeasure string no Unit of measure the usage is billed in, when it differs from unitOfMeasure.
priceBookEntries[].rateCardEntry.conversion string (decimal) no Conversion factor from unitOfMeasure to billableUnitOfMeasure. A quantity, not an amount.
priceBookEntries[].rateCardEntry.invoiceFrequency string no Invoice frequency of the rate card, when it differs from the line. One of 'monthly', 'biMonthly', 'quarterly', 'semiAnnually', 'annually', 'once', 'custom', 'template', 'milestone', 'allAtOnce', 'termEnd'.
priceBookEntries[].rateCardEntry.priceModel string no Price model of the rate card, when it differs from the line. One of 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'.
priceBookEntries[].externalIdentifiers array of object no External identifiers owned by other systems for this entry. At most one entry per fieldName. Absent when it has none.
priceBookEntries[].externalIdentifiers[].fieldName string yes Configured key of the external identifier — a stable camelCase slug, not the human-readable label.
priceBookEntries[].externalIdentifiers[].value string yes The identifier as the source system holds it.
priceBookEntries[].externalIdentifiers[].externalUrl string no Absolute http(s) link to the object in the originating system, when one is stored.

Errors

Code Status
INVALID_ID 400
NOT_FOUND 400

Statuses