Skip to main content
POST
Approve One Carrier Invoice
Business failures return inside a 200 body (error.code: OPEN_EXCEPTIONS, INVOICE_NOT_FOUND) — check the nested error, not just the HTTP status. 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

carrierInvoiceId
string
required

"carrierInvoiceId" is required (enter it either in parameters or request body)

Query Parameters

overrideExceptions
boolean
default:false

Body

application/json

Query parameters can also be provided in the request body as a JSON object

carrierInvoiceId
string

Upwell identifier of the associated carrier invoice. Use an ID returned by the API.

overrideExceptions
boolean | null
default:false

Whether the approval request asks to override blocking exceptions, subject to the endpoint's approval rules.

Response

Successful response

approveCarrierInvoice
CarrierInvoiceResponse Ā· object

Approve carrier invoice. See the schema for its JSON type and allowed values.