Home > Aria Crescendo Documentation > Aria Crescendo core api > move_payment_m
move_payment_m
move_payment_m
Table of contents
Moves a payment from one invoice line to another; this also unapplies a payment from one transaction and applies it to another transaction.
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. | ||||||
|
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||
| OR | ||||||||||
| client_acct_id | string | 50 | Client-defined account identifier. | |||||||
|
payment_id | long | 38 | Aria Event number of payment event. | ||||||
| Start of unapply_list array | ||||||||||
| unapply_list | array | A list of specific charge transaction id to unapply the payment from. | ||||||||
| Field Name | Field Type | Max Length | Description | |||||||
 unapply_trans_id |
long | 32 | Unique transaction ID for specific charge or invoice line item. | |||||||
| unapply_amt |
double | Gross amount to be unapplied from the invoice line. | ||||||||
| End of order_line_items array | ||||||||||
| Start of apply_list array | ||||||||||
apply_list |
array | A list of specific charge transaction id to apply the payment to. | ||||||||
| Field Name | Field Type | Max Length | Description | |||||||
| apply_trans_id |
long | 32 | Unique transaction ID for specific charge or invoice line item. | |||||||
| apply_amt |
double | Gross amount to be allocated to the invoice line. | ||||||||
| End of apply_list array | ||||||||||
| do_write | string | 5 |
Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true.' Allowable values for do_write:
|
|||||||
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred."OK" there was no error. |
| unapplied_list |
array |
A list of specific charge transaction id from which the payment is unapplied. |
| unapplied_trans_id |
long | Unique transaction ID for specific charge or invoice line item. |
| unapplied_amt |
double | Gross amount unapplied from the invoice line or other charge. |
| applied_list | array | A list of specific charge transaction id to which the payment is applied. |
| applied_trans_id |
long | Unique transaction ID for specific charge or invoice line item. |
| applied_amt |
double | Gross amount applied to the invoice line or other charge. |
- © Copyright 2023 Aria Developer Central