Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Accounting · Money in and out

Banking

Reconcile statements, forecast cash and review ACH payment exceptions. 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 Banking guide for the workflow.

63 operationsCompany moduleAll Accounting apps →
  1. GET /rest/v1.0/companies/{company_id}/accounting/ach/monitoringACH fraud-monitoring evidence
  2. GET /rest/v1.0/companies/{company_id}/accounting/ach/noticesACH returns and NOCs
  3. POST /rest/v1.0/companies/{company_id}/accounting/ach/noticesImport an ACH return/NOC file
  4. POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/{id}/resolveResolve a manual NOC
  5. POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/apply_nocsApply NOCs
  6. POST /rest/v1.0/companies/{company_id}/accounting/ach/prenotesGenerate a prenote file
  7. GET /rest/v1.0/companies/{company_id}/accounting/banking/accountsList bank and card accounts
  8. POST /rest/v1.0/companies/{company_id}/accounting/banking/accountsCreate a bank account
  9. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}Show a bank account
  10. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}Update a bank account
  11. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/activity_previewInspect one sandbox card activity response without persistence
  12. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/bank_changeApprove or reject a pending bank number change
  13. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inboxMatching inbox
  14. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inbox/accept_highAccept all High matches
  15. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/outstandingOutstanding items
  16. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_payGenerate a positive pay file
  17. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batchesList positive pay batches
  18. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batches/{batch_id}/regenerateRegenerate a positive pay batch
  19. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/receipt_captureFirst receipt submissions needed for existing native card charge lines
  20. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliationsList reconciliations
  21. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliationsStart a reconciliation
  22. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/registerAccount register
  23. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/revealReveal bank numbers
  24. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_importsList statement imports
  25. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_importsImport a statement
  26. GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_forecastCash forecast
  27. GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_positionCash position
  28. POST /rest/v1.0/companies/{company_id}/accounting/banking/checks/{id}/stopStop payment on a check
  29. GET /rest/v1.0/companies/{company_id}/accounting/banking/feedsList live bank feed connections
  30. POST /rest/v1.0/companies/{company_id}/accounting/banking/feedsLink a bank (exchange a Link public token)
  31. GET /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}Show a live bank feed connection
  32. DELETE /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}Disconnect a live bank feed
  33. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}/accountsMap feed accounts to bank accounts
  34. POST /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}/syncSync a live bank feed now
  35. POST /rest/v1.0/companies/{company_id}/accounting/banking/feeds/link_tokenCreate a bank Link token
  36. GET /rest/v1.0/companies/{company_id}/accounting/banking/receipt_reviewsList pending independent card receipt reviews
  37. GET /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}Show a reconciliation
  38. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}Tick lines / change the statement balance
  39. DELETE /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}Cancel an in-progress reconciliation
  40. POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/finishFinish a reconciliation
  41. POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/reviewReview a finished reconciliation
  42. POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/undoUndo a reconciliation
  43. GET /rest/v1.0/companies/{company_id}/accounting/banking/rulesList bank rules
  44. POST /rest/v1.0/companies/{company_id}/accounting/banking/rulesCreate a bank rule
  45. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}Update a bank rule
  46. DELETE /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}Delete a bank rule
  47. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/create_transactionCreate from a statement line
  48. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/feed_note/clearMark a bank feed note reviewed
  49. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/ignoreIgnore a statement line
  50. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/matchMatch a statement line
  51. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/restoreRestore an ignored statement line
  52. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/unmatchUnmatch a statement line
  53. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactionsList cash documents
  54. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactionsRecord and post a cash document
  55. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}Show a cash document
  56. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/approveRelease or approve a pending cash document
  57. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachmentsList attachments on a bank transaction
  58. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachmentsAttach a file to a bank transaction
  59. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/check_printCheck print data
  60. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/receipt_evidenceRead retained receipt evidence under bank-account scope
  61. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/receipt_evidenceSubmit line evidence for independent review
  62. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/receipt_evidence/reviewRecord immutable independent review; exact reviewer/outcome/reason retries replay
  63. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/voidVoid a cash document

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/ach/monitoring

ACH fraud-monitoring evidence

Needs manage_vendor_banking. Evidence for Nacha's risk-based fraud monitoring (non-consumer Originators, effective 2026-06-22) over a window: controls in force, vendor and employee bank-account changes and NOC applications, prenote and block records, returns by code (unauthorized R05/R07/R10/R29 counted), NOC timeliness and the notices. Masks only. 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)queryrequired
  • to
    string (date)queryrequired

Response · 200 · object

  • from
    string (date)required
  • to
    string (date)required
  • controls
    objectrequired
  • bank_changes
    object[]required
  • accounts
    object[]required
  • returns
    objectrequired
  • nocs
    objectrequired
  • notices
    object[]required
  • notices[].id
    integerrequired
  • notices[].kind
    stringrequired
    One of: return, noc.
  • notices[].code
    stringrequired
    R-code (return) or C-code (NOC)
  • notices[].original_trace
    stringrequired
  • notices[].trace_number
    string | null
  • notices[].id_number
    stringrequired
    Identification number of the original entry: V<vendor id> for AP, the employee number for payroll
  • notices[].amount
    stringrequired
  • notices[].received_date
    string (date)required
  • notices[].due_date
    string | null (date)
    NOC: six banking days after receipt (Nacha Rule 2.12.1)
  • notices[].party_kind
    string | null
    One of: vendor, employee, null.
  • notices[].party_id
    integer | null
  • notices[].ap_payment_id
    integer | null
  • notices[].pay_check_id
    integer | null
  • notices[].entry_id
    integer | null
  • notices[].status
    stringrequired
    One of: open, applied, manual, unmatched.
  • notices[].message
    string | null
  • notices[].applied_at
    string | null (date-time)
  • notices[].applied_by_id
    integer | null
  • notices[].imported_by_id
    integer

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties (sod_noc), wrong company, or read-only workspace
  • 422Validation failed or the ledger refused the change

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/ach/notices

ACH returns and NOCs

Needs manage_vendor_banking. Newest first, up to 500; filter with status (open, applied, manual, unmatched). Corrected NOC data stays encrypted and is never returned. Newest first, paged in the database with the caller's entity scope applied (Total, Per-Page and Link headers). 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
  • status
    anyquery
    Only notices in this status; any other value is 422. One of: open, applied, manual, unmatched.
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integerrequired
  • kind
    stringrequired
    One of: return, noc.
  • code
    stringrequired
    R-code (return) or C-code (NOC)
  • original_trace
    stringrequired
  • trace_number
    string | null
  • id_number
    stringrequired
    Identification number of the original entry: V<vendor id> for AP, the employee number for payroll
  • amount
    stringrequired
  • received_date
    string (date)required
  • due_date
    string | null (date)
    NOC: six banking days after receipt (Nacha Rule 2.12.1)
  • party_kind
    string | null
    One of: vendor, employee, null.
  • party_id
    integer | null
  • ap_payment_id
    integer | null
  • pay_check_id
    integer | null
  • entry_id
    integer | null
  • status
    stringrequired
    One of: open, applied, manual, unmatched.
  • message
    string | null
  • applied_at
    string | null (date-time)
  • applied_by_id
    integer | null
  • imported_by_id
    integer

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties (sod_noc), wrong company, or read-only workspace
  • 422Validation failed or the ledger refused the change

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/ach/notices

Import an ACH return/NOC file

Needs manage_vendor_banking (plus release_payments for AP returns, payroll_run for payroll returns). A NACHA return/COR file (entries with addenda 99/98) or a bank CSV (code, original_trace, id_number, amount, corrected_data, optional trace_number). A return on an AP payment reverses it dated received_date (closed period refused), reopens its bills with an ach_returned hold and, for R02/R03/R04/R07/R10/R12/R14/R15/R16/R20/R23/R29, blocks that bank account; a return on a paycheck posts Dr payroll cash / Cr payroll clearing (net pay owed again); a returned prenote blocks the account. NOCs are queued with their six-banking-day due date. Idempotent: notices already imported are counted in skipped. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403. A grant with neither manage_vendor_banking nor payroll_run (for example a view-only role) gets 403 before anything is written, even for a file whose notices were all imported already, and so does a read-only workspace.

v1.0Implemented

Parameters

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

Request body

  • ach_import
    objectrequired
  • ach_import.format
    stringrequired
    One of: nacha, csv.
  • ach_import.content
    stringrequired
  • ach_import.received_date
    string (date)required

Response · 201 · object

  • notices
    object[]required
  • notices[].id
    integerrequired
  • notices[].kind
    stringrequired
  • notices[].code
    stringrequired
  • notices[].status
    stringrequired
  • notices[].message
    string | null
  • skipped
    integerrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties (sod_noc), wrong company, or read-only workspace
  • 409ach_trace_ambiguous, ach_return_not_posted
  • 422Validation failed or the ledger refused the change

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/ach/notices" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "ach_import": {
    "format": "nacha",
    "content": "string",
    "received_date": "2026-11-01"
  }
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/{id}/resolve

Resolve a manual NOC

Needs manage_vendor_banking. Marks a C04/C06/C07 NOC (status manual) applied after the bank record was corrected by hand; the importer can't resolve it (403 sod_noc). Needs step-up (a token needs the accounting:step_up scope, 403 step_up_required). Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403. A grant with neither manage_vendor_banking nor payroll_run (for example a view-only role) gets 403 before anything is written, even for a file whose notices were all imported already, and so does a read-only workspace.

v1.0Implemented

Parameters

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

Request body

  • resolve
    objectrequired
  • resolve.reason
    stringrequired

