Versions Compared

Key

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

Use this method to delete an item from an existing

invoice

Invoice on Komet Sales.

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.item.delete

Method: POST

Content-Type: Application/JSON


Input Parameters

authenticationToken 

authenticationToken (required)(string:20)

:

Komet Sales security token.


invoiceId (required)(integer:20)

: the

Komet Sales internal

invoice

Invoice ID

that you want to update

.

You can

obtain

get this value from the invoice.create API method.


invoiceItemId (required)(number:20)

: ID of the

Komet Sales invoice item ID.

This value can be obtained

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


returnAvailableBoxes (optional)(boolean

: 1 or 0): default 0. If it's 1, the response will include the number of boxes available.Sample Request

)

Include available Boxes.

Valid values: 0 = No | 1 = Yes

Default is zero.


Code Block
{
  "authenticationToken": "token_info_goes_here",
  "invoiceId": 85063,
  "invoiceItemId": 9999999
}

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.


availableBoxes (integer:10)

: number of boxes that are available if returnAvailableBoxes is given.

Sample Response

Number of available Boxes.


Code Block
{
  "status": "1",
  "message": "success",
  "invoiceId": 111111111,
  "invoiceNumber": 85434
 }
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.