Skip to main content
POST
Approve customer invoice
Business failures return inside a 200 body (approveInvoice.error.code: OPEN_EXCEPTIONS, INVOICE_NOT_FOUND) — check success/error, not just the HTTP status. overrideExceptions=true closes open exceptions and approves. See Error handling.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Path Parameters

id
string
required

The ID of the invoice to approve

Query Parameters

overrideExceptions
boolean
default:false

If true, closes all open exceptions and approves the invoice. If false and exceptions exist, approval will fail.

Body

application/json

Optional request body. Parameters can be provided either in the query string or request body.

id
string

The ID of the invoice to approve (alternative to path parameter)

overrideExceptions
boolean | null
default:false

If true, closes all open exceptions and approves the invoice

Response

Invoice approval response

approveInvoice
InvoiceApprovalResponse · object

The approval operation result