Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > get_reversible_invs_by_payment_m

get_reversible_invs_by_payment_m

Returns the list of invoice transactions that were fully or partially paid by a given payment.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
payment_transaction_id long   The payment transaction by which to search for invoices
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
reversible_inv_trans hash  
invoiced_acct_no long The Aria-assigned account ID which was invoiced
invoice_no long The Aria-assigned unique identifier of a given invoice.
invoice_line_no long The number of this particular line on the invoice
invoice_trans_id long 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 The date of the invoice
invoice_trans_description string The description of this invoice line
invoice_trans_amount double The amount of this invoice
inv_trans_reversed_amount double If any reversals have been previously booked, this is the total of those reversals
inv_trans_reversible_amount double The remaining invoice balance which could be reversed
invoice_trans_is_recur_service long Specifies whether or not this service is a recurring service.
invoice_trans_recur_start_date string Specifies the start date of the recurring service.

You must to post a comment.
Last modified
09:45, 27 Jul 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.