List accounting release templates

Authorization

Send one of these on every request. See Authentication for how to get credentials.

• API key

  Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

• Bearer token

Query parameters

• sort string

  Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

  Available directions: asc, desc.

  Available fields: name, method, type, deferralAccountId, createdAt.

• filter string

  Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

  Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

  Available fields: id, companyId, name, method, type, deferralAccountId, initialAmountPercentage, residualAmountPercentage, status.

• limit integer · int32

  Maximum number of items to return. Default is 50, maximum is 200.

• offset integer · int64deprecated

  Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

• cursor string

  The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

Response

• records array of object

  List of records for the current page

  • id string · uuid

    Unique identifier for the object

  • companyId string · uuid

    ID of the company

  • createdBy string · uuid

    ID of the user who created the template

  • name string

    Name of the template

  • method string

    How the amount is spread across the release schedule

    • STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT - An equal amount each period, with the first and last periods adjusted for partial months
    • REDUCING_BALANCE - A fixed fraction of the remaining balance each period, so the amount declines over time

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT REDUCING_BALANCE

  • type string

    The kind of document or asset this template applies to. Fixed at creation

    • AR - Accounts receivable. Releases deferred revenue on invoice receivables
    • AP - Accounts payable. Releases prepaid expenses on invoice payables, credit notes and card transactions
    • JE - Journal entries
    • CONTRACT - Contracts. Releases deferred revenue over the contract term
    • FIXED_ASSET - Fixed assets. Depreciates a capitalised asset over its useful life

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of AR AP JE CONTRACT FIXED_ASSET

  • deferralAccountId string · uuid

    ID of the ledger account holding the not-yet-released balance. Fixed at creation

  • contractAccountId string · uuid

    ID of the ledger account used when the template is applied to a contract. Fixed at creation

  • additionsAccountId string · uuid

    ID of the ledger account credited or debited by each generated release. Falls back to the deferral account when not set. Fixed at creation

  • disposalAccountId string · uuid

    ID of the ledger account used when a fixed asset is disposed of. Fixed at creation

  • profitAccountId string · uuid

    ID of the ledger account for a gain on disposal. Fixed at creation

  • lossAccountId string · uuid

    ID of the ledger account for a loss on disposal. Fixed at creation

  • initialAmountPercentage number

    Fraction of the amount released in the first period, as a decimal between 0 and 1

  • residualAmountPercentage number

    Fraction of the amount left unreleased at the end of the schedule, as a decimal between 0 and 1

  • residualAmount integer · int64

    Absolute amount in cents left unreleased at the end of the schedule. Only for the REDUCING_BALANCE method, and mutually exclusive with reducingRate

  • reducingRate number

    Fraction of the remaining balance released each period, as a decimal between 0 and 1. Only for the REDUCING_BALANCE method, and mutually exclusive with residualAmount

  • accumulatePastReleasesEnabled boolean

    Whether releases for periods that have already passed are posted as a single catch-up amount in the current period

  • defaultDuration integer · int32

    Default number of months the release schedule runs for. Can be overridden per document

  • context string

    Free-text notes on the template

  • status string

    Template status

    • ACTIVE - The template can be assigned to new documents and contracts
    • ARCHIVED - The template is archived and can no longer be assigned. Existing releases are unaffected

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of ACTIVE ARCHIVED

  • createdAt string · date-time

    Timestamp when the template was created

  • updatedAt string · date-time

    Timestamp when the template was last updated

• hasMore boolean

  Boolean flag indicating if there are more records available

• total integer · int64deprecated

  Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.

• nextCursor string

  Cursor for fetching the next page (only for cursor pagination)

• prevCursor string

  Cursor for fetching the previous page (only for cursor pagination)