edit_surcharge_m
Summary
| API Name | edit_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_no | long | 100 | Yes |
Surcharge No Alternative required field: client_surcharge_id |
||||||||||||||||||||||||||
| surcharge_name | string | 100 | Yes |
Specifies Surcharge Name. Translatable. |
||||||||||||||||||||||||||
| client_surcharge_id | string | 100 | Yes |
Specifies client defined id for Surcharge Alternative required field: surcharge_no |
||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||
| scope_no | int | 2 | Yes |
Specifies the charges eligible for the discount. Allowed values:
|
||||||||||||||||||||||||||
| 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 | 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 Note: This field was deprecated in version 43. |
||||||||||||||||||||||||||
| surcharge_tier | object | Yes |
The surcharge_tier associated with this method. |
|||||||||||||||||||||||||||
| schedule | object | No |
The schedule associated with this method. |
|||||||||||||||||||||||||||
| surcharge_scope | int | 1 | No |
Specifies the surcharge application. The parameter is available only for EOM Clients. Allowed values:
|
||||||||||||||||||||||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||||||||||||||||||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
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][0]=Custom description&surcharge_tier[1][description][1]=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:
|
||||||
| 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:
|
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 |