Ottimate’s approval system allows you to manage invoice approvers programmatically through the API. While approval policies are configured in the Ottimate UI, the API enables you to:
For information on how to configure approval policies in Ottimate, see Approval Policy Configuration.
Note: The Approval API manages approvers and approval actions only. Approval policies themselves must be configured through the Ottimate user interface.
When an invoice enters the approval workflow, it receives a pending-approval status. The invoice must be approved by all assigned approvers before it can proceed to export. Approvers can be assigned either:
To view all approvers assigned to an invoice, including their approval status:
Where {id} is the Ottimate-generated invoice ID.
The response includes an array of approvers, where each approver object contains:
id: The approval record ID (e.g., pbjappr_xxx) - use this ID when removing an approver via the DELETE endpointapprover: User details including ID, email, and display namepolicy: Associated approval policy for policy-based approvers (empty for manual approvers)created_date: When this approver was added to the invoiceIdentifying Manual vs. Policy-Based Approvers: Manual approvers have empty policy.id and policy.name fields, while policy-based approvers include the policy details.
Add an ad-hoc approver to an invoice using:
When you add a manual approver:
Remove a specific approver from an invoice:
id: The invoice IDapproval_id: The approval record ID to remove (e.g., pbjappr_xxx) - this is the id field from the approver object returned by GET /invoices/{id}/approversApprove an invoice to mark it ready for export and payment:
approved_dateready-for-export when all approvals are completeFor authorized users, you can bypass the normal approval chain: