The get_surcharges_m API returns all surcharges for a client.
Additional Guidance
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 |
|
| <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. |
|
| <installment_surcharge_ind> |
Allowable Values
| Values |
Description |
| 0 |
Surcharge will not be spread over installment period |
| 1 |
Surcharge will be spread over installment period. |
|