TRANXACT.AI Help

Accounting · Lease Accounting

Lease Charges

The charges that are not the rent: service charge, tax, insurance, marketing levy, parking. Each with its own basis, frequency and account.

Type REST6 operationsBase path /api/accounting/lease-chargesPublished as /api/v1/lease-charges

Download specification (OpenAPI 3.1) Screen: Lease Charges

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 Charges 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_charges · 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

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

GET/api/accounting/lease-chargesList lease charges

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "charge_type": "text",
      "name": "Example",
      "basis": "fixed",
      "amount": "1250.00",
      "rate_pct": "1250.00",
      "frequency": "monthly",
      "currency": "USD",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_code": "TAX-000001",
      "is_advance_on_budget": true
    }
  ],
  "count": 1
}

Sample request

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

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "charge_type": "text",
  "name": "Example",
  "basis": "fixed",
  "amount": "1250.00",
  "rate_pct": "1250.00",
  "frequency": "monthly",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code": "TAX-000001",
  "is_advance_on_budget": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
lease_iduuidYesLease
line_nointegerNoLine
charge_typetextNoType
nametextYesName
basistextNoBasis
Allowed: fixed per_sqm per_unit pct_of_rent pct_of_turnover actual_cost metered
amountnumericNoAmount
rate_pctnumericNoRate %
frequencytextNoFrequency
Allowed: monthly quarterly semi_annual annual on_demand
currencytextNoCurrency
gl_account_iduuidNoAccount
tax_codetextNoTax code
is_advance_on_budgetbooleanNoBilled on budget, settled on actual — The most argued-about number in commercial property, which is why both figures are kept.
budget_amountnumericNoBudget amount
actual_amountnumericNoActual amount
valid_fromdateNoFrom
valid_todateNoTo
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "line_no": 10,
  "charge_type": "text",
  "basis": "fixed",
  "amount": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "charge_type": "text",
  "name": "Example",
  "basis": "fixed",
  "amount": "1250.00",
  "rate_pct": "1250.00",
  "frequency": "monthly",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code": "TAX-000001",
  "is_advance_on_budget": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/lease-charges" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lease_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","line_no":10,"charge_type":"text","basis":"fixed","amount":"1250.00"}'
PUT/api/accounting/lease-charges/{id}Change a lease charge

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
charge_typetextNoType
nametextYesName
basistextNoBasis
Allowed: fixed per_sqm per_unit pct_of_rent pct_of_turnover actual_cost metered
amountnumericNoAmount
rate_pctnumericNoRate %
frequencytextNoFrequency
Allowed: monthly quarterly semi_annual annual on_demand
currencytextNoCurrency
gl_account_iduuidNoAccount
tax_codetextNoTax code
is_advance_on_budgetbooleanNoBilled on budget, settled on actual — The most argued-about number in commercial property, which is why both figures are kept.
budget_amountnumericNoBudget amount
actual_amountnumericNoActual amount
valid_fromdateNoFrom
valid_todateNoTo
is_activebooleanNoActive
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "charge_type": "text",
  "name": "Example",
  "basis": "fixed",
  "amount": "1250.00",
  "rate_pct": "1250.00",
  "frequency": "monthly",
  "currency": "USD",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code": "TAX-000001",
  "is_advance_on_budget": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/lease-charges/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-charges/{id}Delete a lease charge

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-charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/lease-charges/{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-charges/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 charge, 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_iduuidread, writeLease
line_nointegerread, writeLine
charge_typetextread, writeType
nametextread, writeName
basistextread, writeBasis
Allowed: fixed per_sqm per_unit pct_of_rent pct_of_turnover actual_cost metered
amountnumericread, writeAmount
rate_pctnumericread, writeRate %
frequencytextread, writeFrequency
Allowed: monthly quarterly semi_annual annual on_demand
currencytextread, writeCurrency
gl_account_iduuidread, writeAccount
tax_codetextread, writeTax code
is_advance_on_budgetbooleanread, writeBilled on budget, settled on actual — The most argued-about number in commercial property, which is why both figures are kept.
budget_amountnumericread, writeBudget amount
actual_amountnumericread, writeActual amount
valid_fromdateread, writeFrom
valid_todateread, writeTo
is_activebooleanread, writeActive
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 Charges 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.