Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This method allows you Use this method to update an existing invoice item on Invoice Item in Komet Sales.

Request

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

Method: POST

Content-Type:

application

Application/

json

JSON

Input Parameters

:

  • authenticationToken (required)(string:20): Komet Sales security token.

  • invoiceId (required)(integer:20):

    The

    the Komet Sales

    Invoice

    invoice internal ID that you want to update. You can obtain this value from the invoice.create API method.

  • invoiceItemId (required)(number:20):

    Id

    ID of the Komet Sales invoice item. This value can be obtained from

    the

    the invoice.create API method.

  • boxes (optional)(integer:10):

    New

    new number of boxes.

  • price (required) (decimal:10,2):

    New

    new unit price.

  • discount (optional) (decimal:10,2) : discount percentage.

  • markCode (optional)(string:20):

    New

    new mark code.

  • productAlias (optional)(string:50):

    New

    new product description alias.

  • notes (optional)(string:200):

    New

    new item notes.

  • returnAvailableBoxes (optional)(boolean: 1 or 0):

    Default

    default 0. If it's 1, the response will include the number of boxes available.

Sample Request

language
Code Block
themeConfluence
js
titleSample 1
{
  "authenticationToken": "token_info_goes_here",
  "invoiceId": "085063",
  "invoiceItemId": 9999999,   
  "boxes": 5, 
  "price": 2.50,
  "discount": 10,
  "markCode": "text for mark code", 
  "productAlias" : "text for product alias", 
  "notes": "text for notes"
}
Sample 2
Code Block
themeConfluence
languagejs
title
{
  "authenticationToken": "token_info_goes_here",
  "invoiceId": 08506385063,
  "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

    transaction status. 1 for success or 0 for failure.

  • message (string:500):

    Description

    description of the status of the transaction.

  • invoiceId (integer:20):

    Invoice id

    invoice ID.

  • invoiceNumber (integer:10):

    Invoice

    invoice number.

  • invoiceItemId (integer:20):

    Invoice

    invoice item ID.

  • availableBoxes (integer:10):

    Number

    number of boxes that are available if returnAvailableBoxes is given.

Sample Response

Sample 1
Code Block
themeConfluence
languagejs
title
  {
  "status": "1",
  "message": "success",
  "invoiceId": 111111111,
  "invoiceNumber": "9999999",
  "invoiceItemId": 32323
 }
Code Block
themeConfluence
languagejs
titleSample 2
{
  "status": "1",
  "message": "success",
  "invoiceId": 111111111,
  "invoiceNumber": "9999999",
  "invoiceItemId": 32323,
  "availableBoxes": 2
 }

 

 

 
Info

Multicurrency Option Enabled

If the customer for who you are editing an invoice has a different currency, you should enter prices in your customer's currency and the system will generate the invoice in your company's currency, based on the exchange rate set up at the time of the transaction.

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