Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Accounting · People, jobs and assets

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.

11 operationsCompany moduleAll Accounting apps →
  1. GET /rest/v1.0/companies/{company_id}/accounting/leasesList leases
  2. POST /rest/v1.0/companies/{company_id}/accounting/leasesAdd a lease
  3. GET /rest/v1.0/companies/{company_id}/accounting/leases/{id}Show a lease
  4. GET /rest/v1.0/companies/{company_id}/accounting/leases/{id}/modificationsList lease modifications
  5. POST /rest/v1.0/companies/{company_id}/accounting/leases/{id}/modificationsModify a lease (ASC 842 remeasurement)
  6. POST /rest/v1.0/companies/{company_id}/accounting/leases/{id}/voidVoid a lease
  7. GET /rest/v1.0/companies/{company_id}/accounting/leases/disclosuresLease disclosures
  8. GET /rest/v1.0/companies/{company_id}/accounting/leases/runsList lease runs
  9. POST /rest/v1.0/companies/{company_id}/accounting/leases/runsPreview or post a lease run
  10. GET /rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}Show a lease run
  11. 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/leases

List 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • page
    integerquery
    Page number
  • per_page
    integerquery
    Page size

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
    One of: operating, finance.
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
    One of: advance, arrears.
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
    One of: implicit, incremental_borrowing, risk_free.
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
    A voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
    Entry reversing the lease run lines; the commencement is reversed by its own reversal entry.
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • rate_convention
    stringrequired
    One of: nominal, effective.
  • origin_lease_id
    integer | nullrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace

Example request

Generated from the contractcurl
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/leases

Add 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client 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

  • lease
    objectrequired
  • lease.name
    stringrequired
  • lease.lessor
    string | null
  • lease.asset_class
    stringrequired
  • lease.entity_id
    integer | null
  • lease.classification
    stringrequired
    One of: operating, finance.
  • lease.short_term
    boolean
    Short-term election: term of 12 months or less with no purchase option reasonably certain to be exercised; expense only.
  • lease.commencement_date
    string (date)required
    First day of a month.
  • lease.term_months
    integerrequired
  • lease.payment
    stringrequired
  • lease.escalation_pct
    string
    Percent, at most six decimals, under 100
  • lease.payment_timing
    string
    One of: advance, arrears.
  • lease.discount_rate
    stringrequired
    Percent, at most six decimals, under 100
  • lease.rate_source
    string
    One of: implicit, incremental_borrowing, risk_free.
  • lease.initial_direct_costs
    string
  • lease.incentives
    string
  • lease.purchase_option_price
    string
    Must 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_id
    integer | null
  • lease.liability_account_id
    integer | null
  • lease.current_liability_account_id
    integer | null
  • lease.cost_account_id
    integer | null
  • lease.interest_account_id
    integer | null
  • lease.payment_account_id
    integer | null
  • lease.rate_convention
    string
    Monthly rate from the annual discount rate: nominal = annual / 12 (default), effective = (1 + annual)^(1/12) - 1. One of: nominal, effective.

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
    One of: operating, finance.
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
    One of: advance, arrears.
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
    One of: implicit, incremental_borrowing, risk_free.
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
    A voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
    Entry reversing the lease run lines; the commencement is reversed by its own reversal entry.
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • schedule
    object[]required
  • schedule[].month
    integerrequired
  • schedule[].period
    stringrequired
  • schedule[].payment
    stringrequired
  • schedule[].opening_liability
    stringrequired
  • schedule[].interest
    stringrequired
  • schedule[].principal
    stringrequired
  • schedule[].closing_liability
    stringrequired
  • schedule[].current_portion
    stringrequired
  • schedule[].lease_cost
    stringrequired
  • schedule[].rou_amortization
    stringrequired
  • schedule[].rou_closing
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • rate_convention
    stringrequired
    One of: nominal, effective.
  • origin_lease_id
    integer | nullrequired
  • schedule_version
    integerrequired
  • latest_schedule_version
    integerrequired
  • modifications
    object[]required
  • modifications[].id
    integerrequired
  • modifications[].lease_id
    integerrequired
  • modifications[].sequence
    integerrequired
  • modifications[].kind
    stringrequired
    One of: term_change, payment_change, partial_termination, separate_contract.
  • modifications[].effective_date
    string (date)required
  • modifications[].schedule_version
    integer | nullrequired
  • modifications[].term_months
    integer | nullrequired
  • modifications[].payment
    string | nullrequired
  • modifications[].escalation_pct
    string | nullrequired
  • modifications[].discount_rate
    string | nullrequired
  • modifications[].rate_convention
    string | nullrequired
    One of: nominal, effective, null.
  • modifications[].terminated_fraction
    string | nullrequired
  • modifications[].liability_before
    stringrequired
  • modifications[].liability_after
    stringrequired
  • modifications[].rou_before
    stringrequired
  • modifications[].rou_after
    stringrequired
  • modifications[].gain_loss
    stringrequired
  • modifications[].gain_loss_account_id
    integer | nullrequired
  • modifications[].separate_lease_id
    integer | nullrequired
  • modifications[].entry_id
    integer | nullrequired
  • modifications[].reason
    stringrequired
  • modifications[].created_by_id
    integerrequired
  • modifications[].created_at
    string (date-time)required

