Add Automatic Additional Charges

Table of Contents

URL: https://api.kometsales.com/api/automatic-additional-charge

Method: POST

Content-Type: application/JSON

Header

authenticationToken (required)(string:50)

Komet Sales security token.

Input Parameters

additionalChargeId (required)(numeric)

Additional Charge ID.

companyLocationId (required)(numeric)

Company Location ID.

This is an optional parameter for single-location companies.

amountValue (required)(numeric)

Additional charge total amount.

active (required)(boolean)

Automatic Additional Charge Status.

Valid values: 0 = Inactive | 1 = Active

capPerDay (required)(numeric)

Maximum charge amount the system can apply to a customer on the same day.

minCapPerDay (required)(numeric)

The minimum amount the system will apply to a customer on the same day.

amountType (required)(numeric)

How the system applies the amountValue, it can be in percentage, monetary value, or per box.

If you select box, the system will apply the amountValue to each box until the capPerDay is reached.

Valid values: 0 = Percentage | 1 = Monetary Amount | 2 = Box

orderType (required)(numeric)

Order source.

Valid values: 0 = Both | 1 = Web | 2 = Phone

carrierIds (optional)(integer)

Carrier IDs where the system will apply the charge. You can add multiple IDs separated by a comma.

excludeCustomerIds (optional)(numeric)

Customers the system will not apply this charge to. You can add multiple IDs separated by a comma.

exceptionCustomers (optional)(array)

If you have specific customers that will get this charge applied differently, add them to this array.

active (required)(boolean)

Automatic Additional Charge Status.

Valid values: 0 = Inactive | 1 = Active

customerId (required)(integer)

Automatic Additional Charge Status.

Valid values: 0 = Inactive | 1 = Active

amountValue (required)(numeric)

Additional charge total amount.

amountType (required)(numeric)

How the system applies the amountValue, it can be in percentage, monetary value, or per box.

If you select box, the system will apply the amountValue to each box.

Valid values: 0 = Percentage | 1 = Monetary Amount | 2 = Box

result (integer:1)

Transaction status. 1 = Success | 0 = Failure

automaticAdditionalChargeId (numeric)

Automatic additional charge ID.

message (string:500)

Transaction status description.