TRANXACT.AI Help

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.

Type REST20 operationsBase path /api/accounting/leasesPublished as /api/v1/leases

Download specification (OpenAPI 3.1) Screen: Leases

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.leases · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
nametextYesName
roletextNoWe are the
Allowed: lessee lessor sublessor intercompany
lease_typetextNoAsset type
classificationtextNoClassification — Use the Classify action rather than typing this: the answer depends on the principle and five criteria.
transfers_ownershipbooleanNoOwnership transfers at the end
purchase_option_reasonably_certainbooleanNoPurchase option reasonably certain
term_major_part_of_lifebooleanNoTerm is a major part of the asset’s life
pv_substantially_all_fair_valuebooleanNoPV is substantially all of fair value
specialised_assetbooleanNoSpecialised asset with no alternative use
is_short_termbooleanNoShort term (12 months or less)
is_low_valuebooleanNoLow value
counterparty_supplier_iduuidNoLandlord / lessor (supplier)
counterparty_account_iduuidNoTenant (customer)
counterparty_org_iduuidNoGroup company (intercompany lease)
counterparty_nametextNoCounterparty name
property_iduuidNoProperty
rental_unit_iduuidNoRental unit
asset_iduuidNoAsset id
head_lease_iduuidNoHead lease (for a sublease)
signature_datedateNoSigned on
commencement_datedateNoCommences — When the asset becomes available for use — NOT the signature date, and the two are commonly months apart.
end_datedateNoEnds
term_monthsintegerNoTerm (months)
renewal_option_monthsintegerNoRenewal option (months)
renewal_reasonably_certainbooleanNoRenewal reasonably certain — An option is part of the term when its exercise is reasonably certain, and not when it is not.
termination_option_datedateNoTermination option
termination_penaltynumericNoTermination penalty
notice_period_daysintegerNoNotice period (days)
currencytextNoCurrency
payment_amountnumericNoPayment
payment_frequencytextNoFrequency
Allowed: monthly quarterly semi_annual annual weekly one_off
payment_timingtextNoPaid — 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_datedateNoFirst payment
escalation_typetextNoEscalation — 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_pctnumericNoEscalation %
escalation_amountnumericNoEscalation amount
escalation_monthsintegerNoEscalates every (months)
index_nametextNoIndex
index_base_valuenumericNoIndex base value
variable_payment_basistextNoVariable payment basis — Turnover or usage payments are expensed as incurred and never enter the liability.
discount_rate_pctnumericNoDiscount rate %
rate_basistextNoRate basis
Allowed: implicit incremental_borrowing group_rate risk_free
initial_direct_costsnumericNoInitial direct costs
lease_incentivesnumericNoIncentives received
prepaid_amountnumericNoPrepaid
restoration_provisionnumericNoRestoration provision
security_depositnumericNoSecurity deposit
residual_guaranteenumericNoResidual value guarantee
purchase_option_pricenumericNoPurchase option price
principle_iduuidNoAccounting principle
ledger_iduuidNoLedger
rou_asset_account_iduuidNoRight-of-use asset account
liability_account_iduuidNoLease liability account
interest_account_iduuidNoInterest account
depreciation_account_iduuidNoDepreciation account
rent_expense_account_iduuidNoRent expense account
cost_center_iduuidNoCost center
contract_reftextNoContract reference
document_urltextNoDocument
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
nametextYesName
roletextNoWe are the
Allowed: lessee lessor sublessor intercompany
lease_typetextNoAsset type
classificationtextNoClassification — Use the Classify action rather than typing this: the answer depends on the principle and five criteria.
transfers_ownershipbooleanNoOwnership transfers at the end
purchase_option_reasonably_certainbooleanNoPurchase option reasonably certain
term_major_part_of_lifebooleanNoTerm is a major part of the asset’s life
pv_substantially_all_fair_valuebooleanNoPV is substantially all of fair value
specialised_assetbooleanNoSpecialised asset with no alternative use
is_short_termbooleanNoShort term (12 months or less)
is_low_valuebooleanNoLow value
counterparty_supplier_iduuidNoLandlord / lessor (supplier)
counterparty_account_iduuidNoTenant (customer)
counterparty_org_iduuidNoGroup company (intercompany lease)
counterparty_nametextNoCounterparty name
property_iduuidNoProperty
rental_unit_iduuidNoRental unit
asset_iduuidNoAsset id
head_lease_iduuidNoHead lease (for a sublease)
signature_datedateNoSigned on
commencement_datedateNoCommences — When the asset becomes available for use — NOT the signature date, and the two are commonly months apart.
end_datedateNoEnds
term_monthsintegerNoTerm (months)
renewal_option_monthsintegerNoRenewal option (months)
renewal_reasonably_certainbooleanNoRenewal reasonably certain — An option is part of the term when its exercise is reasonably certain, and not when it is not.
termination_option_datedateNoTermination option
termination_penaltynumericNoTermination penalty
notice_period_daysintegerNoNotice period (days)
currencytextNoCurrency
payment_amountnumericNoPayment
payment_frequencytextNoFrequency
Allowed: monthly quarterly semi_annual annual weekly one_off
payment_timingtextNoPaid — 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_datedateNoFirst payment
escalation_typetextNoEscalation — 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_pctnumericNoEscalation %
escalation_amountnumericNoEscalation amount
escalation_monthsintegerNoEscalates every (months)
index_nametextNoIndex
index_base_valuenumericNoIndex base value
variable_payment_basistextNoVariable payment basis — Turnover or usage payments are expensed as incurred and never enter the liability.
discount_rate_pctnumericNoDiscount rate %
rate_basistextNoRate basis
Allowed: implicit incremental_borrowing group_rate risk_free
initial_direct_costsnumericNoInitial direct costs
lease_incentivesnumericNoIncentives received
prepaid_amountnumericNoPrepaid
restoration_provisionnumericNoRestoration provision
security_depositnumericNoSecurity deposit
residual_guaranteenumericNoResidual value guarantee
purchase_option_pricenumericNoPurchase option price
principle_iduuidNoAccounting principle
ledger_iduuidNoLedger
rou_asset_account_iduuidNoRight-of-use asset account
liability_account_iduuidNoLease liability account
interest_account_iduuidNoInterest account
depreciation_account_iduuidNoDepreciation account
rent_expense_account_iduuidNoRent expense account
cost_center_iduuidNoCost center
contract_reftextNoContract reference
document_urltextNoDocument
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, cashAccountNo

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/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

