TRANXACT.AI Help

Accounting · Lease Accounting

Lease Components

Three floors and eight parking spaces on one contract. The consideration is allocated across them at relative standalone price — the same problem IFRS 15 has, from the other side.

Type REST6 operationsBase path /api/accounting/lease-componentsPublished as /api/v1/lease-components

Download specification (OpenAPI 3.1) Screen: Lease Components

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 › Lease Components 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.lease_components
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

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/lease-componentsList lease components

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",
      "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "name": "Example",
      "component_type": "lease",
      "rental_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "quantity": "12.0000",
      "standalone_price": "1250.00",
      "allocated_amount": "1250.00",
      "allocation_pct": "1250.00",
      "is_separated": true,
      "useful_life_months": 10,
      "notes": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/lease-components?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/lease-components/{id}Read one lease component

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "name": "Example",
  "component_type": "lease",
  "rental_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "standalone_price": "1250.00",
  "allocated_amount": "1250.00",
  "allocation_pct": "1250.00",
  "is_separated": true,
  "useful_life_months": 10,
  "notes": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/lease-components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/lease-componentsCreate a lease component

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
lease_iduuidYesLease
line_nointegerNoLine
nametextYesName
component_typetextNoType — A non-lease component is an ordinary expense and never enters the liability.
Allowed: lease non_lease service maintenance insurance tax utilities
rental_unit_iduuidNoRental unit
asset_iduuidNoAsset id
quantitynumericNoQuantity
standalone_pricenumericNoStandalone price
allocated_amountnumericNoAllocated
allocation_pctnumericNoAllocation %
is_separatedbooleanNoSeparated from the lease
useful_life_monthsintegerNoUseful life (months)
notestextNoNotes

Sample body

{
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "line_no": 10,
  "component_type": "lease",
  "rental_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "name": "Example",
  "component_type": "lease",
  "rental_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "standalone_price": "1250.00",
  "allocated_amount": "1250.00",
  "allocation_pct": "1250.00",
  "is_separated": true,
  "useful_life_months": 10,
  "notes": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/lease-components" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lease_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","line_no":10,"component_type":"lease","rental_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","asset_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/accounting/lease-components/{id}Change a lease component

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
lease_iduuidYesLease
line_nointegerNoLine
nametextYesName
component_typetextNoType — A non-lease component is an ordinary expense and never enters the liability.
Allowed: lease non_lease service maintenance insurance tax utilities
rental_unit_iduuidNoRental unit
asset_iduuidNoAsset id
quantitynumericNoQuantity
standalone_pricenumericNoStandalone price
allocated_amountnumericNoAllocated
allocation_pctnumericNoAllocation %
is_separatedbooleanNoSeparated from the lease
useful_life_monthsintegerNoUseful life (months)
notestextNoNotes

Sample body

{
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "name": "Example",
  "component_type": "lease",
  "rental_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "standalone_price": "1250.00",
  "allocated_amount": "1250.00",
  "allocation_pct": "1250.00",
  "is_separated": true,
  "useful_life_months": 10,
  "notes": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/lease-components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lease_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example"}'
DELETE/api/accounting/lease-components/{id}Delete a lease component

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/lease-components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/lease-components/{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/lease-components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a lease component, 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
lease_iduuidread, writeLease
line_nointegerread, writeLine
nametextread, writeName
component_typetextread, writeType — A non-lease component is an ordinary expense and never enters the liability.
Allowed: lease non_lease service maintenance insurance tax utilities
rental_unit_iduuidread, writeRental unit
asset_iduuidread, writeAsset id
quantitynumericread, writeQuantity
standalone_pricenumericread, writeStandalone price
allocated_amountnumericread, writeAllocated
allocation_pctnumericread, writeAllocation %
is_separatedbooleanread, writeSeparated from the lease
useful_life_monthsintegerread, writeUseful life (months)
notestextread, writeNotes
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
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
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 › Lease Components 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.