Fixed Assets
Capitalize, depreciate, transfer and dispose of assets; track equipment use. 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 Fixed Assets guide for the workflow.
- GET
/rest/v1.0/companies/{company_id}/accounting/assetsList fixed assets - POST
/rest/v1.0/companies/{company_id}/accounting/assetsAdd a fixed asset - GET
/rest/v1.0/companies/{company_id}/accounting/assets/{id}Show a fixed asset - PATCH
/rest/v1.0/companies/{company_id}/accounting/assets/{id}Update a fixed asset - POST
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/adjustmentsPost an asset adjustment - GET
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachmentsList attachments on a fixed asset - POST
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachmentsAttach a file to a fixed asset - POST
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/disposeDispose of a fixed asset - POST
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/meter_readingsRecord a UOP meter reading - POST
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/undo_disposalUndo a disposal - POST
/rest/v1.0/companies/{company_id}/accounting/assets/{id}/voidVoid an asset added in error - POST
/rest/v1.0/companies/{company_id}/accounting/assets/capitalizeCapitalize an AP bill line - GET
/rest/v1.0/companies/{company_id}/accounting/assets/classesList asset classes - POST
/rest/v1.0/companies/{company_id}/accounting/assets/classesAdd an asset class - GET
/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsList depreciation runs - POST
/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsPreview or post a depreciation run - GET
/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}Show a depreciation run - POST
/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}/reverseReverse a depreciation run - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_logsPost approved equipment logs - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesList equipment internal rates - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesAdd an equipment internal rate - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_recoveryEquipment recovery vs cost - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_recovery/reportEquipment cost recovery report - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueupsList equipment true-ups - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueupsPrepare an equipment true-up - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}Show an equipment true-up - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}/decisionApprove or cancel an equipment true-up - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}/reverseReverse a posted equipment true-up - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesList equipment usage charges - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesCharge equipment usage to a job - POST
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages/{id}/voidVoid equipment usage - GET
/rest/v1.0/companies/{company_id}/accounting/assets/equipment_utilizationEquipment utilization - POST
/rest/v1.0/companies/{company_id}/accounting/assets/importImport the fixed asset register
Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assetsList fixed assets
The asset register with posted accumulated depreciation and net book value. Filter with filters[status] (active, disposed), filters[equipment_id], or search (number, name, category). 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
- filters[status]stringqueryactive, disposed
- filters[equipment_id]stringqueryEquipment ids
- searchstringqueryNumber, name or category
- pageintegerqueryPage number
- per_pageintegerqueryPage size
Response · 200 · object[]
- idintegerrequired
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_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/assets" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assetsAdd a fixed asset
Adds an asset (FA-#### numbering) with its book parameters (posting) and an optional MACRS tax book (memo). With acquisition_offset_account_id it also posts Dr asset / Cr that account on the acquisition date. 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
- fixed_assetobjectrequired
- fixed_asset.namestringrequired
- fixed_asset.descriptionstring | null
- fixed_asset.categorystring | null
- fixed_asset.entity_idinteger | null
- fixed_asset.equipment_idinteger | null
- fixed_asset.asset_account_idinteger
- fixed_asset.accumulated_account_idinteger
- fixed_asset.expense_account_idinteger
- fixed_asset.acquisition_datestring (date)required
- fixed_asset.in_service_datestring (date)required
- fixed_asset.coststring | numberrequired
- fixed_asset.salvagestring | number
- fixed_asset.book_methodstringOne of: SL, DDB, DB150, SYD, UOP.
- fixed_asset.book_life_monthsinteger
- fixed_asset.book_conventionstringOne of: full_month, next_month, mid_month, half_year.
- fixed_asset.opening_accumulatedstring | number
- fixed_asset.acquisition_offset_account_idinteger | null
- fixed_asset.tax_recovery_classstring | nullOne of: 3, 5, 7, 10, 15, 20, 27.5, 39, null.
- fixed_asset.tax_systemstringOne of: GDS, ADS.
- fixed_asset.tax_conventionstringOne of: HY, MQ.
- fixed_asset.ads_recovery_yearsstring | number
- fixed_asset.business_use_pctstring | number
- fixed_asset.section_179string | number
- fixed_asset.bonus_pctinteger
- fixed_asset.opening_throughstring | null
- fixed_asset.class_idinteger | nullAsset class: its accounts, method, life, convention and tax class fill any omitted field.
- fixed_asset.total_unitsstring | nullUOP: total estimated units (meter readings drive the schedule).
- fixed_asset.catch_up_in_current_periodbooleanRequired (true) when the in-service date puts depreciation before the first open period and there is no opening baseline (opening_accumulated / opening_through): the next run books those months as current-period catch-up. Otherwise 422.
Response · 201 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- book_scheduleobjectrequired
- book_schedule.depreciable_basestringrequired
- book_schedule.yearsobject[]required
- book_schedule.explainobject[]required
- tax_schedulenull | objectrequired
- tax_schedule.methodstringrequired
- tax_schedule.conventionstringrequired
- tax_schedule.unadjusted_basisstringrequired
- tax_schedule.section_179stringrequired
- tax_schedule.bonusstringrequired
- tax_schedule.depreciable_basisstringrequired
- tax_schedule.first_year_totalstringrequired
- tax_schedule.yearsobject[]required
- tax_schedule.explainobject[]required
- book_tax_differencesobject[]required
- book_tax_differences[].yearintegerrequired
- book_tax_differences[].bookstringrequired
- book_tax_differences[].taxstringrequired
- book_tax_differences[].differencestringrequired
- book_tax_differences[].cumulative_temporary_differencestringrequired
- 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
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
- adjustmentsobject[]required
- adjustments[].idintegerrequired
- adjustments[].asset_idintegerrequired
- adjustments[].kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustments[].datestring (date)required
- adjustments[].cost_deltastringrequired
- adjustments[].accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- adjustments[].proceedsstring | nullrequired
- adjustments[].gain_lossstring | nullrequired
- adjustments[].from_entity_idinteger | nullrequired
- adjustments[].to_entity_idinteger | nullrequired
- adjustments[].memostring | nullrequired
- adjustments[].entry_idinteger | nullrequired
- adjustments[].created_atstring (date-time)required
- adjustments[].entry_numberstring | null
- adjustments[].prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- adjustments[].prior_salvagestring | nullestimate_change: the salvage value in force before it.
- adjustments[].prior_methodstring | nullestimate_change: the book method in force before it.
- meter_readingsobject[]required
- meter_readings[].periodstringrequired
- meter_readings[].unitsstringrequired
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/assets" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"fixed_asset": {
"name": "string",
"acquisition_date": "2026-11-01",
"in_service_date": "2026-11-01",
"cost": "0.00"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/{id}Show a fixed asset
The asset with its book schedule by fiscal year, tax (MACRS) schedule, book-vs-tax temporary differences, and every ledger line posted for it. Each schedule carries an explain trace. 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
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- book_scheduleobjectrequired
- book_schedule.depreciable_basestringrequired
- book_schedule.yearsobject[]required
- book_schedule.explainobject[]required
- tax_schedulenull | objectrequired
- tax_schedule.methodstringrequired
- tax_schedule.conventionstringrequired
- tax_schedule.unadjusted_basisstringrequired
- tax_schedule.section_179stringrequired
- tax_schedule.bonusstringrequired
- tax_schedule.depreciable_basisstringrequired
- tax_schedule.first_year_totalstringrequired
- tax_schedule.yearsobject[]required
- tax_schedule.explainobject[]required
- book_tax_differencesobject[]required
- book_tax_differences[].yearintegerrequired
- book_tax_differences[].bookstringrequired
- book_tax_differences[].taxstringrequired
- book_tax_differences[].differencestringrequired
- book_tax_differences[].cumulative_temporary_differencestringrequired
- 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
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
- adjustmentsobject[]required
- adjustments[].idintegerrequired
- adjustments[].asset_idintegerrequired
- adjustments[].kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustments[].datestring (date)required
- adjustments[].cost_deltastringrequired
- adjustments[].accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- adjustments[].proceedsstring | nullrequired
- adjustments[].gain_lossstring | nullrequired
- adjustments[].from_entity_idinteger | nullrequired
- adjustments[].to_entity_idinteger | nullrequired
- adjustments[].memostring | nullrequired
- adjustments[].entry_idinteger | nullrequired
- adjustments[].created_atstring (date-time)required
- adjustments[].entry_numberstring | null
- adjustments[].prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- adjustments[].prior_salvagestring | nullestimate_change: the salvage value in force before it.
- adjustments[].prior_methodstring | nullestimate_change: the book method in force before it.
- meter_readingsobject[]required
- meter_readings[].periodstringrequired
- meter_readings[].unitsstringrequired
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/assets/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
PATCH/rest/v1.0/companies/{company_id}/accounting/assets/{id}Update a fixed asset
Descriptive and tax-book fields only; the book basis, life and method are locked. Needs post_journal. Audited. Requires the accounting:write scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Request body
- fixed_assetobjectrequired
- fixed_asset.namestring
- fixed_asset.descriptionstring | null
- fixed_asset.categorystring | null
- fixed_asset.equipment_idinteger | null
- fixed_asset.tax_recovery_classstring | nullOne of: 3, 5, 7, 10, 15, 20, 27.5, 39, null.
- fixed_asset.tax_systemstringOne of: GDS, ADS.
- fixed_asset.tax_conventionstringOne of: HY, MQ.
- fixed_asset.ads_recovery_yearsstring | number
- fixed_asset.business_use_pctstring | number
- fixed_asset.section_179string | number
- fixed_asset.bonus_pctinteger
Response · 200 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- book_scheduleobjectrequired
- book_schedule.depreciable_basestringrequired
- book_schedule.yearsobject[]required
- book_schedule.explainobject[]required
- tax_schedulenull | objectrequired
- tax_schedule.methodstringrequired
- tax_schedule.conventionstringrequired
- tax_schedule.unadjusted_basisstringrequired
- tax_schedule.section_179stringrequired
- tax_schedule.bonusstringrequired
- tax_schedule.depreciable_basisstringrequired
- tax_schedule.first_year_totalstringrequired
- tax_schedule.yearsobject[]required
- tax_schedule.explainobject[]required
- book_tax_differencesobject[]required
- book_tax_differences[].yearintegerrequired
- book_tax_differences[].bookstringrequired
- book_tax_differences[].taxstringrequired
- book_tax_differences[].differencestringrequired
- book_tax_differences[].cumulative_temporary_differencestringrequired
- 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
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
- adjustmentsobject[]required
- adjustments[].idintegerrequired
- adjustments[].asset_idintegerrequired
- adjustments[].kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustments[].datestring (date)required
- adjustments[].cost_deltastringrequired
- adjustments[].accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- adjustments[].proceedsstring | nullrequired
- adjustments[].gain_lossstring | nullrequired
- adjustments[].from_entity_idinteger | nullrequired
- adjustments[].to_entity_idinteger | nullrequired
- adjustments[].memostring | nullrequired
- adjustments[].entry_idinteger | nullrequired
- adjustments[].created_atstring (date-time)required
- adjustments[].entry_numberstring | null
- adjustments[].prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- adjustments[].prior_salvagestring | nullestimate_change: the salvage value in force before it.
- adjustments[].prior_methodstring | nullestimate_change: the book method in force before it.
- meter_readingsobject[]required
- meter_readings[].periodstringrequired
- meter_readings[].unitsstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422Validation failed (field errors) or the ledger refused the change (message list)
Example request
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"fixed_asset": {}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/{id}/adjustmentsPost an asset adjustment
addition (Dr asset / Cr offset_account_id), impairment (Dr offset_account_id loss / Cr asset; at most net book value less salvage), transfer (to_entity_id, intercompany; and/or category) or partial_disposal (amount = cost removed, accumulated removed in proportion, proceeds and gain/loss). Depreciation must be posted through the month before date and not for date's month or later (reverse those runs first); a partial disposal may not leave net book value below salvage; the book schedule then rebases from the adjustment month over the remaining life. Needs post_journal. Audited. Requires the accounting:write scope. estimate_change (ASC 250-10-45-17) posts no entry: the asset takes the new life, salvage or method and the schedule rebases from the adjustment month, holding accumulated depreciation through the month before.
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
- adjustmentobjectrequired
- adjustment.kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustment.datestring (date)required
- adjustment.amountstring
- adjustment.offset_account_idinteger | null
- adjustment.to_entity_idinteger | null
- adjustment.categorystring | null
- adjustment.proceedsstring
- adjustment.proceeds_account_idinteger | null
- adjustment.gain_account_idinteger | null
- adjustment.loss_account_idinteger | null
- adjustment.memostring | null
- adjustment.book_life_monthsintegerestimate_change: new total life in months from the in-service date.
- adjustment.salvagestringestimate_change: new salvage value (at most net book value).
- adjustment.book_methodstringestimate_change: new book method (not to or from UOP). One of: SL, DDB, DB150, SYD.
Response · 201 · object
- idintegerrequired
- asset_idintegerrequired
- kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- datestring (date)required
- cost_deltastringrequired
- accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- proceedsstring | nullrequired
- gain_lossstring | nullrequired
- from_entity_idinteger | nullrequired
- to_entity_idinteger | nullrequired
- memostring | nullrequired
- entry_idinteger | nullrequired
- created_atstring (date-time)required
- entry_numberstring | null
- prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- prior_salvagestring | nullestimate_change: the salvage value in force before it.
- prior_methodstring | nullestimate_change: the book method in force before it.
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Conflict, 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/assets/1/adjustments" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"adjustment": {
"kind": "addition",
"date": "2026-11-01"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachmentsList attachments on a fixed asset
Oldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Response · 200 · object[]
- idintegerrequired
- doc_typestringrequiredOne of: journal_entry, ap_bill, vendor, ap_compliance, ap_lien_waiver, ar_invoice, ar_receipt, bank_transaction, fixed_asset, wip_snapshot, account_rec, policy_signoff.
- doc_idintegerrequired
- namestringrequired
- content_typestringrequired
- size_bytesintegerrequired
- sha256stringrequired
- uploaded_byobjectrequired
- uploaded_by.idintegerrequired
- uploaded_by.namestring | nullrequired
- created_atstring (date-time)required
- download_urlstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, outside the parent record's entity scope, 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/assets/1/attachments" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachmentsAttach a file to a fixed asset
Multipart upload (one file part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs post_journal and the parent's entity scope. 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
- filestring (binary)required
Response · 201 · object
- idintegerrequired
- doc_typestringrequiredOne of: journal_entry, ap_bill, vendor, ap_compliance, ap_lien_waiver, ar_invoice, ar_receipt, bank_transaction, fixed_asset, wip_snapshot, account_rec, policy_signoff.
- doc_idintegerrequired
- namestringrequired
- content_typestringrequired
- size_bytesintegerrequired
- sha256stringrequired
- uploaded_byobjectrequired
- uploaded_by.idintegerrequired
- uploaded_by.namestring | nullrequired
- created_atstring (date-time)required
- download_urlstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, outside the parent record's entity scope, wrong company, or read-only workspace404Not found in this company409Idempotency-Key reused for a different request or still in progress413Request body too large422Missing file, empty file, too large, or a type that is not allowed
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/1/attachments" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"file": "string"
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/{id}/disposeDispose of a fixed asset
With preview: true returns the plan without posting (200, read scope suffices). Otherwise posts catch-up depreciation through the month before disposal, then the disposal entry (remove cost and accumulated depreciation, record proceeds and selling costs, gain to 7200 or loss to 8200 unless accounts are given) and marks the asset disposed (201). Needs post_journal. Audited. 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
- idintegerpathrequired
Request body
- disposalobjectrequired
- disposal.datestring (date)required
- disposal.proceedsstring | numberrequired
- disposal.selling_costsstring | number
- disposal.proceeds_account_idinteger | null
- disposal.gain_account_idinteger | null
- disposal.loss_account_idinteger | null
- disposal.previewboolean
Response · 200 · object
- postedbooleanrequired
- asset_idintegerrequired
- datestring (date)required
- accumulated_beforestringrequired
- catch_up_depreciationstringrequired
- catch_up_throughstringrequired
- adjusted_basisstringrequired
- amount_realizedstringrequired
- gainstringrequired
- lossstringrequired
- tax_dispositionnull | objectrequired
- tax_disposition.tax_yearintegerrequired
- tax_disposition.deductionstringrequired
- tax_disposition.accumulated_at_disposalstringrequired
- entry_idinteger | nullrequired
- entry_numberstring | nullrequired
- 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
- explainobject[]required
- explain[].labelstringrequired
- explain[].formulastring
- explain[].valuestringrequired
- explain[].citestring
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422Validation 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/assets/1/dispose" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"disposal": {
"date": "2026-11-01",
"proceeds": "string"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/{id}/meter_readingsRecord a UOP meter reading
Units used in a month (YYYY-MM) for a units-of-production asset; replaces that month's reading. The next depreciation run catches up to base x cumulative units / total units. Needs post_journal. 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
- meter_readingobjectrequired
- meter_reading.periodstringrequired
- meter_reading.unitsstringrequired
Response · 201 · object
- asset_idintegerrequired
- periodstringrequired
- unitsstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422Validation 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/assets/1/meter_readings" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"meter_reading": {
"period": "string",
"units": "string"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/{id}/undo_disposalUndo a disposal
Reverses the disposal entry and its depreciation true-up on date with a reason, and returns the asset to active. Repeating with the same date and reason returns the asset unchanged. 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.reasonstringrequired
Response · 201 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- book_scheduleobjectrequired
- book_schedule.depreciable_basestringrequired
- book_schedule.yearsobject[]required
- book_schedule.explainobject[]required
- tax_schedulenull | objectrequired
- tax_schedule.methodstringrequired
- tax_schedule.conventionstringrequired
- tax_schedule.unadjusted_basisstringrequired
- tax_schedule.section_179stringrequired
- tax_schedule.bonusstringrequired
- tax_schedule.depreciable_basisstringrequired
- tax_schedule.first_year_totalstringrequired
- tax_schedule.yearsobject[]required
- tax_schedule.explainobject[]required
- book_tax_differencesobject[]required
- book_tax_differences[].yearintegerrequired
- book_tax_differences[].bookstringrequired
- book_tax_differences[].taxstringrequired
- book_tax_differences[].differencestringrequired
- book_tax_differences[].cumulative_temporary_differencestringrequired
- 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
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
- adjustmentsobject[]required
- adjustments[].idintegerrequired
- adjustments[].asset_idintegerrequired
- adjustments[].kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustments[].datestring (date)required
- adjustments[].cost_deltastringrequired
- adjustments[].accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- adjustments[].proceedsstring | nullrequired
- adjustments[].gain_lossstring | nullrequired
- adjustments[].from_entity_idinteger | nullrequired
- adjustments[].to_entity_idinteger | nullrequired
- adjustments[].memostring | nullrequired
- adjustments[].entry_idinteger | nullrequired
- adjustments[].created_atstring (date-time)required
- adjustments[].entry_numberstring | null
- adjustments[].prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- adjustments[].prior_salvagestring | nullestimate_change: the salvage value in force before it.
- adjustments[].prior_methodstring | nullestimate_change: the book method in force before it.
- meter_readingsobject[]required
- meter_readings[].periodstringrequired
- meter_readings[].unitsstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422Validation 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/assets/1/undo_disposal" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reversal": {
"date": "2026-11-01",
"reason": "string"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/{id}/voidVoid an asset added in error
Reverses the acquisition entry (if any) on date with a reason and sets status voided. Refused (422) once depreciation or an adjustment has posted: dispose of the asset instead. Repeating with the same date and reason returns the asset unchanged; a different one is 409. 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.reasonstringrequired
Response · 201 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- book_scheduleobjectrequired
- book_schedule.depreciable_basestringrequired
- book_schedule.yearsobject[]required
- book_schedule.explainobject[]required
- tax_schedulenull | objectrequired
- tax_schedule.methodstringrequired
- tax_schedule.conventionstringrequired
- tax_schedule.unadjusted_basisstringrequired
- tax_schedule.section_179stringrequired
- tax_schedule.bonusstringrequired
- tax_schedule.depreciable_basisstringrequired
- tax_schedule.first_year_totalstringrequired
- tax_schedule.yearsobject[]required
- tax_schedule.explainobject[]required
- book_tax_differencesobject[]required
- book_tax_differences[].yearintegerrequired
- book_tax_differences[].bookstringrequired
- book_tax_differences[].taxstringrequired
- book_tax_differences[].differencestringrequired
- book_tax_differences[].cumulative_temporary_differencestringrequired
- 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
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
- adjustmentsobject[]required
- adjustments[].idintegerrequired
- adjustments[].asset_idintegerrequired
- adjustments[].kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustments[].datestring (date)required
- adjustments[].cost_deltastringrequired
- adjustments[].accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- adjustments[].proceedsstring | nullrequired
- adjustments[].gain_lossstring | nullrequired
- adjustments[].from_entity_idinteger | nullrequired
- adjustments[].to_entity_idinteger | nullrequired
- adjustments[].memostring | nullrequired
- adjustments[].entry_idinteger | nullrequired
- adjustments[].created_atstring (date-time)required
- adjustments[].entry_numberstring | null
- adjustments[].prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- adjustments[].prior_salvagestring | nullestimate_change: the salvage value in force before it.
- adjustments[].prior_methodstring | nullestimate_change: the book method in force before it.
- meter_readingsobject[]required
- meter_readings[].periodstringrequired
- meter_readings[].unitsstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Conflict422Validation 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/assets/1/void" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reversal": {
"date": "2026-11-01",
"reason": "string"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/capitalizeCapitalize an AP bill line
Registers a line of a posted AP bill coded to a fixed_asset account as a fixed asset: cost, asset account, entity and acquisition date come from the bill, and no acquisition entry posts (the bill already debited the asset account), so the register ties to the GL. One live asset per line (409); the bill cannot be voided while the asset is live. 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
- fixed_assetobjectrequired
- fixed_asset.namestring
- fixed_asset.descriptionstring | null
- fixed_asset.categorystring | null
- fixed_asset.equipment_idinteger | null
- fixed_asset.accumulated_account_idinteger
- fixed_asset.expense_account_idinteger
- fixed_asset.in_service_datestring (date)
- fixed_asset.catch_up_in_current_periodbooleanRequired (true) when the in-service date (default: the bill's posting date) puts depreciation before the first open period: the next run books those months as current-period catch-up. Otherwise 422.
- fixed_asset.salvagestring | number
- fixed_asset.book_methodstringOne of: SL, DDB, DB150, SYD, UOP.
- fixed_asset.book_life_monthsinteger
- fixed_asset.book_conventionstringOne of: full_month, next_month, mid_month, half_year.
- fixed_asset.tax_recovery_classstring | nullOne of: 3, 5, 7, 10, 15, 20, 27.5, 39, null.
- fixed_asset.tax_systemstringOne of: GDS, ADS.
- fixed_asset.tax_conventionstringOne of: HY, MQ.
- fixed_asset.ads_recovery_yearsstring | number
- fixed_asset.business_use_pctstring | number
- fixed_asset.section_179string | number
- fixed_asset.bonus_pctinteger
- fixed_asset.class_idinteger | nullAsset class: its accounts, method, life, convention and tax class fill any omitted field.
- fixed_asset.total_unitsstring | nullUOP: total estimated units (meter readings drive the schedule).
- fixed_asset.ap_bill_line_idintegerrequired
Response · 201 · object
- idintegerrequired
- numberstringrequired
- namestringrequired
- descriptionstring | nullrequired
- categorystring | nullrequired
- entity_idintegerrequired
- statusstringrequiredOne of: active, disposed, voided.
- equipment_idinteger | nullrequired
- equipment_namestring | nullrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- acquisition_datestring (date)required
- in_service_datestring (date)required
- coststringrequired
- salvagestringrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- opening_accumulatedstringrequired
- opening_throughstring | nullrequiredYYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
- accumulated_depreciationstringrequired
- net_book_valuestringrequired
- tax_recovery_classstring | nullrequired
- tax_systemstringrequiredOne of: GDS, ADS.
- tax_conventionstringrequiredOne of: HY, MQ.
- ads_recovery_yearsstring | nullrequired
- business_use_pctstringrequired
- section_179stringrequired
- bonus_pctintegerrequired
- acquisition_entry_idinteger | nullrequired
- disposed_onstring | null (date)required
- disposal_proceedsstring | nullrequired
- disposal_costsstring | nullrequired
- disposal_gain_lossstring | nullrequired
- disposal_entry_idinteger | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- book_scheduleobjectrequired
- book_schedule.depreciable_basestringrequired
- book_schedule.yearsobject[]required
- book_schedule.explainobject[]required
- tax_schedulenull | objectrequired
- tax_schedule.methodstringrequired
- tax_schedule.conventionstringrequired
- tax_schedule.unadjusted_basisstringrequired
- tax_schedule.section_179stringrequired
- tax_schedule.bonusstringrequired
- tax_schedule.depreciable_basisstringrequired
- tax_schedule.first_year_totalstringrequired
- tax_schedule.yearsobject[]required
- tax_schedule.explainobject[]required
- book_tax_differencesobject[]required
- book_tax_differences[].yearintegerrequired
- book_tax_differences[].bookstringrequired
- book_tax_differences[].taxstringrequired
- book_tax_differences[].differencestringrequired
- book_tax_differences[].cumulative_temporary_differencestringrequired
- 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
- current_coststringrequiredCost plus posted adjustments (additions, impairments, partial disposals).
- class_idinteger | nullrequired
- ap_bill_line_idinteger | nullrequiredCapitalized from this posted AP bill line (no acquisition entry).
- total_unitsstring | nullrequiredUOP: total estimated units over the life.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
- adjustmentsobject[]required
- adjustments[].idintegerrequired
- adjustments[].asset_idintegerrequired
- adjustments[].kindstringrequiredOne of: addition, impairment, transfer, partial_disposal, estimate_change.
- adjustments[].datestring (date)required
- adjustments[].cost_deltastringrequired
- adjustments[].accumulated_deltastringrequiredChange to accumulated depreciation (negative when a partial disposal removes it).
- adjustments[].proceedsstring | nullrequired
- adjustments[].gain_lossstring | nullrequired
- adjustments[].from_entity_idinteger | nullrequired
- adjustments[].to_entity_idinteger | nullrequired
- adjustments[].memostring | nullrequired
- adjustments[].entry_idinteger | nullrequired
- adjustments[].created_atstring (date-time)required
- adjustments[].entry_numberstring | null
- adjustments[].prior_life_monthsinteger | nullestimate_change: the book life in force before it.
- adjustments[].prior_salvagestring | nullestimate_change: the salvage value in force before it.
- adjustments[].prior_methodstring | nullestimate_change: the book method in force before it.
- meter_readingsobject[]required
- meter_readings[].periodstringrequired
- meter_readings[].unitsstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Conflict422Validation 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/assets/capitalize" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"fixed_asset": {
"ap_bill_line_id": 1
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/classesList asset classes
Asset classes of the company, by name. Requires the accounting:read scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
Response · 200 · object[]
- idintegerrequired
- namestringrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- tax_recovery_classstring | nullrequired
- created_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access or wrong company
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/classes" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/classesAdd an asset class
Default accounts, method, life, convention and MACRS class for new assets (fixed_asset.class_id). 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
- asset_classobjectrequired
- asset_class.namestringrequired
- asset_class.asset_account_idintegerrequired
- asset_class.accumulated_account_idintegerrequired
- asset_class.expense_account_idintegerrequired
- asset_class.book_methodstringOne of: SL, DDB, DB150, SYD, UOP.
- asset_class.book_life_monthsintegerrequired
- asset_class.book_conventionstringOne of: full_month, next_month, mid_month, half_year.
- asset_class.tax_recovery_classstring | null
Response · 201 · object
- idintegerrequired
- namestringrequired
- asset_account_idintegerrequired
- accumulated_account_idintegerrequired
- expense_account_idintegerrequired
- book_methodstringrequiredOne of: SL, DDB, DB150, SYD, UOP.
- book_life_monthsintegerrequired
- book_conventionstringrequiredOne of: full_month, next_month, mid_month, half_year.
- tax_recovery_classstring | nullrequired
- created_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422Validation 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/assets/classes" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"asset_class": {
"name": "string",
"asset_account_id": 1,
"accumulated_account_id": 1,
"expense_account_id": 1,
"book_life_months": 1
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsList depreciation runs
Posted book-depreciation 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_amountstringrequired
- asset_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/assets/depreciation_runs" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsPreview or post a depreciation run
For the period, each active asset posts its book schedule to date minus what is already posted (so a reversed run is caught up next time, and repeating a run posts only what is new). preview: true returns the items and posting preview (200). Otherwise posts one FA journal entry dated the period end (201); 422 when nothing is due or the period is closed. Needs post_journal. 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
- depreciation_runobjectrequired
- depreciation_run.period_idintegerrequired
- depreciation_run.previewboolean
Response · 200 · object
- period_idintegerrequired
- period_namestringrequired
- total_amountstringrequired
- itemsobject[]required
- items[].asset_idintegerrequired
- items[].numberstringrequired
- items[].namestringrequired
- items[].posted_to_datestringrequired
- items[].amountstringrequired
- 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 workspace404Not found in this company422Validation 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/assets/depreciation_runs" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"depreciation_run": {
"period_id": 1
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}Show a depreciation run
The run with its journal lines (one debit and one credit per asset). 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_amountstringrequired
- asset_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[].asset_idinteger | nullrequired
- lines[].equipment_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/assets/depreciation_runs/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}/reverseReverse a depreciation run
Posts the mirror entry on date and marks the run's entry reversed; the next run catches the assets up again. 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_amountstringrequired
- asset_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[].asset_idinteger | nullrequired
- lines[].equipment_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 company422Validation 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/assets/depreciation_runs/1/reverse" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reversal": {
"date": "2026-11-01"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_logsPost approved equipment logs
Turns approved field equipment logs (status approved or unset, linked to an equipment unit) dated from..to into equipment usage: operating hours at the operating hourly rate, idle hours at the idle hourly rate, each posted as its own voidable job cost entry. A log and rate type posts once. preview lists what would post and what is skipped (no cost code, no rate, already posted) without posting (200); posting is all-or-nothing (201). Preview needs accounting access; posting needs post_journal. Audited. Requires the accounting:read scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
Request body
- equipment_logsobjectrequired
- equipment_logs.fromstring (date)required
- equipment_logs.tostring (date)required
- equipment_logs.project_idinteger | null
- equipment_logs.previewboolean
Response · 200 · object
- postedobject[]required
- posted[].log_idintegerrequired
- posted[].rate_typestringrequired
- posted[].hoursstringrequired
- posted[].amountstringrequired
- posted[].usage_idinteger | nullrequired
- skippedobject[]required
- skipped[].log_idintegerrequired
- skipped[].rate_typestringrequired
- skipped[].reasonstringrequired
- totalstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company422Validation 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/assets/equipment_logs" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"equipment_logs": {
"from": "2026-11-01",
"to": "2026-11-01"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesList equipment internal rates
Effective-dated internal rates by unit, type (operating, standby, idle) and unit of time. 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
- equipment_idintegerqueryOne equipment unit
- pageintegerqueryPage number
- per_pageintegerqueryPage size
Response · 200 · object[]
- idintegerrequired
- equipment_idintegerrequired
- entity_idinteger | nullrequiredEntity that owns the unit and takes the recovery credit.
- rate_typestringrequiredOne of: operating, standby, idle.
- unitstringrequiredOne of: hour, day, week, month.
- ratestringrequired
- effective_fromstring (date)required
- sourcestringrequired
- job_cost_account_idintegerrequired
- recovery_account_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/assets/equipment_rates" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesAdd an equipment internal rate
Job cost account defaults to 5410 and the recovery (contra-cost) account to 5490. 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
- equipment_rateobjectrequired
- equipment_rate.equipment_idintegerrequired
- equipment_rate.rate_typestringOne of: operating, standby, idle.
- equipment_rate.unitstringOne of: hour, day, week, month.
- equipment_rate.ratestring | numberrequired
- equipment_rate.effective_fromstring (date)required
- equipment_rate.sourcestringOne of: cost_based, blue_book, fhwa, manual.
- equipment_rate.job_cost_account_idinteger | null
- equipment_rate.recovery_account_idinteger | null
- equipment_rate.entity_idinteger | nullOwning entity; defaults to the unit's fixed asset entity, else the company default.
Response · 201 · object
- idintegerrequired
- equipment_idintegerrequired
- entity_idinteger | nullrequiredEntity that owns the unit and takes the recovery credit.
- rate_typestringrequiredOne of: operating, standby, idle.
- unitstringrequiredOne of: hour, day, week, month.
- ratestringrequired
- effective_fromstring (date)required
- sourcestringrequired
- job_cost_account_idintegerrequired
- recovery_account_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 company422Validation 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/assets/equipment_rates" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"equipment_rate": {
"equipment_id": 1,
"rate": "0.00",
"effective_from": "2026-11-01"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_recoveryEquipment recovery vs cost
Unit P&L by equipment: internal-rate recovery from jobs vs actual unit cost (depreciation, fuel, repairs and other expense lines carrying the unit). Positive over_under = over-recovered. 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)queryPosting date on or after
- tostring (date)queryPosting date on or before
Response · 200 · object[]
- equipment_idintegerrequired
- namestringrequired
- asset_numberstring | nullrequired
- recoverystringrequired
- coststringrequired
- over_understringrequired
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/assets/equipment_recovery" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_recovery/reportEquipment cost recovery report
Over/under-recovery per unit and equipment class for from..to, by month: actual cost (expense, cost-of-revenue and other-expense lines coded to the unit, e.g. depreciation, repairs, fuel, insurance, interest) vs recovery (the unit's lines on the rates' recovery accounts: usage charged to jobs and posted true-ups). The tie-out reconciles each recovery account's GL activity to the part attributed to units and each cost account's GL activity to the part coded to units. suggested_hourly_rate = cost / operating hours (advisory). Class = the unit's fixed-asset class, else its category, else Unclassified. Requires the accounting:read scope. A project-scoped grant gets 403; an entity-scoped grant sees its entities' lines.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- fromstring (date)queryrequired
- tostring (date)queryrequired
- class_keystringquery
Response · 200 · object
- fromstring (date)required
- tostring (date)required
- class_keystring | nullrequired
- unitsobject[]required
- units[].equipment_idintegerrequired
- units[].namestringrequired
- units[].asset_numberstring | nullrequired
- units[].class_keystringrequired
- units[].coststringrequired
- units[].recoverystringrequired
- units[].over_understringrequired
- units[].cost_by_accountobject[]required
- units[].by_periodobject[]required
- units[].operating_hoursstringrequired
- units[].current_hourly_ratestring | nullrequired
- units[].suggested_hourly_ratestring | nullrequired
- classesobject[]required
- classes[].class_keystringrequired
- classes[].unitsintegerrequired
- classes[].coststringrequired
- classes[].recoverystringrequired
- classes[].over_understringrequired
- totalsobjectrequired
- totals.coststringrequired
- totals.recoverystringrequired
- totals.over_understringrequired
- tie_outobjectrequired
- tie_out.recovery_accountsobject[]required
- tie_out.cost_accountsobject[]required
- tie_out.recovery_attributedstringrequired
- tie_out.cost_codedstringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace422Validation failed
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_recovery/report" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueupsList equipment true-ups
True-up runs, newest period first (200 at most). Requires the accounting:read scope. Needs a grant over every entity (a project- or entity-scoped grant gets 403).
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- period_idintegerquery
Response · 200 · object[]
- idintegerrequired
- period_idintegerrequired
- class_keystringrequired
- policystringrequiredOne of: jobs, overhead.
- overhead_account_idinteger | nullrequired
- statusstringrequiredOne of: prepared, posted, cancelled, superseded, reversed.
- evidence_hashstringrequired
- total_trueupstringrequired
- unitsobject[]required
- units[].equipment_idintegerrequired
- units[].namestringrequired
- units[].coststringrequired
- units[].recoverystringrequired
- units[].true_upstringrequired
- units[].dispositionstringrequiredOne of: jobs, overhead, balanced, skipped.
- units[].reasonstring | nullrequired
- units[].recovery_account_idinteger | nullrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].entity_idintegerrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostringrequired
- prepared_by_idintegerrequired
- prepared_atstring (date-time)required
- approved_by_idinteger | nullrequired
- approved_atstring | null (date-time)required
- entry_idinteger | nullrequired
- reversal_entry_idinteger | nullrequired
- cancel_reasonstring | nullrequired
- created_atstring (date-time)required
- updated_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/assets/equipment_trueups" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueupsPrepare an equipment true-up
Prepares the true-up of one period and equipment class: each unit's cost - recovery is allocated to the jobs that used it in the period by their usage charges (policy jobs; a unit with no usage goes to overhead_account_id when given, else it is skipped) or to overhead_account_id (policy overhead), against the unit's recovery account. Returns the prepared run with the same evidence (200, unchanged) or supersedes it. 409 when a posted run already covers the period and class; 422 for a closed period or nothing to true up. A second user approves and posts. Needs post_journal and a grant over every entity. 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
- trueupobjectrequired
- trueup.period_idintegerrequired
- trueup.class_keystringrequired
- trueup.policystringrequiredOne of: jobs, overhead.
- trueup.overhead_account_idinteger | null
Response · 200 · object
- idintegerrequired
- period_idintegerrequired
- class_keystringrequired
- policystringrequiredOne of: jobs, overhead.
- overhead_account_idinteger | nullrequired
- statusstringrequiredOne of: prepared, posted, cancelled, superseded, reversed.
- evidence_hashstringrequired
- total_trueupstringrequired
- unitsobject[]required
- units[].equipment_idintegerrequired
- units[].namestringrequired
- units[].coststringrequired
- units[].recoverystringrequired
- units[].true_upstringrequired
- units[].dispositionstringrequiredOne of: jobs, overhead, balanced, skipped.
- units[].reasonstring | nullrequired
- units[].recovery_account_idinteger | nullrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].entity_idintegerrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostringrequired
- prepared_by_idintegerrequired
- prepared_atstring (date-time)required
- approved_by_idinteger | nullrequired
- approved_atstring | null (date-time)required
- entry_idinteger | nullrequired
- reversal_entry_idinteger | nullrequired
- cancel_reasonstring | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
- unchangedbooleanrequiredTrue when an identical prepared run was returned.
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Period not found409Already posted for this period and class422Validation failed, closed period or nothing to true up
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_trueups" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"trueup": {
"period_id": 1,
"class_key": "string",
"policy": "jobs"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}Show an equipment true-up
Units, lines, status and approvals. Requires the accounting:read scope. Needs a grant over every entity.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Response · 200 · object
- idintegerrequired
- period_idintegerrequired
- class_keystringrequired
- policystringrequiredOne of: jobs, overhead.
- overhead_account_idinteger | nullrequired
- statusstringrequiredOne of: prepared, posted, cancelled, superseded, reversed.
- evidence_hashstringrequired
- total_trueupstringrequired
- unitsobject[]required
- units[].equipment_idintegerrequired
- units[].namestringrequired
- units[].coststringrequired
- units[].recoverystringrequired
- units[].true_upstringrequired
- units[].dispositionstringrequiredOne of: jobs, overhead, balanced, skipped.
- units[].reasonstring | nullrequired
- units[].recovery_account_idinteger | nullrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].entity_idintegerrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostringrequired
- prepared_by_idintegerrequired
- prepared_atstring (date-time)required
- approved_by_idinteger | nullrequired
- approved_atstring | null (date-time)required
- entry_idinteger | nullrequired
- reversal_entry_idinteger | nullrequired
- cancel_reasonstring | nullrequired
- created_atstring (date-time)required
- updated_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/assets/equipment_trueups/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}/decisionApprove or cancel an equipment true-up
approve (approve_journal, never the preparer: 403) recomputes the run and posts one balanced JC entry dated the period end (409 if costs or usage changed since preparation); cancel (post_journal) needs a reason. A repeat of the same decision returns the run. Audited. Requires the accounting:write scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- idintegerpathrequired
Request body
- decisionobjectrequired
- decision.actionstringrequiredOne of: approve, cancel.
- decision.reasonstring | null
Response · 200 · object
- idintegerrequired
- period_idintegerrequired
- class_keystringrequired
- policystringrequiredOne of: jobs, overhead.
- overhead_account_idinteger | nullrequired
- statusstringrequiredOne of: prepared, posted, cancelled, superseded, reversed.
- evidence_hashstringrequired
- total_trueupstringrequired
- unitsobject[]required
- units[].equipment_idintegerrequired
- units[].namestringrequired
- units[].coststringrequired
- units[].recoverystringrequired
- units[].true_upstringrequired
- units[].dispositionstringrequiredOne of: jobs, overhead, balanced, skipped.
- units[].reasonstring | nullrequired
- units[].recovery_account_idinteger | nullrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].entity_idintegerrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostringrequired
- prepared_by_idintegerrequired
- prepared_atstring (date-time)required
- approved_by_idinteger | nullrequired
- approved_atstring | null (date-time)required
- entry_idinteger | nullrequired
- reversal_entry_idinteger | nullrequired
- cancel_reasonstring | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Not prepared, or the evidence moved422Validation failed or the ledger refused the entry (closed period)
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_trueups/1/decision" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"decision": {
"action": "approve"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}/reverseReverse a posted equipment true-up
Reverses the run's entry on date with a reason (approve_journal); the period and class can then be trued up again. Idempotent for the same date and reason. 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.reasonstringrequired
Response · 201 · object
- idintegerrequired
- period_idintegerrequired
- class_keystringrequired
- policystringrequiredOne of: jobs, overhead.
- overhead_account_idinteger | nullrequired
- statusstringrequiredOne of: prepared, posted, cancelled, superseded, reversed.
- evidence_hashstringrequired
- total_trueupstringrequired
- unitsobject[]required
- units[].equipment_idintegerrequired
- units[].namestringrequired
- units[].coststringrequired
- units[].recoverystringrequired
- units[].true_upstringrequired
- units[].dispositionstringrequiredOne of: jobs, overhead, balanced, skipped.
- units[].reasonstring | nullrequired
- units[].recovery_account_idinteger | nullrequired
- linesobject[]required
- lines[].account_idintegerrequired
- lines[].entity_idintegerrequired
- lines[].project_idinteger | nullrequired
- lines[].cost_code_idinteger | nullrequired
- lines[].equipment_idinteger | nullrequired
- lines[].debitstringrequired
- lines[].creditstringrequired
- lines[].memostringrequired
- prepared_by_idintegerrequired
- prepared_atstring (date-time)required
- approved_by_idinteger | nullrequired
- approved_atstring | null (date-time)required
- entry_idinteger | nullrequired
- reversal_entry_idinteger | nullrequired
- cancel_reasonstring | nullrequired
- created_atstring (date-time)required
- updated_atstring (date-time)required
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Not posted, or already reversed differently422Validation failed or the ledger refused the reversal
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_trueups/1/reverse" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reversal": {
"date": "2026-11-01",
"reason": "string"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesList equipment usage charges
Usage charged to jobs, newest first. Requires the accounting:read scope. A project-scoped (project_manager_view) grant sees only usage on projects it is a member of.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- equipment_idintegerqueryEquipment unit
- project_idintegerqueryProject
- fromstring (date)queryOn or after
- tostring (date)queryOn or before
- pageintegerqueryPage number
- per_pageintegerqueryPage size
Response · 200 · object[]
- idintegerrequired
- equipment_idintegerrequired
- project_idintegerrequired
- cost_code_idinteger | nullrequired
- datestring (date)required
- rate_idintegerrequired
- rate_typestringrequired
- unitstringrequired
- quantitystringrequired
- ratestringrequired
- amountstringrequired
- memostring | nullrequired
- entry_idinteger | nullrequired
- created_atstring (date-time)required
- entity_idinteger | nullrequiredEntity the usage posted in.
- statusstringrequiredOne of: posted, voided.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_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/assets/equipment_usages" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesCharge equipment usage to a job
Prices the quantity at the rate effective on the date and posts Dr job cost (project, cost code, unit; writes the job cost subledger as equipment cost) / Cr equipment cost recovery (unit) in the JC journal (201). preview: true validates against the ledger and returns the lines without posting (200). Needs post_journal. 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
- 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
- equipment_usageobjectrequired
- equipment_usage.equipment_idintegerrequired
- equipment_usage.project_idintegerrequired
- equipment_usage.cost_code_idintegerrequired
- equipment_usage.datestring (date)required
- equipment_usage.rate_typestringOne of: operating, standby, idle.
- equipment_usage.unitstringOne of: hour, day, week, month.
- equipment_usage.quantitystring | numberrequired
- equipment_usage.memostring | null
- equipment_usage.previewboolean
- equipment_usage.entity_idinteger | nullDefaults to the project's forecast entity, else the rate's owning entity. Usage in an entity other than the unit's owner is refused (no intercompany yet).
Response · 200 · object
- usagenull | objectrequired
- usage.idintegerrequired
- usage.equipment_idintegerrequired
- usage.project_idintegerrequired
- usage.cost_code_idinteger | nullrequired
- usage.datestring (date)required
- usage.rate_idintegerrequired
- usage.rate_typestringrequired
- usage.unitstringrequired
- usage.quantitystringrequired
- usage.ratestringrequired
- usage.amountstringrequired
- usage.memostring | nullrequired
- usage.entry_idinteger | nullrequired
- usage.created_atstring (date-time)required
- usage.entity_idinteger | nullrequiredEntity the usage posted in.
- usage.statusstringrequiredOne of: posted, voided.
- usage.voided_onstring | null (date)required
- usage.void_reasonstring | nullrequired
- usage.void_entry_idinteger | nullrequired
- rateobjectrequired
- rate.idintegerrequired
- rate.equipment_idintegerrequired
- rate.entity_idinteger | nullrequiredEntity that owns the unit and takes the recovery credit.
- rate.rate_typestringrequiredOne of: operating, standby, idle.
- rate.unitstringrequiredOne of: hour, day, week, month.
- rate.ratestringrequired
- rate.effective_fromstring (date)required
- rate.sourcestringrequired
- rate.job_cost_account_idintegerrequired
- rate.recovery_account_idintegerrequired
- rate.created_atstring (date-time)required
- amountstringrequired
- 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
400Malformed JSON body or Idempotency-Key header401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Conflict, 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/assets/equipment_usages" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"equipment_usage": {
"equipment_id": 1,
"project_id": 1,
"cost_code_id": 1,
"date": "2026-11-01",
"quantity": "0.00"
}
}'Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages/{id}/voidVoid equipment usage
Reverses the usage entry (and so its job cost rows) on date with a reason and marks the usage voided. Repeating with the same date and reason returns it unchanged; a different date or reason is 409. 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.reasonstringrequired
Response · 201 · object
- idintegerrequired
- equipment_idintegerrequired
- project_idintegerrequired
- cost_code_idinteger | nullrequired
- datestring (date)required
- rate_idintegerrequired
- rate_typestringrequired
- unitstringrequired
- quantitystringrequired
- ratestringrequired
- amountstringrequired
- memostring | nullrequired
- entry_idinteger | nullrequired
- created_atstring (date-time)required
- entity_idinteger | nullrequiredEntity the usage posted in.
- statusstringrequiredOne of: posted, voided.
- voided_onstring | null (date)required
- void_reasonstring | nullrequired
- void_entry_idinteger | nullrequired
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/assets/equipment_usages/1/void" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"reversal": {
"date": "2026-11-01",
"reason": "string"
}
}'Accounting / Fixed Assets
GET/rest/v1.0/companies/{company_id}/accounting/assets/equipment_utilizationEquipment utilization
Operating, idle and standby hours (hourly usage), utilization % (operating / all hours) and recovery per unit from posted usage, optionally within from..to. Requires the accounting:read scope.
Parameters
- company_idintegerpathrequiredCompany id; must be the token's company
- fromstring (date)query
- tostring (date)query
Response · 200 · object[]
- equipment_idintegerrequired
- namestringrequired
- operating_hoursstringrequired
- idle_hoursstringrequired
- standby_hoursstringrequired
- utilization_pctstringrequired
- recoverystringrequired
Errors
401Missing or invalid bearer token403No accounting access or wrong company
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_utilization" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"Accounting / Fixed Assets
POST/rest/v1.0/companies/{company_id}/accounting/assets/importImport the fixed asset register
CSV columns: name, legacy_number, description, category, class, equipment_asset_number, asset_account, accumulated_account, expense_account, cost, salvage, method, life_months, convention, acquisition_date, in_service_date, opening_accumulated, depreciated_through, tax_class, total_units (headers case-insensitive; up to 2,000 rows). Without apply, a preview (200, or 422 with row errors). With apply, every row must validate; all are added in one transaction (201) and nothing posts (the GL balances come in through the opening trial balance); tie_out compares the GL fixed asset and accumulated depreciation accounts with the register for the entity as of as_of (default today). Preview needs accounting access; apply needs post_journal. Audited. An Idempotency-Key makes a retried apply replay the first response instead of importing twice. Requires the accounting:read 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
- csvstringrequired
- applyboolean
- entity_idinteger | null
- as_ofstring (date)
Response · 200 · object
- appliedbooleanrequired
- rowsintegerrequired
- coststringrequired
- opening_accumulatedstringrequired
- errorsobject[]required
- errors[].rowintegerrequired
- errors[].messagestringrequired
- tie_outobject | nullrequired
- tie_out.as_ofstring (date)required
- tie_out.glstringrequired
- tie_out.registerstringrequired
- tie_out.differencestringrequired
Errors
401Missing or invalid bearer token403No accounting access, missing permission, wrong company, or read-only workspace404Not found in this company409Conflict, 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/assets/import" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"csv": "string"
}'