Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Accounting · Books and controls

Approvals

Review accounting work with approval rules and delegated authority. 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 Approvals guide for the workflow.

15 operationsCompany moduleAll Accounting apps →
  1. GET /rest/v1.0/companies/{company_id}/accounting/approval_delegationsList approval delegations
  2. POST /rest/v1.0/companies/{company_id}/accounting/approval_delegationsCreate an approval delegation
  3. DELETE /rest/v1.0/companies/{company_id}/accounting/approval_delegations/{id}Revoke an approval delegation
  4. GET /rest/v1.0/companies/{company_id}/accounting/approval_rulesList approval rules
  5. POST /rest/v1.0/companies/{company_id}/accounting/approval_rulesCreate an approval rule
  6. DELETE /rest/v1.0/companies/{company_id}/accounting/approval_rules/{id}Deactivate an approval rule
  7. GET /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/historyApproval escalation history of an item
  8. GET /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/policiesList approval escalation policies
  9. POST /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/policiesSave an approval escalation policy
  10. POST /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/runRun reminders and escalation now
  11. GET /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/settingsApproval escalation settings
  12. PUT /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/settingsSave approval escalation settings
  13. GET /rest/v1.0/companies/{company_id}/accounting/approvals/inboxApprovals inbox
  14. GET /rest/v1.0/companies/{company_id}/accounting/approvals/overdueOverdue approvals
  15. GET /rest/v1.0/companies/{company_id}/accounting/approvals/self_approvedSelf-approved documents

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approval_delegations

List approval delegations

Delegations from or to the caller; every delegation with manage_grants. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • from_user_id
    integerrequired
  • to_user_id
    integerrequired
  • doc_types
    any[]required
    One of: ap_bill, payment_batch, journal_entry.
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • starts_at
    string (date-time)required
  • ends_at
    string (date-time)required
  • reason
    stringrequired
  • created_by_id
    integerrequired
  • revoked_at
    string | null (date-time)required
  • created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties, 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/approval_delegations" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Approvals

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

Create an approval delegation

Lets to_user fill from_user's approval slots between starts_at and ends_at for the listed doc types, up to max_amount and within entity_ids (empty = all). The delegate needs the same approve flag and entity scope, never approves a document they or the delegator prepared, and the step records who they acted for. Delegating your own approvals needs each doc type's approve flag; from_user_id for someone else needs manage_grants and can't name yourself as to_user_id (403 self_delegation); a delegation someone created to themselves never fills a slot. 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

  • delegation
    objectrequired
  • delegation.from_user_id
    integer
  • delegation.to_user_id
    integerrequired
  • delegation.doc_types
    any[]required
    One of: ap_bill, payment_batch, journal_entry.
  • delegation.max_amount
    string | null
  • delegation.entity_ids
    integer[]
  • delegation.starts_at
    string (date-time)required
  • delegation.ends_at
    string (date-time)required
  • delegation.reason
    stringrequired

Response · 201 · object

  • id
    integerrequired
  • from_user_id
    integerrequired
  • to_user_id
    integerrequired
  • doc_types
    any[]required
    One of: ap_bill, payment_batch, journal_entry.
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • starts_at
    string (date-time)required
  • ends_at
    string (date-time)required
  • reason
    stringrequired
  • created_by_id
    integerrequired
  • revoked_at
    string | null (date-time)required
  • created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties, wrong company, or read-only workspace
  • 404Not found 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/approval_delegations" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "delegation": {
    "to_user_id": 1,
    "doc_types": "ap_bill",
    "starts_at": "2026-11-01T12:00:00Z",
    "ends_at": "2026-11-01T12:00:00Z",
    "reason": "string"
  }
}'

Accounting / Approvals

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

Revoke an approval delegation

The delegator or manage_grants. 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, segregation of duties, wrong company, or read-only workspace
  • 404Not found in this company

Example request

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

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approval_rules

List approval rules

Approval routing rules for ap_bill and payment_batch (WORKFLOWS §2), active first by priority. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry.
  • name
    stringrequired
  • priority
    integerrequired
  • min_amount
    string | nullrequired
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • project_ids
    integer[]required
  • vendor_risk
    any[]required
    One of: new_vendor, compliance_hold, bank_changed.
  • steps
    object[]required
  • steps[].approvers
    string[]required
  • steps[].quorum
    integer
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties, 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/approval_rules" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Approvals

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

Create an approval rule

Needs manage_grants. Among active rules for a doc type whose every non-empty condition matches (amount in [min_amount, max_amount), any entity, any line project, any vendor risk), the lowest priority routes the document; no match uses the AP approval bands (bills) or a single releaser (payment runs). Steps run in order; each step's approvers are grant:any (anyone with the doc type's approve flag), grant:<role>, project:<team role> (resolved from the project team when the route is snapshotted, leaving out the document's makers and members without the approve flag) or user:<id> (must hold the doc type's approve flag, else 422); quorum defaults to all of them (N-of-M otherwise) and shrinks to the approvers left after resolution. An equal priority among active rules of the doc type is 409 priority_taken. Rules are not edited in place: deactivate and create. 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

  • approval_rule
    objectrequired
  • approval_rule.doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry.
  • approval_rule.name
    stringrequired
  • approval_rule.priority
    integerrequired
  • approval_rule.min_amount
    string | null
  • approval_rule.max_amount
    string | null
  • approval_rule.entity_ids
    integer[]
  • approval_rule.project_ids
    integer[]
  • approval_rule.vendor_risk
    any[]
    One of: new_vendor, compliance_hold, bank_changed.
  • approval_rule.steps
    object[]required
  • approval_rule.steps[].approvers
    string[]required
  • approval_rule.steps[].quorum
    integer

Response · 201 · object

  • id
    integerrequired
  • doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry.
  • name
    stringrequired
  • priority
    integerrequired
  • min_amount
    string | nullrequired
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • project_ids
    integer[]required
  • vendor_risk
    any[]required
    One of: new_vendor, compliance_hold, bank_changed.
  • steps
    object[]required
  • steps[].approvers
    string[]required
  • steps[].quorum
    integer
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, segregation of duties, wrong company, or read-only workspace
  • 404Not found in this company
  • 409Conflict (duplicate_suspected, match_exception, a payment hold, already approved)
  • 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/approval_rules" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "approval_rule": {
    "doc_type": "ap_bill",
    "name": "string",
    "priority": 1,
    "steps": [
      {
        "approvers": []
      }
    ]
  }
}'

Accounting / Approvals

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

Deactivate an approval rule

Needs manage_grants. Documents already routed keep the steps they snapshotted. 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, segregation of duties, wrong company, or read-only workspace
  • 404Not found in this company

Example request

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

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/history

Approval escalation history of an item

Every reminder and escalation of one approval item (all revisions), newest first, with recipients, re-routed steps and who was left out and why. Needs view_ledger and the item's entities in scope (404 otherwise); refused to project-scoped grants. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • doc_type
    anyqueryrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • doc_id
    integerqueryrequired

Response · 200 · object[]

  • id
    integerrequired
  • doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • doc_id
    integerrequired
  • doc_revision
    integerrequired
  • kind
    anyrequired
    One of: reminder, escalation.
  • seq
    integerrequired
  • run_date
    string (date)required
  • business_days_waiting
    integerrequired
  • recipient_ids
    integer[]required
  • reroute_step_ids
    integer[]required
  • detail
    object | nullrequired
  • status
    anyrequired
    One of: sent, skipped.
  • created_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access or a project-scoped grant
  • 404Item not found or outside the viewer's scope
  • 422Invalid query

Example request

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

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/policies

List approval escalation policies

One policy per item kind. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integerrequired
  • doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • is_active
    booleanrequired
  • reminder_every_days
    integerrequired
  • escalate_after_days
    integerrequired
  • max_levels
    integerrequired
  • target
    stringrequired
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access or a project-scoped grant

Example request

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

Accounting / Approvals

POST /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/policies

Save an approval escalation policy

Create or replace the policy of one item kind (natural key: doc_type; 201 when created, 200 when replaced). target: next_role, principal, role:controller, role:owner or user:<id> (a user target must hold the kind's approve grant). Needs manage_grants and step-up. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • escalation_policy
    objectrequired
  • escalation_policy.doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • escalation_policy.is_active
    boolean
  • escalation_policy.reminder_every_days
    integerrequired
  • escalation_policy.escalate_after_days
    integerrequired
  • escalation_policy.max_levels
    integer
  • escalation_policy.target
    string

Response · 200 · object

  • id
    integerrequired
  • doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • is_active
    booleanrequired
  • reminder_every_days
    integerrequired
  • escalate_after_days
    integerrequired
  • max_levels
    integerrequired
  • target
    stringrequired
  • updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403Missing manage_grants or step-up, or read-only workspace
  • 404Target user not found
  • 422The target user cannot approve that kind

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/approvals/escalation/policies" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "escalation_policy": {
    "doc_type": "ap_bill",
    "reminder_every_days": 1,
    "escalate_after_days": 1
  }
}'

Accounting / Approvals

POST /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/run

Run reminders and escalation now

The same run as the daily job, as of the company's today: due escalations (re-routing named steps to eligible targets) and due reminders. Idempotent: a reminder or escalation already sent is never sent again. Needs manage_grants. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • as_of
    string (date)required
  • status
    anyrequired
    One of: ran, disabled, not_business_day.
  • reminders
    integerrequired
  • escalations
    integerrequired
  • rerouted
    integerrequired
  • emails
    integerrequired
  • skipped
    integerrequired
  • duplicates
    integerrequired

