Create Amortization Schedule
POST/api/cost-entries/:costEntry/amortization-schedule
Creates an amortization schedule for a cost entry, spreading its amount across future periods. Each period, when processed, allocates its share to the configured target. A cost entry can have only one schedule.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Required fields: start_date (Y-m-d), periods (1-120), frequency (daily, weekly, monthly, quarterly, annually), method (straight_line, front_loaded, back_loaded), allocatable_type (product, brand, supplier or sales_channel) and allocatable_id.
Optional: proration_strategy (default specific_line).
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.