v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Close an invoice

This API closes the specified invoice. You can only close an invoice after the total invoice amount has been paid in full (which means that the balance amount of the invoice is zero).

You must provide appropriate data for the invoice_id parameter.

post/v1/invoices/{invoice_id}/close

Path parameters

invoice_idstring required

Mandatory Unique 32-character ID of the specific invoice. This is a mandatory parameter.

Response

200

is_invoice_closedboolean

{"stackTrail":"paths:/v1/invoices/{invoice_id}/close:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

statusinteger

Example response

{
  "is_invoice_closed": true,
  "status": 11
}