Response · 200 · object

  • id
    integerrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties (sod_noc), wrong company, or read-only workspace
  • 404Not a manual NOC in this company
  • 422Validation failed or the ledger refused the change

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/ach/notices/1/resolve" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "resolve": {
    "reason": "string"
  }
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/apply_nocs

Apply NOCs

Needs manage_vendor_banking (payroll_run for employee NOCs). Applies the open C01/C02/C03/C05 NOCs named in ids (required, at least one: there is no apply-all; an empty list is 422 noc_ids_required) to the vendor or employee bank record and records the corrected account as verified, so the next file pays it. Needs step-up (a token needs the accounting:step_up scope, 403 step_up_required). The importer can't apply (403 sod_noc). Audited per notice (noc_applied) with masks only; the response carries each notice's masked old -> new routing and account last 4 (changes). Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403. A grant with neither manage_vendor_banking nor payroll_run (for example a view-only role) gets 403 before anything is written, even for a file whose notices were all imported already, and so does a read-only workspace.

v1.0Implemented

Parameters

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

Request body

  • apply
    objectrequired
  • apply.ids
    integer[]required

Response · 200 · object

  • applied
    integer[]required
  • changes
    object[]required
  • changes[].id
    integer
  • changes[].party_kind
    string
    One of: vendor, employee.
  • changes[].party_id
    integer
  • changes[].routing_last4
    string[]
  • changes[].account_last4
    string[]
  • changes[].account_type
    string[]

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties (sod_noc), wrong company, or read-only workspace
  • 404An id is not an open NOC
  • 409noc_no_account
  • 422Validation failed or the ledger refused the change

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/ach/notices/apply_nocs" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "apply": {
    "ids": []
  }
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/ach/prenotes

Generate a prenote file

Vendors need manage_vendor_banking and bank_account_id (the ODFI); employees need payroll_run and view_payroll_pii over every entity. Zero-dollar prenote entries (transaction code 23/33) for every ACH vendor or direct-deposit employee whose current account has no prenote, verification or block; vendor batches use the SEC code from bank_account_ownership. Records the settlement date and the earliest live date (third banking day after, Nacha Rules 2.6). 422 nothing_to_prenote when none is due. Returns the NACHA text with X-Prenote-Count and X-Earliest-Live-Date headers. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • prenote
    objectrequired
  • prenote.kind
    stringrequired
    One of: vendor, employee.
  • prenote.effective_date
    string (date)required
  • prenote.bank_account_id
    integer | null

Response · 200 · string

No documented fields.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties (sod_noc), wrong company, or read-only workspace
  • 404Bank account not found
  • 422Validation failed or the ledger refused the change

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/ach/prenotes" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "prenote": {
    "kind": "vendor",
    "effective_date": "2026-11-01"
  }
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts

List bank and card accounts

Bank, savings, money market, cash and credit card registers, each tied to one GL account. Bank numbers are masked. 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
  • active
    stringquery
    Filter by active One of: true, false.

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
    ****1234; full numbers only via /reveal
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
    Always the company base currency.
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • positive_pay_options
    object | nullrequired
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
    A requested account/routing number change waiting for a second manage_vendor_banking user (POST .../bank_change). Masked values only.
  • pending_bank_change.requested_by_id
    integerrequired
  • pending_bank_change.changes
    object[]required
  • pending_bank_change.change_hash
    stringrequired
    Send back with the decision; a change replaced since you reviewed it is refused (409).
  • feed
    object | null
    Live bank feed mapping (null when not fed).
  • feed.connection_id
    integer
  • feed.feed_account_id
    string | null
  • feed.start_date
    string | null (date)
  • feed.institution_name
    string | null
  • feed.status
    string | null
  • feed.last_success_at
    string | null (date-time)
  • feed.health
    object | null

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/banking/accounts" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts

Create a bank account

Links an existing GL account (bank/cash, or credit_card for cards) or creates one (create_gl_account). Needs manage_coa; bank numbers need manage_vendor_banking. 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

  • bank_account
    objectrequired
  • bank_account.name
    stringrequired
  • bank_account.kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • bank_account.gl_account_id
    integer | null
  • bank_account.create_gl_account
    boolean
  • bank_account.entity_id
    integer | null
  • bank_account.institution
    string | null
  • bank_account.account_number
    string | null
    4–17 digits; needs manage_vendor_banking; encrypted at rest
  • bank_account.routing_number
    string | null
    9 digits; needs manage_vendor_banking
  • bank_account.currency
    string
    ISO 4217 code. Must equal the company base currency (AcctSettings.baseCurrency); any other value is refused with 422 until multi-currency exists. Defaults to the base currency.
  • bank_account.is_active
    boolean
  • bank_account.next_check_number
    integer | null
  • bank_account.receipt_required_over
    string | null
  • bank_account.match_window_days
    integer
  • bank_account.low_balance_threshold
    string | null
  • bank_account.csv_mapping
    object | null
  • bank_account.csv_mapping.date
    string | integerrequired
  • bank_account.csv_mapping.description
    string | integerrequired
  • bank_account.csv_mapping.amount
    string | integer
  • bank_account.csv_mapping.debit
    string | integer
  • bank_account.csv_mapping.credit
    string | integer
  • bank_account.csv_mapping.reference
    string | integer
  • bank_account.csv_mapping.check_number
    string | integer
  • bank_account.csv_mapping.balance
    string | integer
  • bank_account.csv_mapping.date_format
    string
    One of: YYYYMMDD, MMDDYYYY, MMDDYY, YYMMDD, MM/DD/YYYY, YYYY-MM-DD.
  • bank_account.csv_mapping.sign
    string
    One of: deposit_positive, withdrawal_positive.
  • bank_account.csv_mapping.has_header
    boolean
  • bank_account.csv_mapping.skip_rows
    integer
  • bank_account.csv_mapping.delimiter
    string
  • bank_account.positive_pay_options
    object | null
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
    ****1234; full numbers only via /reveal
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
    Always the company base currency.
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • positive_pay_options
    object | nullrequired
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
    A requested account/routing number change waiting for a second manage_vendor_banking user (POST .../bank_change). Masked values only.
  • pending_bank_change.requested_by_id
    integerrequired
  • pending_bank_change.changes
    object[]required
  • pending_bank_change.change_hash
    stringrequired
    Send back with the decision; a change replaced since you reviewed it is refused (409).
  • feed
    object | null
    Live bank feed mapping (null when not fed).
  • feed.connection_id
    integer
  • feed.feed_account_id
    string | null
  • feed.start_date
    string | null (date)
  • feed.institution_name
    string | null
  • feed.status
    string | null
  • feed.last_success_at
    string | null (date-time)
  • feed.health
    object | null

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}

Show a bank account

One bank account with masked numbers. 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
  • name
    stringrequired
  • kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
    ****1234; full numbers only via /reveal
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
    Always the company base currency.
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • positive_pay_options
    object | nullrequired
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
    A requested account/routing number change waiting for a second manage_vendor_banking user (POST .../bank_change). Masked values only.
  • pending_bank_change.requested_by_id
    integerrequired
  • pending_bank_change.changes
    object[]required
  • pending_bank_change.change_hash
    stringrequired
    Send back with the decision; a change replaced since you reviewed it is refused (409).
  • feed
    object | null
    Live bank feed mapping (null when not fed).
  • feed.connection_id
    integer
  • feed.feed_account_id
    string | null
  • feed.start_date
    string | null (date)
  • feed.institution_name
    string | null
  • feed.status
    string | null
  • feed.last_success_at
    string | null (date-time)
  • feed.health
    object | null

Errors

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

Example request

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

Accounting / Banking

PATCH /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}

Update a bank account

Name, institution, controls, CSV mapping, check numbering. Account and routing numbers need manage_vendor_banking and are not applied: they become pending_bank_change (audited bank_change_requested) until a second manage_vendor_banking user approves them via POST .../bank_change. entity_id can't change once the account's GL account has journal lines (422). Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • bank_account
    objectrequired
  • bank_account.name
    string
  • bank_account.kind
    string
    One of: checking, savings, money_market, credit_card, cash.
  • bank_account.gl_account_id
    integer | null
  • bank_account.create_gl_account
    boolean
  • bank_account.entity_id
    integer | null
  • bank_account.institution
    string | null
  • bank_account.account_number
    string | null
    4–17 digits; needs manage_vendor_banking; encrypted at rest
  • bank_account.routing_number
    string | null
    9 digits; needs manage_vendor_banking
  • bank_account.currency
    string
    ISO 4217 code. Must equal the company base currency (AcctSettings.baseCurrency); any other value is refused with 422 until multi-currency exists. Defaults to the base currency.
  • bank_account.is_active
    boolean
  • bank_account.next_check_number
    integer | null
  • bank_account.receipt_required_over
    string | null
  • bank_account.match_window_days
    integer
  • bank_account.low_balance_threshold
    string | null
  • bank_account.csv_mapping
    object | null
  • bank_account.csv_mapping.date
    string | integerrequired
  • bank_account.csv_mapping.description
    string | integerrequired
  • bank_account.csv_mapping.amount
    string | integer
  • bank_account.csv_mapping.debit
    string | integer
  • bank_account.csv_mapping.credit
    string | integer
  • bank_account.csv_mapping.reference
    string | integer
  • bank_account.csv_mapping.check_number
    string | integer
  • bank_account.csv_mapping.balance
    string | integer
  • bank_account.csv_mapping.date_format
    string
    One of: YYYYMMDD, MMDDYYYY, MMDDYY, YYMMDD, MM/DD/YYYY, YYYY-MM-DD.
  • bank_account.csv_mapping.sign
    string
    One of: deposit_positive, withdrawal_positive.
  • bank_account.csv_mapping.has_header
    boolean
  • bank_account.csv_mapping.skip_rows
    integer
  • bank_account.csv_mapping.delimiter
    string
  • bank_account.positive_pay_options
    object | null
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
    ****1234; full numbers only via /reveal
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
    Always the company base currency.
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • positive_pay_options
    object | nullrequired
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
    A requested account/routing number change waiting for a second manage_vendor_banking user (POST .../bank_change). Masked values only.
  • pending_bank_change.requested_by_id
    integerrequired
  • pending_bank_change.changes
    object[]required
  • pending_bank_change.change_hash
    stringrequired
    Send back with the decision; a change replaced since you reviewed it is refused (409).
  • feed
    object | null
    Live bank feed mapping (null when not fed).
  • feed.connection_id
    integer
  • feed.feed_account_id
    string | null
  • feed.start_date
    string | null (date)
  • feed.institution_name
    string | null
  • feed.status
    string | null
  • feed.last_success_at
    string | null (date-time)
  • feed.health
    object | null

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "bank_account": {}
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/activity_preview

