Sign in
approvalPolicies

Create an invoice approval policy

Creates a new invoice approval policy. Partners use this to provision Advanced Approval rules programmatically. Exactly one owner scope field is required: ottimate_location_id, ottimate_company_id, group, or account. At least one of user_approvers or role_approvers is required.

post/approval-policies

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request body

namestring required

Policy display name

applicable_type'invoice' required

Must be invoice for this resource

min_users_for_approvalinteger required

Minimum distinct approvers required

ottimate_location_idinteger

Scope policy to a single location

ottimate_company_idinteger

Scope policy to a company

groupstring

Restaurant group ID

accountstring

Account ID (racc_ prefixed)

user_approversApprovalPoliciesPostRequestBodyContentApplicationJsonSchemaUserApproversItems[]

User approver entries ({"user": <id>} or bare user ID)

role_approversApprovalPoliciesPostRequestBodyContentApplicationJsonSchemaRoleApproversItems[]

Role approver entries ({"role": "<role_id>"} or bare role ID string)

conditionsApprovalPoliciesPostRequestBodyContentApplicationJsonSchemaConditionsItems[]

Policy conditions (subject, operator, value)

auto_approve_rulesstring[]

Auto-approve rule types, e.g. ["user_uploaded"]

use_buyer_approverboolean

Count buyer as an implicit approver (default false)

is_enabledboolean

Enable on create (default true)

Response

Policy created

ApprovalPoliciesPostApprovalPoliciesRootResponse201 required

Empty response body

Changes