Skip to main content

List Approval Policies

GET 
/api/approval-policies

List the approval policy for every document type an approval policy can govern — purchase orders, vendor deposits and bill payments. A document type that was never configured is returned as an unsaved, disabled default (id: null, no tiers), so the response always has three entries.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token with the purchase-orders scope (read for GET, write for POST/PUT/DELETE).

Requires permission: approval_policies.view

Response fields (per policy):

  • document_type — purchase_order | vendor_deposit | bill_payment; document_type_label is its plural display label
  • enabled — when false, documents of this type follow their pre-policy approval behaviour
  • separation_of_duties — allow_if_sole_approver (a requester may approve their own request only when nobody else is eligible for that step; flagged self_approved), strict (never — the step escalates to administrators instead), off (the requester is eligible like anyone else)
  • reminder_interval_hours / reminder_max — automatic reminders to the current step's approvers every N weekday hours, at most reminder_max times, then administrators are alerted once (null interval = no automatic reminders)
  • reapproval_tolerance_percent — an approved document whose total later rises by more than this percentage needs re-approval
  • applies_to_sources — purchase orders only: which creation sources the policy governs (available_sources lists every source with governable and locked — manual is always governed)
  • base_currency — amounts are routed in this currency
  • pending_count — open requests under this policy
  • tiers[] — amount bands, smallest first. up_to_amount is the inclusive upper limit in base currency (null on the last tier = no limit). requires_approval: false auto-approves the band. Each tier has up to 3 sequential steps[]; each step needs required_approvals approvals from its approvers[] (type user or role; missing: true when the user left the account or the role was deleted). distinct_from_previous_steps stops someone who approved an earlier step from also approving this one.

Request​

Responses​

OK

Response Headers
    Content-Type