Inspect one sandbox card activity response without persistence

Requires accounting:read token scope, manageIntegrations and bankReconcile, accounting MFA and whole-account entity access. Mapping is a transient operator assertion. Source polarity is preserved, never interpreted as statement direction. No provider calls, imports, matches, receipts, jobs or postings. Supported settlement exponents: USD/CAD/EUR/GBP=2, JPY=0, KWD=3; other currencies excluded. No local duplicate identity inferred.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • sandbox_confirmed
    booleanrequired
  • external_entity_id
    stringrequired
  • entity_id
    integerrequired
  • currency
    stringrequired
  • source_page
    stringrequired
    One selected sandbox transaction response JSON page, at most 256 KiB UTF-8 and 100 data rows. entity_amount and merchant_amount are currency/value integer minor-unit objects.

Response · 200 · object

  • account
    objectrequired
  • account.id
    integer
  • account.company_id
    integer
  • account.entity_id
    integer
  • account.gl_account_id
    integer
  • account.currency
    string
  • account.name
    string
  • external_entity_id
    stringrequired
  • rows
    object[]required
  • rows[].row
    integerrequired
  • rows[].external_id
    string | nullrequired
  • rows[].state
    string | nullrequired
  • rows[].settlement_date
    string | nullrequired
  • rows[].merchant
    string | nullrequired
  • rows[].settlement
    object | nullrequired
  • rows[].merchant_amount
    object | nullrequired
  • rows[].status
    stringrequired
    One of: evidence_only, excluded, duplicate, conflict.
  • rows[].reasons
    string[]required
  • counts
    objectrequired
  • counts.rows
    integer
  • counts.evidence_only
    integer
  • counts.excluded
    integer
  • counts.duplicate
    integer
  • counts.conflict
    integer
  • has_more
    booleanrequired
  • statement_direction
    stringrequired
  • existing_record_identity
    stringrequired
  • actions_available
    booleanrequired

Errors

  • 400Malformed JSON request
  • 401Authentication required
  • 403Scope or authority denied
  • 404Account outside access
  • 409Target account changed
  • 413Request above 512 KiB or response page above 256 KiB
  • 415JSON Content-Type required
  • 422Invalid mapping, input, page or target account

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/activity_preview" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "sandbox_confirmed": true,
  "external_entity_id": "string",
  "entity_id": 1,
  "currency": "string",
  "source_page": "string"
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/bank_change

Approve or reject a pending bank number change

A manage_vendor_banking user other than the requester applies or discards pending_bank_change. change_hash must match the change reviewed (409 stale_change otherwise). Audited as bank_changed or bank_change_rejected. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • decision
    stringrequired
    One of: approve, reject.
  • change_hash
    stringrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
    ****1234; full numbers only via /reveal
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
    Always the company base currency.
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • positive_pay_options
    object | nullrequired
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
    A requested account/routing number change waiting for a second manage_vendor_banking user (POST .../bank_change). Masked values only.
  • pending_bank_change.requested_by_id
    integerrequired
  • pending_bank_change.changes
    object[]required
  • pending_bank_change.change_hash
    stringrequired
    Send back with the decision; a change replaced since you reviewed it is refused (409).
  • feed
    object | null
    Live bank feed mapping (null when not fed).
  • feed.connection_id
    integer
  • feed.feed_account_id
    string | null
  • feed.start_date
    string | null (date)
  • feed.institution_name
    string | null
  • feed.status
    string | null
  • feed.last_success_at
    string | null (date-time)
  • feed.health
    object | null

Errors

  • 401Missing or invalid bearer token
  • 403No access, missing manage_vendor_banking, or you requested this change
  • 404Not found
  • 409The pending change was replaced after review
  • 422Validation error, or no pending change

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/bank_change" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "decision": "approve",
  "change_hash": "string"
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inbox

Matching inbox

Statement lines with one suggestion each: a match (source match; confidence high = amount + reference/payee/check number agree, medium = unique amount or a combination, low = several candidates) or a bank rule. Each book item is offered to one line only. 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
  • status
    stringquery
    Default unmatched One of: unmatched, matched, ignored, all.

Response · 200 · object

  • bank_account_id
    integerrequired
  • statement_balance
    string | nullrequired
  • statement_date
    string | null (date)required
  • counts
    objectrequired
  • counts.all
    integerrequired
  • counts.suggested
    integerrequired
  • counts.high
    integerrequired
  • counts.rule
    integerrequired
  • counts.none
    integerrequired
  • lines
    object[]required
  • lines[].id
    integerrequired
  • lines[].bank_account_id
    integerrequired
  • lines[].import_id
    integerrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    stringrequired
  • lines[].reference
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].bank_txn_id
    string | nullrequired
  • lines[].type_code
    string | nullrequired
  • lines[].status
    stringrequired
    One of: unmatched, matched, ignored.
  • lines[].match_source
    string | nullrequired
  • lines[].match_confidence
    string | nullrequired
  • lines[].rule_id
    integer | nullrequired
  • lines[].matched_at
    string | null (date-time)required
  • lines[].journal_line_ids
    integer[]required
  • lines[].suggestion
    object | nullrequired
  • lines[].feed_note
    string | nullrequired
    Set when the live feed changed or removed this line after it was matched; cleared by Mark reviewed or unmatch.
  • total
    integerrequired
    Statement lines matching the status filter
  • truncated
    booleanrequired
    True when more lines match than the inbox shows (oldest 1000 first); match or ignore some to see the rest

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inbox/accept_high

Accept all High matches

Matches every high-confidence suggestion on the account (book lines become cleared, not reconciled). Needs bank_reconcile. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • matched
    integerrequired
  • total
    stringrequired
    Decimal string, 2 dp

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/inbox/accept_high" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/outstanding

Outstanding items

Deposits in transit and outstanding payments as of a date, with the proof book balance = reconciled and void + outstanding (difference 0.00). The item lists are paginated (Total counts both lists); totals always cover every outstanding line. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • as_of
    string (date)query
    Default today
  • page
    integerquery
    Page (1-based)
  • per_page
    integerquery
    Items per page

