Allocate Cost Entry to Stock Take
POST/api/cost-entries/:costEntry/allocate/stock-take/:stockTake
Allocates the cost entry across the items of a stock take, creating one allocation per product using the chosen proration strategy (default quantity_based).
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields: strategy (optional proration strategy: straight_line, front_loaded, back_loaded, revenue_based, cost_based, weight_based, volume_based, quantity_based, specific_line, manual), amount (optional - defaults to the cost entry's unallocated amount), allocation_date (defaults to today), period_start and period_end.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.