Versions Compared

Key

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

Overview

Excerpt

This method allows you to delete an item from an existing invoice on Komet Sales.

 

Request

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

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 internal

    Invoice

    invoice 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.

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

    Default

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

 
Code Block
themeConfluence
languagejs
titleSample 1
{
  "authenticationToken": "token_info_goes_here",
  "invoiceId": 85063,
  "invoiceItemId": 9999999
}
Code Block
themeConfluence
languagejs
titleSample 2

Sample Request

Code Block
{
  "authenticationToken": "token_info_goes_here",
  "invoiceId": 85063,
  "invoiceItemId": 9999999,
  "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.

  • availableBoxes (integer:10):

    Number

    number of boxes that are available if returnAvailableBoxes is given.

Sample Response

title
Code Block
themeConfluence
languagejs
Sample 1
{
  "status": "1",
  "message": "success",
  "invoiceId": 111111111,
  "invoiceNumber": 85434
 }
Filter by label (Content by label)
showLabels
code
false
theme
max
Confluence
5
language
sort
js
 
title
titleRelated Articles
Sample 2
{
  "status": "1",
  "message": "success",
  "invoiceId": 111111111,
  "invoiceNumber": 85434,
  "availableBoxes": 4
 }
cqllabel in ( "invoice" , "order" , "invoice-creation" , "invoice-editing" )
labelsinvoice invoice-creation order invoice-editing