NameTypeDescription
idstring (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|reassessment

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/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, isTestRun

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/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, standard

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
lease_notextread onlyLease no
nametextread, writeName
roletextread, writeWe are the
Allowed: lessee lessor sublessor intercompany
lease_typetextread, writeAsset type
classificationtextread, writeClassification — Use the Classify action rather than typing this: the answer depends on the principle and five criteria.
transfers_ownershipbooleanread, writeOwnership transfers at the end
purchase_option_reasonably_certainbooleanread, writePurchase option reasonably certain
term_major_part_of_lifebooleanread, writeTerm is a major part of the asset’s life
pv_substantially_all_fair_valuebooleanread, writePV is substantially all of fair value
specialised_assetbooleanread, writeSpecialised asset with no alternative use
is_short_termbooleanread, writeShort term (12 months or less)
is_low_valuebooleanread, writeLow value
counterparty_supplier_iduuidread, writeLandlord / lessor (supplier)
counterparty_account_iduuidread, writeTenant (customer)
counterparty_org_iduuidread, writeGroup company (intercompany lease)
counterparty_nametextread, writeCounterparty name
property_iduuidread, writeProperty
rental_unit_iduuidread, writeRental unit
asset_iduuidread, writeAsset id
head_lease_iduuidread, writeHead lease (for a sublease)
signature_datedateread, writeSigned on
commencement_datedateread, writeCommences — When the asset becomes available for use — NOT the signature date, and the two are commonly months apart.
end_datedateread, writeEnds
term_monthsintegerread, writeTerm (months)
renewal_option_monthsintegerread, writeRenewal option (months)
renewal_reasonably_certainbooleanread, writeRenewal reasonably certain — An option is part of the term when its exercise is reasonably certain, and not when it is not.
termination_option_datedateread, writeTermination option
termination_penaltynumericread, writeTermination penalty
notice_period_daysintegerread, writeNotice period (days)
currencytextread, writeCurrency
payment_amountnumericread, writePayment
payment_frequencytextread, writeFrequency
Allowed: monthly quarterly semi_annual annual weekly one_off
payment_timingtextread, writePaid — 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_datedateread, writeFirst payment
escalation_typetextread, writeEscalation — 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_pctnumericread, writeEscalation %
escalation_amountnumericread, writeEscalation amount
escalation_monthsintegerread, writeEscalates every (months)
index_nametextread, writeIndex
index_base_valuenumericread, writeIndex base value
variable_payment_basistextread, writeVariable payment basis — Turnover or usage payments are expensed as incurred and never enter the liability.
discount_rate_pctnumericread, writeDiscount rate %
rate_basistextread, writeRate basis
Allowed: implicit incremental_borrowing group_rate risk_free
initial_direct_costsnumericread, writeInitial direct costs
lease_incentivesnumericread, writeIncentives received
prepaid_amountnumericread, writePrepaid
restoration_provisionnumericread, writeRestoration provision
security_depositnumericread, writeSecurity deposit
residual_guaranteenumericread, writeResidual value guarantee
purchase_option_pricenumericread, writePurchase option price
initial_liabilitynumericread onlyInitial liability
initial_rou_assetnumericread onlyInitial rou asset
total_paymentsnumericread onlyTotal payments
total_interestnumericread onlyTotal interest
principle_iduuidread, writeAccounting principle
ledger_iduuidread, writeLedger
rou_asset_account_iduuidread, writeRight-of-use asset account
liability_account_iduuidread, writeLease liability account
interest_account_iduuidread, writeInterest account
depreciation_account_iduuidread, writeDepreciation account
rent_expense_account_iduuidread, writeRent expense account
cost_center_iduuidread, writeCost center
statustextread onlyStatus
versionintegerread onlyVersion
contract_reftextread, writeContract reference
document_urltextread, writeDocument
notestextread, writeNotes
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Leases for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.