Returns the details of a surcharge.
Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.
| API Specification: |
get_surcharge_details_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <surcharge_no> or <client_surcharge_id>
|
Additional Guidelines:
Input Fields
| Field Name |
Notes |
| <include_translations> |
Allowable Values
| Values |
Description |
| true |
Translated fields will be fetched in all the locales defined. |
| false |
Translation information will not be fetched. |
|
Output Fields
| Field Name |
Notes |
| <surcharge_type_cd> |
Allowable Values
| Values |
Description |
| F |
Fixed discount |
| S |
Standard percentage discount |
| V |
Volume percentage discount |
|
| <inline_offset_ind> |
Allowable Values
| Values |
Description |
| I |
Includes with original line item(s) |
| O |
Adds a separate surcharge line item |
|
| <apply_b4_or_after_discount_cd> |
Allowable Values
| Values |
Description |
| B |
Before the discount |
| A |
After the discount |
|
| <scope_no> |
Allowable Values
| Values |
Description |
| 1 |
All Charges |
| 2 |
All Plan Charges, All Plans |
| 3 |
All Plan Charges, Specified Plans |
| 4 |
All Plans, Specified Service Charges |
| 5 |
Specified Plan/Service Charges |
| 6 |
All Recurring Service Charges |
| 7 |
All Usage Service Charges |
| 8 |
All Activation Service Charges |
| 9 |
All Item Charges |
| 10 |
Specified Item Charges |
| 11 |
Payment Method |
| 12 |
Payment Term |
|
| <surcharge_scope> |
Allowable Values
| Values |
Description |
| 1 |
Surcharge can be applied to Account only. |
| 2 |
Surcharge can be applied to Master plan instance only. |
| 3 |
Surcharge can be applied to Account & Master plan instance. |
|
| <tax_inclusive_ind> |
Allowable Values
| Values |
Description |
| 0 |
False or indicates tax exclusive surcharge (default) |
| 1 |
True or indicates surcharge is inclusive of taxes. |
|