Response · 200 · object

  • bank_account_id
    integerrequired
  • as_of
    string (date)required
  • deposits_in_transit
    object[]required
  • deposits_in_transit[].journal_line_id
    integerrequired
  • deposits_in_transit[].entry_number
    string | nullrequired
  • deposits_in_transit[].date
    string (date)required
  • deposits_in_transit[].amount
    stringrequired
    Decimal string, 2 dp
  • deposits_in_transit[].description
    string | nullrequired
  • deposits_in_transit[].bank_transaction_id
    integer | nullrequired
  • deposits_in_transit[].check_number
    string | nullrequired
  • deposits_in_transit[].reconcile_state
    stringrequired
    One of: n, c.
  • deposits_in_transit[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • deposits_in_transit[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • outstanding_payments
    object[]required
  • outstanding_payments[].journal_line_id
    integerrequired
  • outstanding_payments[].entry_number
    string | nullrequired
  • outstanding_payments[].date
    string (date)required
  • outstanding_payments[].amount
    stringrequired
    Decimal string, 2 dp
  • outstanding_payments[].description
    string | nullrequired
  • outstanding_payments[].bank_transaction_id
    integer | nullrequired
  • outstanding_payments[].check_number
    string | nullrequired
  • outstanding_payments[].reconcile_state
    stringrequired
    One of: n, c.
  • outstanding_payments[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • outstanding_payments[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • totals
    objectrequired
  • totals.deposits_in_transit
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.reconciled_and_void
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_net
    stringrequired
    Decimal string, 2 dp
  • totals.book_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • total
    integerrequired
    Outstanding lines across both lists (all pages)

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay

Generate a positive pay file

CSV issue file of checks not yet sent plus voids of checks the bank already has. Generated on demand, never stored; marks the checks sent unless dry_run. A dry run returns counts and totals only (content is empty: the file carries the decrypted account number). Pending checks are not included until released. Needs release_payments; audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • positive_pay
    object
  • positive_pay.dry_run
    boolean

Response · 200 · object

  • batch_id
    integer | nullrequired
    The batch this file sent (null for a dry run or an empty file); regenerate it via .../positive_pay/batches/{batch_id}/regenerate
  • file_name
    stringrequired
  • content
    stringrequired
    CSV issue file (full account number); never stored
  • dry_run
    booleanrequired
  • item_count
    integerrequired
  • issued_count
    integerrequired
  • void_count
    integerrequired
  • issued_total
    stringrequired
    Decimal string, 2 dp
  • void_total
    stringrequired
    Decimal string, 2 dp
  • check_numbers
    string[]required

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/positive_pay" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "positive_pay": {}
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batches

List positive pay batches

Positive pay files sent from this account (banking and AP run files), newest first: counts and totals only. Needs release_payments. 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
  • bank_account_id
    integerrequired
  • source
    stringrequired
    One of: banking, ap_run.
  • ap_run_id
    integer | nullrequired
  • issued_count
    integerrequired
  • void_count
    integerrequired
  • issued_total
    stringrequired
    Decimal string, 2 dp
  • void_total
    stringrequired
    Decimal string, 2 dp
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batches/{batch_id}/regenerate

Regenerate a positive pay batch

Rebuilds a sent batch (for a lost download): the same checks with the status each was sent with, under the original file name. Marks nothing. A batch holds only the rows it marked first (an AP run file that repeated rows an earlier file sent regenerates without them), and the current account number and file options are used. Needs release_payments; audited as positive_pay_regenerated. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • batch_id
    integerrequired
  • file_name
    stringrequired
  • content
    stringrequired
    The batch's CSV, rebuilt (full account number); never stored
  • item_count
    integerrequired
  • check_numbers
    string[]required

Errors

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

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/positive_pay/batches/1/regenerate" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/receipt_capture

First receipt submissions needed for existing native card charge lines

Read only. Requires accounting:read token scope, bankReconcile and whole-account access; project-scoped grants refused. Non-void card charges strictly above the current Decimal account threshold with no submission history. Legacy assertions do not exclude work. Scoped ascending line-ID cursor; no counts. Final common authorization/state snapshot; 409 if changed. No import, matching or financial writes.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • after
    integerquery
  • per_page
    integerquery

Response · 200 · object

  • account
    objectrequired
  • account.id
    integer
  • account.company_id
    integer
  • account.gl_account_id
    integer
  • account.entity_id
    integer | null
  • account.name
    string
  • account.currency
    string
  • account.receipt_required_over
    string | null
  • items
    object[]required
  • items[].line_id
    integerrequired
  • items[].line_no
    integerrequired
  • items[].transaction_id
    integerrequired
  • items[].transaction_number
    stringrequired
  • items[].transaction_status
    stringrequired
  • items[].amount
    stringrequired
  • items[].href
    stringrequired
  • items[].transaction_date
    string (date)required
  • items[].payee
    string | nullrequired
  • items[].legacy_has_receipt
    booleanrequired
  • per_page
    integerrequired
  • next_after
    integer | nullrequired

Errors

  • 401Authentication required
  • 403Scope/authority denied
  • 404Account outside access
  • 409Work changed; reload
  • 422Invalid query or inactive/non-card account

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliations

List reconciliations

Sessions for the account, latest statement first. Paginated. 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
  • page
    integerquery
    Page (1-based)
  • per_page
    integerquery
    Items per page

Response · 200 · object[]

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliations

Start a reconciliation

Beginning balance = the sum of reconciled lines; lines already cleared on or before the statement date are pre-ticked. One session in progress per account; the date must follow the last finished one. Needs bank_reconcile. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • reconciliation
    objectrequired
  • reconciliation.statement_date
    string (date)required
  • reconciliation.statement_ending_balance
    stringrequired
    Decimal string, 2 dp

Response · 201 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • totals.beginning_balance
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_payments
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_balance
    stringrequired
    Decimal string, 2 dp
  • totals.statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.explain
    object[]required
  • lines
    object[]required
  • lines[].journal_line_id
    integerrequired
  • lines[].entry_id
    integerrequired
  • lines[].entry_number
    string | nullrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    string | nullrequired
  • lines[].bank_transaction_id
    integer | nullrequired
  • lines[].bank_transaction_number
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].cleared
    booleanrequired
  • lines[].matched
    booleanrequired
  • lines[].reconcile_state
    stringrequired
    One of: n, c, y, v.
  • lines[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • lines[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • warnings
    string[]required
    For example: the statement ending balance differs from the closing balance of a statement imported for the same date.
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/reconciliations" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "reconciliation": {
    "statement_date": "2026-11-01",
    "statement_ending_balance": "0.00"
  }
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/register

Account register

Posted lines on the account's GL account, newest first, with a running balance and the reconcile state (n new, c cleared, y reconciled and locked, v void). Paginated. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • from
    string (date)query
    From date
  • to
    string (date)query
    To date
  • page
    integerquery
    Page (1-based)
  • per_page
    integerquery
    Items per page

Response · 200 · object[]

  • journal_line_id
    integerrequired
  • entry_id
    integerrequired
  • entry_number
    string | nullrequired
  • date
    string (date)required
  • description
    string | nullrequired
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • bank_transaction_id
    integer | nullrequired
  • bank_transaction_number
    string | nullrequired
  • check_number
    string | nullrequired
  • amount
    stringrequired
    Decimal string, 2 dp
  • deposit
    string | nullrequired
  • payment
    string | nullrequired
  • balance
    stringrequired
    Decimal string, 2 dp
  • reconcile_state
    stringrequired
    One of: n, c, y, v.
  • ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reveal

Reveal bank numbers

Full account and routing numbers. manage_vendor_banking only; writes a pii_revealed audit event. Not cached. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • account_number
    string | nullrequired
  • routing_number
    string | nullrequired

Errors

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

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_imports

List statement imports

Statement files imported into this account, newest first. Paginated (default 100 per page). Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired
  • page
    integerquery
    Page (1-based)
  • per_page
    integerquery
    Items per page

Response · 200 · object[]

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • format
    stringrequired
    One of: csv, ofx, bai2, camt053, feed.
  • file_name
    string | nullrequired
  • statement_start
    string | null (date)required
  • statement_end
    string | null (date)required
  • opening_balance
    string | nullrequired
  • closing_balance
    string | nullrequired
  • line_count
    integerrequired
  • duplicate_count
    integerrequired
  • warnings
    string[]required
  • 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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_imports

Import a statement

Parses CSV (with a column mapping), OFX/QFX, BAI2 or camt.053 through the shared statement parsers. The same file can't be imported twice (409); lines already imported (bank id, else a line hash) are skipped and counted. Needs bank_reconcile. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • statement_import
    objectrequired
  • statement_import.format
    stringrequired
    One of: csv, ofx, qfx, bai2, camt053.
  • statement_import.file_name
    string | null
  • statement_import.content
    stringrequired
  • statement_import.csv_mapping
    object
  • statement_import.csv_mapping.date
    string | integerrequired
  • statement_import.csv_mapping.description
    string | integerrequired
  • statement_import.csv_mapping.amount
    string | integer
  • statement_import.csv_mapping.debit
    string | integer
  • statement_import.csv_mapping.credit
    string | integer
  • statement_import.csv_mapping.reference
    string | integer
  • statement_import.csv_mapping.check_number
    string | integer
  • statement_import.csv_mapping.balance
    string | integer
  • statement_import.csv_mapping.date_format
    string
    One of: YYYYMMDD, MMDDYYYY, MMDDYY, YYMMDD, MM/DD/YYYY, YYYY-MM-DD.
  • statement_import.csv_mapping.sign
    string
    One of: deposit_positive, withdrawal_positive.
  • statement_import.csv_mapping.has_header
    boolean
  • statement_import.csv_mapping.skip_rows
    integer
  • statement_import.csv_mapping.delimiter
    string
  • statement_import.positive_pay_options
    object | null
    Positive pay layout: CSV (format csv or omitted: columns, dateFormat, header, statusCodes) or fixed-width (format fixed with template: recordLength, dateFormat, statusCodes, detail/header/trailer fields of source, start, length, align, pad, value).
  • statement_import.save_mapping
    boolean

Response · 201 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • format
    stringrequired
    One of: csv, ofx, bai2, camt053, feed.
  • file_name
    string | nullrequired
  • statement_start
    string | null (date)required
  • statement_end
    string | null (date)required
  • opening_balance
    string | nullrequired
  • closing_balance
    string | nullrequired
  • line_count
    integerrequired
  • duplicate_count
    integerrequired
  • warnings
    string[]required
  • 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
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/accounts/1/statement_imports" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "statement_import": {
    "format": "csv",
    "content": "string"
  }
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_forecast

Cash forecast

Weekly projection of the cash (non-card) accounts: opening book balance plus postdated cash lines, recurring journals touching cash, and (unless trend=false) the trailing 13-week run rate excluding transfers. Each flow names its source. 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
  • as_of
    string (date)query
    Default today
  • weeks
    integerquery
    1–52, default 13
  • trend
    stringquery
    Include run rate One of: true, false.
  • open_items
    stringquery
    Include open AP bills (due date), draft payment runs (pay date), open AR (due date plus ar_lag_days) and payroll (unposted runs and each pay group's next regular runs); default true One of: true, false.
  • ar_lag_days
    integerquery
    Days after the due date AR is expected to collect; default 0

Response · 200 · object

  • as_of
    string (date)required
  • opening
    stringrequired
    Decimal string, 2 dp
  • closing
    stringrequired
    Decimal string, 2 dp
  • floor
    string | nullrequired
  • trailing_net
    stringrequired
    Decimal string, 2 dp
  • low_point
    object | nullrequired
  • low_point.week_end
    string (date)required
  • low_point.balance
    stringrequired
    Decimal string, 2 dp
  • accounts
    object[]required
  • accounts[].id
    integerrequired
  • accounts[].name
    stringrequired
  • weeks
    object[]required
  • weeks[].week_start
    string (date)required
  • weeks[].week_end
    string (date)required
  • weeks[].opening
    stringrequired
    Decimal string, 2 dp
  • weeks[].inflows
    stringrequired
    Decimal string, 2 dp
  • weeks[].outflows
    stringrequired
    Decimal string, 2 dp
  • weeks[].net
    stringrequired
    Decimal string, 2 dp
  • weeks[].closing
    stringrequired
    Decimal string, 2 dp
  • weeks[].below_floor
    booleanrequired
  • weeks[].flows
    object[]required
  • explain
    object[]required
  • explain[].label
    stringrequired
  • explain[].value
    stringrequired
  • explain[].formula
    stringrequired

Errors

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

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_position

Cash position

Per account: book, reconciled and cleared balances, outstanding items, last reconciliation and statement, lines to match; totals for cash and cards owed. 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
  • as_of
    string (date)query
    Default today

Response · 200 · object

  • as_of
    string (date)required
  • totals
    objectrequired
  • totals.cash
    stringrequired
    Decimal string, 2 dp
  • totals.cards_owed
    stringrequired
    Decimal string, 2 dp
  • totals.net_cash
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.unmatched
    integerrequired
  • accounts
    object[]required
  • accounts[].bank_account_id
    integerrequired
  • accounts[].name
    stringrequired
  • accounts[].kind
    stringrequired
    One of: checking, savings, money_market, credit_card, cash.
  • accounts[].gl_account_number
    stringrequired
  • accounts[].account_number_masked
    string | nullrequired
  • accounts[].book_balance
    stringrequired
    Decimal string, 2 dp
  • accounts[].reconciled_balance
    stringrequired
    Decimal string, 2 dp
  • accounts[].cleared_balance
    stringrequired
    Decimal string, 2 dp
  • accounts[].outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • accounts[].outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • accounts[].last_reconciliation
    object | nullrequired
  • accounts[].reconciliation_in_progress_id
    integer | nullrequired
  • accounts[].last_statement
    object | nullrequired
  • accounts[].unmatched_count
    integerrequired

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/checks/{id}/stop

Stop payment on a check

Marks an issued check in the register (banking, AP or payroll) as stopped; the next positive pay file sends it to the bank with the stop status. The books do not change: void or reissue the check to move the money. release_payments; audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • stop
    objectrequired
  • stop.reason
    stringrequired

Response · 200 · object

  • id
    integerrequired
  • check_number
    stringrequired
  • bank_account_id
    integerrequired
  • status
    stringrequired
  • amount
    string | nullrequired
    Null for a payroll check (net pay stays with payroll).
  • payee
    string | nullrequired
    Null for a payroll check.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Check not found
  • 422The check is not issued, or validation failed

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/checks/1/stop" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "stop": {
    "reason": "string"
  }
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/feeds

List live bank feed connections

Connections in the grant's entity scope (a connection without an entity is visible to all-entity grants only). enabled is false when feeds are not configured on this server. Entity-wide: a project-scoped grant gets 403. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • enabled
    booleanrequired
  • connections
    object[]required
  • connections[].id
    integerrequired
  • connections[].provider
    stringrequired
    One of: plaid, fake.
  • connections[].entity_id
    integer | nullrequired
  • connections[].institution_name
    string | nullrequired
  • connections[].status
    stringrequired
    One of: active, login_required, expiring, revoked, error, disconnected.
  • connections[].status_detail
    string | nullrequired
  • connections[].health
    objectrequired
  • connections[].new_accounts_available
    booleanrequired
  • connections[].accounts
    object[]required
  • connections[].bank_accounts
    object[]required
  • connections[].last_sync_at
    string | null (date-time)required
  • connections[].last_success_at
    string | null (date-time)required
  • connections[].consecutive_failures
    integerrequired
  • connections[].last_error
    string | nullrequired
  • connections[].last_stats
    objectrequired
    Counts from the last successful sync: added, modified, removed, pending_skipped, unmapped, before_start, exceptions.
  • connections[].created_at
    string (date-time)required
  • connections[].updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), 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/banking/feeds" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/feeds

Link a bank (exchange a Link public token)

Exchanges the provider Link public token and stores the connection; the access token is encrypted, bound to the row and never returned. Needs manage_integrations and bank_reconcile. 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

  • public_token
    stringrequired
  • entity_id
    integer | null
  • institution_name
    string | null

Response · 201 · object

  • id
    integerrequired
  • provider
    stringrequired
    One of: plaid, fake.
  • entity_id
    integer | nullrequired
  • institution_name
    string | nullrequired
  • status
    stringrequired
    One of: active, login_required, expiring, revoked, error, disconnected.
  • status_detail
    string | nullrequired
  • health
    objectrequired
  • health.state
    stringrequired
    One of: live, stale, reconnect, expiring, error, pending, disconnected.
  • health.label
    stringrequired
  • new_accounts_available
    booleanrequired
  • accounts
    object[]required
  • accounts[].id
    stringrequired
  • accounts[].name
    stringrequired
  • accounts[].mask
    string | nullrequired
  • accounts[].type
    stringrequired
  • accounts[].subtype
    string | nullrequired
  • accounts[].currency
    string | nullrequired
    Provider ISO currency; unknown or unofficial currency cannot be mapped.
  • bank_accounts
    object[]required
  • bank_accounts[].id
    integerrequired
  • bank_accounts[].name
    stringrequired
  • bank_accounts[].feed_account_id
    string | nullrequired
  • bank_accounts[].start_date
    string | null (date)required
  • last_sync_at
    string | null (date-time)required
  • last_success_at
    string | null (date-time)required
  • consecutive_failures
    integerrequired
  • last_error
    string | nullrequired
  • last_stats
    objectrequired
    Counts from the last successful sync: added, modified, removed, pending_skipped, unmapped, before_start, exceptions.
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 409Conflict (state, duplicate, already linked or already fed, or the start date reaches reconciled history)
  • 422Validation error
  • 503Live bank feeds are not configured on this server (PLAID_CLIENT_ID, PLAID_SECRET, PLAID_ENV), or encryption is not configured

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}

Show a live bank feed connection

Entity-wide: a project-scoped grant gets 403. 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
  • provider
    stringrequired
    One of: plaid, fake.
  • entity_id
    integer | nullrequired
  • institution_name
    string | nullrequired
  • status
    stringrequired
    One of: active, login_required, expiring, revoked, error, disconnected.
  • status_detail
    string | nullrequired
  • health
    objectrequired
  • health.state
    stringrequired
    One of: live, stale, reconnect, expiring, error, pending, disconnected.
  • health.label
    stringrequired
  • new_accounts_available
    booleanrequired
  • accounts
    object[]required
  • accounts[].id
    stringrequired
  • accounts[].name
    stringrequired
  • accounts[].mask
    string | nullrequired
  • accounts[].type
    stringrequired
  • accounts[].subtype
    string | nullrequired
  • accounts[].currency
    string | nullrequired
    Provider ISO currency; unknown or unofficial currency cannot be mapped.
  • bank_accounts
    object[]required
  • bank_accounts[].id
    integerrequired
  • bank_accounts[].name
    stringrequired
  • bank_accounts[].feed_account_id
    string | nullrequired
  • bank_accounts[].start_date
    string | null (date)required
  • last_sync_at
    string | null (date-time)required
  • last_success_at
    string | null (date-time)required
  • consecutive_failures
    integerrequired
  • last_error
    string | nullrequired
  • last_stats
    objectrequired
    Counts from the last successful sync: added, modified, removed, pending_skipped, unmapped, before_start, exceptions.
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 404Not found

Example request

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

Accounting / Banking

DELETE /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}

