Skip to main content

Get Amortization Schedule

GET 
/api/amortization-schedules/:amortizationSchedule

Get a single amortization schedule, including its full list of periods and the allocation configuration that is applied when each period is processed.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

An amortization schedule spreads a cost entry's unallocated amount over a series of periods (for example, an annual customs bond premium spread over four quarterly periods). Schedules are created with POST /api/cost-entries/:costEntry/amortization-schedule (documented under Cost Entries).

Response fields:

  • start_date / end_date - The date range covered by the schedule; end_date is the last period's end date.
  • total_periods, frequency (daily, weekly, monthly, quarterly, annually) and method (straight_line, front_loaded, back_loaded) - How the amount is distributed over time.
  • total_amount / amount_per_period - The amount being amortized and the per-period amount (the final period absorbs any rounding difference).
  • is_fully_processed, pending_periods_count, processed_periods_count - Processing progress.
  • allocation_config - Where each period's amount is allocated when processed: allocatable_type is one of product, brand, supplier, sales_channel; allocatable_id is the target entity's ID; proration_strategy is one of revenue_based, cost_based, weight_based, volume_based, quantity_based, specific_line, manual. allocatable_name is null on this endpoint; use the status endpoint to resolve the target's display name.
  • periods - Every period with its number, date range, amount, and processed state.

Authentication: Requires Bearer token. Scope: purchase-orders (read/write).

Request​

Responses​

OK

Response Headers
    Content-Type