Esc

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

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.

33 operationsCompany moduleAll Accounting apps →
  1. GET /rest/v1.0/companies/{company_id}/accounting/assetsList fixed assets
  2. POST /rest/v1.0/companies/{company_id}/accounting/assetsAdd a fixed asset
  3. GET /rest/v1.0/companies/{company_id}/accounting/assets/{id}Show a fixed asset
  4. PATCH /rest/v1.0/companies/{company_id}/accounting/assets/{id}Update a fixed asset
  5. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/adjustmentsPost an asset adjustment
  6. GET /rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachmentsList attachments on a fixed asset
  7. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachmentsAttach a file to a fixed asset
  8. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/disposeDispose of a fixed asset
  9. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/meter_readingsRecord a UOP meter reading
  10. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/undo_disposalUndo a disposal
  11. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/voidVoid an asset added in error
  12. POST /rest/v1.0/companies/{company_id}/accounting/assets/capitalizeCapitalize an AP bill line
  13. GET /rest/v1.0/companies/{company_id}/accounting/assets/classesList asset classes
  14. POST /rest/v1.0/companies/{company_id}/accounting/assets/classesAdd an asset class
  15. GET /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsList depreciation runs
  16. POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsPreview or post a depreciation run
  17. GET /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}Show a depreciation run
  18. POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}/reverseReverse a depreciation run
  19. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_logsPost approved equipment logs
  20. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesList equipment internal rates
  21. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesAdd an equipment internal rate
  22. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_recoveryEquipment recovery vs cost
  23. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_recovery/reportEquipment cost recovery report
  24. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueupsList equipment true-ups
  25. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueupsPrepare an equipment true-up
  26. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}Show an equipment true-up
  27. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}/decisionApprove or cancel an equipment true-up
  28. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups/{id}/reverseReverse a posted equipment true-up
  29. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesList equipment usage charges
  30. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesCharge equipment usage to a job
  31. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages/{id}/voidVoid equipment usage
  32. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_utilizationEquipment utilization
  33. 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/assets

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • filters[status]
    stringquery
    active, disposed
  • filters[equipment_id]
    stringquery
    Equipment ids
  • search
    stringquery
    Number, name or category
  • page
    integerquery
    Page number
  • per_page
    integerquery
    Page size

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

POST /rest/v1.0/companies/{company_id}/accounting/assets

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • fixed_asset
    objectrequired
  • fixed_asset.name
    stringrequired
  • fixed_asset.description
    string | null
  • fixed_asset.category
    string | null
  • fixed_asset.entity_id
    integer | null
  • fixed_asset.equipment_id
    integer | null
  • fixed_asset.asset_account_id
    integer
  • fixed_asset.accumulated_account_id
    integer
  • fixed_asset.expense_account_id
    integer
  • fixed_asset.acquisition_date
    string (date)required
  • fixed_asset.in_service_date
    string (date)required
  • fixed_asset.cost
    string | numberrequired
  • fixed_asset.salvage
    string | number
  • fixed_asset.book_method
    string
    One of: SL, DDB, DB150, SYD, UOP.
  • fixed_asset.book_life_months
    integer
  • fixed_asset.book_convention
    string
    One of: full_month, next_month, mid_month, half_year.
  • fixed_asset.opening_accumulated
    string | number
  • fixed_asset.acquisition_offset_account_id
    integer | null
  • fixed_asset.tax_recovery_class
    string | null
    One of: 3, 5, 7, 10, 15, 20, 27.5, 39, null.
  • fixed_asset.tax_system
    string
    One of: GDS, ADS.
  • fixed_asset.tax_convention
    string
    One of: HY, MQ.
  • fixed_asset.ads_recovery_years
    string | number
  • fixed_asset.business_use_pct
    string | number
  • fixed_asset.section_179
    string | number
  • fixed_asset.bonus_pct
    integer
  • fixed_asset.opening_through
    string | null
  • fixed_asset.class_id
    integer | null
    Asset class: its accounts, method, life, convention and tax class fill any omitted field.
  • fixed_asset.total_units
    string | null
    UOP: total estimated units (meter readings drive the schedule).
  • fixed_asset.catch_up_in_current_period
    boolean
    Required (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

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • book_schedule.depreciable_base
    stringrequired
  • book_schedule.years
    object[]required
  • book_schedule.explain
    object[]required
  • tax_schedule
    null | objectrequired
  • tax_schedule.method
    stringrequired
  • tax_schedule.convention
    stringrequired
  • tax_schedule.unadjusted_basis
    stringrequired
  • tax_schedule.section_179
    stringrequired
  • tax_schedule.bonus
    stringrequired
  • tax_schedule.depreciable_basis
    stringrequired
  • tax_schedule.first_year_total
    stringrequired
  • tax_schedule.years
    object[]required
  • tax_schedule.explain
    object[]required
  • book_tax_differences
    object[]required
  • book_tax_differences[].year
    integerrequired
  • book_tax_differences[].book
    stringrequired
  • book_tax_differences[].tax
    stringrequired
  • book_tax_differences[].difference
    stringrequired
  • book_tax_differences[].cumulative_temporary_difference
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    object[]required
  • adjustments[].id
    integerrequired
  • adjustments[].asset_id
    integerrequired
  • adjustments[].kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustments[].date
    string (date)required
  • adjustments[].cost_delta
    stringrequired
  • adjustments[].accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • adjustments[].proceeds
    string | nullrequired
  • adjustments[].gain_loss
    string | nullrequired
  • adjustments[].from_entity_id
    integer | nullrequired
  • adjustments[].to_entity_id
    integer | nullrequired
  • adjustments[].memo
    string | nullrequired
  • adjustments[].entry_id
    integer | nullrequired
  • adjustments[].created_at
    string (date-time)required
  • adjustments[].entry_number
    string | null
  • adjustments[].prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • adjustments[].prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • adjustments[].prior_method
    string | null
    estimate_change: the book method in force before it.
  • meter_readings
    object[]required
  • meter_readings[].period
    stringrequired
  • meter_readings[].units
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • book_schedule.depreciable_base
    stringrequired
  • book_schedule.years
    object[]required
  • book_schedule.explain
    object[]required
  • tax_schedule
    null | objectrequired
  • tax_schedule.method
    stringrequired
  • tax_schedule.convention
    stringrequired
  • tax_schedule.unadjusted_basis
    stringrequired
  • tax_schedule.section_179
    stringrequired
  • tax_schedule.bonus
    stringrequired
  • tax_schedule.depreciable_basis
    stringrequired
  • tax_schedule.first_year_total
    stringrequired
  • tax_schedule.years
    object[]required
  • tax_schedule.explain
    object[]required
  • book_tax_differences
    object[]required
  • book_tax_differences[].year
    integerrequired
  • book_tax_differences[].book
    stringrequired
  • book_tax_differences[].tax
    stringrequired
  • book_tax_differences[].difference
    stringrequired
  • book_tax_differences[].cumulative_temporary_difference
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    object[]required
  • adjustments[].id
    integerrequired
  • adjustments[].asset_id
    integerrequired
  • adjustments[].kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustments[].date
    string (date)required
  • adjustments[].cost_delta
    stringrequired
  • adjustments[].accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • adjustments[].proceeds
    string | nullrequired
  • adjustments[].gain_loss
    string | nullrequired
  • adjustments[].from_entity_id
    integer | nullrequired
  • adjustments[].to_entity_id
    integer | nullrequired
  • adjustments[].memo
    string | nullrequired
  • adjustments[].entry_id
    integer | nullrequired
  • adjustments[].created_at
    string (date-time)required
  • adjustments[].entry_number
    string | null
  • adjustments[].prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • adjustments[].prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • adjustments[].prior_method
    string | null
    estimate_change: the book method in force before it.
  • meter_readings
    object[]required
  • meter_readings[].period
    stringrequired
  • meter_readings[].units
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/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.

v1.0Implemented

Parameters

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

Request body

  • fixed_asset
    objectrequired
  • fixed_asset.name
    string
  • fixed_asset.description
    string | null
  • fixed_asset.category
    string | null
  • fixed_asset.equipment_id
    integer | null
  • fixed_asset.tax_recovery_class
    string | null
    One of: 3, 5, 7, 10, 15, 20, 27.5, 39, null.
  • fixed_asset.tax_system
    string
    One of: GDS, ADS.
  • fixed_asset.tax_convention
    string
    One of: HY, MQ.
  • fixed_asset.ads_recovery_years
    string | number
  • fixed_asset.business_use_pct
    string | number
  • fixed_asset.section_179
    string | number
  • fixed_asset.bonus_pct
    integer

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • book_schedule.depreciable_base
    stringrequired
  • book_schedule.years
    object[]required
  • book_schedule.explain
    object[]required
  • tax_schedule
    null | objectrequired
  • tax_schedule.method
    stringrequired
  • tax_schedule.convention
    stringrequired
  • tax_schedule.unadjusted_basis
    stringrequired
  • tax_schedule.section_179
    stringrequired
  • tax_schedule.bonus
    stringrequired
  • tax_schedule.depreciable_basis
    stringrequired
  • tax_schedule.first_year_total
    stringrequired
  • tax_schedule.years
    object[]required
  • tax_schedule.explain
    object[]required
  • book_tax_differences
    object[]required
  • book_tax_differences[].year
    integerrequired
  • book_tax_differences[].book
    stringrequired
  • book_tax_differences[].tax
    stringrequired
  • book_tax_differences[].difference
    stringrequired
  • book_tax_differences[].cumulative_temporary_difference
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    object[]required
  • adjustments[].id
    integerrequired
  • adjustments[].asset_id
    integerrequired
  • adjustments[].kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustments[].date
    string (date)required
  • adjustments[].cost_delta
    stringrequired
  • adjustments[].accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • adjustments[].proceeds
    string | nullrequired
  • adjustments[].gain_loss
    string | nullrequired
  • adjustments[].from_entity_id
    integer | nullrequired
  • adjustments[].to_entity_id
    integer | nullrequired
  • adjustments[].memo
    string | nullrequired
  • adjustments[].entry_id
    integer | nullrequired
  • adjustments[].created_at
    string (date-time)required
  • adjustments[].entry_number
    string | null
  • adjustments[].prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • adjustments[].prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • adjustments[].prior_method
    string | null
    estimate_change: the book method in force before it.
  • meter_readings
    object[]required
  • meter_readings[].period
    stringrequired
  • meter_readings[].units
    stringrequired

Errors

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

Example request

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

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • adjustment
    objectrequired
  • adjustment.kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustment.date
    string (date)required
  • adjustment.amount
    string
  • adjustment.offset_account_id
    integer | null
  • adjustment.to_entity_id
    integer | null
  • adjustment.category
    string | null
  • adjustment.proceeds
    string
  • adjustment.proceeds_account_id
    integer | null
  • adjustment.gain_account_id
    integer | null
  • adjustment.loss_account_id
    integer | null
  • adjustment.memo
    string | null
  • adjustment.book_life_months
    integer
    estimate_change: new total life in months from the in-service date.
  • adjustment.salvage
    string
    estimate_change: new salvage value (at most net book value).
  • adjustment.book_method
    string
    estimate_change: new book method (not to or from UOP). One of: SL, DDB, DB150, SYD.

Response · 201 · object

  • id
    integerrequired
  • asset_id
    integerrequired
  • kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • date
    string (date)required
  • cost_delta
    stringrequired
  • accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • proceeds
    string | nullrequired
  • gain_loss
    string | nullrequired
  • from_entity_id
    integer | nullrequired
  • to_entity_id
    integer | nullrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • entry_number
    string | null
  • prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • prior_method
    string | null
    estimate_change: the book method in force before it.

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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}/attachments

List attachments on a fixed asset

Oldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • doc_type
    stringrequired
    One 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_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • uploaded_by.id
    integerrequired
  • uploaded_by.name
    string | nullrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, outside the parent record's entity scope, wrong company, or read-only workspace
  • 404Not found in this company

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/1/attachments" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/attachments

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • file
    string (binary)required

Response · 201 · object

  • id
    integerrequired
  • doc_type
    stringrequired
    One 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_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • uploaded_by.id
    integerrequired
  • uploaded_by.name
    string | nullrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, outside the parent record's entity scope, wrong company, or read-only workspace
  • 404Not found in this company
  • 409Idempotency-Key reused for a different request or still in progress
  • 413Request body too large
  • 422Missing file, empty file, too large, or a type that is not allowed

Example request

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

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

v1.0Implemented

Parameters

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

Request body

  • disposal
    objectrequired
  • disposal.date
    string (date)required
  • disposal.proceeds
    string | numberrequired
  • disposal.selling_costs
    string | number
  • disposal.proceeds_account_id
    integer | null
  • disposal.gain_account_id
    integer | null
  • disposal.loss_account_id
    integer | null
  • disposal.preview
    boolean

Response · 200 · object

  • posted
    booleanrequired
  • asset_id
    integerrequired
  • date
    string (date)required
  • accumulated_before
    stringrequired
  • catch_up_depreciation
    stringrequired
  • catch_up_through
    stringrequired
  • adjusted_basis
    stringrequired
  • amount_realized
    stringrequired
  • gain
    stringrequired
  • loss
    stringrequired
  • tax_disposition
    null | objectrequired
  • tax_disposition.tax_year
    integerrequired
  • tax_disposition.deduction
    stringrequired
  • tax_disposition.accumulated_at_disposal
    stringrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].account_number
    string | nullrequired
  • lines[].account_name
    string | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • explain
    object[]required
  • explain[].label
    stringrequired
  • explain[].formula
    string
  • explain[].value
    stringrequired
  • explain[].cite
    string

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_readings

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • meter_reading
    objectrequired
  • meter_reading.period
    stringrequired
  • meter_reading.units
    stringrequired

Response · 201 · object

  • asset_id
    integerrequired
  • period
    stringrequired
  • units
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_disposal

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

v1.0Implemented

Parameters

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

Request body

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

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • book_schedule.depreciable_base
    stringrequired
  • book_schedule.years
    object[]required
  • book_schedule.explain
    object[]required
  • tax_schedule
    null | objectrequired
  • tax_schedule.method
    stringrequired
  • tax_schedule.convention
    stringrequired
  • tax_schedule.unadjusted_basis
    stringrequired
  • tax_schedule.section_179
    stringrequired
  • tax_schedule.bonus
    stringrequired
  • tax_schedule.depreciable_basis
    stringrequired
  • tax_schedule.first_year_total
    stringrequired
  • tax_schedule.years
    object[]required
  • tax_schedule.explain
    object[]required
  • book_tax_differences
    object[]required
  • book_tax_differences[].year
    integerrequired
  • book_tax_differences[].book
    stringrequired
  • book_tax_differences[].tax
    stringrequired
  • book_tax_differences[].difference
    stringrequired
  • book_tax_differences[].cumulative_temporary_difference
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    object[]required
  • adjustments[].id
    integerrequired
  • adjustments[].asset_id
    integerrequired
  • adjustments[].kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustments[].date
    string (date)required
  • adjustments[].cost_delta
    stringrequired
  • adjustments[].accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • adjustments[].proceeds
    string | nullrequired
  • adjustments[].gain_loss
    string | nullrequired
  • adjustments[].from_entity_id
    integer | nullrequired
  • adjustments[].to_entity_id
    integer | nullrequired
  • adjustments[].memo
    string | nullrequired
  • adjustments[].entry_id
    integer | nullrequired
  • adjustments[].created_at
    string (date-time)required
  • adjustments[].entry_number
    string | null
  • adjustments[].prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • adjustments[].prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • adjustments[].prior_method
    string | null
    estimate_change: the book method in force before it.
  • meter_readings
    object[]required
  • meter_readings[].period
    stringrequired
  • meter_readings[].units
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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}/void

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

v1.0Implemented

Parameters

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

Request body

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

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • book_schedule.depreciable_base
    stringrequired
  • book_schedule.years
    object[]required
  • book_schedule.explain
    object[]required
  • tax_schedule
    null | objectrequired
  • tax_schedule.method
    stringrequired
  • tax_schedule.convention
    stringrequired
  • tax_schedule.unadjusted_basis
    stringrequired
  • tax_schedule.section_179
    stringrequired
  • tax_schedule.bonus
    stringrequired
  • tax_schedule.depreciable_basis
    stringrequired
  • tax_schedule.first_year_total
    stringrequired
  • tax_schedule.years
    object[]required
  • tax_schedule.explain
    object[]required
  • book_tax_differences
    object[]required
  • book_tax_differences[].year
    integerrequired
  • book_tax_differences[].book
    stringrequired
  • book_tax_differences[].tax
    stringrequired
  • book_tax_differences[].difference
    stringrequired
  • book_tax_differences[].cumulative_temporary_difference
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    object[]required
  • adjustments[].id
    integerrequired
  • adjustments[].asset_id
    integerrequired
  • adjustments[].kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustments[].date
    string (date)required
  • adjustments[].cost_delta
    stringrequired
  • adjustments[].accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • adjustments[].proceeds
    string | nullrequired
  • adjustments[].gain_loss
    string | nullrequired
  • adjustments[].from_entity_id
    integer | nullrequired
  • adjustments[].to_entity_id
    integer | nullrequired
  • adjustments[].memo
    string | nullrequired
  • adjustments[].entry_id
    integer | nullrequired
  • adjustments[].created_at
    string (date-time)required
  • adjustments[].entry_number
    string | null
  • adjustments[].prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • adjustments[].prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • adjustments[].prior_method
    string | null
    estimate_change: the book method in force before it.
  • meter_readings
    object[]required
  • meter_readings[].period
    stringrequired
  • meter_readings[].units
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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/capitalize

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • fixed_asset
    objectrequired
  • fixed_asset.name
    string
  • fixed_asset.description
    string | null
  • fixed_asset.category
    string | null
  • fixed_asset.equipment_id
    integer | null
  • fixed_asset.accumulated_account_id
    integer
  • fixed_asset.expense_account_id
    integer
  • fixed_asset.in_service_date
    string (date)
  • fixed_asset.catch_up_in_current_period
    boolean
    Required (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.salvage
    string | number
  • fixed_asset.book_method
    string
    One of: SL, DDB, DB150, SYD, UOP.
  • fixed_asset.book_life_months
    integer
  • fixed_asset.book_convention
    string
    One of: full_month, next_month, mid_month, half_year.
  • fixed_asset.tax_recovery_class
    string | null
    One of: 3, 5, 7, 10, 15, 20, 27.5, 39, null.
  • fixed_asset.tax_system
    string
    One of: GDS, ADS.
  • fixed_asset.tax_convention
    string
    One of: HY, MQ.
  • fixed_asset.ads_recovery_years
    string | number
  • fixed_asset.business_use_pct
    string | number
  • fixed_asset.section_179
    string | number
  • fixed_asset.bonus_pct
    integer
  • fixed_asset.class_id
    integer | null
    Asset class: its accounts, method, life, convention and tax class fill any omitted field.
  • fixed_asset.total_units
    string | null
    UOP: total estimated units (meter readings drive the schedule).
  • fixed_asset.ap_bill_line_id
    integerrequired

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
    One of: active, disposed, voided.
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
    YYYY-MM: opening_accumulated is depreciation through this month; the schedule spreads the rest over the remaining life.
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
    One of: GDS, ADS.
  • tax_convention
    stringrequired
    One of: HY, MQ.
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • book_schedule.depreciable_base
    stringrequired
  • book_schedule.years
    object[]required
  • book_schedule.explain
    object[]required
  • tax_schedule
    null | objectrequired
  • tax_schedule.method
    stringrequired
  • tax_schedule.convention
    stringrequired
  • tax_schedule.unadjusted_basis
    stringrequired
  • tax_schedule.section_179
    stringrequired
  • tax_schedule.bonus
    stringrequired
  • tax_schedule.depreciable_basis
    stringrequired
  • tax_schedule.first_year_total
    stringrequired
  • tax_schedule.years
    object[]required
  • tax_schedule.explain
    object[]required
  • book_tax_differences
    object[]required
  • book_tax_differences[].year
    integerrequired
  • book_tax_differences[].book
    stringrequired
  • book_tax_differences[].tax
    stringrequired
  • book_tax_differences[].difference
    stringrequired
  • book_tax_differences[].cumulative_temporary_difference
    stringrequired
  • history
    object[]required
  • history[].entry_id
    integerrequired
  • history[].entry_number
    string | nullrequired
  • history[].posting_date
    string (date)required
  • history[].source_type
    stringrequired
  • history[].entry_status
    stringrequired
  • history[].account_id
    integerrequired
  • history[].account_number
    stringrequired
  • history[].debit
    stringrequired
  • history[].credit
    stringrequired
  • history[].memo
    string | nullrequired
  • current_cost
    stringrequired
    Cost plus posted adjustments (additions, impairments, partial disposals).
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
    Capitalized from this posted AP bill line (no acquisition entry).
  • total_units
    string | nullrequired
    UOP: total estimated units over the life.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    object[]required
  • adjustments[].id
    integerrequired
  • adjustments[].asset_id
    integerrequired
  • adjustments[].kind
    stringrequired
    One of: addition, impairment, transfer, partial_disposal, estimate_change.
  • adjustments[].date
    string (date)required
  • adjustments[].cost_delta
    stringrequired
  • adjustments[].accumulated_delta
    stringrequired
    Change to accumulated depreciation (negative when a partial disposal removes it).
  • adjustments[].proceeds
    string | nullrequired
  • adjustments[].gain_loss
    string | nullrequired
  • adjustments[].from_entity_id
    integer | nullrequired
  • adjustments[].to_entity_id
    integer | nullrequired
  • adjustments[].memo
    string | nullrequired
  • adjustments[].entry_id
    integer | nullrequired
  • adjustments[].created_at
    string (date-time)required
  • adjustments[].entry_number
    string | null
  • adjustments[].prior_life_months
    integer | null
    estimate_change: the book life in force before it.
  • adjustments[].prior_salvage
    string | null
    estimate_change: the salvage value in force before it.
  • adjustments[].prior_method
    string | null
    estimate_change: the book method in force before it.
  • meter_readings
    object[]required
  • meter_readings[].period
    stringrequired
  • meter_readings[].units
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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/classes

List asset classes

Asset classes of the company, by name. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • tax_recovery_class
    string | nullrequired
  • created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access or wrong company

Example request

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

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • asset_class
    objectrequired
  • asset_class.name
    stringrequired
  • asset_class.asset_account_id
    integerrequired
  • asset_class.accumulated_account_id
    integerrequired
  • asset_class.expense_account_id
    integerrequired
  • asset_class.book_method
    string
    One of: SL, DDB, DB150, SYD, UOP.
  • asset_class.book_life_months
    integerrequired
  • asset_class.book_convention
    string
    One of: full_month, next_month, mid_month, half_year.
  • asset_class.tax_recovery_class
    string | null

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • book_method
    stringrequired
    One of: SL, DDB, DB150, SYD, UOP.
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
    One of: full_month, next_month, mid_month, half_year.
  • tax_recovery_class
    string | nullrequired
  • created_at
    string (date-time)required

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_runs

List depreciation runs

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

v1.0Implemented

Parameters

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

Response · 200 · object[]

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

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/depreciation_runs" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs

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

v1.0Implemented

Parameters

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

Request body

  • depreciation_run
    objectrequired
  • depreciation_run.period_id
    integerrequired
  • depreciation_run.preview
    boolean

Response · 200 · object

  • period_id
    integerrequired
  • period_name
    stringrequired
  • total_amount
    stringrequired
  • items
    object[]required
  • items[].asset_id
    integerrequired
  • items[].number
    stringrequired
  • items[].name
    stringrequired
  • items[].posted_to_date
    stringrequired
  • items[].amount
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].account_number
    string | nullrequired
  • lines[].account_name
    string | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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.

v1.0Implemented

Parameters

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

Response · 200 · object

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

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/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}/reverse

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

v1.0Implemented

Parameters

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

Request body

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

Response · 201 · object

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

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_logs

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

v1.0Implemented

Parameters

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

Request body

  • equipment_logs
    objectrequired
  • equipment_logs.from
    string (date)required
  • equipment_logs.to
    string (date)required
  • equipment_logs.project_id
    integer | null
  • equipment_logs.preview
    boolean

Response · 200 · object

  • posted
    object[]required
  • posted[].log_id
    integerrequired
  • posted[].rate_type
    stringrequired
  • posted[].hours
    stringrequired
  • posted[].amount
    stringrequired
  • posted[].usage_id
    integer | nullrequired
  • skipped
    object[]required
  • skipped[].log_id
    integerrequired
  • skipped[].rate_type
    stringrequired
  • skipped[].reason
    stringrequired
  • total
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_rates

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

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • equipment_id
    integerrequired
  • entity_id
    integer | nullrequired
    Entity that owns the unit and takes the recovery credit.
  • rate_type
    stringrequired
    One of: operating, standby, idle.
  • unit
    stringrequired
    One of: hour, day, week, month.
  • rate
    stringrequired
  • effective_from
    string (date)required
  • source
    stringrequired
  • job_cost_account_id
    integerrequired
  • recovery_account_id
    integerrequired
  • created_at
    string (date-time)required

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_rates" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_rates

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • equipment_rate
    objectrequired
  • equipment_rate.equipment_id
    integerrequired
  • equipment_rate.rate_type
    string
    One of: operating, standby, idle.
  • equipment_rate.unit
    string
    One of: hour, day, week, month.
  • equipment_rate.rate
    string | numberrequired
  • equipment_rate.effective_from
    string (date)required
  • equipment_rate.source
    string
    One of: cost_based, blue_book, fhwa, manual.
  • equipment_rate.job_cost_account_id
    integer | null
  • equipment_rate.recovery_account_id
    integer | null
  • equipment_rate.entity_id
    integer | null
    Owning entity; defaults to the unit's fixed asset entity, else the company default.

Response · 201 · object

  • id
    integerrequired
  • equipment_id
    integerrequired
  • entity_id
    integer | nullrequired
    Entity that owns the unit and takes the recovery credit.
  • rate_type
    stringrequired
    One of: operating, standby, idle.
  • unit
    stringrequired
    One of: hour, day, week, month.
  • rate
    stringrequired
  • effective_from
    string (date)required
  • source
    stringrequired
  • job_cost_account_id
    integerrequired
  • recovery_account_id
    integerrequired
  • created_at
    string (date-time)required

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_recovery

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • from
    string (date)query
    Posting date on or after
  • to
    string (date)query
    Posting date on or before

Response · 200 · object[]

  • equipment_id
    integerrequired
  • name
    stringrequired
  • asset_number
    string | nullrequired
  • recovery
    stringrequired
  • cost
    stringrequired
  • over_under
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_recovery" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_recovery/report

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • from
    string (date)queryrequired
  • to
    string (date)queryrequired
  • class_key
    stringquery

Response · 200 · object

  • from
    string (date)required
  • to
    string (date)required
  • class_key
    string | nullrequired
  • units
    object[]required
  • units[].equipment_id
    integerrequired
  • units[].name
    stringrequired
  • units[].asset_number
    string | nullrequired
  • units[].class_key
    stringrequired
  • units[].cost
    stringrequired
  • units[].recovery
    stringrequired
  • units[].over_under
    stringrequired
  • units[].cost_by_account
    object[]required
  • units[].by_period
    object[]required
  • units[].operating_hours
    stringrequired
  • units[].current_hourly_rate
    string | nullrequired
  • units[].suggested_hourly_rate
    string | nullrequired
  • classes
    object[]required
  • classes[].class_key
    stringrequired
  • classes[].units
    integerrequired
  • classes[].cost
    stringrequired
  • classes[].recovery
    stringrequired
  • classes[].over_under
    stringrequired
  • totals
    objectrequired
  • totals.cost
    stringrequired
  • totals.recovery
    stringrequired
  • totals.over_under
    stringrequired
  • tie_out
    objectrequired
  • tie_out.recovery_accounts
    object[]required
  • tie_out.cost_accounts
    object[]required
  • tie_out.recovery_attributed
    stringrequired
  • tie_out.cost_coded
    stringrequired

Errors

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

