TRANXACT.AI Help

Accounting · Lease Accounting

Lease Events

What changed, when, and by how much. A remeasurement is an event in its own right and the difference it makes to the liability is a disclosed number.

Type REST6 operationsBase path /api/accounting/lease-eventsPublished as /api/v1/lease-events

Download specification (OpenAPI 3.1) Screen: Lease Events

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 Events 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_events · 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-eventsList lease events

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",
      "event_no": "EVE-000001",
      "event_type": "text",
      "event_date": "2026-10-30",
      "effective_date": "2026-10-30",
      "description": "text",
      "reason": "text",
      "old_term_months": 10,
      "new_term_months": 10,
      "old_payment": "1250.00",
      "new_payment": "1250.00",
      "old_rate_pct": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "event_no": "EVE-000001",
  "event_type": "text",
  "event_date": "2026-10-30",
  "effective_date": "2026-10-30",
  "description": "text",
  "reason": "text",
  "old_term_months": 10,
  "new_term_months": 10,
  "old_payment": "1250.00",
  "new_payment": "1250.00",
  "old_rate_pct": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
lease_iduuidYesLease id
event_typetextYesEvent type
event_datedateNoEvent date
effective_datedateNoEffective date
descriptiontextNoDescription
reasontextNoReason
old_term_monthsintegerNoOld term months
new_term_monthsintegerNoNew term months
old_paymentnumericNoOld payment
new_paymentnumericNoNew payment
old_rate_pctnumericNoOld rate pct
new_rate_pctnumericNoNew rate pct

Sample body

{
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_type": "text",
  "event_date": "2026-10-30",
  "effective_date": "2026-10-30",
  "description": "text",
  "reason": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_no": "EVE-000001",
  "event_type": "text",
  "event_date": "2026-10-30",
  "effective_date": "2026-10-30",
  "description": "text",
  "reason": "text",
  "old_term_months": 10,
  "new_term_months": 10,
  "old_payment": "1250.00",
  "new_payment": "1250.00",
  "old_rate_pct": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/lease-events" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lease_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","event_type":"text","event_date":"2026-10-30","effective_date":"2026-10-30","description":"text","reason":"text"}'
PUT/api/accounting/lease-events/{id}Change a lease event

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 id
event_typetextYesEvent type
event_datedateNoEvent date
effective_datedateNoEffective date
descriptiontextNoDescription
reasontextNoReason
old_term_monthsintegerNoOld term months
new_term_monthsintegerNoNew term months
old_paymentnumericNoOld payment
new_paymentnumericNoNew payment
old_rate_pctnumericNoOld rate pct
new_rate_pctnumericNoNew rate pct

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lease_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_no": "EVE-000001",
  "event_type": "text",
  "event_date": "2026-10-30",
  "effective_date": "2026-10-30",
  "description": "text",
  "reason": "text",
  "old_term_months": 10,
  "new_term_months": 10,
  "old_payment": "1250.00",
  "new_payment": "1250.00",
  "old_rate_pct": "1250.00"
}

Sample request

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

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-events/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/lease-events/{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-events/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 event, 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 id
event_notextread onlyEvent no
event_typetextread, writeEvent type
event_datedateread, writeEvent date
effective_datedateread, writeEffective date
descriptiontextread, writeDescription
reasontextread, writeReason
old_term_monthsintegerread, writeOld term months
new_term_monthsintegerread, writeNew term months
old_paymentnumericread, writeOld payment
new_paymentnumericread, writeNew payment
old_rate_pctnumericread, writeOld rate pct
new_rate_pctnumericread, writeNew rate pct
old_liabilitynumericread onlyOld liability
new_liabilitynumericread onlyNew liability
liability_adjustmentnumericread onlyLiability adjustment
rou_adjustmentnumericread onlyRou adjustment
gain_lossnumericread onlyGain loss
new_versionintegerread onlyNew version
journal_iduuidread onlyJournal id
statustextread onlyStatus
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 › Lease Events 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.