Errors

  • 400Malformed JSON body or Idempotency-Key header
  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 409Conflict, including an Idempotency-Key reused for a different request or still in progress
  • 422Validation failed (field errors) or the ledger refused the change (message list)

Example request

Generated from the contractcurl
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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • version
    integerquery
    Schedule version: 0 = the original schedule, k = after the k-th remeasurement. Default: the schedule in force.

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
    One of: operating, finance.
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
    One of: advance, arrears.
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
    One of: implicit, incremental_borrowing, risk_free.
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
    A voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
    Entry reversing the lease run lines; the commencement is reversed by its own reversal entry.
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • schedule
    object[]required
  • schedule[].month
    integerrequired
  • schedule[].period
    stringrequired
  • schedule[].payment
    stringrequired
  • schedule[].opening_liability
    stringrequired
  • schedule[].interest
    stringrequired
  • schedule[].principal
    stringrequired
  • schedule[].closing_liability
    stringrequired
  • schedule[].current_portion
    stringrequired
  • schedule[].lease_cost
    stringrequired
  • schedule[].rou_amortization
    stringrequired
  • schedule[].rou_closing
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • rate_convention
    stringrequired
    One of: nominal, effective.
  • origin_lease_id
    integer | nullrequired
  • schedule_version
    integerrequired
  • latest_schedule_version
    integerrequired
  • modifications
    object[]required
  • modifications[].id
    integerrequired
  • modifications[].lease_id
    integerrequired
  • modifications[].sequence
    integerrequired
  • modifications[].kind
    stringrequired
    One of: term_change, payment_change, partial_termination, separate_contract.
  • modifications[].effective_date
    string (date)required
  • modifications[].schedule_version
    integer | nullrequired
  • modifications[].term_months
    integer | nullrequired
  • modifications[].payment
    string | nullrequired
  • modifications[].escalation_pct
    string | nullrequired
  • modifications[].discount_rate
    string | nullrequired
  • modifications[].rate_convention
    string | nullrequired
    One of: nominal, effective, null.
  • modifications[].terminated_fraction
    string | nullrequired
  • modifications[].liability_before
    stringrequired
  • modifications[].liability_after
    stringrequired
  • modifications[].rou_before
    stringrequired
  • modifications[].rou_after
    stringrequired
  • modifications[].gain_loss
    stringrequired
  • modifications[].gain_loss_account_id
    integer | nullrequired
  • modifications[].separate_lease_id
    integer | nullrequired
  • modifications[].entry_id
    integer | nullrequired
  • modifications[].reason
    stringrequired
  • modifications[].created_by_id
    integerrequired
  • modifications[].created_at
    string (date-time)required

Errors

  • 400version is not a whole number
  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company
  • 422No such schedule version

Example request

Generated from the contractcurl
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}/modifications

List 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • lease_id
    integerrequired
  • sequence
    integerrequired
  • kind
    stringrequired
    One of: term_change, payment_change, partial_termination, separate_contract.
  • effective_date
    string (date)required
  • schedule_version
    integer | nullrequired
  • term_months
    integer | nullrequired
  • payment
    string | nullrequired
  • escalation_pct
    string | nullrequired
  • discount_rate
    string | nullrequired
  • rate_convention
    string | nullrequired
    One of: nominal, effective, null.
  • terminated_fraction
    string | nullrequired
  • liability_before
    stringrequired
  • liability_after
    stringrequired
  • rou_before
    stringrequired
  • rou_after
    stringrequired
  • gain_loss
    stringrequired
  • gain_loss_account_id
    integer | nullrequired
  • separate_lease_id
    integer | nullrequired
  • entry_id
    integer | nullrequired
  • reason
    stringrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company

Example request

Generated from the contractcurl
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}/modifications