Disconnect a live bank feed

Removes the Item at the provider (best effort), forgets the token and cursor, sets status disconnected and unmaps its bank accounts. Statement lines stay. Needs manage_integrations and bank_reconcile. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • provider
    stringrequired
    One of: plaid, fake.
  • entity_id
    integer | nullrequired
  • institution_name
    string | nullrequired
  • status
    stringrequired
    One of: active, login_required, expiring, revoked, error, disconnected.
  • status_detail
    string | nullrequired
  • health
    objectrequired
  • health.state
    stringrequired
    One of: live, stale, reconnect, expiring, error, pending, disconnected.
  • health.label
    stringrequired
  • new_accounts_available
    booleanrequired
  • accounts
    object[]required
  • accounts[].id
    stringrequired
  • accounts[].name
    stringrequired
  • accounts[].mask
    string | nullrequired
  • accounts[].type
    stringrequired
  • accounts[].subtype
    string | nullrequired
  • accounts[].currency
    string | nullrequired
    Provider ISO currency; unknown or unofficial currency cannot be mapped.
  • bank_accounts
    object[]required
  • bank_accounts[].id
    integerrequired
  • bank_accounts[].name
    stringrequired
  • bank_accounts[].feed_account_id
    string | nullrequired
  • bank_accounts[].start_date
    string | null (date)required
  • last_sync_at
    string | null (date-time)required
  • last_success_at
    string | null (date-time)required
  • consecutive_failures
    integerrequired
  • last_error
    string | nullrequired
  • last_stats
    objectrequired
    Counts from the last successful sync: added, modified, removed, pending_skipped, unmapped, before_start, exceptions.
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 404Not found

Example request

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

Accounting / Banking

PATCH /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}/accounts

Map feed accounts to bank accounts

