get_payment_plan_terms_m
Summary
| API Name | get_payment_plan_terms_m |
|---|---|
| Class | administration_services_m |
| Update Version | 73 |
Description
Returns client-level payment plan terms
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| client_payment_plan_term_id | string | No |
Specifies the client-defined payment plan term id. If provided, only the matching term is returned. |
|||||||
| status_filter | int | No |
Filters the returned payment plan terms by status. Allowable values are: 0 - Active only (default when not provided); 1 - All (active and inactive). Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| payment_plan_term_list | object | No |
The payment_plan_term_list associated with this method. |
payment_plan_term_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| payment_plan_term_no | long | Yes |
Aria-assigned unique identifier for the client payment plan term |
|
| client_payment_plan_term_id | string | Yes |
Client-defined payment plan term id |
|
| payment_plan_term_name | string | Yes |
Payment plan term name |
|
| payment_plan_term_description | string | No |
Payment plan term description |
|
| payment_plan_term_type | int | No |
Payment plan term type. Values are: 0 - Independent (its own schedule and due dates); 1 - Aligned (aligned with existing master plan instance). |
|
| payment_plan_term_length | int | No |
For payment_plan_term_type = 0 (independent), used jointly with period type. For payment_plan_term_type = 1 (aligned), the value is the number of statements the payment plan amount will be part of. |
|
| payment_plan_term_period_type | string | No |
M (Months), W (Weeks), D (Days). Applicable only for payment_plan_term_type = 0 (independent). |
|
| payment_plan_term_interval | int | No |
Payment plan interval, works jointly with period type. Applicable only for payment_plan_term_type = 0 (independent). |
|
| payment_plan_term_lump_sum_type | string | No |
Lump sum type. Values are: P - proportionately split charge/tax; T - purchase tax only. |
|
| payment_plan_term_lump_sum_amount | float | 8 | No |
A one-time amount that reduces the total amount spread over the course of the payment plan term. Applicable when payment_plan_term_lump_sum_type = P. |
| payment_plan_term_lump_sum_amount_type | string | No |
Lump sum amount type. Values are: P - percentage; F - flat amount. |
|
| client_sku | string | No |
Client SKU of the fee-type inventory item associated with this payment plan term |
|
| status | string | No |
Payment plan term status label (e.g. Active, Inactive) |