Use this API to edit an existing installment term.
Input Arguments
| Req |
Field Name |
Field Type |
Max Length |
Description |
 |
client_no |
long |
22 |
Aria-assigned unique identifier indicating the Aria client providing service to this account |
|
auth_key |
string |
32 |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
|
client_installment_term_id |
string |
|
Specifies client installment id. If null, then it selects the installment default |
| |
OR |
|
|
|
| |
installment_term_no |
string |
50 |
Installment no on product catalog. If null, then it selects installment default |
| |
installment_term_name |
string |
100 |
Specifies installment term name |
| |
description |
string |
1000 |
Installment term description |
| |
aligned_installment |
string |
1 |
Aligned installment schedule with existing master plan instance. If aligned, installment amount will be charged along with master plan instance anniversary statement.
Allowable values:
| Values |
Description |
| Y |
Yes (Aligned with existing master plan instance) |
| N |
No (Its own installment schedule and due dates) |
|
| |
term_type |
string |
1 |
Installment term types; this is mandatory when aligned installment is N (No). If aligned installment is Y (Yes), this is irrelevant and will be ignored if passed.
Allowable values:
| Values |
Description |
| M |
Months (if Null, Months value will be used) |
| W |
Weeks |
| D |
Days |
|
| |
term_length |
int |
8 |
Installment term length. For aligned_installment = N, the input will be used jointly with interval type, so for example if interval type is M (Monthly), and users enter 36 then, installment period is 36 months. For aligned_installment = Y, this will be interpreted as number of statements that the installment amount will be part of. |
| |
installment_term_interval |
int |
1 |
Installment interval, works jointly with terms type. For example: 2 on interval and months in terms type mean installment is due every 2 months. If defined, must be less than terms length. Mandatory if aligned_installment is N (No). For aligned_installment Y (Yes), this is irrelevant and will be ignored if passed. |
| |
days_to_start |
Int |
8 |
Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after a purchase or invoice date that the first installment will start. For example: if 5 is passed, then 5 days after an invoice date, 1st installment will start and be notified to customers. If 0 is passed, then 1st installment will start (and be notified to customers) on purchase date (invoice date). |
| |
days_until_due |
int |
8 |
Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due. |
| |
lump_sum_type |
string |
1 |
Lump sum type determines type of charges to be considered as a lump sum. Two types of lump sum are: proportionately split (tax/charge) or tax only.
Allowable values:
| Values |
Description |
| P |
For proportionately split charge/tax |
| T |
For purchase tax only |
|
| |
lump_sum_amount |
float |
8 |
Applicable only when lump sump type is proportionately split (lump_sum_type = P). A one-time amount that will reduce the total installment to be spread over the course of installment term. For example: a $1200 phone purchase with $200 lump sump will reduce the total installment amount to $1000, which will be spread monthly over 10 months installment term ($100 per month). Lump sum amount is mandatory when only when lump_sum_type is P (proportionately split charge/tax). |
| |
aligned_lump_sum |
string |
1 |
Applicable only for aligned installment (aligned installment - Y). Determines when to notify customers of the lump sum.
Allowable values:
| Values |
Description |
| 0 |
Aligned with when an invoice is created |
| 1 |
Aligned with the 1st installment |
|
| |
lump_sum_days |
Int |
3 |
Applicable only for independent installment (aligned_installment = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers. For example: if 3 is passed, then 3 days after an invoice date, a lump sum will be charged. If 0 is passed, then 1st installment will start (and be notified to customers) on purchase date (invoice date). |
| |
lump_sum_days_until_due |
Int |
3 |
Applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due. For example: if 5 is passed, then 5 days after customers are notified, the lump sum will be due. For independent installment, if it's NULL, it will be treated as 0, and lump sum is due when it's notified to customers. If it's NULL for aligned installment, it will follow the statement due date that lump sum is on. |
Output Arguments
| Field Name |
Field Type |
Description |
| error_code |
long |
Aria-assigned error identifier. 0 indicates no error |
| error_message |
string |
Textual description of any error that occurred. "OK" if there was no error. |
