Home > Aria Crescendo core api > get_acct_surcharges_m
get_acct_surcharges_m
get_acct_surcharges_m
Use this API to return the details of surcharges assigned to the given account/Master Plan Instance.
For error messages generated by this API, see get_acct_surcharges_m Error Messages.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
|
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| OR | ||||
| client_acct_id | string | 50 | Client-defined account identifier. | |
| master_plan_instance_no | long | 22 | The unique identifier for the master plan instance. | |
| OR | ||||
| client_master_plan_instance_id | string | 100 | Client-defined unique identifier for the master plan instance. | |
| include_detail_ind | string | 5 | Whether or not this is to retrieve the surcharge rate details Allowable Values | |
| locale_no | long | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | |
| OR | ||||
| locale_name | string | 100 | Name of the locale. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| all_surcharges | hash | An array containing surcharges. |
 surcharge_no |
long | The surcharge number for a specific account |
| surcharge_name |
string | The Aria-assigned surcharge name for that account |
| client_surcharge_id |
string | Client-defined surcharge id. |
| description |
string | Description for the surcharge number |
| ext_description |
string | Ext_description for the surcharge number |
| surcharge_type |
string | It specifies the surcharge type Allowable Values |
| currency |
string | The currency to which this surcharge applies |
| tax_group |
string | If taxable, the tax group this item belongs to |
| invoice_app_method |
string | Invoice applied method |
| rev_gl_code |
string | rev gl code for this surcharge |
| ar_gl_code |
string | Aria-defined general ledger code |
| surcharge_plan |
hash | Represents all the plans of the surcharge |
| plan_no |
long | Aria-assigned unique plan identifier |
| plan_name |
string | Specifies the name of the plan associated with the plan_no. |
| surcharge_rate |
hash | Represents the rates for the default rate schedule for the default currency for the plan |
| rate_seq_no |
long | Sequential number in the rate schedule for dertermining tiers |
| from_unit |
double | Tiered Units (from) This value represents the start of a tiered range of values. |
| to_unit |
double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
| rate_per_unit |
double | The cost per unit of this service over the time period the plan is billed for |
| include_zero |
long | This indicator indicates whether the rate schedule has includes zero or not. Allowable Values |
| rate_sched_is_assigned_ind |
long | This indicator indicates the assigned rate schedule for the surcharge. Allowable Values |
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
| acct_locale_no | long | Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED |
| acct_locale_no_2 | long | Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. |
| acct_locale_name | string | Name of the account level locale. |
- © Copyright 2019 Aria Developer Central