invoice.item.delete

This method allows you to delete an item from an existing invoice on Komet Sales.

Request

URL: https://api.kometsales.com/api/invoice.item.delete

Method: POST

Content-Type: Application/JSON

Input Parameters

  • authenticationToken (required)(string:20): Komet Sales security token.

  • invoiceId (required)(integer:20): the Komet Sales internal invoice ID that you want to update. You can obtain this value from the invoice.create API method.

  • invoiceItemId (required)(number:20): ID of the Komet Sales invoice item. This value can be obtained from the invoice.create API method.

  • returnAvailableBoxes (optional)(boolean: 1 or 0): default 0. If it's 1, the response will include the number of boxes available.

Sample Request

{ "authenticationToken": "token_info_goes_here", "invoiceId": 85063, "invoiceItemId": 9999999 }

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.

  • message (string:500): description of the status of the transaction.

  • invoiceId (integer:20): invoice ID.

  • invoiceNumber (integer:10): invoice number.

  • availableBoxes (integer:10): number of boxes that are available if returnAvailableBoxes is given.

Sample Response

{ "status": "1", "message": "success", "invoiceId": 111111111, "invoiceNumber": 85434 }

Related Articles