Build Order Invoice
Intent
Runs the build order invoice action.
When to call it
Call this when your workflow reaches the point where it must build order invoice.
Access boundary
Authorize the request with a token that carries customer_portal:read or customer_portal:write.
Successful result
A successful request returns 202. The response schema below defines the body your integration receives.
Operational notes
Trigger generation of an order’s invoice.
POST
Build Order Invoice
A successful call returns a
202 response, which tells you the invoice
generation has been queued. Typically it only takes a few seconds before the
invoice is available via the GET /v1/customer-portal/orders/{id}/invoice endpoint.For dependable notification once the invoice is ready, subscribe to the
order.updated webhook and inspect the is_invoice_generated field.Authorizations
Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.
Path Parameters
The order ID.
Response
Successful Response