Excerpt | ||
---|---|---|
Use this method to cancel an Invoice in Komet Sales.
|
Filter by label (Content by label) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/invoice.void
Method: POST
Content-Type: URL Parameters.
Input Parameters
authenticationToken (required)(string:50):
Komet Sales security token.
invoiceNumber (required)(number:10): number
Number of invoices to be voided.
Do not include prefix characters such as 'W' or 'T'.
reason (required)(string:300): the
The reason why the order was voided.
Code Block |
---|
{ "authenticationToken": "ot2fcstsjsie3438dhdkdamo34rub", "invoiceNumber": "003429", "reason": "cancelled order" } |
Response
status (integer:1): transaction
Transaction status. 1 for success or 0 for failure.
1 = Success | 0 = Failure
message (string:500):
Transaction status description of the transaction status.
Code Block |
---|
{ "status": "1", "message": "The invoice was successfully voided." } |