invoice.update

This method allows you to update an existing Invoice on Komet Sales. You can only update the main attributes of the Invoice.

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): the Komet Sales internal ID that you want to update. You can obtain this value from the invoice.create API method.
carrierId (optional) (number:20) : carrier ID. You can obtain 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 way bill number.
warehouseInstructions (optional) (string:200): new instructions for warehouse.
invoiceNotes (optional) (string:200): new notes that will be printed on the invoice.

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.

Sample Request

{
  "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

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.

Sample Response

{
  "status": "1",
  "message": "success",
  "invoiceId": 232333,
  "invoiceNumber": 850634    
}

Knowledge Base