Sign in

v1

latestOpenAPI 3.0.02026-07-245095152.4 KB
invoice-controller

cancelInvoice

cancel an invoice

post/veem/v1.2/invoices/{invoiceId}/cancel

Path parameters

invoiceIdinteger required

invoiceId

Response

Success, a cancelled invoice object is returned

ccEmailsstring[]

The list of emails who will be notified about the payment

claimLinkstring

The link that allows the recipient to perform the payment

clientIdstring
dueDatestring date-time

The due date of the payment or invoice request

exchangeRateQuoteIdstring required

The quote id that was received earlier for the payment

externalInvoiceRefIdstring

The external invoice if for which payment is made, viewable by receiver

idinteger required

The invoice id

notesstring

The memo/note associated with payment, viewable by receiver

purposeOfPaymentstring

The purpose of payment required by banks for certain countries, applicable for following countries.SG,AE,KR,BR,CN,HK,HR,IS,ID,IN,IL,KE,PK,SA,ZA,TW,UA,VN

purposeOfPaymentDescriptionstring

The purpose of payment description

status'Drafted' | 'Sent' | 'Cancelled' | 'Closed' | 'Claimed' | 'MarkAsPaid' | 'Rejected' | 'Scheduled' required

The status of the invoice

timeCreatedstring date-time required

The creation time of the invoice. The format would be UTC, ISO-8601