Aria-assigned unique identifier indicating the Aria client providing service to this account.

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

Specifies the surcharge name. Translatable.

Specifies the client-defined ID for the surcharge.

Specifies the description for the surcharge. Translatable.

Specifies the description that can be added to the statement and is visible to the user. Translatable.

Specifies the currency code of the surcharge.

Specifies whether the discount is fixed or percentage based.

Specifies how the discount is displayed in the invoice.

Specifies whether the surcharge should consider item totals before or after discounts are applied.

Specifies whether the minimum surcharge should apply to a zero dollar invoice.

Specifies the tax group to use when calculating the surcharge.

Specifies the revenue account chart of access code.

Specifies the accounts receivable chart of access code.

Specifies the charges eligible for the surcharge.

Specifies the plans that are eligible for the surcharge. This is mandatory for scope 3 and 5. REST input arrays should be passed in the following format: plan_no[0]=1002&plan_no[1]=1003, etc.

Alternative field: client_plan_id

Specifies the plans that are eligible for the surcharge. This is mandatory for scope 3 and 5. REST input arrays should be passed in the following format: client_plan_id[0]=1002&client_plan_id[1]=1003, etc.

Alternative field: plan_no

Specifies the services that are eligible for the surcharge. This is mandatory for scope 4 and 5. REST input arrays should be passed in the following format: for scope 4, service_no[0]=1002&service_no[1]=1003. For scope 5, service_no[0][0]=10002&service_no[0][1]=1001&service_no[1][0]=100&service_no[1][1]=103.

Alternative field: client_service_id

Specifies the services that are eligible for the surcharge. This is mandatory for scope 4 and 5. REST input arrays should be passed in the following format: for scope 4, client_service_id[0]=1002&client_service_id[1]=1003. For scope 5, client_service_id[0][0]=10002.

Alternative field: service_no

Specifies the inventory items that are eligible for the surcharge. This is mandatory for scope 10. REST input arrays should be passed in the following format: item_no[0]=1002&item_no[1]=103.

Alternative field: client_sku

Specifies the inventory items that are eligible for the surcharge. This is mandatory for scope 10. REST input arrays should be passed in the following format: client_sku[0]=1002&client_sku[1]=103.

Alternative field: item_no

Specifies the client-defined identifiers of the inventory items that are eligible for the surcharge.

See fields below

Specifies the pricing tiers for the surcharge.

See fields below

Specifies the rate schedule associated with the surcharge.

See fields below

Specifies the surcharge application. This parameter is available only for EOM clients.

This flag denotes whether a surcharge is inclusive of taxes. Valid values are 1, meaning a tax-inclusive surcharge, and 0 (default), meaning a tax-exclusive surcharge.

Indicates whether the surcharge should be spread over the installment period. This applies only when an item is purchased with installments. Valid values are 0, meaning the surcharge is not spread over the installment period, and 1, meaning the surcharge is spread over the installment period.

Specifies the inventory items that are eligible for the surcharge. This is mandatory for scope 10. REST input arrays should be passed in the following format: client_item_id[0]=1002&client_item_id[1]=103.

REST input arrays should be passed in the following format: surcharge_tier[0][from]=1&surcharge_tier[1][from]=1, etc. Index 0 specifies the first tier, index 1 specifies the second tier, and so on.

REST input arrays should be passed in the following format: surcharge_tier[0][to]=3&surcharge_tier[1][to]=7, etc. Index 0 specifies the first tier, index 1 specifies the second tier, and so on. This field is mandatory unless it is the last tier.

REST input arrays should be passed in the following format: surcharge_tier[0][rate][0]=3&surcharge_tier[0][rate][1]=4, etc.

This field is used to display a custom rate tier description. REST input arrays should be passed in the following format: surcharge_tier[1][description]=Custom description, etc. Index [tier][0] specifies the first tier, index [tier][1] specifies the second tier, and so on. Translatable.

Specifies the schedule name. REST input arrays should be passed in the following format: schedule[0][schedule_name]=TestSchedule1&schedule[1][schedule_name]=TestSchedule2, etc. Translatable.

Currency of the rate schedule. REST input arrays should be passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=eur, etc.

Specifies whether the rate schedule is the default for the currency. REST input arrays should be passed in the following format: schedule[0][is_default]=1&schedule[1][is_default]=1, etc.

Minimum surcharge to apply. REST input arrays should be passed in the following format: schedule[0][min_surcharge_to_apply]=10, etc.

Specifies how the discount is displayed in the invoice.

Aria-assigned error identifier. Zero indicates no error.

Textual description of any error that occurred. "OK" if there was no error.

Surcharge number.