Versions Compared

Key

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

This method allows you to add additional invoice charges under your company settings.

Request

Excerpt

Use this method to add a new Additional Invoice Charge to your Company. You can also see these Additional Charges in the Order Entry Settings.

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
sorttitle
titleRelated Articles
cqllabel in ( "additional-charges-api" , "additional-charges" )
labelsadditional-charges additional-charges-api

Request


URL: https://api.kometsales.com/api/additional.charge.add

Method: POST

Content-Type: application/

json

JSON


Input Parameters

authenticationToken

authenticationToken (required)(string:50)

:  

Komet Sales security token.

name

name (required)(string:200):

name

Name of the

additional charge

Additional Charge.


code (optional)(string:10)

: code of the additional charge

Additional Charge code.


Code Block
{
  "authenticationToken": "token_info_goes_here",
  "name": "Fuel Surcharge",
  "code": "FS"
}

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.


additionalChargeId (integer:20)

:

Komet Sales internal Additional Charge

internal

ID

that was just created

.

Code Block
{
  "status": "1",
  "message": "The additional charge was successfully saved.",
  "additionalChargeId": 234234
}
Filter by label (Content by label)showLabelsfalsemax10showSpacefalsesorttitlecqllabel in ( "additional-charges-api" , "additional-charges" )labelsadditional-charges additional-charges-api


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