get_surcharge_details_m
Summary
| API Name | get_surcharge_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.22 |
Description
Returns the details of 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 |
Specifies Surcharge No Alternative required field: client_surcharge_id |
||||||
| client_surcharge_id | string | 100 | Yes |
Specifies the client defined id for surcharge Alternative required field: surcharge_no |
||||||
| 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 |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. 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 | 100 | No |
Specifies Surcharge No |
||||||||||||||||||||||||||
| surcharge_name | string | 100 | No |
Specifies Surcharge Name |
||||||||||||||||||||||||||
| client_surcharge_id | string | 100 | No |
Specifies client defined id for Surcharge |
||||||||||||||||||||||||||
| description | string | 1000 | No |
Specifies description for the Surcharge |
||||||||||||||||||||||||||
| ext_description | string | 1000 | No |
Specifies description that can be added to statement and is visible to the user. |
||||||||||||||||||||||||||
| currency_cd | string | 3 | No |
Specifies the currency code of the surcharge |
||||||||||||||||||||||||||
| surcharge_type_cd | string | 1 | No |
Specifies whether the discount is going to be fixed or percentage based. Allowed values:
|
||||||||||||||||||||||||||
| inline_offset_ind | string | 1 | No |
Specifies how the discount will be displayed in the invoice. Allowed values:
|
||||||||||||||||||||||||||
| 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 |
||||||||||||||||||||||||||
| apply_b4_or_after_discount_cd | string | 1 | No |
Specifies whether the surcharge should consider item totals before or after discounts are applied Allowed values:
|
||||||||||||||||||||||||||
| 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 | No |
Specifies the charges eligible for the discount. Allowed values:
|
||||||||||||||||||||||||||
| surcharge_tier | object | No |
The surcharge_tier associated with this method. |
|||||||||||||||||||||||||||
| surcharge_rate_schedule_details | object | No |
Array of all rate schedules configured on the surcharge. Each entry contains the schedule metadata and its ordered rate tiers. Returned in the following format: surcharge_rate_schedule_details[0][schedule_no]=101 etc. |
|||||||||||||||||||||||||||
| plan_no | object | No |
The plan_no associated with this method. |
|||||||||||||||||||||||||||
| client_plan_id | object | No |
The client_plan_id associated with this method. |
|||||||||||||||||||||||||||
| service_no | object | No |
The service_no associated with this method. |
|||||||||||||||||||||||||||
| client_service_id | object | No |
The client_service_id associated with this method. |
|||||||||||||||||||||||||||
| item_no | object | No |
The item_no associated with this method. |
|||||||||||||||||||||||||||
| client_item_id | object | No |
The client_item_id associated with this method. Note: This field was deprecated in version 43. |
|||||||||||||||||||||||||||
| client_sku | object | No |
The client_sku associated with this method. |
|||||||||||||||||||||||||||
| plan_service | object | No |
The plan_service associated with this method. |
|||||||||||||||||||||||||||
| surcharge_scope | int | 1 | No |
Specifies the surcharge application. The value will be available only for EOM Clients. Allowed values:
|
||||||||||||||||||||||||||
| pay_method | object | No |
Payment method types on which this surcharge is applied to. |
|||||||||||||||||||||||||||
| surcharge_translation_details | object | No |
Array that contains all the translated values for a given locale. |
|||||||||||||||||||||||||||
| 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. |
surcharge_tier fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| from | int | 10 | Yes |
Returned 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 |
Returned 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. |
| rate | float | 12 | No |
Returned in the following format: surcharge_tier[0][rate]=3&surcharge_tier[1][rate]=4 etc. |
| description | string | No |
Returned in the following format: surcharge_tier[0][description]=description&surcharge_tier[1][rate]=surcharge etc. |
surcharge_rate_schedule_details.surcharge_rate_schedule_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | int | 10 | Yes |
Specifies the sequence number of the rate tier |
| from_unit | int | 10 | Yes |
Tiered pricing rule that specifies the from units for the tier |
| to_unit | int | 10 | No |
Tiered pricing rule that specifies the to units for the tier. This is null for the final (open-ended) tier. |
| rate_per_unit | float | 12 | Yes |
Specifies the rate per unit for the tier |
| rate_tier_description | string | 50 | No |
Specifies the rate tier description |
surcharge_rate_schedule_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| schedule_no | long | 10 | Yes |
Specifies the rate schedule number |
| schedule_name | string | 100 | No |
Specifies the rate schedule name |
| schedule_currency | string | 3 | Yes |
Specifies the currency code of the rate schedule |
| default_ind | int | 1 | Yes |
Indicates whether this is the default rate schedule. 1 - default schedule, 0 - not the default schedule. |
| include_zero | int | 1 | Yes |
Indicates whether zero-unit usage is included in the schedule. 1 - included, 0 - not included. |
| comments | string | 4000 | No |
Specifies optional comments for the rate schedule |
| surcharge_rate_schedule_rates | object | No |
The surcharge_rate_schedule_rates associated with this method. |
plan_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_nos | 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 |
client_plan_id fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_plan_ids | string | 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: client_plan_id[0]=1002&client_plan_id[1]=1003 etc |
service_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| service_nos | 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 |
client_service_id fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_service_ids | 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 |
item_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| item_nos | 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 |
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 |
client_sku fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_skus | string | 100 | No |
Specifies the inventory items that are eligible for the discount. This is mandatory for scope 10. |
plan_service.service_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| service_nos | long | 12 | No |
Specifies the services that are eligible for the surcharge. |
plan_service.client_service_id fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_service_ids | string | 100 | No |
Specifies the client defined id for the services that are eligible for the surcharge. |
plan_service fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | No |
Specifies the plans that are eligible for the surcharge. |
|
| client_plan_id | string | No | ||
| service_no | object | No |
The service_no associated with this method. |
|
| client_service_id | object | No |
The client_service_id associated with this method. |
surcharge_translation_details.surcharge_tier_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| description | string | No |
Returned in the following format: surcharge_tier[0][description]=description&surcharge_tier[1][rate]=surcharge etc. |
surcharge_translation_details.surcharge_rate_schedule_t.surcharge_rate_schedule_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_tier_description | string | 50 | No |
Translated rate tier description for the locale |
surcharge_translation_details.surcharge_rate_schedule_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| schedule_name | string | 100 | No |
Translated rate schedule name for the locale |
| surcharge_rate_schedule_rates | object | No |
The surcharge_rate_schedule_rates associated with this method. |
surcharge_translation_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| 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_no | long | 100 | No |
Specifies Surcharge No |
| surcharge_name | string | 100 | No |
Specifies Surcharge Name |
| description | string | 1000 | No |
Specifies description for the Surcharge |
| ext_description | string | 1000 | No |
Specifies description that can be added to statement and is visible to the user. |
| surcharge_tier_t | object | No |
The surcharge_tier_t associated with this method. |
|
| surcharge_rate_schedule_t | object | No |
The surcharge_rate_schedule_t associated with this method. |