Accounting · Lease Accounting
Leases
IFRS 16 and ASC 842 give different answers for the same lease, and a group reporting both needs both. The classification is applied rather than typed.
/api/accounting/leasesPublished as /api/v1/leasesOverview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › Leases on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.leases · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
20 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/leasesList leases
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lease_no": "LEA-000001",
"name": "Example",
"role": "lessee",
"lease_type": "text",
"classification": "text",
"transfers_ownership": true,
"purchase_option_reasonably_certain": true,
"term_major_part_of_life": true,
"pv_substantially_all_fair_value": true,
"specialised_asset": true,
"is_short_term": true,
"is_low_value": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/leases?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/leases/{id}Read one lease
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lease_no": "LEA-000001",
"name": "Example",
"role": "lessee",
"lease_type": "text",
"classification": "text",
"transfers_ownership": true,
"purchase_option_reasonably_certain": true,
"term_major_part_of_life": true,
"pv_substantially_all_fair_value": true,
"specialised_asset": true,
"is_short_term": true,
"is_low_value": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/leasesCreate a lease
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
role | text | No | We are the Allowed: lessee lessor sublessor intercompany |
lease_type | text | No | Asset type |
classification | text | No | Classification — Use the Classify action rather than typing this: the answer depends on the principle and five criteria. |
transfers_ownership | boolean | No | Ownership transfers at the end |
purchase_option_reasonably_certain | boolean | No | Purchase option reasonably certain |
term_major_part_of_life | boolean | No | Term is a major part of the asset’s life |
pv_substantially_all_fair_value | boolean | No | PV is substantially all of fair value |
specialised_asset | boolean | No | Specialised asset with no alternative use |
is_short_term | boolean | No | Short term (12 months or less) |
is_low_value | boolean | No | Low value |
counterparty_supplier_id | uuid | No | Landlord / lessor (supplier) |
counterparty_account_id | uuid | No | Tenant (customer) |
counterparty_org_id | uuid | No | Group company (intercompany lease) |
counterparty_name | text | No | Counterparty name |
property_id | uuid | No | Property |
rental_unit_id | uuid | No | Rental unit |
asset_id | uuid | No | Asset id |
head_lease_id | uuid | No | Head lease (for a sublease) |
signature_date | date | No | Signed on |
commencement_date | date | No | Commences — When the asset becomes available for use — NOT the signature date, and the two are commonly months apart. |
end_date | date | No | Ends |
term_months | integer | No | Term (months) |
renewal_option_months | integer | No | Renewal option (months) |
renewal_reasonably_certain | boolean | No | Renewal reasonably certain — An option is part of the term when its exercise is reasonably certain, and not when it is not. |
termination_option_date | date | No | Termination option |
termination_penalty | numeric | No | Termination penalty |
notice_period_days | integer | No | Notice period (days) |
currency | text | No | Currency |
payment_amount | numeric | No | Payment |
payment_frequency | text | No | Frequency Allowed: monthly quarterly semi_annual annual weekly one_off |
payment_timing | text | No | Paid — An annuity due is worth more than an ordinary annuity by one period’s discount — about 2% on a five-year lease. Allowed: advance arrears |
first_payment_date | date | No | First payment |
escalation_type | text | No | Escalation — Fixed escalations enter the liability; index-linked ones do not and are picked up by a remeasurement. Allowed: none fixed_pct fixed_amount index market_review stepped |
escalation_pct | numeric | No | Escalation % |
escalation_amount | numeric | No | Escalation amount |
escalation_months | integer | No | Escalates every (months) |
index_name | text | No | Index |
index_base_value | numeric | No | Index base value |
variable_payment_basis | text | No | Variable payment basis — Turnover or usage payments are expensed as incurred and never enter the liability. |
discount_rate_pct | numeric | No | Discount rate % |
rate_basis | text | No | Rate basis Allowed: implicit incremental_borrowing group_rate risk_free |
initial_direct_costs | numeric | No | Initial direct costs |
lease_incentives | numeric | No | Incentives received |
prepaid_amount | numeric | No | Prepaid |
restoration_provision | numeric | No | Restoration provision |
security_deposit | numeric | No | Security deposit |
residual_guarantee | numeric | No | Residual value guarantee |
purchase_option_price | numeric | No | Purchase option price |
principle_id | uuid | No | Accounting principle |
ledger_id | uuid | No | Ledger |
rou_asset_account_id | uuid | No | Right-of-use asset account |
liability_account_id | uuid | No | Lease liability account |
interest_account_id | uuid | No | Interest account |
depreciation_account_id | uuid | No | Depreciation account |
rent_expense_account_id | uuid | No | Rent expense account |
cost_center_id | uuid | No | Cost center |
contract_ref | text | No | Contract reference |
document_url | text | No | Document |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"role": "lessee",
"lease_type": "text",
"classification": "text",
"transfers_ownership": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lease_no": "LEA-000001",
"name": "Example",
"role": "lessee",
"lease_type": "text",
"classification": "text",
"transfers_ownership": true,
"purchase_option_reasonably_certain": true,
"term_major_part_of_life": true,
"pv_substantially_all_fair_value": true,
"specialised_asset": true,
"is_short_term": true,
"is_low_value": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","role":"lessee","lease_type":"text","classification":"text","transfers_ownership":true}'PUT/api/accounting/leases/{id}Change a lease
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
role | text | No | We are the Allowed: lessee lessor sublessor intercompany |
lease_type | text | No | Asset type |
classification | text | No | Classification — Use the Classify action rather than typing this: the answer depends on the principle and five criteria. |
transfers_ownership | boolean | No | Ownership transfers at the end |
purchase_option_reasonably_certain | boolean | No | Purchase option reasonably certain |
term_major_part_of_life | boolean | No | Term is a major part of the asset’s life |
pv_substantially_all_fair_value | boolean | No | PV is substantially all of fair value |
specialised_asset | boolean | No | Specialised asset with no alternative use |
is_short_term | boolean | No | Short term (12 months or less) |
is_low_value | boolean | No | Low value |
counterparty_supplier_id | uuid | No | Landlord / lessor (supplier) |
counterparty_account_id | uuid | No | Tenant (customer) |
counterparty_org_id | uuid | No | Group company (intercompany lease) |
counterparty_name | text | No | Counterparty name |
property_id | uuid | No | Property |
rental_unit_id | uuid | No | Rental unit |
asset_id | uuid | No | Asset id |
head_lease_id | uuid | No | Head lease (for a sublease) |
signature_date | date | No | Signed on |
commencement_date | date | No | Commences — When the asset becomes available for use — NOT the signature date, and the two are commonly months apart. |
end_date | date | No | Ends |
term_months | integer | No | Term (months) |
renewal_option_months | integer | No | Renewal option (months) |
renewal_reasonably_certain | boolean | No | Renewal reasonably certain — An option is part of the term when its exercise is reasonably certain, and not when it is not. |
termination_option_date | date | No | Termination option |
termination_penalty | numeric | No | Termination penalty |
notice_period_days | integer | No | Notice period (days) |
currency | text | No | Currency |
payment_amount | numeric | No | Payment |
payment_frequency | text | No | Frequency Allowed: monthly quarterly semi_annual annual weekly one_off |
payment_timing | text | No | Paid — An annuity due is worth more than an ordinary annuity by one period’s discount — about 2% on a five-year lease. Allowed: advance arrears |
first_payment_date | date | No | First payment |
escalation_type | text | No | Escalation — Fixed escalations enter the liability; index-linked ones do not and are picked up by a remeasurement. Allowed: none fixed_pct fixed_amount index market_review stepped |
escalation_pct | numeric | No | Escalation % |
escalation_amount | numeric | No | Escalation amount |
escalation_months | integer | No | Escalates every (months) |
index_name | text | No | Index |
index_base_value | numeric | No | Index base value |
variable_payment_basis | text | No | Variable payment basis — Turnover or usage payments are expensed as incurred and never enter the liability. |
discount_rate_pct | numeric | No | Discount rate % |
rate_basis | text | No | Rate basis Allowed: implicit incremental_borrowing group_rate risk_free |
initial_direct_costs | numeric | No | Initial direct costs |
lease_incentives | numeric | No | Incentives received |
prepaid_amount | numeric | No | Prepaid |
restoration_provision | numeric | No | Restoration provision |
security_deposit | numeric | No | Security deposit |
residual_guarantee | numeric | No | Residual value guarantee |
purchase_option_price | numeric | No | Purchase option price |
principle_id | uuid | No | Accounting principle |
ledger_id | uuid | No | Ledger |
rou_asset_account_id | uuid | No | Right-of-use asset account |
liability_account_id | uuid | No | Lease liability account |
interest_account_id | uuid | No | Interest account |
depreciation_account_id | uuid | No | Depreciation account |
rent_expense_account_id | uuid | No | Rent expense account |
cost_center_id | uuid | No | Cost center |
contract_ref | text | No | Contract reference |
document_url | text | No | Document |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"role": "lessee"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lease_no": "LEA-000001",
"name": "Example",
"role": "lessee",
"lease_type": "text",
"classification": "text",
"transfers_ownership": true,
"purchase_option_reasonably_certain": true,
"term_major_part_of_life": true,
"pv_substantially_all_fair_value": true,
"specialised_asset": true,
"is_short_term": true,
"is_low_value": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","role":"lessee"}'DELETE/api/accounting/leases/{id}Delete a lease
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/leases/maturityMaturity
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/leases/maturity" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/leases/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/accounting/leases/{id}/classifyClassify
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/classify" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/leases/{id}/commenceCommence
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
post, rouAccountNo, liabilityAccountNo, cashAccountNoResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/commence" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"post":"value","rouAccountNo":"value","liabilityAccountNo":"value","cashAccountNo":"value"}'POST/api/accounting/leases/{id}/remeasureRemeasure
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
eventType, effectiveDate, newPayment, newTermMonths, newRatePct, reason, scopeReductionPct; eventType one of commencement|remeasurement|modification|index_review|option_exercised|option_lapsed|termination|impairment|transfer|expiry|reassessmentResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/remeasure" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"eventType":"value","effectiveDate":"value","newPayment":"value","newTermMonths":"value","newRatePct":"value","reason":"value"}'POST/api/accounting/leases/runRun
Request body
The keys this action reads (* = required; "one of" lists the only values):
ledgerId, periodCode, isTestRunResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/run" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"ledgerId":"value","periodCode":"value","isTestRun":"value"}'POST/api/accounting/leases/what-ifWhat if
Request body
The keys this action reads (* = required; "one of" lists the only values):
payment, termMonths, ratePct, frequency, timing, escalationPct, escalationMonths, initialDirectCosts, incentives, standardResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/what-if" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"payment":"value","termMonths":"value","ratePct":"value","frequency":"value","timing":"value","escalationPct":"value"}'GET/api/accounting/leases/{parentId}/componentsComponents
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/leases/{parentId}/componentsComponents
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/leases/{parentId}/components/{lineId}Components
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/leases/{parentId}/components/{lineId}Components
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/leases/{parentId}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/leases/{parentId}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/leases/{parentId}/schedule/{lineId}Schedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/leases/{parentId}/schedule/{lineId}Schedule
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/leases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a lease, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
lease_no | text | read only | Lease no |
name | text | read, write | Name |
role | text | read, write | We are the Allowed: lessee lessor sublessor intercompany |
lease_type | text | read, write | Asset type |
classification | text | read, write | Classification — Use the Classify action rather than typing this: the answer depends on the principle and five criteria. |
transfers_ownership | boolean | read, write | Ownership transfers at the end |
purchase_option_reasonably_certain | boolean | read, write | Purchase option reasonably certain |
term_major_part_of_life | boolean | read, write | Term is a major part of the asset’s life |
pv_substantially_all_fair_value | boolean | read, write | PV is substantially all of fair value |
specialised_asset | boolean | read, write | Specialised asset with no alternative use |
is_short_term | boolean | read, write | Short term (12 months or less) |
is_low_value | boolean | read, write | Low value |
counterparty_supplier_id | uuid | read, write | Landlord / lessor (supplier) |
counterparty_account_id | uuid | read, write | Tenant (customer) |
counterparty_org_id | uuid | read, write | Group company (intercompany lease) |
counterparty_name | text | read, write | Counterparty name |
property_id | uuid | read, write | Property |
rental_unit_id | uuid | read, write | Rental unit |
asset_id | uuid | read, write | Asset id |
head_lease_id | uuid | read, write | Head lease (for a sublease) |
signature_date | date | read, write | Signed on |
commencement_date | date | read, write | Commences — When the asset becomes available for use — NOT the signature date, and the two are commonly months apart. |
end_date | date | read, write | Ends |
term_months | integer | read, write | Term (months) |
renewal_option_months | integer | read, write | Renewal option (months) |
renewal_reasonably_certain | boolean | read, write | Renewal reasonably certain — An option is part of the term when its exercise is reasonably certain, and not when it is not. |
termination_option_date | date | read, write | Termination option |
termination_penalty | numeric | read, write | Termination penalty |
notice_period_days | integer | read, write | Notice period (days) |
currency | text | read, write | Currency |
payment_amount | numeric | read, write | Payment |
payment_frequency | text | read, write | Frequency Allowed: monthly quarterly semi_annual annual weekly one_off |
payment_timing | text | read, write | Paid — An annuity due is worth more than an ordinary annuity by one period’s discount — about 2% on a five-year lease. Allowed: advance arrears |
first_payment_date | date | read, write | First payment |
escalation_type | text | read, write | Escalation — Fixed escalations enter the liability; index-linked ones do not and are picked up by a remeasurement. Allowed: none fixed_pct fixed_amount index market_review stepped |
escalation_pct | numeric | read, write | Escalation % |
escalation_amount | numeric | read, write | Escalation amount |
escalation_months | integer | read, write | Escalates every (months) |
index_name | text | read, write | Index |
index_base_value | numeric | read, write | Index base value |
variable_payment_basis | text | read, write | Variable payment basis — Turnover or usage payments are expensed as incurred and never enter the liability. |
discount_rate_pct | numeric | read, write | Discount rate % |
rate_basis | text | read, write | Rate basis Allowed: implicit incremental_borrowing group_rate risk_free |
initial_direct_costs | numeric | read, write | Initial direct costs |
lease_incentives | numeric | read, write | Incentives received |
prepaid_amount | numeric | read, write | Prepaid |
restoration_provision | numeric | read, write | Restoration provision |
security_deposit | numeric | read, write | Security deposit |
residual_guarantee | numeric | read, write | Residual value guarantee |
purchase_option_price | numeric | read, write | Purchase option price |
initial_liability | numeric | read only | Initial liability |
initial_rou_asset | numeric | read only | Initial rou asset |
total_payments | numeric | read only | Total payments |
total_interest | numeric | read only | Total interest |
principle_id | uuid | read, write | Accounting principle |
ledger_id | uuid | read, write | Ledger |
rou_asset_account_id | uuid | read, write | Right-of-use asset account |
liability_account_id | uuid | read, write | Lease liability account |
interest_account_id | uuid | read, write | Interest account |
depreciation_account_id | uuid | read, write | Depreciation account |
rent_expense_account_id | uuid | read, write | Rent expense account |
cost_center_id | uuid | read, write | Cost center |
status | text | read only | Status |
version | integer | read only | Version |
contract_ref | text | read, write | Contract reference |
document_url | text | read, write | Document |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Leases for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.