Leases
Maintain lessee schedules, monthly postings and disclosures. Every operation below is generated from the published OpenAPI contract. Paths are company-scoped; read the Accounting API guide for scopes, step-up and permissions, and the Leases guide for the workflow.
- GET
/rest/v1.0/companies/{company_id}/accounting/leasesList leases - POST
/rest/v1.0/companies/{company_id}/accounting/leasesAdd a lease - GET
/rest/v1.0/companies/{company_id}/accounting/leases/{id}Show a lease - GET
/rest/v1.0/companies/{company_id}/accounting/leases/{id}/modificationsList lease modifications - POST
/rest/v1.0/companies/{company_id}/accounting/leases/{id}/modificationsModify a lease (ASC 842 remeasurement) - POST
/rest/v1.0/companies/{company_id}/accounting/leases/{id}/voidVoid a lease - GET
/rest/v1.0/companies/{company_id}/accounting/leases/disclosuresLease disclosures - GET
/rest/v1.0/companies/{company_id}/accounting/leases/runsList lease runs - POST
/rest/v1.0/companies/{company_id}/accounting/leases/runsPreview or post a lease run - GET
/rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}Show a lease run - POST
/rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}/reverseReverse a lease run
Accounting / Leases
GET/rest/v1.0/companies/{company_id}/accounting/leasesList leases
The ASC 842 lessee lease register with each lease's commencement liability and ROU. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- pageintegerqueryPage number
- per_pageintegerqueryPage size
Response · 200 · object[]
- idintegerrequired
- numberstringrequired
- namestringrequired
- lessorstring | nullrequired
- asset_classstringrequired
- entity_idintegerrequired
- classificationstringrequiredOne of: operating, finance.
- short_termbooleanrequired
- commencement_datestring (date)required
- term_monthsintegerrequired
- paymentstringrequired
- escalation_pctstringrequired
- payment_timingstringrequiredOne of: advance, arrears.
- discount_ratestringrequired
- rate_sourcestringrequiredOne of: implicit, incremental_borrowing, risk_free.
- initial_direct_costsstringrequired
- incentivesstringrequired
- purchase_option_pricestringrequired
- rou_account_idinteger | nullrequired
- liability_account_idinteger | nullrequired
- current_liability_account_idinteger | nullrequired
- cost_account_idintegerrequired
- interest_account_idinteger | nullrequired
- payment_account_idintegerrequired
- commencement_entry_idinteger | nullrequired
- statusstringrequiredA voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequiredEntry reversing the lease run lines; the commencement is reversed by its own reversal entry.
- initial_liabilitystringrequired
- initial_roustringrequired
- total_paymentsstringrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- rate_conventionstringrequiredOne of: nominal, effective.
- origin_lease_idinteger | nullrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/leases" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Leases
POST/rest/v1.0/companies/{company_id}/accounting/leasesAdd a lease
Adds a lessee lease (LS-#### numbering) and, unless it is a short-term election, posts the commencement entry Dr right-of-use asset / Cr lease liability at the present value of the payments (annual rate / 12, monthly). Accounts default to 1841/1842 ROU, 2741/2742 and 2535/2536 liabilities, 6200 (operating and short-term) or 6710 (finance amortization) cost, 8100 interest and 2130 payments. Terms are locked once added. Needs post_journal. Audited. Requires the accounting:write scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- Idempotency-KeystringheaderClient retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.
Request body
- leaseobjectrequired
- lease.namestringrequired
- lease.lessorstring | null
- lease.asset_classstringrequired
- lease.entity_idinteger | null
- lease.classificationstringrequiredOne of: operating, finance.
- lease.short_termbooleanShort-term election: term of 12 months or less with no purchase option reasonably certain to be exercised; expense only.
- lease.commencement_datestring (date)requiredFirst day of a month.
- lease.term_monthsintegerrequired
- lease.paymentstringrequired
- lease.escalation_pctstringPercent, at most six decimals, under 100
- lease.payment_timingstringOne of: advance, arrears.
- lease.discount_ratestringrequiredPercent, at most six decimals, under 100
- lease.rate_sourcestringOne of: implicit, incremental_borrowing, risk_free.
- lease.initial_direct_costsstring
- lease.incentivesstring
- lease.purchase_option_pricestringMust be 0: a purchase option reasonably certain to be exercised is refused (operating leases must be classified finance under ASC 842-10-25-2(b); useful-life amortization for finance leases is not built).
- lease.rou_account_idinteger | null
- lease.liability_account_idinteger | null
- lease.current_liability_account_idinteger | null
- lease.cost_account_idinteger | null
- lease.interest_account_idinteger | null
- lease.payment_account_idinteger | null
- lease.rate_conventionstringMonthly rate from the annual discount rate: nominal = annual / 12 (default), effective = (1 + annual)^(1/12) - 1. One of: nominal, effective.
Response · 201 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- lessorstring | nullrequired
- asset_classstringrequired
- entity_idintegerrequired
- classificationstringrequiredOne of: operating, finance.
- short_termbooleanrequired
- commencement_datestring (date)required
- term_monthsintegerrequired
- paymentstringrequired
- escalation_pctstringrequired
- payment_timingstringrequiredOne of: advance, arrears.
- discount_ratestringrequired
- rate_sourcestringrequiredOne of: implicit, incremental_borrowing, risk_free.
- initial_direct_costsstringrequired
- incentivesstringrequired
- purchase_option_pricestringrequired
- rou_account_idinteger | nullrequired
- liability_account_idinteger | nullrequired
- current_liability_account_idinteger | nullrequired
- cost_account_idintegerrequired
- interest_account_idinteger | nullrequired
- payment_account_idintegerrequired
- commencement_entry_idinteger | nullrequired
- statusstringrequiredA voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequiredEntry reversing the lease run lines; the commencement is reversed by its own reversal entry.
- initial_liabilitystringrequired
- initial_roustringrequired
- total_paymentsstringrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- scheduleobject[]required
- schedule[].monthintegerrequired
- schedule[].periodstringrequired
- schedule[].paymentstringrequired
- schedule[].opening_liabilitystringrequired
- schedule[].intereststringrequired
- schedule[].principalstringrequired
- schedule[].closing_liabilitystringrequired
- schedule[].current_portionstringrequired
- schedule[].lease_coststringrequired
- schedule[].rou_amortizationstringrequired
- schedule[].rou_closingstringrequired
- historyobject[]required
- history[].entry_idintegerrequired
- history[].entry_numberstring | nullrequired
- history[].posting_datestring (date)required
- history[].source_typestringrequired
- history[].entry_statusstringrequired
- history[].account_idintegerrequired
- history[].account_numberstringrequired
- history[].debitstringrequired
- history[].creditstringrequired
- history[].memostring | nullrequired
- rate_conventionstringrequiredOne of: nominal, effective.
- origin_lease_idinteger | nullrequired
- schedule_versionintegerrequired
- latest_schedule_versionintegerrequired
- modificationsobject[]required
- modifications[].idintegerrequired
- modifications[].lease_idintegerrequired
- modifications[].sequenceintegerrequired
- modifications[].kindstringrequiredOne of: term_change, payment_change, partial_termination, separate_contract.
- modifications[].effective_datestring (date)required
- modifications[].schedule_versioninteger | nullrequired
- modifications[].term_monthsinteger | nullrequired
- modifications[].paymentstring | nullrequired
- modifications[].escalation_pctstring | nullrequired
- modifications[].discount_ratestring | nullrequired
- modifications[].rate_conventionstring | nullrequiredOne of: nominal, effective, null.
- modifications[].terminated_fractionstring | nullrequired
- modifications[].liability_beforestringrequired
- modifications[].liability_afterstringrequired
- modifications[].rou_beforestringrequired
- modifications[].rou_afterstringrequired
- modifications[].gain_lossstringrequired
- modifications[].gain_loss_account_idinteger | nullrequired
- modifications[].separate_lease_idinteger | nullrequired
- modifications[].entry_idinteger | nullrequired
- modifications[].reasonstringrequired
- modifications[].created_by_idintegerrequired
- modifications[].created_atstring (date-time)required
Errors
400Malformed JSON body or Idempotency-Key header401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace409Conflict, including an Idempotency-Key reused for a different request or still in progress422Validation failed (field errors) or the ledger refused the change (message list)
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/leases" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"lease": {
"name": "string",
"asset_class": "string",
"classification": "operating",
"commencement_date": "2026-11-01",
"term_months": 1,
"payment": "string",
"discount_rate": "0.00"
}
}'Accounting / Leases
GET/rest/v1.0/companies/{company_id}/accounting/leases/{id}Show a lease
The lease with its monthly schedule (liability, interest, principal, current portion, lease cost, ROU) and the GL lines that carry it. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
- versionintegerquerySchedule version: 0 = the original schedule, k = after the k-th remeasurement. Default: the schedule in force.
Response · 200 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- lessorstring | nullrequired
- asset_classstringrequired
- entity_idintegerrequired
- classificationstringrequiredOne of: operating, finance.
- short_termbooleanrequired
- commencement_datestring (date)required
- term_monthsintegerrequired
- paymentstringrequired
- escalation_pctstringrequired
- payment_timingstringrequiredOne of: advance, arrears.
- discount_ratestringrequired
- rate_sourcestringrequiredOne of: implicit, incremental_borrowing, risk_free.
- initial_direct_costsstringrequired
- incentivesstringrequired
- purchase_option_pricestringrequired
- rou_account_idinteger | nullrequired
- liability_account_idinteger | nullrequired
- current_liability_account_idinteger | nullrequired
- cost_account_idintegerrequired
- interest_account_idinteger | nullrequired
- payment_account_idintegerrequired
- commencement_entry_idinteger | nullrequired
- statusstringrequiredA voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequiredEntry reversing the lease run lines; the commencement is reversed by its own reversal entry.
- initial_liabilitystringrequired
- initial_roustringrequired
- total_paymentsstringrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- scheduleobject[]required
- schedule[].monthintegerrequired
- schedule[].periodstringrequired
- schedule[].paymentstringrequired
- schedule[].opening_liabilitystringrequired
- schedule[].intereststringrequired
- schedule[].principalstringrequired
- schedule[].closing_liabilitystringrequired
- schedule[].current_portionstringrequired
- schedule[].lease_coststringrequired
- schedule[].rou_amortizationstringrequired
- schedule[].rou_closingstringrequired
- historyobject[]required
- history[].entry_idintegerrequired
- history[].entry_numberstring | nullrequired
- history[].posting_datestring (date)required
- history[].source_typestringrequired
- history[].entry_statusstringrequired
- history[].account_idintegerrequired
- history[].account_numberstringrequired
- history[].debitstringrequired
- history[].creditstringrequired
- history[].memostring | nullrequired
- rate_conventionstringrequiredOne of: nominal, effective.
- origin_lease_idinteger | nullrequired
- schedule_versionintegerrequired
- latest_schedule_versionintegerrequired
- modificationsobject[]required
- modifications[].idintegerrequired
- modifications[].lease_idintegerrequired
- modifications[].sequenceintegerrequired
- modifications[].kindstringrequiredOne of: term_change, payment_change, partial_termination, separate_contract.
- modifications[].effective_datestring (date)required
- modifications[].schedule_versioninteger | nullrequired
- modifications[].term_monthsinteger | nullrequired
- modifications[].paymentstring | nullrequired
- modifications[].escalation_pctstring | nullrequired
- modifications[].discount_ratestring | nullrequired
- modifications[].rate_conventionstring | nullrequiredOne of: nominal, effective, null.
- modifications[].terminated_fractionstring | nullrequired
- modifications[].liability_beforestringrequired
- modifications[].liability_afterstringrequired
- modifications[].rou_beforestringrequired
- modifications[].rou_afterstringrequired
- modifications[].gain_lossstringrequired
- modifications[].gain_loss_account_idinteger | nullrequired
- modifications[].separate_lease_idinteger | nullrequired
- modifications[].entry_idinteger | nullrequired
- modifications[].reasonstringrequired
- modifications[].created_by_idintegerrequired
- modifications[].created_atstring (date-time)required
Errors
400version is not a whole number401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422No such schedule version
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Leases
GET/rest/v1.0/companies/{company_id}/accounting/leases/{id}/modificationsList lease modifications
The lease's modifications, oldest first. Append-only history: each remeasurement creates a schedule version. Requires the accounting:read scope. A project-scoped grant gets 403.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Response · 200 · object[]
- idintegerrequired
- lease_idintegerrequired
- sequenceintegerrequired
- kindstringrequiredOne of: term_change, payment_change, partial_termination, separate_contract.
- effective_datestring (date)required
- schedule_versioninteger | nullrequired
- term_monthsinteger | nullrequired
- paymentstring | nullrequired
- escalation_pctstring | nullrequired
- discount_ratestring | nullrequired
- rate_conventionstring | nullrequiredOne of: nominal, effective, null.
- terminated_fractionstring | nullrequired
- liability_beforestringrequired
- liability_afterstringrequired
- rou_beforestringrequired
- rou_afterstringrequired
- gain_lossstringrequired
- gain_loss_account_idinteger | nullrequired
- separate_lease_idinteger | nullrequired
- entry_idinteger | nullrequired
- reasonstringrequired
- created_by_idintegerrequired
- created_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/1/modifications" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Leases
POST/rest/v1.0/companies/{company_id}/accounting/leases/{id}/modificationsModify a lease (ASC 842 remeasurement)
Records an audited modification effective on the first day of a month. term_change, payment_change and partial_termination remeasure the liability at the revised discount_rate (required) as the PV of the revised remaining payments, adjust the ROU asset, recognize a gain or loss on a partial termination (f x ROU vs f x liability) or on a decrease beyond the ROU carrying amount, post one noncash entry on the effective date, and re-run the schedule from that month (earlier months unchanged: a new schedule version). separate_contract records the added right of use as a new lease (separate_lease) and leaves this one unchanged. Refused for a voided (409) or short-term lease, out of order, or while lease lines are posted on or after the effective date (422). preview: true returns the remeasurement, entry lines and revised schedule without posting (200). Lease terms themselves are locked: this is the only way to change them. Needs post_journal (preview: view). Audited. Requires the accounting:write scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
- Idempotency-KeystringheaderClient retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.
Request body
- modificationobjectrequired
- modification.kindstringrequiredOne of: term_change, payment_change, partial_termination, separate_contract.
- modification.effective_datestring (date)required
- modification.reasonstringrequired
- modification.term_monthsintegerRevised lease term counted from commencement.
- modification.paymentstringPayment due in the effective month (default: the scheduled payment).
- modification.escalation_pctstring
- modification.discount_ratestringRevised annual discount rate at the effective date (required for a remeasurement).
- modification.rate_conventionstringOne of: nominal, effective.
- modification.terminated_fractionstringpartial_termination: share of the right of use given up, above 0 and below 1.
- modification.gain_loss_account_idinteger | null
- modification.separate_leaseobject
- modification.separate_lease.namestringrequired
- modification.separate_lease.lessorstring | null
- modification.separate_lease.asset_classstringrequired
- modification.separate_lease.classificationstringOne of: operating, finance.
- modification.separate_lease.short_termbooleanShort-term election: term of 12 months or less with no purchase option reasonably certain to be exercised; expense only.
- modification.separate_lease.term_monthsintegerrequired
- modification.separate_lease.paymentstringrequired
- modification.separate_lease.escalation_pctstringPercent, at most six decimals, under 100
- modification.separate_lease.payment_timingstringOne of: advance, arrears.
- modification.separate_lease.discount_ratestringrequiredPercent, at most six decimals, under 100
- modification.separate_lease.rate_sourcestringOne of: implicit, incremental_borrowing, risk_free.
- modification.separate_lease.initial_direct_costsstring
- modification.separate_lease.incentivesstring
- modification.separate_lease.purchase_option_pricestringMust be 0: a purchase option reasonably certain to be exercised is refused (operating leases must be classified finance under ASC 842-10-25-2(b); useful-life amortization for finance leases is not built).
- modification.separate_lease.rou_account_idinteger | null
- modification.separate_lease.liability_account_idinteger | null
- modification.separate_lease.current_liability_account_idinteger | null
- modification.separate_lease.cost_account_idinteger | null
- modification.separate_lease.interest_account_idinteger | null
- modification.separate_lease.payment_account_idinteger | null
- modification.separate_lease.rate_conventionstringMonthly rate from the annual discount rate: nominal = annual / 12 (default), effective = (1 + annual)^(1/12) - 1. One of: nominal, effective.
- modification.previewboolean
Response · 200 · object
- previewbooleanrequired
- remeasurementobject | nullrequired
- remeasurement.schedule_versionintegerrequired
- remeasurement.kindstringrequired
- remeasurement.effective_periodstringrequired
- remeasurement.liability_beforestringrequired
- remeasurement.rou_beforestringrequired
- remeasurement.terminated_liabilitystringrequired
- remeasurement.terminated_roustringrequired
- remeasurement.liability_afterstringrequired
- remeasurement.rou_afterstringrequired
- remeasurement.gain_lossstringrequired
- remeasurement.annual_ratestringrequired
- remeasurement.monthly_ratestringrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].account_numberstring | nullrequired
- lines[].account_namestring | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostring | nullrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
- scheduleobject[]required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409The lease is voided422Validation failed, out of order, later lease lines posted, or the ledger refused the entry (closed period)
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/1/modifications" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"modification": {
"kind": "term_change",
"effective_date": "2026-11-01",
"reason": "string"
}
}'Accounting / Leases
POST/rest/v1.0/companies/{company_id}/accounting/leases/{id}/voidVoid a lease
For a lease entered by mistake: reverses its commencement entry and posts one entry negating every other line the lease carries, on date. Runs, the daily job and the disclosures skip a voided lease. Idempotent for the same date and reason. Needs post_journal. Audited. Requires the accounting:write scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Request body
- voidobjectrequired
- void.datestring (date)required
- void.reasonstringrequired
Response · 201 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- lessorstring | nullrequired
- asset_classstringrequired
- entity_idintegerrequired
- classificationstringrequiredOne of: operating, finance.
- short_termbooleanrequired
- commencement_datestring (date)required
- term_monthsintegerrequired
- paymentstringrequired
- escalation_pctstringrequired
- payment_timingstringrequiredOne of: advance, arrears.
- discount_ratestringrequired
- rate_sourcestringrequiredOne of: implicit, incremental_borrowing, risk_free.
- initial_direct_costsstringrequired
- incentivesstringrequired
- purchase_option_pricestringrequired
- rou_account_idinteger | nullrequired
- liability_account_idinteger | nullrequired
- current_liability_account_idinteger | nullrequired
- cost_account_idintegerrequired
- interest_account_idinteger | nullrequired
- payment_account_idintegerrequired
- commencement_entry_idinteger | nullrequired
- statusstringrequiredA voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequiredEntry reversing the lease run lines; the commencement is reversed by its own reversal entry.
- initial_liabilitystringrequired
- initial_roustringrequired
- total_paymentsstringrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- scheduleobject[]required
- schedule[].monthintegerrequired
- schedule[].periodstringrequired
- schedule[].paymentstringrequired
- schedule[].opening_liabilitystringrequired
- schedule[].intereststringrequired
- schedule[].principalstringrequired
- schedule[].closing_liabilitystringrequired
- schedule[].current_portionstringrequired
- schedule[].lease_coststringrequired
- schedule[].rou_amortizationstringrequired
- schedule[].rou_closingstringrequired
- historyobject[]required
- history[].entry_idintegerrequired
- history[].entry_numberstring | nullrequired
- history[].posting_datestring (date)required
- history[].source_typestringrequired
- history[].entry_statusstringrequired
- history[].account_idintegerrequired
- history[].account_numberstringrequired
- history[].debitstringrequired
- history[].creditstringrequired
- history[].memostring | nullrequired
- rate_conventionstringrequiredOne of: nominal, effective.
- origin_lease_idinteger | nullrequired
- schedule_versionintegerrequired
- latest_schedule_versionintegerrequired
- modificationsobject[]required
- modifications[].idintegerrequired
- modifications[].lease_idintegerrequired
- modifications[].sequenceintegerrequired
- modifications[].kindstringrequiredOne of: term_change, payment_change, partial_termination, separate_contract.
- modifications[].effective_datestring (date)required
- modifications[].schedule_versioninteger | nullrequired
- modifications[].term_monthsinteger | nullrequired
- modifications[].paymentstring | nullrequired
- modifications[].escalation_pctstring | nullrequired
- modifications[].discount_ratestring | nullrequired
- modifications[].rate_conventionstring | nullrequiredOne of: nominal, effective, null.
- modifications[].terminated_fractionstring | nullrequired
- modifications[].liability_beforestringrequired
- modifications[].liability_afterstringrequired
- modifications[].rou_beforestringrequired
- modifications[].rou_afterstringrequired
- modifications[].gain_lossstringrequired
- modifications[].gain_loss_account_idinteger | nullrequired
- modifications[].separate_lease_idinteger | nullrequired
- modifications[].entry_idinteger | nullrequired
- modifications[].reasonstringrequired
- modifications[].created_by_idintegerrequired
- modifications[].created_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Already voided with a different date or reason422Validation failed (field errors) or the ledger refused the change (message list)
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/1/void" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"void": {
"date": "2026-11-01",
"reason": "string"
}
}'Accounting / Leases
GET/rest/v1.0/companies/{company_id}/accounting/leases/disclosuresLease disclosures
ASC 842-20-50 lessee disclosures from the lease schedules: lease cost by type, cash paid (operating vs financing), ROU assets obtained for new lease liabilities (noncash), and at to the balances, weighted average remaining term and discount rate, and the maturity analysis (years 1-5, thereafter, less imputed interest, which equals the liability). Payments count as paid when due. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- fromstring (date)queryStart date (default: January 1 of the year of `to`)
- tostring (date)queryEnd date (default: today)
Response · 200 · object
- fromstring (date)required
- tostring (date)required
- lease_countintegerrequired
- lease_costobjectrequired
- lease_cost.operatingstringrequired
- lease_cost.short_termstringrequired
- lease_cost.finance_amortizationstringrequired
- lease_cost.finance_intereststringrequired
- cash_paidobjectrequired
- cash_paid.operating_cash_operating_leasesstringrequired
- cash_paid.operating_cash_finance_leasesstringrequired
- cash_paid.financing_cash_finance_leasesstringrequired
- rou_obtained_for_new_liabilitiesobjectrequired
- rou_obtained_for_new_liabilities.operatingstringrequired
- rou_obtained_for_new_liabilities.financestringrequired
- operatingobjectrequired
- operating.rou_assetsstringrequired
- operating.current_liabilitiesstringrequired
- operating.noncurrent_liabilitiesstringrequired
- operating.total_liabilitiesstringrequired
- operating.weighted_average_remaining_term_yearsstring | nullrequired
- operating.weighted_average_discount_rate_pctstring | nullrequired
- operating.maturityobjectrequired
- financeobjectrequired
- finance.rou_assetsstringrequired
- finance.current_liabilitiesstringrequired
- finance.noncurrent_liabilitiesstringrequired
- finance.total_liabilitiesstringrequired
- finance.weighted_average_remaining_term_yearsstring | nullrequired
- finance.weighted_average_discount_rate_pctstring | nullrequired
- finance.maturityobjectrequired
- remeasurementsobjectrequired
- remeasurements.operatingobjectrequired
- remeasurements.financeobjectrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace422Validation failed (field errors) or the ledger refused the change (message list)
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/disclosures" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Leases
GET/rest/v1.0/companies/{company_id}/accounting/leases/runsList lease runs
Posted monthly lease runs, newest first. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- pageintegerqueryPage number
- per_pageintegerqueryPage size
Response · 200 · object[]
- idintegerrequired
- period_idintegerrequired
- period_namestring | nullrequired
- posting_datestring (date)required
- total_coststringrequired
- lease_countintegerrequired
- entry_idinteger | nullrequired
- entry_numberstring | nullrequired
- entry_statusstring | nullrequired
- created_by_idintegerrequired
- created_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/runs" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Leases
POST/rest/v1.0/companies/{company_id}/accounting/leases/runsPreview or post a lease run
With preview: true returns what the run would post (200). Otherwise posts one entry for the calendar-month period (201): per lease, the schedule to date minus what its lines already hold (catch-up), covering lease cost, interest, ROU amortization, payments and the current/noncurrent reclass. Refused when nothing is due, when a later lease entry exists, or when the period is closed. Needs post_journal to post. Audited. The accounting:read scope is enough for a preview. Requires the accounting:write scope. A project-scoped (project_manager_view) grant gets 403, preview included.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
Request body
- lease_runobjectrequired
- lease_run.period_idintegerrequired
- lease_run.previewboolean
Response · 200 · object
- period_idintegerrequired
- period_namestringrequired
- total_coststringrequired
- itemsobject[]required
- items[].lease_idintegerrequired
- items[].numberstringrequired
- items[].namestringrequired
- items[].coststringrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].account_numberstring | nullrequired
- lines[].account_namestring | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostring | nullrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Period not found422Validation failed (field errors) or the ledger refused the change (message list)
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/runs" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"lease_run": {
"period_id": 1
}
}'Accounting / Leases
GET/rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}Show a lease run
The run with its journal lines. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Response · 200 · object
- idintegerrequired
- period_idintegerrequired
- period_namestring | nullrequired
- posting_datestring (date)required
- total_coststringrequired
- lease_countintegerrequired
- entry_idinteger | nullrequired
- entry_numberstring | nullrequired
- entry_statusstring | nullrequired
- created_by_idintegerrequired
- created_atstring (date-time)required
- linesobject[]required
- lines[].line_nointegerrequired
- lines[].account_idintegerrequired
- lines[].account_numberstringrequired
- lines[].account_namestringrequired
- lines[].lease_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostring | nullrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/runs/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Leases
POST/rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}/reverseReverse a lease run
Posts the mirror entry on date and marks the run's entry reversed; the next run catches the leases up again. Idempotent for the same date and reason. Needs post_journal. Audited. Requires the accounting:write scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Request body
- reversalobjectrequired
- reversal.datestring (date)required
- reversal.reasonstring | null
Response · 201 · object
- idintegerrequired
- period_idintegerrequired
- period_namestring | nullrequired
- posting_datestring (date)required
- total_coststringrequired
- lease_countintegerrequired
- entry_idinteger | nullrequired
- entry_numberstring | nullrequired
- entry_statusstring | nullrequired
- created_by_idintegerrequired
- created_atstring (date-time)required
- linesobject[]required
- lines[].line_nointegerrequired
- lines[].account_idintegerrequired
- lines[].account_numberstringrequired
- lines[].account_namestringrequired
- lines[].lease_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostring | nullrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Already reversed with a different date or reason422Validation failed (field errors) or the ledger refused the change (message list)
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/leases/runs/1/reverse" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reversal": {
"date": "2026-11-01"
}
}'