Skip to main content
Aria Knowledge Central

create_surcharge_m

Summary

API Name create_surcharge_m
Class administration_services_m
Update Version 6.22

Description

Creates a surcharge

Inputs

Name Type Length Required Description
client_no long 12 Yes

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

auth_key string 32 Yes

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

surcharge_name string 100 Yes

Specifies Surcharge Name. Translatable.

client_surcharge_id string 100 No

Specifies client defined id for Surcharge

description string 1000 Yes

Specifies description for the Surcharge. Translatable

ext_description string 1000 Yes

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

currency_cd string 3 No

Specifies the currency code of the surcharge

Note: This field was deprecated in version 41.

surcharge_type_cd string 1 Yes

Specifies whether the discount is going to be fixed or percentage based.

Allowed values:

Value Description
F Fixed surcharge
V Volume percentage (Volume surcharge)
S Standard percentage
inline_offset_ind string 1 Yes

Specifies how the discount will be displayed in the invoice.

Allowed values:

Value Description
I Includes with original line item(s)
O Adds a separate surcharge line item
apply_b4_or_after_discount_cd string 1 Yes

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

Allowed values:

Value Description
B Before the discount
A After the discount
apply_to_zero_invoice_ind int 8 No

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

Note: This field was deprecated in version 11.1.

tax_group int 8 No

Specifies the tax group to be used while calculating surcharge.

gl_cd string 30 No

Specifies the revenue account chart of access code

ar_gl_cd string 30 No

Specifies the account recievable chart of access code

scope_no int 2 Yes

Specifies the charges eligible for the discount.

Allowed values:

Value Description
1 All Charges
2 All Plan Charges, All Plans
3 All Plan Charges, Specified Plans
4 All Plans, Specified Service Charges
5 Specified Plan/Service Charges
6 All Recurring Service Charges
7 All Usage Service Charges
8 All Activation Service Charges
9 All Item Charges
10 Specified Item Charges
11 Payment Method
12 Payment Term
plan_no long 12 No

Specifies the plan 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

client_plan_id string 100 No

Specifies the plan 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

service_no long 12 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

client_service_id string 100 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 client_service_id[0]=1002&client_service_id[1]=1003 For scope 5 client_service_id[0][0]=10002

Alternative field: service_no

item_no long 12 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

client_sku string 30 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: client_sku[0]=1002&client_sku[1]=103

Alternative field: item_no

client_item_id object   No

The client_item_id associated with this method.

See fields below

Note: This field was deprecated in version 43.

surcharge_tier object   Yes

The surcharge_tier associated with this method.

See fields below

schedule object   No

The schedule associated with this method.

See fields below

surcharge_scope int 1 No

Specifies the surcharge application. The parameter is available only for EOM Clients.

Allowed values:

Value Description
1 Surcharge can be applied to Account only.
2 Surcharge can be applied to Master plan instance only.
3 Surcharge can be applied to Account & Master plan instance.
tax_inclusive_ind int 1 No

This flag denotes if a Surcharge is inclusive of taxes. Valid values are: 1 - means tax inclusive surcharge and 0 (default) - means tax exclusive surcharge.'

installment_surcharge_ind int 1 No

Indicates if the surcharge should be spread over installment period. Applicable only when an item is purchased with installment. Allowable values are: 0 - Surcharge will not be spread over installment period 1 - Surcharge will be spread over installment period.

client_item_id fields

Name Type Length Required Description
client_item_ids string 100 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: client_item_id[0]=1002&client_item_id[1]=103

surcharge_tier fields

Name Type Length Required Description
from int 10 Yes

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 and 1 specifies the second tier and so on.

to int 10 No

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 and 1 specifies the second tier and so on. This is mandatory unless it is the last tier

rate float 12 Yes

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

description string 50 No

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

schedule fields

Name Type Length Required Description
schedule_name string 10 Yes

Specifies 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_cd string 3 Yes

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.

is_default int 5 No

Specifies if the rate schedule is 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.

Allowed values:

Value Description
0 The rate schedule is taken as default for the currency
1 The rate schedule is not taken as default for the currency
min_surcharge_to_apply float 5 No

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

include_zero int 1 No

Specifies how the discount will be displayed in the invoice.

Allowed values:

Value Description
1 Include zero in rate tier
0 Ignore zero in rate tier

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error

error_msg string   No

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

surcharge_no long 32 No

Surcharge No

TOP
  • Was this article helpful?