Versions Compared

Key

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

Anchor
topofpage
topofpage

Excerpt

Use this method to add an Item to an existing Invoice on Komet Sales.

Tip

Valid Tokens: Company.

Info

Invoices created through this method are subject to a transaction fee. Internal company transactions are generally exempt from this transaction fee.

For Multi-Currency Customers:

If the customer you are creating an invoice for has a different currency, you must enter prices in your customer's currency.
The system will automatically generate the invoice in your company's currency based on the exchange rate set up at the transaction time.


Table of Contents

Table of Contents
minLevel1
maxLevel1
include
outlinefalse
indent
excludeTable of Contents
typelist
classprintablefalse
class

Request


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

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


invoiceId (required)(integer:20)

Komet Sales internal invoice ID.

You can get this value from the invoice.create API method.


orderItemId (required)(integer:20)

Komet Sales internal inventory item ID.

You can get this value from the inventory.list API method.


productCode (required if orderItemId is not given)(string:20)

Product code of the Komet Sales inventory item.

You can get this value from the product.list API method.


boxTypeCode (required if orderItemId is not given)(string:3)

Box type code of the Komet Sales inventory item.

You can get this value from the boxtype.list API method.


unitsPerBox (required if orderItemId is not given)(integer:10)

Units per box.


unitType (required if orderItemId is not given)(string:5)

Unit type.

Valid values: Stem or Bunch


boxes (required)(integer:10)

Number of boxes.


price (required)(decimal:10,2)

Unit price.


markCode (optional)(string:20)

Item mark code.


productAlias (optional)(string:50)

Product description alias.


notes (optional)(string:200)

Item notes.


returnAvailableBoxes (optional)(boolean)

Include available boxes.

Valid values: 0 = No | 1 = Yes

Default is zero.


locationId (optional)(integer:20)

Komet Sales internal Location ID.

Only applies to Multi-Location companies.

You can get this value from the location.list API method.


Info

You can use either orderItemId or the productCode, boxTypeCode, unitsPerBox, and unitType, but you cannot use orderItemId and the other parameters at the same time.

Back to top


Code Block
{
  "authenticationToken": "token_info_goes_here",
  "invoiceId": 85063,
  "productCode": "RS50",   
  "boxTypeCode": "HB",
  "unitsPerBox": 150,
  "unitType": "Stem",
  "boxes": 5, 
  "price": 2.50,
  "markCode": "text for mark code", 
  "productAlias" : "text for product alias", 
  "notes": "text for notes",
  "returnAvailableBoxes":1
}

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.

Back to top


Code Block
{
  "status": "1",
  "message": "OK"
}

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

...