Map, remap or unmap (bank_account_id null) each provider account. start_date is the first day the feed owns (default: the day after the account's latest statement line, else 30 days ago); it may not be on or before the last finished reconciliation (409). A bank account fed by another connection is refused (409); one outside the connection's entity is 404. Mapping queues a sync. Needs manage_integrations and bank_reconcile. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • mappings
    object[]required
  • mappings[].feed_account_id
    stringrequired
  • mappings[].bank_account_id
    integer | nullrequired
  • mappings[].start_date
    string (date)

Response · 200 · object

  • id
    integerrequired
  • provider
    stringrequired
    One of: plaid, fake.
  • entity_id
    integer | nullrequired
  • institution_name
    string | nullrequired
  • status
    stringrequired
    One of: active, login_required, expiring, revoked, error, disconnected.
  • status_detail
    string | nullrequired
  • health
    objectrequired
  • health.state
    stringrequired
    One of: live, stale, reconnect, expiring, error, pending, disconnected.
  • health.label
    stringrequired
  • new_accounts_available
    booleanrequired
  • accounts
    object[]required
  • accounts[].id
    stringrequired
  • accounts[].name
    stringrequired
  • accounts[].mask
    string | nullrequired
  • accounts[].type
    stringrequired
  • accounts[].subtype
    string | nullrequired
  • accounts[].currency
    string | nullrequired
    Provider ISO currency; unknown or unofficial currency cannot be mapped.
  • bank_accounts
    object[]required
  • bank_accounts[].id
    integerrequired
  • bank_accounts[].name
    stringrequired
  • bank_accounts[].feed_account_id
    string | nullrequired
  • bank_accounts[].start_date
    string | null (date)required
  • last_sync_at
    string | null (date-time)required
  • last_success_at
    string | null (date-time)required
  • consecutive_failures
    integerrequired
  • last_error
    string | nullrequired
  • last_stats
    objectrequired
    Counts from the last successful sync: added, modified, removed, pending_skipped, unmapped, before_start, exceptions.
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, already linked or already fed, or the start date reaches reconciled history)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/feeds/1/accounts" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "mappings": [
    {
      "feed_account_id": "string",
      "bank_account_id": 1
    }
  ]
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/feeds/{id}/sync

Sync a live bank feed now

Queues a sync job (one per connection per minute; never syncs inline). New posted transactions become statement lines in the matching inbox; pending ones are skipped. Needs bank_reconcile. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 202 · object

  • job_id
    integerrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, already linked or already fed, or the start date reaches reconciled history)
  • 503Live bank feeds are not configured on this server (PLAID_CLIENT_ID, PLAID_SECRET, PLAID_ENV), or encryption is not configured

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/feeds/link_token

Create a bank Link token

A provider Link token for a new connection, or update mode (reconnect after login_required, or add accounts) with connection_id. Needs manage_integrations and bank_reconcile. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • connection_id
    integer

Response · 200 · object

  • link_token
    stringrequired
  • expires_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, already linked or already fed, or the start date reaches reconciled history)
  • 503Live bank feeds are not configured on this server (PLAID_CLIENT_ID, PLAID_SECRET, PLAID_ENV), or encryption is not configured

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/feeds/link_token" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "connection_id": 1
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/receipt_reviews

List pending independent card receipt reviews

Requires accounting:read and live bankReconcile. Excludes project-scoped grants and inaccessible, shared or mixed-entity accounts according to the existing bank artifact policy. Scope and independence precede keyset pagination. Includes stale pending submissions for explicit rejection; never mutates financial state. No total count is exposed.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • after
    integerquery
    Exclusive submission ID cursor from next_after.
  • per_page
    integerquery

Response · 200 · object

  • items
    object[]required
  • items[].submission_id
    integerrequired
  • items[].transaction_id
    integerrequired
  • items[].transaction_number
    stringrequired
  • items[].line_id
    integerrequired
  • items[].line_no
    integer | nullrequired
  • items[].amount
    string | nullrequired
  • items[].currency
    stringrequired
  • items[].bank_account_name
    stringrequired
  • items[].submitted_at
    string (date-time)required
  • items[].evidence_type
    stringrequired
    One of: receipt, exception.
  • items[].status
    stringrequired
    One of: pending, stale.
  • items[].review_url
    stringrequired
    Exact submission anchor on the existing authorized transaction detail.
  • items[].attachment
    object | nullrequired
  • per_page
    integerrequired
  • next_after
    integer | nullrequired

Errors

  • 403Accounting read scope, bankReconcile or entity-wide authority missing.
  • 409Eligibility changed while loading; reload the queue.
  • 422Invalid cursor or page size.

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}

Show a reconciliation

The session with its lines (in progress: every candidate with a cleared flag; finished: the locked items) and totals with an explain trace. 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
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • totals.beginning_balance
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_payments
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_balance
    stringrequired
    Decimal string, 2 dp
  • totals.statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.explain
    object[]required
  • lines
    object[]required
  • lines[].journal_line_id
    integerrequired
  • lines[].entry_id
    integerrequired
  • lines[].entry_number
    string | nullrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    string | nullrequired
  • lines[].bank_transaction_id
    integer | nullrequired
  • lines[].bank_transaction_number
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].cleared
    booleanrequired
  • lines[].matched
    booleanrequired
  • lines[].reconcile_state
    stringrequired
    One of: n, c, y, v.
  • lines[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • lines[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • warnings
    string[]required
    For example: the statement ending balance differs from the closing balance of a statement imported for the same date.
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409The session links a line that is not a valid bank ledger line for it (another account or tenant, dated after the statement, not posted, or in the wrong reconcile state). Cancel an in-progress session (DELETE) or undo a finished one to recover.

Example request

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

Accounting / Banking

PATCH /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}

Tick lines / change the statement balance

clear / unclear journal line ids (n ↔ c) and the statement ending balance, while in progress. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • reconciliation
    objectrequired
  • reconciliation.statement_ending_balance
    string
    Decimal string, 2 dp
  • reconciliation.clear
    integer[]
  • reconciliation.unclear
    integer[]

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • totals.beginning_balance
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_payments
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_balance
    stringrequired
    Decimal string, 2 dp
  • totals.statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.explain
    object[]required
  • lines
    object[]required
  • lines[].journal_line_id
    integerrequired
  • lines[].entry_id
    integerrequired
  • lines[].entry_number
    string | nullrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    string | nullrequired
  • lines[].bank_transaction_id
    integer | nullrequired
  • lines[].bank_transaction_number
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].cleared
    booleanrequired
  • lines[].matched
    booleanrequired
  • lines[].reconcile_state
    stringrequired
    One of: n, c, y, v.
  • lines[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • lines[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • warnings
    string[]required
    For example: the statement ending balance differs from the closing balance of a statement imported for the same date.
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock). A 409 also means the session links an invalid bank ledger line (another account or tenant, dated after the statement, not posted, or in the wrong reconcile state); cancel it (DELETE) to recover.
  • 422Validation error

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/reconciliations/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "reconciliation": {}
}'

Accounting / Banking

DELETE /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}

Cancel an in-progress reconciliation

Drops the ticks; matched lines stay cleared. Requires the accounting:write scope. Also the recovery path for a session with invalid ledger links: those links are dropped without changing the lines they point at, and the audit entry lists them.

v1.0Implemented

Parameters

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

Response · 204

No response body.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/finish

Finish a reconciliation

Only at a difference of 0.00, or with adjustment_reason, which posts an adjustment entry (to adjustment_account_id or SUSPENSE). The adjustment is refused (422) above settings.recon_adjustment_limit, or, when that is null, at or above require_approval_above (any difference when both are null): record the difference as a bank transaction, which a second person approves at or above the threshold, clear it, then finish. Every ticked line becomes reconciled (y) and is locked; the database refuses any later change to it outside an undo. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • finish
    object
  • finish.adjustment_reason
    string
  • finish.adjustment_account_id
    integer | null

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • totals.beginning_balance
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_payments
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_balance
    stringrequired
    Decimal string, 2 dp
  • totals.statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.explain
    object[]required
  • lines
    object[]required
  • lines[].journal_line_id
    integerrequired
  • lines[].entry_id
    integerrequired
  • lines[].entry_number
    string | nullrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    string | nullrequired
  • lines[].bank_transaction_id
    integer | nullrequired
  • lines[].bank_transaction_number
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].cleared
    booleanrequired
  • lines[].matched
    booleanrequired
  • lines[].reconcile_state
    stringrequired
    One of: n, c, y, v.
  • lines[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • lines[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • warnings
    string[]required
    For example: the statement ending balance differs from the closing balance of a statement imported for the same date.
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock). A 409 also means the session links an invalid bank ledger line (another account or tenant, dated after the statement, not posted, or in the wrong reconcile state); cancel it (DELETE) to recover.
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/reconciliations/1/finish" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "finish": {}
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/review

Review a finished reconciliation

Independent sign-off of a finished reconciliation by a user with close_period or approve_journal who did not finish it (403 for the finisher). Sets reviewed_by_id and reviewed_at and is audited. 409 when the session is not finished or is already reviewed. Close readiness blocks (reconciliation_unreviewed) on a finished, unreviewed reconciliation dated in the period. No request body. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • totals.beginning_balance
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_payments
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_balance
    stringrequired
    Decimal string, 2 dp
  • totals.statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.explain
    object[]required
  • lines
    object[]required
  • lines[].journal_line_id
    integerrequired
  • lines[].entry_id
    integerrequired
  • lines[].entry_number
    string | nullrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    string | nullrequired
  • lines[].bank_transaction_id
    integer | nullrequired
  • lines[].bank_transaction_number
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].cleared
    booleanrequired
  • lines[].matched
    booleanrequired
  • lines[].reconcile_state
    stringrequired
    One of: n, c, y, v.
  • lines[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • lines[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • warnings
    string[]required
    For example: the statement ending balance differs from the closing balance of a statement imported for the same date.
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Not finished, already reviewed, or changed concurrently

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/undo

Undo a reconciliation

Controller only (close_period), latest finished session only. Reconciled lines go back to cleared. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • undo
    objectrequired
  • undo.reason
    stringrequired

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • beginning_balance
    stringrequired
    Decimal string, 2 dp
  • status
    stringrequired
    One of: in_progress, finished, undone.
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • totals.beginning_balance
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_payments
    stringrequired
    Decimal string, 2 dp
  • totals.cleared_balance
    stringrequired
    Decimal string, 2 dp
  • totals.statement_ending_balance
    stringrequired
    Decimal string, 2 dp
  • totals.difference
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_deposits
    stringrequired
    Decimal string, 2 dp
  • totals.outstanding_payments
    stringrequired
    Decimal string, 2 dp
  • totals.explain
    object[]required
  • lines
    object[]required
  • lines[].journal_line_id
    integerrequired
  • lines[].entry_id
    integerrequired
  • lines[].entry_number
    string | nullrequired
  • lines[].date
    string (date)required
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].description
    string | nullrequired
  • lines[].bank_transaction_id
    integer | nullrequired
  • lines[].bank_transaction_number
    string | nullrequired
  • lines[].check_number
    string | nullrequired
  • lines[].cleared
    booleanrequired
  • lines[].matched
    booleanrequired
  • lines[].reconcile_state
    stringrequired
    One of: n, c, y, v.
  • lines[].ap_payment_id
    integer | nullrequired
    AP payment behind the line (sourced from an AP payment run); check_number and description come from it
  • lines[].link
    string | nullrequired
    App path to the source document (bank transaction or AP payment run)
  • warnings
    string[]required
    For example: the statement ending balance differs from the closing balance of a statement imported for the same date.
  • reviewed_by_id
    integer | nullrequired
    Independent reviewer (close_period or approve_journal, never the finisher).
  • reviewed_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock). A 409 also means the session links an invalid bank ledger line (another account or tenant, dated after the statement, not posted, or in the wrong reconcile state); undo still succeeds for a finished session and drops those links, naming them in the audit entry.
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/reconciliations/1/undo" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "undo": {
    "reason": "string"
  }
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/rules

