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

 

Home > Aria6 core api > get_payments_on_invoice

get_payments_on_invoice

Returns a list of credit transactions that have been applied against a particular charge transaction for a specified account.

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.
src_transaction_id long 22 Either the Aria transaction ID or the Aria invoice number for the invoice
  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.
invoice_payments hash Array of invoice payments returned upon succesful completion of the API call.
transaction_id long The unique identifier for a given transaction
transaction_type long Aria-assigned identifier for this type of transaction  Allowable Values
description string Text description of the transaction
amount double Total monetary value of this transaction
applied_amount double For transaction types that decrease an accounts balance (e.g. Payments) the amount of this transaction applied to date to charge transactions on the account.
currency_code string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
transaction_date string Date the transaction was executed.
is_voided string A return value of "true" here indicates the transaction has been voided.  Allowable Values
statement_no long If the given transaction has been included within a statement (an Aria-generated internal grouping of all financial transactions on this account within a given period), the Aria-assigned identifier of that statement.
payment_type string For payment transactions only, the type of payment (e.g. Credit Card).  Allowable Values
payment_src_description string For electronic payment transactions only, the granular type of the source of the payment (e.g. American Express)
payment_src_suffix string For electronic payment transactions only, the last 4 digits of the account (e.g. the last 4 digits if the credit card used).
client_receipt_id string Client-defined unique identifier used to track related system actions
seq_statement_id string The unique sequential statement number.

You must to post a comment.
Last modified
10:48, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.