Versions Compared

Key

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

Overview

Excerpt

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

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

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

    with 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

    charge specified.  

  • amountType (optional)(char:1): % or $

Elite soft json viewer
width100%
languagejs
themeConfluence
titleSample
height100%

Sample Request

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

Response

Output

:

width100%languagejsthemeConfluencetitle
  • status (integer:1): transaction status. 1 for success or 0 for failure.

  • message (string:500): description of the status of the transaction.


Elite soft json viewer

Sample Response

height
Code Block
100%
 {
  "status": "1",
  "message": "The automatic additional charge was successfully saved."
 }
Elite soft json viewer
width100%
languagejs
themeConfluence
titleSample
height100%
 {
  "status": "0",
  "message": "The additional charge DEL does not exist or its inactive."
 }

Panel
titleRelated Articles
Filter by label (Content by label)
showLabelsfalse
max10
showSpacefalse
sorttitle
cqllabel in ( "additional-charge-update" , "additional-charges" , "customer-setup" )
labelsadditional-charges customer-setup additional-charge-update