List bank rules

Rules in priority order. 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
  • bank_account_id
    integer | nullrequired
  • priority
    integerrequired
  • is_active
    booleanrequired
  • direction
    stringrequired
    One of: in, out, any.
  • description_contains
    stringrequired
  • amount_min
    string | nullrequired
  • amount_max
    string | nullrequired
  • account_id
    integerrequired
  • project_id
    integer | nullrequired
  • cost_code_id
    integer | nullrequired
  • vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • times_applied
    integerrequired
  • 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/banking/rules" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/rules

Create a bank rule

Text match (case-insensitive) plus direction and amount band, coding to a postable non-control account. Needs bank_reconcile. 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

  • bank_rule
    objectrequired
  • bank_rule.name
    stringrequired
  • bank_rule.bank_account_id
    integer | null
  • bank_rule.priority
    integer
  • bank_rule.is_active
    boolean
  • bank_rule.direction
    string
    One of: in, out, any.
  • bank_rule.description_contains
    stringrequired
  • bank_rule.amount_min
    string | null
  • bank_rule.amount_max
    string | null
  • bank_rule.account_id
    integerrequired
  • bank_rule.project_id
    integer | null
  • bank_rule.cost_code_id
    integer | null
  • bank_rule.cost_type_id
    integer | null
  • bank_rule.vendor_id
    integer | null
  • bank_rule.memo
    string | null

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • bank_account_id
    integer | nullrequired
  • priority
    integerrequired
  • is_active
    booleanrequired
  • direction
    stringrequired
    One of: in, out, any.
  • description_contains
    stringrequired
  • amount_min
    string | nullrequired
  • amount_max
    string | nullrequired
  • account_id
    integerrequired
  • project_id
    integer | nullrequired
  • cost_code_id
    integer | nullrequired
  • vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • times_applied
    integerrequired
  • 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
  • 422Validation error

Example request

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

Accounting / Banking

PATCH /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}

Update a bank rule

Any rule field. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • bank_rule
    objectrequired
  • bank_rule.name
    string
  • bank_rule.bank_account_id
    integer | null
  • bank_rule.priority
    integer
  • bank_rule.is_active
    boolean
  • bank_rule.direction
    string
    One of: in, out, any.
  • bank_rule.description_contains
    string
  • bank_rule.amount_min
    string | null
  • bank_rule.amount_max
    string | null
  • bank_rule.account_id
    integer
  • bank_rule.project_id
    integer | null
  • bank_rule.cost_code_id
    integer | null
  • bank_rule.cost_type_id
    integer | null
  • bank_rule.vendor_id
    integer | null
  • bank_rule.memo
    string | null

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • bank_account_id
    integer | nullrequired
  • priority
    integerrequired
  • is_active
    booleanrequired
  • direction
    stringrequired
    One of: in, out, any.
  • description_contains
    stringrequired
  • amount_min
    string | nullrequired
  • amount_max
    string | nullrequired
  • account_id
    integerrequired
  • project_id
    integer | nullrequired
  • cost_code_id
    integer | nullrequired
  • vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • times_applied
    integerrequired
  • 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
  • 422Validation error

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/rules/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "bank_rule": {}
}'

Accounting / Banking

DELETE /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}

Delete a bank rule

Lines it matched keep their match. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 204

No response body.

Errors

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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/create_transaction

Create from a statement line

Records the document the bank line represents (deposit/withdrawal, or card charge/credit), posts it, matches it, and optionally saves a bank rule from the coding. At or above the journal approval threshold the document is held as pending_approval and the line stays unmatched until a second person approves it (approval matches it); creating again from that line is refused with 409. A single line defaults to the full amount. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • create
    objectrequired
  • create.payee
    string | null
  • create.memo
    string | null
  • create.rule_id
    integer | null
  • create.lines
    object[]required
  • create.lines[].account_id
    integerrequired
  • create.lines[].amount
    string
    Decimal string, 2 dp
  • create.lines[].memo
    string | null
  • create.lines[].project_id
    integer | null
  • create.lines[].cost_code_id
    integer | null
  • create.lines[].cost_type_id
    integer | null
  • create.lines[].vendor_id
    integer | null
  • create.lines[].customer_id
    integer | null
  • create.lines[].equipment_id
    integer | null
  • create.lines[].has_receipt
    boolean
  • create.lines[].reportable_1099
    boolean
    Checks and withdrawals to a 1099 vendor: false keeps the line off the 1099. Default true.
  • create.save_rule
    object
  • create.save_rule.name
    stringrequired
  • create.save_rule.description_contains
    stringrequired

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • status
    stringrequired
    One of: pending_approval, posted, void.
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
    The second person who released the check or approved the document; null when posted below the threshold.
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].cost_type_id
    integer | nullrequired
  • lines[].vendor_id
    integer | nullrequired
  • lines[].customer_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].has_receipt
    booleanrequired
  • lines[].reportable_1099
    boolean
  • lines[].receipt_missing
    booleanrequired
  • 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
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/statement_lines/1/create_transaction" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "create": {
    "lines": [
      {
        "account_id": 1
      }
    ]
  }
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/feed_note/clear

Mark a bank feed note reviewed

Clears the note the live feed left on a matched line it changed or removed. Needs bank_reconcile. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
    One of: unmatched, matched, ignored.
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
  • feed_note
    string | nullrequired
    Set when the live feed changed or removed this line after it was matched; cleared by Mark reviewed or unmatch.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission (project-scoped grants are refused), wrong company, or read-only workspace
  • 404Not found

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/statement_lines/1/feed_note/clear" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/ignore

Ignore a statement line

Moves an unmatched line out of the inbox. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
    One of: unmatched, matched, ignored.
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
  • feed_note
    string | nullrequired
    Set when the live feed changed or removed this line after it was matched; cleared by Mark reviewed or unmatch.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/match

Match a statement line

Matches one or more book lines (posted, on the account, not reconciled or void, not matched elsewhere) whose total equals the bank amount to the cent. Book lines become cleared. Needs bank_reconcile. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • match
    objectrequired
  • match.journal_line_ids
    integer[]required

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
    One of: unmatched, matched, ignored.
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
  • feed_note
    string | nullrequired
    Set when the live feed changed or removed this line after it was matched; cleared by Mark reviewed or unmatch.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/statement_lines/1/match" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "match": {
    "journal_line_ids": []
  }
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/restore

Restore an ignored statement line

Puts the line back in the inbox. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
    One of: unmatched, matched, ignored.
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
  • feed_note
    string | nullrequired
    Set when the live feed changed or removed this line after it was matched; cleared by Mark reviewed or unmatch.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/unmatch

Unmatch a statement line

Refused with 409 when a matched book line is reconciled (the lock). Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
    One of: unmatched, matched, ignored.
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
  • feed_note
    string | nullrequired
    Set when the live feed changed or removed this line after it was matched; cleared by Mark reviewed or unmatch.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions

List cash documents

Deposits, checks, withdrawals, transfers and card charges/credits. Filters: filters[bank_account_id], filters[kind], filters[status]; from/to; search (number, payee, memo, check #). Paginated. Delta sync: updated_since and/or cursor return changes in ascending (updated_at, id) order with Next-Cursor. 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
    From date
  • to
    string (date)query
    To date
  • search
    stringquery
    Search
  • page
    integerquery
    Page (1-based)
  • per_page
    integerquery
    Items per page
  • updated_since
    string (date-time)query
    Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id.
  • cursor
    stringquery
    Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is.

Response · 200 · object[]

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • status
    stringrequired
    One of: pending_approval, posted, void.
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
    The second person who released the check or approved the document; null when posted below the threshold.
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].cost_type_id
    integer | nullrequired
  • lines[].vendor_id
    integer | nullrequired
  • lines[].customer_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].has_receipt
    booleanrequired
  • lines[].reportable_1099
    boolean
  • lines[].receipt_missing
    booleanrequired
  • 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
  • 422Validation error

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions

