get_rate_schedules_for_plan_m Guide
- Last updated
-
-
Save as PDF
-
The get_rate_schedules_for_plan_m API returns a list of rate schedules associated with a specified plan. The plan's default rate schedule will always be the first rate schedule returned and the remaining rate schedules will be sorted by schedule number.
Additional Guidance
Input Fields
| Field Name |
Notes |
| <include_translations> |
Allowable values
| Values |
Description |
| true |
true |
| false |
false |
|
Output Fields
| Field Name |
Notes |
| <default_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <display_ind> |
Allowable values
| Values |
Description |
| 0 |
Rate schedule is not displayable. |
| 1 |
Rate schedule is displayable. |
|
| <default_ind_curr> |
Allowable values
| Values |
Description |
| 0 |
Rate schedule is not default for specified currency. |
| 1 |
Rate schedule is default for specified currency. |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<auth_key>, <client_no> |
1033: a parameter that represents a true or false value contains invalid input
|
<include_translations> |
1066: Locale name does not exist in the system.
|
<locale_name> |
1067: Locale no does not exist in the system.
|
<locale_name> |
|
|
<new_plan_no>, <rollover_plan_no> |
14035: Invalid client Plan id
|
<client_plan_id> |
