Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

This method allows you to update or associate a certain additional invoice charge to a specific customer. This method is directly related to the Automatic Invoice Additional Charges feature. 

Request

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

  • Method: POST
  • Content-Type: application/json

Input Parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • customerId (required) (integer:20): Komet Sales internal ID of the customer that you want to update. You can obtain this value from the customer.list API method.
  • additionalChargeCode (required)(string:20): Code of the additional charge that you want to associate to the customer. You can obtain this value from the additional.charge.list API method.
  • amountValue (optional)(decimal:10,2): amount exception that you want to apply to the customer for the additional charged specified.  
  • amountType (optional)(char:1): % or $


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

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.

Sample
 {
  "status": "1",
  "message": "The automatic additional charge was successfully saved."
 }
Sample
 {
  "status": "0",
  "message": "The additional charge DEL does not exist or its inactive."
 }
  • No labels