Example request

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

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

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • period_id
    integerrequired
  • class_key
    stringrequired
  • policy
    stringrequired
    One of: jobs, overhead.
  • overhead_account_id
    integer | nullrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded, reversed.
  • evidence_hash
    stringrequired
  • total_trueup
    stringrequired
  • units
    object[]required
  • units[].equipment_id
    integerrequired
  • units[].name
    stringrequired
  • units[].cost
    stringrequired
  • units[].recovery
    stringrequired
  • units[].true_up
    stringrequired
  • units[].disposition
    stringrequired
    One of: jobs, overhead, balanced, skipped.
  • units[].reason
    string | nullrequired
  • units[].recovery_account_id
    integer | nullrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].entity_id
    integerrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • reversal_entry_id
    integer | nullrequired
  • cancel_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_trueups" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_trueups

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • trueup
    objectrequired
  • trueup.period_id
    integerrequired
  • trueup.class_key
    stringrequired
  • trueup.policy
    stringrequired
    One of: jobs, overhead.
  • trueup.overhead_account_id
    integer | null

Response · 200 · object

  • id
    integerrequired
  • period_id
    integerrequired
  • class_key
    stringrequired
  • policy
    stringrequired
    One of: jobs, overhead.
  • overhead_account_id
    integer | nullrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded, reversed.
  • evidence_hash
    stringrequired
  • total_trueup
    stringrequired
  • units
    object[]required
  • units[].equipment_id
    integerrequired
  • units[].name
    stringrequired
  • units[].cost
    stringrequired
  • units[].recovery
    stringrequired
  • units[].true_up
    stringrequired
  • units[].disposition
    stringrequired
    One of: jobs, overhead, balanced, skipped.
  • units[].reason
    string | nullrequired
  • units[].recovery_account_id
    integer | nullrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].entity_id
    integerrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • reversal_entry_id
    integer | nullrequired
  • cancel_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • unchanged
    booleanrequired
    True when an identical prepared run was returned.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Period not found
  • 409Already posted for this period and class
  • 422Validation failed, closed period or nothing to true up

Example request

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

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • period_id
    integerrequired
  • class_key
    stringrequired
  • policy
    stringrequired
    One of: jobs, overhead.
  • overhead_account_id
    integer | nullrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded, reversed.
  • evidence_hash
    stringrequired
  • total_trueup
    stringrequired
  • units
    object[]required
  • units[].equipment_id
    integerrequired
  • units[].name
    stringrequired
  • units[].cost
    stringrequired
  • units[].recovery
    stringrequired
  • units[].true_up
    stringrequired
  • units[].disposition
    stringrequired
    One of: jobs, overhead, balanced, skipped.
  • units[].reason
    string | nullrequired
  • units[].recovery_account_id
    integer | nullrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].entity_id
    integerrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • reversal_entry_id
    integer | nullrequired
  • cancel_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/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}/decision

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

v1.0Implemented

Parameters

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

Request body

  • decision
    objectrequired
  • decision.action
    stringrequired
    One of: approve, cancel.
  • decision.reason
    string | null

Response · 200 · object

  • id
    integerrequired
  • period_id
    integerrequired
  • class_key
    stringrequired
  • policy
    stringrequired
    One of: jobs, overhead.
  • overhead_account_id
    integer | nullrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded, reversed.
  • evidence_hash
    stringrequired
  • total_trueup
    stringrequired
  • units
    object[]required
  • units[].equipment_id
    integerrequired
  • units[].name
    stringrequired
  • units[].cost
    stringrequired
  • units[].recovery
    stringrequired
  • units[].true_up
    stringrequired
  • units[].disposition
    stringrequired
    One of: jobs, overhead, balanced, skipped.
  • units[].reason
    string | nullrequired
  • units[].recovery_account_id
    integer | nullrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].entity_id
    integerrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • reversal_entry_id
    integer | nullrequired
  • cancel_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company
  • 409Not prepared, or the evidence moved
  • 422Validation failed or the ledger refused the entry (closed period)

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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}/reverse

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

v1.0Implemented

Parameters

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

Request body

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

Response · 201 · object

  • id
    integerrequired
  • period_id
    integerrequired
  • class_key
    stringrequired
  • policy
    stringrequired
    One of: jobs, overhead.
  • overhead_account_id
    integer | nullrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded, reversed.
  • evidence_hash
    stringrequired
  • total_trueup
    stringrequired
  • units
    object[]required
  • units[].equipment_id
    integerrequired
  • units[].name
    stringrequired
  • units[].cost
    stringrequired
  • units[].recovery
    stringrequired
  • units[].true_up
    stringrequired
  • units[].disposition
    stringrequired
    One of: jobs, overhead, balanced, skipped.
  • units[].reason
    string | nullrequired
  • units[].recovery_account_id
    integer | nullrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].entity_id
    integerrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • reversal_entry_id
    integer | nullrequired
  • cancel_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found in this company
  • 409Not posted, or already reversed differently
  • 422Validation failed or the ledger refused the reversal