Errors

  • 401Missing or invalid bearer token
  • 403Missing manage_grants or read-only workspace

Example request

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

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/settings

Approval escalation settings

Whether reminders and escalation run, the business-day calendar and the policy of each item kind. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • enabled
    booleanrequired
  • business_days
    integer[]required
  • holidays
    string[]required
  • revision
    integerrequired
  • updated_at
    string | null (date-time)required
  • policies
    object[]required
  • policies[].id
    integerrequired
  • policies[].doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • policies[].is_active
    booleanrequired
  • policies[].reminder_every_days
    integerrequired
  • policies[].escalate_after_days
    integerrequired
  • policies[].max_levels
    integerrequired
  • policies[].target
    stringrequired
  • policies[].updated_at
    string (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access or a project-scoped grant

Example request

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

Accounting / Approvals

PUT /rest/v1.0/companies/{company_id}/accounting/approvals/escalation/settings

Save approval escalation settings

Turn reminders and escalation on or off and set the business days (ISO weekdays) and holidays. Needs manage_grants and step-up (routing is a control, like approval rules). Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

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

Request body

  • escalation_settings
    objectrequired
  • escalation_settings.enabled
    booleanrequired
  • escalation_settings.business_days
    integer[]required
  • escalation_settings.holidays
    string (date)[]required

Response · 200 · object

  • enabled
    booleanrequired
  • business_days
    integer[]required
  • holidays
    string[]required
  • revision
    integerrequired
  • updated_at
    string | null (date-time)required

Errors

  • 401Missing or invalid bearer token
  • 403Missing manage_grants or step-up, or read-only workspace
  • 422Invalid body

Example request

Generated from the contractcurl
curl -X PUT "https://app.os.construction/rest/v1.0/companies/1/accounting/approvals/escalation/settings" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "escalation_settings": {
    "enabled": true,
    "business_days": [],
    "holidays": []
  }
}'

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approvals/inbox

Approvals inbox

The caller's open approval slots across journal entries, AP bills and payment runs (directly, or as the delegate of a user within an active delegation), plus pending vendor bank/TIN changes for manage_vendor_banking users, and the caller's own documents an approver returned in the last 30 days (returned). Only documents the approve call would accept are listed. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object

  • items
    object[]required
  • items[].doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, vendor_bank_change, period_reopen, bank_transfer, budget, fx_revaluation.
  • items[].doc_id
    integerrequired
  • items[].label
    stringrequired
  • items[].amount
    string | null
  • items[].path
    stringrequired
    In-app path below /companies/{company_id}/accounting.
  • items[].submitted_at
    string | null (date-time)
  • items[].exception
    string | null
    Why it can't be bulk approved (match exception, self-approval, bank change review).
  • items[].delegate_of_id
    integer | null
    Set when the caller acts as this user's delegate.
  • returned
    object[]required
  • returned[].doc_type
    any
    One of: ap_bill, payment_batch, journal_entry.
  • returned[].doc_id
    integer
  • returned[].label
    string
  • returned[].path
    string
  • returned[].reason
    string
  • returned[].rejected_at
    string (date-time)
  • returned[].rejected_by_id
    integer

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, or wrong company
  • 404Not found in this company
  • 422Validation failed

Example request

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

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approvals/overdue

Overdue approvals

Approval items waiting at least their kind's escalation threshold in business days (the reminder cadence when the policy does not escalate; 3 without a policy), longest first, in the viewer's entity scope, with who they wait on and their escalation level. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • doc_type
    anyrequired
    One of: ap_bill, payment_batch, journal_entry, bank_transfer, vendor_bank_change, budget, fx_revaluation.
  • doc_id
    integerrequired
  • doc_revision
    integerrequired
  • label
    stringrequired
  • amount
    string | nullrequired
  • path
    stringrequired
  • entity_ids
    integer[]required
  • waiting_since
    string (date-time)required
  • business_days_waiting
    integerrequired
  • threshold_days
    integerrequired
  • escalation_level
    integerrequired
  • reminders_sent
    integerrequired
  • last_notified_at
    string | null (date-time)required
  • waiting_on
    object[]required
  • waiting_on[].id
    integerrequired
  • waiting_on[].name
    string | nullrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access or a project-scoped grant

Example request

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

Accounting / Approvals

GET /rest/v1.0/companies/{company_id}/accounting/approvals/self_approved

Self-approved documents

Approvals a maker made on their own document in small-team SoD mode, with the reason (close-checklist review). Needs close_period (403 otherwise); entity-scoped grants get an empty list. Requires the accounting:read scope.

v1.0Implemented

Parameters

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

Response · 200 · object[]

  • id
    integer
  • item_type
    string
  • item_id
    integer
  • actor_id
    integer
  • summary
    string
  • reason
    string | null
  • created_at
    string (date-time)

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, or wrong company
  • 404Not found in this company
  • 422Validation failed

Example request

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

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