Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This method allows you
Excerpt

Use this method to update an existing Invoice

on

in Komet Sales. You can only update the main attributes of the Invoice.

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
sorttitle
titleRelated Articles
cqllabel in ( "invoice" , "order" , "invoice-creation" , "invoice-editing" )
labelsinvoice invoice-creation order invoice-editing

Request


URL: https://api.kometsales.com/api/invoice.update

Method: POST

Content-Type: application/

json

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

get this value from the invoice.create API method.


carrierId (optional) (number:20)

: carrier

Carrier ID.

You can

obtain

get this value from the carrier.list API method.


carrierCode (optional)(string:20)

: carrier

Carrier code.


carrierDescription (required

:

if carrierCode is given)(string:200)

: carrier

Carrier name.


shipDate (optional)(date)

: new

New shipping date

(date

.

Date format: YYYY-MM-DD

).


poNumber (optional)(string:20)

: new

New customer PO#.


reference (optional)(string:20)

: new

New reference or

way bill number

AWB.


warehouseInstructions (optional)(string:200)

: new

New instructions for warehouse.


invoiceNotes (optional)(string:200)

: new

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.

Sample Request


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

Output


status (integer:1)

: transaction

Transaction status.

1 for success or 0 for failure.

Valid values: 1 = Success | 0 = Failure


message (string:500)

: description of the status of the transaction

Transaction status description.


invoiceId (integer:20)

: invoice

Invoice ID.


invoiceNumber (integer:10)

: invoice

Invoice number.

Sample Response


Code Block
{
  "status": "1",
  "message": "success",
  "invoiceId": 232333,
  "invoiceNumber": 850634    
}
Filter by label (Content by label)showLabelsfalsemax5sorttitletitleRelated Articlescqllabel in ( "invoice" , "order" , "invoice-creation" , "invoice-editing" )labelsinvoice invoice-creation order invoice-editing

We've encountered an issue exporting this macro. Please try exporting this page again later.