update_payment_plan_m Guide
The update_payment_plan_m API updates an existing payment plan schedule on a specified account. It allows you to:
- update a payment plan aligned with a master plan instance;
- update the payment method associated with a payment plan;
- update a payment plan schedule. You can initiate two types of modifications:
- modify specific payment plan sequences (dates, due amounts, or both); or
- modify remaining payment plan sequences.
- initiate a lump sum collection.
Fields that are not updated will retain their original definition, unless they are specified.
API Specification: |
update_payment_plan_m |
Required Fields: |
|
Additional Guidance
- When modifying specific sequences (dates, due amounts, or both), note:
- When you change a specified sequence due amount, Aria will recalculate and distribute the remaining amount evenly to other sequences not specified.
- This modification does not change the number of sequences in the payment plan schedule.
- You can update dates only without changing the due amount (independent only).
- You can update the due amount only without changing the dates.
- You cannot modify the last sequence due amount.
- When modifying remaining sequences, note:
- When you alter the due amount, the number of sequences could change (e.g. from 3 sequences to 5 sequences).
- When you specify one sequence, Aria replicates the change to the remaining sequences.
- In this type of change, Aria uses the original payment plan interval and type to calculate the schedule changes.
- When you alter a due amount, it impacts the length of the payment plan: it becomes longer if the new due amount is lower; or shorter if new due amount is higher.
- You can only modify unnotified sequences that are neither partially nor fully paid.
- You cannot modify notify dates nor due dates for aligned payment plans.
- The amount you enter per sequence is tax inclusive.
- When an account misses a sequence due date and Aria puts a subscription into dunning: if you modify that specific sequence due date to a future date, Aria removes the subscription from dunning the next day.
Input Fields
| Field Name | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| <update_scope> |
Specifies how the system should apply those changes. Allowable Values
|
||||||||
| <do_write> |
Boolean indicator that specifies whether to perform the requested operation or not. Allowable Values
|
||||||||
|
<new_payment_plan_type> |
Defines the type of payment plan for the remaining unpaid balance. Allowable Values
|
||||||||
|
<new_payment_plan_period_type> |
Specifies the payment plan period type. This field is mandatory when <new_payment_plan_type> = 0. Allowable Values
|
Error Codes
| Error Code/Description | Associated Inputs |
|---|---|
| <acct_no>, <client_acct_id> | |
| <payment_plan_no>, <client_payment_plan_id>, <primary_payment_method_no>, <client_primary_payment_method_id>, <backup_payment_method_no>, <update_scope>, <seq_no>, <notify_date>, <due_date>, <due_amount>, <update_specific_sequence_list>, <new_independent_payment_plan_date> | |
| <notify_date>, <due_date>, <new_independent_payment_plan_date> | |
| <aligned_payment_plan_master_plan_instance_no> | |
| <aligned_payment_plan_client_master_plan_instance_id> | |
| <client_no> |