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. | ||||||
include_detail_ind | string | 5 | Whether or not this is to retrieve the surcharge rate details
Allowable values for include_detail_ind
|
Field Name | Field Type | Description |
---|---|---|
all_acct_surcharges | hash | An array containing surcharges. |
![]() |
long | The surcharge number for a specific account |
![]() |
string | The Aria-assigned surcharge name for that account |
![]() |
string | Client-defined surcharge id. |
![]() |
string | Description for the surcharge number |
![]() |
string | Ext_description for the surcharge number |
![]() |
string | It specifies the surcharge type |
![]() |
string | The currency to which this surcharge applies |
![]() |
string | If taxable, the tax group this item belongs to |
![]() |
string | Invoice applied method |
![]() |
string | rev gl code for this surcharge |
![]() |
string | aria defined gl code for this |
![]() |
hash | Represents all the plans of the surcharge |
![]() |
long | Aria-assigned unique plan identifier |
![]() |
string | Specifies the name of the plan associated with the plan_no. |
![]() |
hash | Represents the rates for the default rate schedule for the default currency for the plan |
![]() |
long | Sequential number in the rate schedule for dertermining tiers |
![]() |
double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() |
double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() |
double | The cost per unit of this service over the time period the plan is billed for |
![]() |
long | This indicator indicates whether the rate schedule has includes zero or not. |
![]() |
long | This indicator indicates the assigned rate schedule for the surcharge. |
![]() |
string | Rate Tier Description |
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. |