create_payment_plan_term_m
Summary
| API Name | create_payment_plan_term_m |
|---|---|
| Class | administration_services_m |
| Update Version | 73 |
Description
Creates a new client-level payment plan term
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 | Yes |
Specifies the client-defined payment plan term id (unique per client) |
|||||||||
| payment_plan_term_name | string | Yes |
Specifies the payment plan term name (unique per client) |
|||||||||
| payment_plan_term_description | string | No |
Payment plan term description |
|||||||||
| payment_plan_term_type | int | No |
Payment plan term type. Allowable values are: 0 - Independent (its own schedule and due dates) OR 1 - Aligned (aligned with existing master plan instance). If Null, will be treated as 0 (independent). Allowed values:
|
|||||||||
| payment_plan_term_period_type | string | No |
M (Months), W (Weeks), D (Days). Required when payment_plan_term_type = 0 (independent). Allowed values:
|
|||||||||
| payment_plan_term_length | int | Yes |
For payment_plan_term_type = 0 (independent), used jointly with period type; for example, if period type is M (Monthly) and length is 36, the period is 36 months. For payment_plan_term_type = 1 (aligned), the value is interpreted as the number of statements that the payment plan amount will be part of. |
|||||||||
| payment_plan_term_interval | int | No |
Payment plan interval, works jointly with period type. For example: 2 on interval and M on period type means the payment is due every 2 months. If defined, must be less than or equal to length. Defaults to 1. |
|||||||||
| payment_plan_term_lump_sum_type | string | No |
Lump sum type determines the type of charges to be considered as a lump sum. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only. Allowed values:
|
|||||||||
| payment_plan_term_lump_sum_amount | float | 8 | No |
Applicable only when lump sum type is proportionately split (payment_plan_term_lump_sum_type = P). A one-time amount that will reduce the total amount to be spread over the course of the payment plan term. Mandatory when payment_plan_term_lump_sum_type = P. |
||||||||
| payment_plan_term_lump_sum_amount_type | string | No |
Lump sum amount type. Allowable values are: P - percentage; F - flat amount. Mandatory when payment_plan_term_lump_sum_type = P. Allowed values:
|
|||||||||
| client_sku | string | No |
Client SKU of the fee-type inventory item associated with this payment plan term |
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_no | long | No |
Aria-assigned unique identifier for the client payment plan term |
|
| client_payment_plan_term_id | string | No |
Client-defined payment plan term id |