List Cost Allocations
GET/api/cost-allocations
Returns a paginated list of cost allocations. A cost allocation assigns part (or all) of a cost entry's amount to a target entity - a product, brand, supplier, sales channel or sales order line - for landed cost and profitability reporting.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each allocation includes the target type, a human-readable type label, a summary of the target entity (allocatable), the allocated amount in the cost entry's currency and in the account currency (amount_in_tenant_currency), the proration strategy that produced it, and whether it was generated by an amortization schedule (is_amortized).
Filtering uses plain query parameters (not the filter[...] syntax used elsewhere in this API): cost_entry_id, allocatable_type, allocatable_id, date_from, date_to and proration_strategy - see each parameter's description. Results are always sorted by allocation date, newest first; there is no sort parameter.
Pagination: page (default 1) and per_page (default 15, max 100).
Authentication: Requires Bearer token. Scope: purchase-orders (read/write).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.