Home > Aria Crescendo Documentation > Aria Crescendo core api > get_payments_on_invoice_m


Returns a list of payments that are applied against a given invoice.

For information on error messages generated by this API, see get_payments_on_invoice_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  client_acct_id string 50 Client-defined account identifier.
required-icon.png invoice_no long 22 The Aria-assigned unique identifier of a given 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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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_payment_details hash Array of invoice payments returned upon succesful completion of the API call.
brd_arrow.gif transaction_id long The unique identifier for a given transaction
brd_arrow.gif transaction_type long Aria-assigned identifier for this type of transaction   Allowable Values
brd_arrow.gif description string Text description of the transaction
brd_arrow.gif amount double Total monetary value of this transaction
brd_arrow.gif 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.
brd_arrow.gif currency_code string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif transaction_date string Date the transaction was executed.
brd_arrow.gif is_voided string A return value of "true" here indicates the transaction has been voided.   Allowable Values
brd_arrow.gif 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.
brd_arrow.gif payment_type string For payment transactions only, the type of payment (e.g. Credit Card).   Allowable Values
brd_arrow.gif payment_src_description string For electronic payment transactions only, the granular type of the source of the payment (e.g. American Express)
brd_arrow.gif 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).
brd_arrow.gif client_receipt_id string Client-defined unique identifier used to track related system actions
brd_arrow.gif seq_statement_id string The unique sequential statement number.
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gif client_payment_method_id string The client-defined identifier of the payment method used for payment.
brd_arrow.gif reason_code long Client-defined reason code for the transaction
brd_arrow.gif reason_description string Client-defined reason code description
brd_arrow.gif payment_option string This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'   Allowable Values
brd_arrow.gif client_payment_term_id string Client Payment Term ID from Payment Terms configuration.
brd_arrow.gif payment_terms_name string Payment Terms Name from Payment Terms configuration.
brd_arrow.gif payment_terms_no long Payment Terms Number from Payment Terms configuration.
brd_arrow.gif ean_gln_num string 'EAN or GLN Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
brd_arrow.gif ean_gln_requisition_num string 'EAN or GLN Requisition Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
brd_arrow.gif bill_email string Email of the billing contact.
brd_arrow.gif payment_terms_type string Payment Terms Type from Payment Terms configuration.   Allowable Values
Last modified


This page has no custom tags.


This page has no classifications.