get_reversible_invs_by_payment_m Guide

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

The get_reversible_invs_by_payment_m API returns the list of invoice transactions that were fully or partially paid by a given payment.

Note: If using this API to retrieve eligible payment details for a refund with open paid line items, you should pass 1 or 2 at the <include_open_trans> input field.

API Specification:	get_reversible_invs_by_payment_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <payment_transaction_id>

Input Fields

Field Name

Notes

<include_open_trans>

Optional input

Allowable Values

Values	Description
0 (default)	exclude <refund_open_trans> hash, which excludes details of invoice line items open by refund with opening line items. If it’s null, it will be treated as the default.
1	include transactions that can be opened with refund with opening line items.
2	output only <refund_open_trans> hash, exclude <reversible_inv_trans> hash

Output Fields

Field Name	Notes
<refund_open_trans>	Array
<transaction_id>	Aria-assigned identifier for this transaction
<invoice_no>	The Aria-assigned unique identifier of a given invoice
<invoice_line_no>	The number of this particular line on the invoice
<date_created>	The date the transaction was created
<description>	Text description of the transaction
<remaining_amt_to_open>	The remaining amouint which could be opened through refund with opening line item. Amount is tax inclusive.

Error Codes

Error Code/Description	Associated Inputs
1016: invalid input Additional Comments: This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.	Invalid Input for <include_open_trans>. Allowed values are 0, 1, 2 or NULL