Skip to main content
POST
/
api
/
rest
/
invoices
/
{id}
/
approve
Approve customer invoice
curl --request POST \
  --url https://api.upwell.com/api/rest/invoices/{id}/approve \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "overrideExceptions": false
}
'
{
  "approveInvoice": {
    "error": {
      "code": "<string>",
      "message": "<string>"
    },
    "exceptions": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "ownerId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "success": true
  }
}

Headers

​
authorization
string

Your API key for authentication

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

200 - application/json

Invoice approval response

​
approveInvoice
InvoiceApprovalResponse · object

The approval operation result