move_payment_m Sample Call and Response
This example shows a payment being unapplied from one invoice line item and reapplied to a different invoice line item on the same account, based on the move_payment_m method defined in plsql_m_r73.yml. All identifiers shown are clearly fake placeholder values and do not represent any real payment or account.
This example includes the required field and a representative set of optional fields for moving a specific dollar amount of a payment from one charge transaction to another. It does not cover moving an entire payment without specifying individual transactions, or omitting the account scope entirely.
Sample call
{
"rest_call": "move_payment_m",
"output_format": "json",
"client_no": 32409,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"acct_no": 5008842,
"payment_id": 700219384,
"unapply_list": [
{
"unapply_trans_id": 88041127,
"unapply_amt": 45.69
}
],
"apply_list": [
{
"apply_trans_id": 88041205,
"apply_amt": 45.69
}
],
"do_write": "true",
"comments": "Correcting misapplied payment; moving from the prior invoice line to the current period's usage charge."
}
The field acct_no scopes the call to a specific account and is an alternative to client_acct_id; this example uses acct_no, the Aria-assigned numeric identifier, though the yml documents both as optional rather than required. The field payment_id is the required field on this method, identifying the Aria event number of the payment being moved. The unapply_list and apply_list fields are each JSON arrays because their descriptions name a list of specific charge transaction identifiers, even though this example includes only one entry in each; a real call could unapply from, and apply to, several transactions in the same request. The field do_write is set to the string value "true", meaning Aria actually performs the move rather than merely previewing it. The fields rest_call and output_format are envelope fields added by the REST layer and are not part of the method's own documented arguments.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"unapplied_list": [
{
"unapplied_trans_id": 88041127,
"unapplied_amt": 45.69
}
],
"applied_list": [
{
"applied_trans_id": 88041205,
"applied_amt": 45.69
}
]
}
The error_code value of 0 and the error_msg value of "OK" indicate that the payment move completed without error. The unapplied_list and applied_list arrays each show the one representative entry matching this example's call; a response involving more transactions would list additional entries in each array reflecting every transaction affected by the move.