Versions Compared

Key

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

Use this method to update an existing Additional Charge from an Invoice in Komet Sales.

Tip

Valid Tokens: Company.


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

Request


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

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


additionalChargeId (required)(integer:20)

Komet Sales Additional Charge internal ID you want to update.

You can get this value from the additional.charge.list API method.


name (optional)(string:200)

Additional Charge name.


code (optional)(string:10)

Additional Charge code.


active (optional)(boolean:1)

If the customer is active.

Valid values: 1 = Active | 0 = Inactive


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

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


additionalChargeId (integer:20)

Komet Sales Internal Additional Charge ID.


Code Block
{
  "status": "1",
  "message": "The additional charge was successfully saved.",
  "additionalChargeId": 234234
}

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