Example request

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

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • equipment_id
    integerquery
    Equipment unit
  • project_id
    integerquery
    Project
  • from
    string (date)query
    On or after
  • to
    string (date)query
    On or before
  • page
    integerquery
    Page number
  • per_page
    integerquery
    Page size

Response · 200 · object[]

  • id
    integerrequired
  • equipment_id
    integerrequired
  • project_id
    integerrequired
  • cost_code_id
    integer | nullrequired
  • date
    string (date)required
  • rate_id
    integerrequired
  • rate_type
    stringrequired
  • unit
    stringrequired
  • quantity
    stringrequired
  • rate
    stringrequired
  • amount
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • entity_id
    integer | nullrequired
    Entity the usage posted in.
  • status
    stringrequired
    One of: posted, voided.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired

Errors

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

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/equipment_usages" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Fixed Assets

POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • equipment_usage
    objectrequired
  • equipment_usage.equipment_id
    integerrequired
  • equipment_usage.project_id
    integerrequired
  • equipment_usage.cost_code_id
    integerrequired
  • equipment_usage.date
    string (date)required
  • equipment_usage.rate_type
    string
    One of: operating, standby, idle.
  • equipment_usage.unit
    string
    One of: hour, day, week, month.
  • equipment_usage.quantity
    string | numberrequired
  • equipment_usage.memo
    string | null
  • equipment_usage.preview
    boolean
  • equipment_usage.entity_id
    integer | null
    Defaults 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

  • usage
    null | objectrequired
  • usage.id
    integerrequired
  • usage.equipment_id
    integerrequired
  • usage.project_id
    integerrequired
  • usage.cost_code_id
    integer | nullrequired
  • usage.date
    string (date)required
  • usage.rate_id
    integerrequired
  • usage.rate_type
    stringrequired
  • usage.unit
    stringrequired
  • usage.quantity
    stringrequired
  • usage.rate
    stringrequired
  • usage.amount
    stringrequired
  • usage.memo
    string | nullrequired
  • usage.entry_id
    integer | nullrequired
  • usage.created_at
    string (date-time)required
  • usage.entity_id
    integer | nullrequired
    Entity the usage posted in.
  • usage.status
    stringrequired
    One of: posted, voided.
  • usage.voided_on
    string | null (date)required
  • usage.void_reason
    string | nullrequired
  • usage.void_entry_id
    integer | nullrequired
  • rate
    objectrequired
  • rate.id
    integerrequired
  • rate.equipment_id
    integerrequired
  • rate.entity_id
    integer | nullrequired
    Entity that owns the unit and takes the recovery credit.
  • rate.rate_type
    stringrequired
    One of: operating, standby, idle.
  • rate.unit
    stringrequired
    One of: hour, day, week, month.
  • rate.rate
    stringrequired
  • rate.effective_from
    string (date)required
  • rate.source
    stringrequired
  • rate.job_cost_account_id
    integerrequired
  • rate.recovery_account_id
    integerrequired
  • rate.created_at
    string (date-time)required
  • amount
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].account_number
    string | nullrequired
  • lines[].account_name
    string | nullrequired
  • lines[].debit
    stringrequired
  • lines[].credit
    stringrequired
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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}/void

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

v1.0Implemented

Parameters

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

Request body

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

Response · 201 · object

  • id
    integerrequired
  • equipment_id
    integerrequired
  • project_id
    integerrequired
  • cost_code_id
    integer | nullrequired
  • date
    string (date)required
  • rate_id
    integerrequired
  • rate_type
    stringrequired
  • unit
    stringrequired
  • quantity
    stringrequired
  • rate
    stringrequired
  • amount
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • entity_id
    integer | nullrequired
    Entity the usage posted in.
  • status
    stringrequired
    One of: posted, voided.
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/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_utilization

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • from
    string (date)query
  • to
    string (date)query

Response · 200 · object[]

  • equipment_id
    integerrequired
  • name
    stringrequired
  • operating_hours
    stringrequired
  • idle_hours
    stringrequired
  • standby_hours
    stringrequired
  • utilization_pct
    stringrequired
  • recovery
    stringrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access or wrong company

Example request

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

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

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • csv
    stringrequired
  • apply
    boolean
  • entity_id
    integer | null
  • as_of
    string (date)

Response · 200 · object

  • applied
    booleanrequired
  • rows
    integerrequired
  • cost
    stringrequired
  • opening_accumulated
    stringrequired
  • errors
    object[]required
  • errors[].row
    integerrequired
  • errors[].message
    stringrequired
  • tie_out
    object | nullrequired
  • tie_out.as_of
    string (date)required
  • tie_out.gl
    stringrequired
  • tie_out.register
    stringrequired
  • tie_out.difference
    stringrequired

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/assets/import" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "csv": "string"
}'

Ask the OS

Reading this page

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

Suggested

    AI · may be imperfect · sample data where shown

    Open file