Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
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:
applicationApplication/
jsonJSON
Input Parameters
:authenticationToken (required)(string:20): Komet Sales security token.
invoiceId (required)(integer:20):
Thethe Komet Sales internal
Invoiceinvoice ID that you want to update. You can obtain this value from the invoice.create API method.
invoiceItemId (required)(number:20):
IdID of the Komet Sales invoice item. This value can be obtained from
thethe invoice.create API method.
returnAvailableBoxes (optional)(boolean: 1 or 0):
Defaultdefault 0. If it's 1, the response will include the number of boxes available.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"authenticationToken": "token_info_goes_here",
"invoiceId": 85063,
"invoiceItemId": 9999999
} |
theme | Confluence |
---|---|
language | js |
title | Sample 2 |
Sample Request
Code Block |
---|
{ "authenticationToken": "token_info_goes_here", "invoiceId": 85063, "invoiceItemId": 9999999, "returnAvailableBoxes":1 } |
Response
Output:
status (integer:1):
Transactiontransaction status. 1 for success or 0 for failure.
message (string:500):
Descriptiondescription of the status of the transaction.
invoiceId (integer:20):
Invoice idinvoice ID.
invoiceNumber (integer:10):
Invoiceinvoice number.
availableBoxes (integer:10):
Numbernumber of boxes that are available if returnAvailableBoxes is given.
Sample Response
Code Block | |
---|---|
theme | Confluence |
language | js |
Sample 1 | { "status": "1", "message": "success", "invoiceId": 111111111, "invoiceNumber": 85434 } |
Filter by label (Content by label) | |
---|---|
|
|
|
|
|
|
{
"status": "1",
"message": "success",
"invoiceId": 111111111,
"invoiceNumber": 85434,
"availableBoxes": 4
}
|