| 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 for surcharge_type
| Values |
Description |
| F |
Fixed/Flat Amount |
| P |
Percentage based (with standard/multi-tier or volume/single-tier pricing rule) |
|
| 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 for include_zero
| Values |
Description |
| 1 |
This (first) tier's range includes and starts from 0th unit (charge). |
| 0 |
This (first) tier's range does not include 0th unit (charge) and applicable only for charges greater than 0. |
| null |
This indicator is not applicable for tiers other than the first tier. |
|
| rate_sched_is_assigned_ind |
long |
This indicator indicates the assigned rate schedule for the surcharge.
Allowable values for rate_schedule_is_assigned_ind
| Values |
Description |
| 1 |
Indicates that this rate schedule is in use on the given account. |
| 0 |
Indicates that this rate schedule is not used by the given account. |
|
| 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. |
| tax_inclusive_ind |
int |
This flag denotes if a surcharge is inclusive of taxes.
Allowable values for tax_inclusive_ind
| Values |
Description |
| 0 |
False or indicates tax exclusive surcharge (default) |
| 1 |
True or indicates surcharge is inclusive of taxes. |
|
