Get Amortization Schedule Status
GET/api/amortization-schedules/:amortizationSchedule/status
Get a compact processing-progress summary for an amortization schedule - useful for dashboards and polling without fetching the full period list.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response fields:
total_periods,processed_periods,pending_periods,is_fully_processed- Progress counters.total_amount/amount_per_period- The amount being amortized.next_period- The next unprocessed period (period_number,period_start,period_end,amount, andis_due, which is true once the period's end date has passed). Null when every period has been processed.allocation_config- The stored allocation target:allocatable_type(product,brand,supplier,sales_channel),allocatable_id,allocatable_name(the target's name or SKU), andproration_strategy.
Schedules are created with POST /api/cost-entries/:costEntry/amortization-schedule (documented under Cost Entries).
Authentication: Requires Bearer token. Scope: purchase-orders (read/write).
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.