move_payment_m
Summary
| API Name | move_payment_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 19 |
Description
Move a payment from one invoice line to another.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| acct_no | long | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative field: client_acct_id |
|||||||
| client_acct_id | string | 50 | No |
Client-defined account identifier. Alternative field: acct_no |
||||||
| payment_id | long | 38 | Yes |
Aria Event number of payment event. |
||||||
| Start of unapply_list object | ||||||||||
| unapply_list | object | No |
A list of specific charge transaction id to unapply the payment from. |
|||||||
| Name | Type | Length | Required | Description | ||||||
| ▶unapply_trans_id | long | 32 | No |
Unique transaction ID for specific charge or invoice line item. |
||||||
| ▶unapply_amt | double | No |
Gross amount to be unapplied from the invoice line. |
|||||||
| End of unapply_list object | ||||||||||
| Start of apply_list object | ||||||||||
| apply_list | object | No |
A list of specific charge transaction id to apply the payment to. |
|||||||
| Name | Type | Length | Required | Description | ||||||
| ▶apply_trans_id | long | 32 | No |
Unique transaction ID for specific charge or invoice line item. |
||||||
| ▶apply_amt | double | No |
Gross amount to be allocated to the invoice line. |
|||||||
| End of apply_list object | ||||||||||
| do_write | string | 5 | No |
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' Allowed values:
|
||||||
| comments | string | 500 | No |
Additional explanatory text relating to this API call. |
||||||
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| Start of unapplied_list object | ||||
| unapplied_list | object | No |
A list of specific charge transaction id from which the payment is unapplied. |
|
| Name | Type | Length | Required | Description |
| ▶unapplied_trans_id | long | No |
Unique transaction ID for specific charge or invoice line item. |
|
| ▶unapplied_amt | double | No |
Gross amount unapplied from the invoice line or other charge. |
|
| End of unapplied_list object | ||||
| Start of applied_list object | ||||
| applied_list | object | No |
A list of specific charge transaction id to which the payment is applied. |
|
| Name | Type | Length | Required | Description |
| ▶applied_trans_id | long | No |
Unique transaction ID for specific charge or invoice line item. |
|
| ▶applied_amt | double | No |
Gross amount applied to the invoice line or other charge. |
|
| End of applied_list object | ||||