get_acct_surcharges_m
Summary
| API Name | get_acct_surcharges_m |
|---|---|
| Class | system_services_m |
| Update Version | 42 |
Description
Use this API to return the details of surcharges assigned to the given account/MPI.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||
| master_plan_instance_no | long | 22 | No |
The unique identifier for the master plan instance. Alternative field: client_master_plan_instance_id |
||||||
| client_master_plan_instance_id | string | 100 | No |
Client-defined unique identifier for the master plan instance. Alternative field: master_plan_instance_no |
||||||
| include_detail_ind | string | 5 | No |
Whether or not this is to retrieve the surcharge rate details Allowed values:
|
||||||
| locale_no | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. Alternative field: locale_name |
||||||
| locale_name | string | 100 | No |
Name of the locale. Alternative field: locale_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| all_surcharges | object | No |
An array containing surcharges. |
|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| acct_locale_no | long | 30 | No |
Note: This field is deprecated. Aria no longer supports acct_locale_no. |
| acct_locale_name | string | 100 | No |
Name of the account level locale. |
| acct_locale_no_2 | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. |
all_surcharges.surcharge_plan fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | 22 | No |
Aria-assigned unique plan identifier |
| plan_name | string | No |
Specifies the name of the plan associated with the plan_no. |
all_surcharges.surcharge_rate_schedule_details.surcharge_rate_schedule_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | long | No |
Sequential number in the rate schedule for determining tiers |
|
| from_amount | double | No |
Tiered amount (from) This value represents the start of a tiered range of values. |
|
| to_amount | double | No |
Tiered amount (to) This value represents the end of the range for a single tier of values. |
|
| rate | double | No |
Rate for the tiered amount. |
|
| rate_tier_description | string | No |
Rate Tier Description |
all_surcharges.surcharge_rate_schedule_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| schedule_no | long | No |
Rate schedule number |
|
| schedule_name | string | 100 | No |
Rate schedule name |
| include_zero | long | No |
This indicator indicates whether the rate schedule has includes zero or not. |
|
| comments | string | No |
Comments provided for Surcharge rate schedule. |
|
| surcharge_rate_schedule_rates | object | No |
All rates for all rate schedules. |
all_surcharges fields
| Name | Type | Length | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| surcharge_no | long | No |
The surcharge number for a specific account |
|||||||||||||
| surcharge_name | string | No |
The Aria-assigned surcharge name for that account |
|||||||||||||
| client_surcharge_id | string | No |
Client-defined surcharge id. |
|||||||||||||
| description | string | No |
Description for the surcharge number |
|||||||||||||
| ext_description | string | No |
Ext_description for the surcharge number |
|||||||||||||
| surcharge_type | string | No |
It specifies the surcharge type |
|||||||||||||
| currency | string | No |
The currency to which this surcharge applies |
|||||||||||||
| tax_group | string | No |
If taxable, the tax group this item belongs to |
|||||||||||||
| invoice_app_method | string | No |
Invoice applied method |
|||||||||||||
| rev_gl_code | string | No |
rev gl code for this surcharge |
|||||||||||||
| ar_gl_code | string | No |
Aria-defined general ledger code |
|||||||||||||
| surcharge_plan | object | No |
Represents all the plans of the surcharge |
|||||||||||||
| surcharge_rate | object | No |
Note: This field is deprecated. Aria no longer supports surcharge_rate. |
|||||||||||||
| tax_inclusive_ind | long | 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. Allowed values:
|
|||||||||||||
| assignment_level | long | No |
Indicates the level at which the surcharge is applied. Allowed values:
|
|||||||||||||
| master_plan_instance_no | long | 22 | No |
Aria-assigned unique plan identifier for the master subscription plan instance. |
||||||||||||
| plan_no | long | 22 | No |
Aria-assigned unique plan identifier |
||||||||||||
| plan_name | string | No |
Plan Name |
|||||||||||||
| pay_method_type | long | No |
Pay Method Type identifier from Pay Methods configuration. |
|||||||||||||
| pay_method_type_name | string | 100 | No |
Pay Method Name from Pay Methods configuration. |
||||||||||||
| payment_terms_no | long | No |
Payment Terms number. |
|||||||||||||
| payment_terms_name | string | 50 | No |
Payment Terms Name from Payment Terms configuration. |
||||||||||||
| surcharge_rate_schedule_details | object | No |
Rate schedule applied for this surcharge |