get_payments_on_invoice_m Sample Call and Response
This example retrieves the list of payments applied against a given invoice, based on the get_payments_on_invoice_m method defined in plsql_m_r73.yml.
This example shows two representative payments applied to the same invoice, one by credit card and one an externally recorded payment, to illustrate that an invoice can be paid through more than one payment source; it does not show every optional field this method can return.
Sample call
{
"rest_call": "get_payments_on_invoice_m",
"output_format": "json",
"client_no": 100848,
"auth_key": "8cfb51c1c9110f4152c",
"acct_no": 5017732,
"invoice_no": 7723410
}
The account is identified by acct_no rather than by its alternative, client_acct_id. The invoice_no field is required and identifies the invoice whose applied payments are being retrieved.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"invoice_payment_details": [
{
"transaction_id": 48820150,
"transaction_type": 7,
"description": "Credit card payment",
"amount": 102.50,
"applied_amount": 102.50,
"currency_code": "usd",
"transaction_date": "2026-02-15T09:03:00Z",
"is_voided": "false",
"statement_no": 990211,
"payment_type": "1",
"payment_src_description": "Visa",
"payment_src_suffix": "4471",
"payment_src_cc_prefix": "411111",
"client_receipt_id": "RCPT-20260215-01",
"seq_statement_id": "SEQ-000883",
"payment_method_no": 774221,
"client_payment_method_id": "CARD-END-4471",
"bill_email": "dana.brooks@example.com"
},
{
"transaction_id": 48820162,
"transaction_type": 7,
"description": "External wire payment",
"amount": 50.00,
"applied_amount": 50.00,
"currency_code": "usd",
"transaction_date": "2026-02-18T11:47:00Z",
"is_voided": "false",
"statement_no": 990211,
"payment_type": "-1",
"payment_src_description": "Wire transfer confirmation provided by customer",
"client_receipt_id": "RCPT-20260218-02"
}
]
}
An error_code of zero and an error_msg of "OK" indicate the request completed successfully. The transaction_type value of 7 is an Aria-assigned transaction type code from the Transaction Types legend; consult that legend for the full list of codes. The first payment has a payment_type of "1", meaning Credit card, and shows the last four digits and first six digits of the card in payment_src_suffix and payment_src_cc_prefix; the second payment has a payment_type of "-1", meaning External Payment, which Aria recorded from a source outside its own payment processing, so fields specific to electronic payments, such as payment_src_suffix and payment_method_no, do not apply and are left out. The invoice_payment_details array would contain additional entries for an invoice paid through more payments; this example shows only two. This example omits the reason_code, reason_description, client_payment_term_id, payment_terms_name, payment_terms_no, payment_terms_type, ean_gln_num, and ean_gln_requisition_num fields, since those apply to adjustment and payment-terms scenarios rather than the electronic and external payments shown here, and it omits error_details, since that field is marked nonpublic.