get_payment_application_dtls_m
Summary
| API Name | get_payment_application_dtls_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 34 |
Description
Returns the list of invoices on which the payment has been applied. Also returns the invoice line item details related to the payment application.
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 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
| transaction_id | long | 22 | Yes |
Payment transaction ID for which the application details are to be retrieved. |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
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. |
|
| payment_application_details | object | No |
An Array of account payment application details. |
payment_application_details.applied_transactions fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| transaction_id | long | No |
Id of the specific invoice transaction. |
|
| original_amount | double | No |
Original amount of the transaction. |
|
| amount_applied | double | No |
Amount of the payment applied to the transaction. |
|
| date_applied | string | No |
Payment application date. |
payment_application_details fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| invoice_date | string | No |
Specifies Invoice Date. The date is in the format yyyy-mm-dd |
|
| invoice_from_date | string | No |
Specifies Invoice From Date. The date is in the format yyyy-mm-dd |
|
| invoice_to_date | string | No |
Specifies Invoice To Date. The date is in the format yyyy-mm-dd. |
|
| invoice_pay_applied_amount | double | No |
Specifies the payment amount applied on the invoice by this transaction. |
|
| invoice_overall_paid_amount | double | No |
Specifies the total payment amount applied on the invoice by all transactions. |
|
| invoice_charge | double | No |
Specifies the Invoice Charge Amount |
|
| invoice_credit | double | No |
Specifies the Invoice Credit Amount. |
|
| invoice_bal_due | double | No |
Specifies the Invoice Balance Amount. |
|
| applied_transactions | object | No |
Array of specific invoice transactions that the payment was applied to. |
|
| invoice_due_date | string | No |
Specifies the Invoice due date |