| Excerpt | ||
|---|---|---|
Use this method to update an existing Invoice in Komet Sales. You can only update the main attributes of the Invoice.
|
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/invoice.update
Method: POST
Content-Type: application/JSON
Input Parameters
authenticationToken (required)(string:20)
Komet Sales security token.
invoiceId (required)(integer:20)
Komet Sales internal Invoice ID.
You can get this value from the invoice.create API method.
carrierId (optional) (number:20)
Carrier ID.
You can get this value from the carrier.list API method.
carrierCode (optional)(string:20)
Carrier code.
carrierDescription (required if carrierCode is given)(string:200)
Carrier name.
shipDate (optional)(date)
New shipping date.
Date format: YYYY-MM-DD
poNumber (optional)(string:20)
New customer PO#.
reference (optional)(string:20)
New reference or AWB.
warehouseInstructions (optional)(string:200)
New instructions for warehouse.
invoiceNotes (optional)(string:200)
New notes that will be printed on the invoice.
| Info |
|---|
You can use either carrierId or carrierCode and carrierName but you cannot use both parameters at the same time. We recommend using the carrierId which can be obtained from the carrier.list API method. |
| Code Block |
|---|
{
"authenticationToken": "token_info_goes_here",
"invoiceId": 345345,
"carrierId": 1878,
"shipDate": "2014-04-11",
"poNumber": "P099999",
"reference" : "R99999",
"warehouseInstructions": "New instructions",
"invoiceNotes": "New notes for the invoice"
} |
Response
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
invoiceId (integer:20)
Invoice ID.
invoiceNumber (integer:10)
Invoice number.
| Code Block |
|---|
{
"status": "1",
"message": "success",
"invoiceId": 232333,
"invoiceNumber": 850634
} |