Retrieve the approval policy chain for a specific invoice

Beta

GET

/invoices/:id/approval-chain

GET

/v1/invoices/:id/approval-chain

curl -G https://api.ottimate.com/v1/invoices/<invoice_id>/approval-chain \
     -H "X-Api-Key: your-api-key-here" \
     -H "X-API-Version: 1.0.0" \
     -H "Authorization: Bearer <token>" \
     -d sync_approval=false

[
  {
    "policy_id": "plcy_7d27b39042ab11f09213577c0b92a500",
    "policy_name": "Manager Approval — Over $500",
    "object_id": "139727692",
    "status": "pending",
    "min_approver": 1,
    "approved": 0,
    "error": null,
    "approvers": [
      {
        "id": 12346,
        "name": "Jane Smith",
        "email": "jane.smith@example.com",
        "approved_date": null,
        "approver_id": "pbjappr_660f9511f30c52e5b827557766551111",
        "replaced_approver": null,
        "is_active": true,
        "auto_approved": false,
        "is_oa_active": true
      }
    ],
    "children": []
  }
]

Returns the ordered policy chain for an invoice, including hierarchical child policies, per-tier status, and approver rows. Each tier’s status is one of approved, pending, or NA.

Note: response is a bare JSON array (no version wrapper). Child policies are nested under children.

Authentication

AuthorizationBearer

OAuth2 authentication flows. Auth server URLs will vary by environment

Path parameters

idstringRequired

Ottimate invoice ID

Query parameters

sync_approvalbooleanOptionalDefaults to false

When true, re-applies policies before returning the chain (default false). Only effective when the invoice is not exported.

Response

Successful response with the ordered approval policy chain

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors