get_reversible_invs_by_payment_m
Summary
| API Name | get_reversible_invs_by_payment_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 34 |
Description
Returns the list of invoice transactions that were fully or partially paid by a given payment.
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 |
||||||||
| payment_transaction_id | long | Yes |
The payment transaction by which to search for invoices |
|||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||
| include_open_trans | long | 1 | No |
Allowed values:
|
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. |
|
| reversible_inv_trans | object | No | ||
| refund_open_trans | object | No |
reversible_inv_trans fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoiced_acct_no | long | No |
The Aria-assigned account ID which was invoiced |
|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| invoice_line_no | long | No |
The number of this particular line on the invoice |
|
| invoice_trans_id | long | No |
The Aria-assigned financial transaction ID corresponding to the invoice upon which this usage record was billed to the account holder. |
|
| invoice_trans_date | string | No |
The date of the invoice |
|
| invoice_trans_description | string | No |
The description of this invoice line |
|
| invoice_trans_amount | double | No |
The amount of this invoice |
|
| inv_trans_reversed_amount | double | No |
If any reversals have been previously booked, this is the total of those reversals |
|
| inv_trans_reversible_amount | double | No |
The remaining invoice reversible amount (inv_trans_payment_applied_amount - inv_trans_reversed_amount). There is one exception when parent Master Plan Instances (MPIs) are responsible for children. If there are multiple invoice charge lines for a child MPI, the inv_trans_reversible_amount is a combination of those charges since their sum would be transferred as a single balance transfer. Thus the inv_trans_reversible_amount may be less than what is displayed in those exceptions. |
|
| invoice_trans_is_recur_service | long | 2 | No |
Specifies whether or not this service is a recurring service. |
| invoice_trans_recur_start_date | string | No |
Specifies the start date of the recurring service. |
|
| inv_trans_payment_applied_amount | double | No |
The amount of payment applied to this invoice line item. There is one exception when parent Master Plan Instances (MPIs) are responsible for children. If there are multiple invoice charge lines for a child MPI, since their sum would be transferred as a single balance transfer, the inv_trans_payment_applied_amount is an indication of the max amount that can be considered as applied on that charge out of the total amount of the payment being refunded. Thus the sum of inv_trans_payment_applied_amount from all lines may not tally with the total payment amount in those exceptions. |
refund_open_trans fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| transaction_id | long | No |
Aria assigned identifier for this transaction |
|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| invoice_line_no | long | No |
The number of this particular line on the invoice |
|
| date_created | string | No |
The date of the transaction created. |
|
| description | string | No |
Text description of the transaction. |
|
| remaining_amt_to_open | double | No |
The remaining amount which could be opened through refund with opening line item. Amount is tax inclusive. |