Update accounting release template
Updates an existing accounting release template. Only the fields present in the request body are changed.
The ledger accounts and type are fixed at creation and cannot be updated. To use different ones, create a new template and archive this one.
Request
- Base URLhttps://light.inc (the document declares no server; this is the origin it was published from)
- Auth
- API key in header Authorization
- or HTTP bearer
Path parameters
Request body
Name of the template
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.
Legacy alternative to accumulationMode. When sent alone, true selects POSTING_DATE and false selects OFF. Prefer sending accumulationMode alone. When both fields are sent, this must equal whether accumulationMode is POSTING_DATE
OFF keeps every scheduled release on its original date. POSTING_DATE combines releases dated before the document posting date with the first scheduled release on or after that date; if none remains, it uses the document posting date. OPEN_PERIOD finds the first postable date from the schedule start and combines earlier releases with the first scheduled release on or after that date; if none remains, it uses the first postable date. It applies only when the schedule starts before the document posting date. Later closed or locked periods still block posting. The document posting date stays unchanged. Omit both this field and accumulatePastReleasesEnabled to preserve the current mode
⚠️ This enum is not exhaustive; new values may be added in the future.
Default number of months the release schedule runs for. Send null to clear it
Fraction of the amount released in the first period, as a decimal between 0 and 1. Send null to clear it
Fraction of the amount left unreleased at the end of the schedule, as a decimal between 0 and 1. Send null to clear it
Absolute amount in cents left unreleased at the end of the schedule. Send null to clear it
Fraction of the remaining balance released each period, as a decimal between 0 and 1. Send null to clear it
Free-text notes on the template. Send null to clear it
Response
default response
Unique identifier for the object
ID of the company
ID of the user who created the template
Name of the template
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.
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.
ID of the ledger account holding the not-yet-released balance. Fixed at creation
ID of the ledger account used when the template is applied to a contract. Fixed at creation
ID of the ledger account credited or debited by each generated release. Falls back to the deferral account when not set. Fixed at creation
ID of the ledger account used when a fixed asset is disposed of. Fixed at creation
ID of the ledger account for a gain on disposal. Fixed at creation
ID of the ledger account for a loss on disposal. Fixed at creation
Fraction of the amount released in the first period, as a decimal between 0 and 1
Fraction of the amount left unreleased at the end of the schedule, as a decimal between 0 and 1
Absolute amount in cents left unreleased at the end of the schedule. Only for the REDUCING_BALANCE method, and mutually exclusive with reducingRate
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
Legacy representation of accumulationMode. True only for POSTING_DATE; false for OFF and OPEN_PERIOD. Read accumulationMode to distinguish all modes
OFF keeps every scheduled release on its original date. POSTING_DATE combines releases dated before the document posting date with the first scheduled release on or after that date; if none remains, it uses the document posting date. OPEN_PERIOD finds the first postable date from the schedule start and combines earlier releases with the first scheduled release on or after that date; if none remains, it uses the first postable date. It applies only when the schedule starts before the document posting date. Later closed or locked periods still block posting. The document posting date stays unchanged.
⚠️ This enum is not exhaustive; new values may be added in the future.
Default number of months the release schedule runs for. Can be overridden per document
Free-text notes on the template
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.
Timestamp when the template was created
Timestamp when the template was last updated
Changes
No recorded changes to this operation across all 1 revision of this API.