Record and post a cash document

Posts one CM journal entry (idempotent on the document id), or holds the document as pending_approval with no posting until a second person approves it (POST .../approve): checks always (release by a different release_payments user), deposits, withdrawals and card documents at or above the journal approval threshold. Transfers between the company's own accounts follow the transfer policy (settings transfer_approval_cross_entity, default true, and transfer_approval_above, null = require_approval_above when set): a transfer between entities or at or above the amount is held for release by a different release_payments user; others post at once. Checks take the account's next check number unless one is given, need a payee, and need release_payments; the others need bank_reconcile. Coding lines must total the amount and can't use control accounts or other bank registers. 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

  • bank_transaction
    objectrequired
  • bank_transaction.bank_account_id
    integerrequired
  • bank_transaction.kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • bank_transaction.date
    string (date)required
  • bank_transaction.amount
    stringrequired
    Decimal string, 2 dp
  • bank_transaction.payee
    string | null
  • bank_transaction.payee_vendor_id
    integer | null
  • bank_transaction.memo
    string | null
  • bank_transaction.reference
    string | null
  • bank_transaction.check_number
    string | null
  • bank_transaction.to_bank_account_id
    integer | null
  • bank_transaction.lines
    object[]
  • bank_transaction.lines[].account_id
    integerrequired
  • bank_transaction.lines[].amount
    stringrequired
    Decimal string, 2 dp
  • bank_transaction.lines[].memo
    string | null
  • bank_transaction.lines[].project_id
    integer | null
  • bank_transaction.lines[].cost_code_id
    integer | null
  • bank_transaction.lines[].cost_type_id
    integer | null
  • bank_transaction.lines[].vendor_id
    integer | null
  • bank_transaction.lines[].customer_id
    integer | null
  • bank_transaction.lines[].equipment_id
    integer | null
  • bank_transaction.lines[].has_receipt
    boolean
  • bank_transaction.lines[].reportable_1099
    boolean
    Checks and withdrawals to a 1099 vendor: false keeps the line off the 1099. Default true.

Response · 201 · object

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • status
    stringrequired
    One of: pending_approval, posted, void.
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
    The second person who released the check or approved the document; null when posted below the threshold.
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].cost_type_id
    integer | nullrequired
  • lines[].vendor_id
    integer | nullrequired
  • lines[].customer_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].has_receipt
    booleanrequired
  • lines[].reportable_1099
    boolean
  • lines[].receipt_missing
    booleanrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 400Malformed JSON body or Idempotency-Key header
  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/transactions" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "bank_transaction": {
    "bank_account_id": 1,
    "kind": "deposit",
    "date": "2026-11-01",
    "amount": "0.00"
  }
}'

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}

Show a cash document

One document with its coding lines; card charges flag receipt_missing above the account's threshold. 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
  • number
    stringrequired
  • kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • status
    stringrequired
    One of: pending_approval, posted, void.
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
    The second person who released the check or approved the document; null when posted below the threshold.
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].cost_type_id
    integer | nullrequired
  • lines[].vendor_id
    integer | nullrequired
  • lines[].customer_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].has_receipt
    booleanrequired
  • lines[].reportable_1099
    boolean
  • lines[].receipt_missing
    booleanrequired
  • 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

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/approve

Release or approve a pending cash document

Posts a cash document that is waiting for a second person (status pending_approval): a check or transfer needs release_payments, any other kind approve_journal. Refused with 403 for the user who created it (segregation of duties) and 409 when it is not pending. Checks are always held for release; deposits, withdrawals and card documents are held at or above the journal approval threshold (settings.require_approval_above; null holds every one). Approval registers the check for positive pay and matches the statement line it was created from. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • status
    stringrequired
    One of: pending_approval, posted, void.
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
    The second person who released the check or approved the document; null when posted below the threshold.
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].cost_type_id
    integer | nullrequired
  • lines[].vendor_id
    integer | nullrequired
  • lines[].customer_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].has_receipt
    booleanrequired
  • lines[].reportable_1099
    boolean
  • lines[].receipt_missing
    booleanrequired
  • 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
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachments

List attachments on a bank transaction

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/banking/transactions/1/attachments" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Banking

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

Attach a file to a bank transaction

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 bank_reconcile 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/banking/transactions/1/attachments" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "file": "string"
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/check_print

Check print data

MICR line, amount in words and stub for a check. Decrypts the bank numbers: release_payments only, audited, not cached. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • check_number
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • amount_numeric
    stringrequired
  • amount_words
    stringrequired
  • payee_line
    stringrequired
  • payee_address
    string[]required
  • memo
    string | nullrequired
  • legend
    string | nullrequired
  • micr
    objectrequired
  • micr.text
    stringrequired
  • micr.font_text
    stringrequired
  • stub
    object[]required
  • stub[].reference
    stringrequired
  • stub[].date
    string (date)
  • stub[].gross
    stringrequired
  • stub[].discount
    stringrequired
  • stub[].net
    stringrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, or read-only workspace
  • 404Not found
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

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

Accounting / Banking

GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/receipt_evidence

Read retained receipt evidence under bank-account scope

Read only. Requires accounting:read token scope and view access to the card account. Lists the card charge lines with their latest submission status and full submission history; never mutates financial state.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • transaction_id
    integerrequired
  • attachments
    object[]required
  • attachments[].id
    integerrequired
  • attachments[].name
    stringrequired
  • lines
    object[]required
  • lines[].line_id
    integerrequired
  • lines[].line_no
    integerrequired
  • lines[].amount
    stringrequired
  • lines[].legacy_has_receipt
    booleanrequired
    Unverified legacy assertion; independent of reviewed evidence.
  • lines[].status
    stringrequired
    One of: unsubmitted, pending, verified, exception_approved, rejected, stale.
  • lines[].receipt_required
    booleanrequired
  • lines[].history
    object[]required

Errors

  • 403Token scope, grant or independence refused.
  • 404Source, account, line or attachment not accessible.
  • 409Stale evidence, pending submission or conflicting retry.
  • 422Invalid input or non-card transaction.

Example request

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

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/receipt_evidence

Submit line evidence for independent review

Requires accounting:write token scope and bankReconcile on the card account. Attaches an uploaded receipt (or an exception reason) to one card charge line for independent review. request_key in the body makes retries safe: the same key and evidence returns the first submission, a different payload under the same key is refused (409). Creates no posting and does not change approval, void or reconciliation state.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • request_key
    string (uuid)required
    Same actor and exact payload replay the prior submission; reused with a different payload returns 409.
  • line_id
    integerrequired
  • attachment_id
    integer | nullrequired
  • exception_reason
    string | nullrequired

Response · 201 · object

  • submission_id
    integerrequired

Errors

  • 403Token scope, grant or independence refused.
  • 404Source, account, line or attachment not accessible.
  • 409Stale evidence, pending submission or conflicting retry.
  • 422Invalid input or non-card transaction.

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/transactions/1/receipt_evidence" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "request_key": "00000000-0000-4000-8000-000000000000",
  "line_id": 1,
  "attachment_id": 1,
  "exception_reason": "string"
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/receipt_evidence/review

Record immutable independent review; exact reviewer/outcome/reason retries replay

Requires accounting:write token scope and bankReconcile on the card account. The reviewer must be independent of the charge creator, the submitter and the uploader. Decisions are immutable: an exact retry returns the recorded decision, anything else is refused (409). Creates no posting.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • submission_id
    integerrequired
  • outcome
    stringrequired
    One of: verified, exception_approved, rejected.
  • reason
    stringrequired

Response · 200 · object

  • decision_id
    integerrequired
  • outcome
    stringrequired
    One of: verified, exception_approved, rejected.

Errors

  • 403Token scope, grant or independence refused.
  • 404Source, account, line or attachment not accessible.
  • 409Stale evidence, pending submission or conflicting retry.
  • 422Invalid input or non-card transaction.

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/transactions/1/receipt_evidence/review" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "submission_id": 1,
  "outcome": "verified",
  "reason": "string"
}'

Accounting / Banking

POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/void

Void a cash document

Posts the reversing entry on the void date (an open period; a check from a closed month voids in the current one) and flags both bank lines void. Refused with 409 when the bank line is reconciled (the lock) or matched to a statement line. Requires the accounting:write scope. A pending_approval document is voided without any posting (withdrawn or rejected).

v1.0Implemented

Parameters

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

Request body

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

Response · 200 · object

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
    One of: deposit, check, withdrawal, transfer, card_charge, card_credit.
  • status
    stringrequired
    One of: pending_approval, posted, void.
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
    Decimal string, 2 dp
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
    The second person who released the check or approved the document; null when posted below the threshold.
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    object[]required
  • lines[].line_no
    integerrequired
  • lines[].account_id
    integerrequired
  • lines[].amount
    stringrequired
    Decimal string, 2 dp
  • lines[].memo
    string | nullrequired
  • lines[].project_id
    integer | nullrequired
  • lines[].cost_code_id
    integer | nullrequired
  • lines[].cost_type_id
    integer | nullrequired
  • lines[].vendor_id
    integer | nullrequired
  • lines[].customer_id
    integer | nullrequired
  • lines[].equipment_id
    integer | nullrequired
  • lines[].has_receipt
    booleanrequired
  • lines[].reportable_1099
    boolean
  • lines[].receipt_missing
    booleanrequired
  • 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
  • 409Conflict (state, duplicate, or the reconciliation lock)
  • 422Validation error

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/banking/transactions/1/void" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "void": {
    "date": "2026-11-01",
    "reason": "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