Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Excerpt |
---|
This method allows you to update an existing invoice item on Komet Sales. |
Request
https://api.kometsales.com/api/invoice.item.update
- Method: POST
- Content-Type: application/json
Input Parameters:
- authenticationToken (required)(string:20): Komet Sales security token.
- invoiceId (required)(integer:20): the Komet Sales invoice internal 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.
- boxes (optional)(integer:10): new number of boxes.
- price (required) (decimal:10,2): new unit price.
- markCode (optional)(string:20): new mark code.
- productAlias (optional)(string:50): new product description alias.
- notes (optional)(string:200): new item notes.
- returnAvailableBoxes (optional)(boolean: 1 or 0): default 0. If it's 1, the response will include the number of boxes available.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "authenticationToken": "token_info_goes_here", "invoiceId": 085063, "invoiceItemId": 9999999, "boxes": 5, "price": 2.50, "markCode": "text for mark code", "productAlias" : "text for product alias", "notes": "text for notes" } |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "authenticationToken": "token_info_goes_here", "invoiceId": 085063, "invoiceItemId": 9999999, "boxes": 5, "price": 2.50, "markCode": "text for mark code", "productAlias" : "text for product alias", "notes": "text for notes", "returnAvailableBoxes":1 } |
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.
- invoiceItemId (integer:20): invoice item ID.
- availableBoxes (integer:10): number of boxes that are available if returnAvailableBoxes is given.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": "1", "message": "success", "invoiceId": 111111111, "invoiceNumber": "9999999", "invoiceItemId": 32323 } |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": "1", "message": "success", "invoiceId": 111111111, "invoiceNumber": "9999999", "invoiceItemId": 32323, "availableBoxes": 2 } |
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Info | ||
---|---|---|
| ||
If the customer for who you are editing an invoice has a different currency, you will be able to should enter prices in your companycustomer's currency and the system will generate the invoice in your customercompany's currency, based on the exchange rate set up at the time of the transaction. |