Void Proforma Invoice
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Voids a proforma invoice that has the status "draft".
Proforma invoices are only available on Relationship Invoicing sites.
Only proforma invoices that have the appropriate status may be reopened. If the invoice identified by {uid} does not have the appropriate status, the response will have HTTP status code 422 and an error message.
A reason for the void operation is required to be included in the request body. If one is not provided, the response will have HTTP status code 422 and an error message.
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The uid of the proforma invoice
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/proforma_invoices/proforma_invoice_uid/void.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "void": { "reason": "reason" }}'