Modify 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader
    Client 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

  • modification
    objectrequired
  • modification.kind
    stringrequired
    One of: term_change, payment_change, partial_termination, separate_contract.
  • modification.effective_date
    string (date)required
  • modification.reason
    stringrequired
  • modification.term_months
    integer
    Revised lease term counted from commencement.
  • modification.payment
    string
    Payment due in the effective month (default: the scheduled payment).
  • modification.escalation_pct
    string
  • modification.discount_rate
    string
    Revised annual discount rate at the effective date (required for a remeasurement).
  • modification.rate_convention
    string
    One of: nominal, effective.
  • modification.terminated_fraction
    string
    partial_termination: share of the right of use given up, above 0 and below 1.
  • modification.gain_loss_account_id
    integer | null
  • modification.separate_lease
    object
  • modification.separate_lease.name
    stringrequired
  • modification.separate_lease.lessor
    string | null
  • modification.separate_lease.asset_class
    stringrequired
  • modification.separate_lease.classification
    string
    One of: operating, finance.
  • modification.separate_lease.short_term
    boolean
    Short-term election: term of 12 months or less with no purchase option reasonably certain to be exercised; expense only.
  • modification.separate_lease.term_months
    integerrequired
  • modification.separate_lease.payment
    stringrequired
  • modification.separate_lease.escalation_pct
    string
    Percent, at most six decimals, under 100
  • modification.separate_lease.payment_timing
    string
    One of: advance, arrears.
  • modification.separate_lease.discount_rate
    stringrequired
    Percent, at most six decimals, under 100
  • modification.separate_lease.rate_source
    string
    One of: implicit, incremental_borrowing, risk_free.
  • modification.separate_lease.initial_direct_costs
    string
  • modification.separate_lease.incentives
    string
  • modification.separate_lease.purchase_option_price
    string
    Must 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_id
    integer | null
  • modification.separate_lease.liability_account_id
    integer | null
  • modification.separate_lease.current_liability_account_id
    integer | null
  • modification.separate_lease.cost_account_id
    integer | null
  • modification.separate_lease.interest_account_id
    integer | null
  • modification.separate_lease.payment_account_id
    integer | null
  • modification.separate_lease.rate_convention
    string
    Monthly rate from the annual discount rate: nominal = annual / 12 (default), effective = (1 + annual)^(1/12) - 1. One of: nominal, effective.
  • modification.preview
    boolean

Response · 200 · object

  • preview
    booleanrequired
  • remeasurement
    object | nullrequired
  • remeasurement.schedule_version
    integerrequired
  • remeasurement.kind
    stringrequired
  • remeasurement.effective_period
    stringrequired
  • remeasurement.liability_before
    stringrequired
  • remeasurement.rou_before
    stringrequired
  • remeasurement.terminated_liability
    stringrequired
  • remeasurement.terminated_rou
    stringrequired
  • remeasurement.liability_after
    stringrequired
  • remeasurement.rou_after
    stringrequired
  • remeasurement.gain_loss
    stringrequired
  • remeasurement.annual_rate
    stringrequired
  • remeasurement.monthly_rate
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].account_number
    string | nullrequired
  • lines[].account_name
    string | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • schedule
    object[]required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company
  • 409The lease is voided
  • 422Validation failed, out of order, later lease lines posted, or the ledger refused the entry (closed period)

Example request

Generated from the contractcurl
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}/void

Void 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Request body

  • void
    objectrequired
  • void.date
    string (date)required
  • void.reason
    stringrequired

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
    One of: operating, finance.
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
    One of: advance, arrears.
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
    One of: implicit, incremental_borrowing, risk_free.
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
    A voided lease is skipped by runs, the daily job and the disclosures. One of: active, voided.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
    Entry reversing the lease run lines; the commencement is reversed by its own reversal entry.
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • schedule
    object[]required
  • schedule[].month
    integerrequired
  • schedule[].period
    stringrequired
  • schedule[].payment
    stringrequired
  • schedule[].opening_liability
    stringrequired
  • schedule[].interest
    stringrequired
  • schedule[].principal
    stringrequired
  • schedule[].closing_liability
    stringrequired
  • schedule[].current_portion
    stringrequired
  • schedule[].lease_cost
    stringrequired
  • schedule[].rou_amortization
    stringrequired
  • schedule[].rou_closing
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • rate_convention
    stringrequired
    One of: nominal, effective.
  • origin_lease_id
    integer | nullrequired
  • schedule_version
    integerrequired
  • latest_schedule_version
    integerrequired
  • modifications
    object[]required
  • modifications[].id
    integerrequired
  • modifications[].lease_id
    integerrequired
  • modifications[].sequence
    integerrequired
  • modifications[].kind
    stringrequired
    One of: term_change, payment_change, partial_termination, separate_contract.
  • modifications[].effective_date
    string (date)required
  • modifications[].schedule_version
    integer | nullrequired
  • modifications[].term_months
    integer | nullrequired
  • modifications[].payment
    string | nullrequired
  • modifications[].escalation_pct
    string | nullrequired
  • modifications[].discount_rate
    string | nullrequired
  • modifications[].rate_convention
    string | nullrequired
    One of: nominal, effective, null.
  • modifications[].terminated_fraction
    string | nullrequired
  • modifications[].liability_before
    stringrequired
  • modifications[].liability_after
    stringrequired
  • modifications[].rou_before
    stringrequired
  • modifications[].rou_after
    stringrequired
  • modifications[].gain_loss
    stringrequired
  • modifications[].gain_loss_account_id
    integer | nullrequired
  • modifications[].separate_lease_id
    integer | nullrequired
  • modifications[].entry_id
    integer | nullrequired
  • modifications[].reason
    stringrequired
  • modifications[].created_by_id
    integerrequired
  • modifications[].created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company
  • 409Already voided with a different date or reason
  • 422Validation failed (field errors) or the ledger refused the change (message list)

