Amortization Schedule Lines

GET /accounting/amortization-schedule-lines

Group: Accounting › Amortization Schedule Lines · Operation ID: amortizationScheduleLines

Returns a list of amortization schedule instalments, one line per schedule per period. Filter outstanding=true, by entity and book, to find what a period close still owes.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
amortizationScheduleHeaderId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
bookId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
scheduledPeriodId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
scheduledPeriodStartDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
scheduledPeriodEndDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
transactionCurrency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
amortizationMethod — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isJournalEntryPosted — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isConfirmedZero — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
outstanding — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, scheduledPeriodStartDate, scheduledPeriodEndDate, amount, amortizationStartDate, amortizationEndDate, lastModifiedDate
Selectable: id, amortizationScheduleHeaderId, entityId, entityName, bookId, bookName, scheduledPeriodId, scheduledPeriodName, scheduledPeriodStartDate, scheduledPeriodEndDate, amount, transactionCurrency, amortizationMethod, amortizationStartDate, amortizationEndDate, isJournalEntryPosted, isConfirmedZero, outstanding, lastModifiedDate

Response

200 Success

Under data, an array of amortizationScheduleLinesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for this amortization schedule line.
`amortizationScheduleHeaderId`	string or null	no	The identifier of the amortization schedule this line belongs to. Several lines, one per period, share it. There is no endpoint for the schedule itself.
`entityId`	string or null	no	The identifier of the legal entity this instalment belongs to. See id on GET base/entities. It is joined in through the schedule's source journal entry line, so it is absent when that link is broken, and such a row does not match an entityId filter even though it is still returned.
`entityName`	string or null	no	The name of the legal entity this instalment belongs to.
`bookId`	string or null	no	The identifier of the accounting book this schedule posts into. See id on GET accounting/books/:id.
`bookName`	string or null	no	The name of the accounting book this schedule posts into.
`scheduledPeriodId`	string or null	no	The identifier of the accounting period this instalment is scheduled into. See accountingPeriodId on GET accounting/accounting-periods. To check whether a close is blocked, bound by scheduledPeriodEndDate instead, since filtering on this misses earlier unposted instalments.
`scheduledPeriodName`	string or null	no	The display name of the scheduled period as its fiscal calendar defines it, for example 'Aug 2026'. The format varies by calendar, so do not parse it. Match on dates instead.
`scheduledPeriodStartDate`	string (date) or null	no	The first day of the scheduled period, inclusive. Format YYYY-MM-DD.
`scheduledPeriodEndDate`	string (date) or null	no	The last day of the scheduled period, inclusive. Format YYYY-MM-DD. Use this bound for a close check: it catches every instalment due on or before the period being closed.
`amount`	string (decimal) or null	no	The amount of this instalment, in the currency given by transactionCurrency. Read the two together.
`transactionCurrency`	string or null	no	The currency that denominates amount, taken from the schedule's source journal entry line. Format ISO 4217, for example 'USD'. Absent on a row whose header or source document was deleted. A query that does not filter by book can return rows in several currencies.
`amortizationMethod`	string or null	no	How the schedule spreads its total, from the header. Possible values: 'straightLine', 'straightLineProRateFirstLast', 'exactDays', 'pointInTime', 'usageBased'.
`amortizationStartDate`	string (date) or null	no	The first day the schedule amortizes over, from the header. Format YYYY-MM-DD. This is the schedule's start, not this instalment's period.
`amortizationEndDate`	string (date) or null	no	The last day the schedule amortizes over, from the header. Format YYYY-MM-DD.
`isJournalEntryPosted`	boolean or null	no	Whether this instalment's journal entry has been posted. Prefer filtering on outstanding, which combines this with isConfirmedZero.
`isConfirmedZero`	boolean or null	no	Whether this instalment was confirmed as a zero and so needs no posting. It can be unset, which means it is not confirmed zero. Do not negate it directly. Filter on outstanding instead.
`outstanding`	boolean or null	no	Whether this instalment still has to happen, true when it is neither posted nor a confirmed zero. This is the field a period-close check filters on.
`lastModifiedDate`	string (date-time) or null	no	The date and time this schedule line last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. It tracks the line itself, so a change to the header or the joined entity, book or period does not advance it.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error