Versions Compared

Key

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

Use this method to update or associate an Additional Invoice Charge to a specific Customer.

Tip

Valid Tokens: Company.

This method is directly related to the Automatic Invoice Additional Charges feature.



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

Request


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

Method: POST

Content-Type: application/jsonJSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


customerId (required) (integer:20)

The Komet Sales internal Customer ID.

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


additionalChargeCode (required)(string:20)

The Additional Charge code to associate with the Customer.

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


amountValue (optional)(decimal:10,2)

The amount you want to apply to the Customer for the specific Additional Charge.  


amountType (optional)(char:1)

The unit-type for the Additional Charge.

Valid values: % or $


Code Block
{
  "authenticationToken": "token_info_goes_here",
  "customerId": 42423,
  "additionalChargeCode": "DEL",
  "amountValue": "10",
  "amountType": "$"
 }

Response


status (integer:1)

Transaction status. 1 for success or 0 for failure.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


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