Use this API to return the details of surcharges assigned to the given account/MPI.
| API Specification: |
get_acct_surcharges_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <include_detail_ind> |
Allowable values
| Values |
Description |
| true |
true |
| false (default) |
false (default) |
|
Output Fields
| Field Name |
Notes |
| <surcharge_type> |
Allowable values
| Values |
Description |
| F |
Fixed/Flat Amount |
| P |
Percentage based (with standard/multi-tier or volume/single-tier pricing rule) |
|
| <include_zero> |
Allowable values
| 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> |
Allowable values
| 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. |
|
| <tax_inclusive_ind> |
Allowable values
| Values |
Description |
| 0 |
False or indicates tax exclusive surcharge (default) |
| 1 |
True or indicates surcharge is inclusive of taxes. |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<master_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
|
<client_master_plan_instance_id> |
1066: Locale name does not exist in the system.
Associated Inputs: locale_name
|
<locale_name> |
1067: Locale no does not exist in the system.
Associated Inputs: locale_no, master_plan_instance_no
|
<locale_name> |
