InvoiceVersion: 2021-07-28
Void invoice
POST/invoices/{invoiceId}/void
API to delete invoice by invoice id
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
invoices.Auth methods:
OAuthPrivate IntegrationToken types:
Sub-Account TokenAgency TokenRequest
Headers
Versionstringrequired
API Version
Available options
2021-07-28Path Parameters
invoiceIdstringrequired
Invoice Id
Example:
6578278e879ad2646715ba9cBody
altIdstringrequired
location Id / company Id based on altType
Example:
6578278e879ad2646715ba9caltTypestringrequired
Alt Type
Available options
locationExample:
locationResponse
Successful response
_idstringrequired
Invoice Id
Example:
6578278e879ad2646715ba9cstatusstringrequired
Invoice Status
Available options
draftsentpayment_processingpaidvoidpartially_paidExample:
draftliveModebooleanrequired
Live Mode
Example:
falseamountPaidnumberrequired
Amount Paid
Example:
0altIdstringrequired
Location Id or Agency Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
Available options
locationnamestringrequired
Name of the invoice
Example:
New InvoicebusinessDetailsobjectrequired
Business Details
invoiceNumbernumberrequired
Invoice Number
Example:
19currencystringrequired
Currency
Example:
USDcontactDetailsobjectrequired
Contact Details
issueDatestringrequired
Issue date in YYYY-MM-DD format
Example:
2023-01-01dueDatestringrequired
Due date in YYYY-MM-DD format
Example:
2023-01-01discountobject
Discount
invoiceItemsstring[]required
Invoice Items
totalnumberrequired
Total Amount
Example:
999titlestringrequired
Title
Example:
INVOICEamountDuenumberrequired
Total Amount Due
Example:
999createdAtstringrequired
created at
Example:
2023-12-12T09:27:42.355ZupdatedAtstringrequired
updated at
Example:
2023-12-12T09:27:42.355ZautomaticTaxesEnabledboolean
Automatic taxes enabled for the Invoice
Example:
trueautomaticTaxesCalculatedboolean
Is Automatic taxes calculated for the Invoice items
Example:
truepaymentScheduleobject
split invoice into payment schedule summing up to full invoice amount