Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to cancel an Invoice in Komet Sales.

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
sorttitle
titleRelated Articles
cqllabel in ( "invoice" , "invoice-status" , "void-invoice" , "order-confirmation" )
labelsinvoice invoice-status

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 of invoices to be voided.

Do not include prefix characters such as 'W' or 'T'.


reason (required)(string:300)

The reason why the order was voided.


Code Block
{
   "authenticationToken": "ot2fcstsjsie3438dhdkdamo34rub",
   "invoiceNumber": "003429",
   "reason": "cancelled order"
}

Response


status (integer:1)

Transaction status.

1 = Success | 0 = Failure


message (string:500)

Transaction status description.


Code Block
{
   "status": "1",
   "message": "The invoice was successfully voided."
}
We've encountered an issue exporting this macro. Please try exporting this page again later.