Example request

Generated from the contractcurl
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/disclosures

Lease 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • from
    string (date)query
    Start date (default: January 1 of the year of `to`)
  • to
    string (date)query
    End date (default: today)

Response · 200 · object

  • from
    string (date)required
  • to
    string (date)required
  • lease_count
    integerrequired
  • lease_cost
    objectrequired
  • lease_cost.operating
    stringrequired
  • lease_cost.short_term
    stringrequired
  • lease_cost.finance_amortization
    stringrequired
  • lease_cost.finance_interest
    stringrequired
  • cash_paid
    objectrequired
  • cash_paid.operating_cash_operating_leases
    stringrequired
  • cash_paid.operating_cash_finance_leases
    stringrequired
  • cash_paid.financing_cash_finance_leases
    stringrequired
  • rou_obtained_for_new_liabilities
    objectrequired
  • rou_obtained_for_new_liabilities.operating
    stringrequired
  • rou_obtained_for_new_liabilities.finance
    stringrequired
  • operating
    objectrequired
  • operating.rou_assets
    stringrequired
  • operating.current_liabilities
    stringrequired
  • operating.noncurrent_liabilities
    stringrequired
  • operating.total_liabilities
    stringrequired
  • operating.weighted_average_remaining_term_years
    string | nullrequired
  • operating.weighted_average_discount_rate_pct
    string | nullrequired
  • operating.maturity
    objectrequired
  • finance
    objectrequired
  • finance.rou_assets
    stringrequired
  • finance.current_liabilities
    stringrequired
  • finance.noncurrent_liabilities
    stringrequired
  • finance.total_liabilities
    stringrequired
  • finance.weighted_average_remaining_term_years
    string | nullrequired
  • finance.weighted_average_discount_rate_pct
    string | nullrequired
  • finance.maturity
    objectrequired
  • remeasurements
    objectrequired
  • remeasurements.operating
    objectrequired
  • remeasurements.finance
    objectrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 422Validation failed (field errors) or the ledger refused the change (message list)

Example request

Generated from the contractcurl
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/runs

List lease runs

Posted monthly lease runs, newest first. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • page
    integerquery
    Page number
  • per_page
    integerquery
    Page size

Response · 200 · object[]

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_cost
    stringrequired
  • lease_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace

Example request

Generated from the contractcurl
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/runs

Preview 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company

Request body

  • lease_run
    objectrequired
  • lease_run.period_id
    integerrequired
  • lease_run.preview
    boolean

Response · 200 · object

  • period_id
    integerrequired
  • period_name
    stringrequired
  • total_cost
    stringrequired
  • items
    object[]required
  • items[].lease_id
    integerrequired
  • items[].number
    stringrequired
  • items[].name
    stringrequired
  • items[].cost
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].account_number
    string | nullrequired
  • lines[].account_name
    string | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Period not found
  • 422Validation failed (field errors) or the ledger refused the change (message list)

Example request

Generated from the contractcurl
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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_cost
    stringrequired
  • lease_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].account_number
    stringrequired
  • lines[].account_name
    stringrequired
  • lines[].lease_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company

Example request

Generated from the contractcurl
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}/reverse

Reverse 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.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired
  • reversal.date
    string (date)required
  • reversal.reason
    string | null

Response · 201 · object

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_cost
    stringrequired
  • lease_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].account_number
    stringrequired
  • lines[].account_name
    stringrequired
  • lines[].lease_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company
  • 409Already reversed with a different date or reason
  • 422Validation failed (field errors) or the ledger refused the change (message list)

Example request

Generated from the contractcurl
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"
  }
}'

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file