Skip to main content
Aria Knowledge Central

get_payments_on_invoice_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_payments_on_invoice_m
Class transaction_services_m
Update Version 6.33

Description

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

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 No

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
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
invoice_no long   Yes

The Aria-assigned unique identifier of a given invoice.

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.
invoice_payment_details object   No

Array of invoice payments returned upon succesful completion of the API call.

See fields below

invoice_payment_details fields

Name Type Length Required Description
transaction_id long 22 No

The unique identifier for a given transaction
transaction_type long 3 No

Aria-assigned identifier for this type of transaction

Allowed values:

Value Description
1 Invoice
-1 Voided Invoice
2 check
-2 Voided Check
3 Electronic Payment
-3 Voided Electronic Payment
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
6 Write Off
-6 Voided Write Off
8 Refund Request
-8 Voided Refund Request
9 Balance Forward
-9 Voided Balance Forward
10 Cash Credit
-10 Voided Cash Credit
11 Credit From Overpayment
-11 Voided Credit From Overpayment
12 Electronic Refund Disbursement
-12 Voided Electronic Refund Disbursement
13 Check Refund Disbursementt
-13 Voided Check Refund Disbursement
14 External charge
-14 Voided External Charge
15 Dunning Charge
-15 Voided Dunning Charge
16 reinstated Charge transaction
-16 voided reinstated Charge transaction
17 reinstated Payment transaction
-17 voided reinstated payment transaction
18 Negative Balance Forward
-18 Voided Negative Balance Forward
19 3rd party payment
-19 voided 3rd party payment
20 3rd party payment refund
-20 voided 3rd party payment refund
21 Invoice charge line item
-21 Voided Invoice charge line item
22 Invoice credit line item
-22 Voided Invoice credit line item
description string   No

Text description of the transaction
amount double   No

Total monetary value of this transaction
applied_amount double   No

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   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
transaction_date string   No

Date the transaction was executed.
is_voided string   No

A return value of "true" here indicates the transaction has been voided.

Allowed values:

Value Description
True  
False  
statement_no long   No

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   No

For payment transactions only, the type of payment (e.g. Credit Card).

Allowed values:

Value Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Deprecated Net Terms 30 - use Payment Terms
5 Deprecated Net Terms 10 - use Payment Terms
6 Deprecated Net Terms 15 - use Payment Terms
7 Deprecated Net Terms 60 - use Payment Terms
8 Click&Buy
9 Deprecated Net Terms 0 - use Payment Terms
10 PayByCash
11 PayPal Express Checkout
12 Deprecated Net Terms 45 - use Payment Terms
13 Tokenized Credit Card
14 Purchase Power
15 Deprecated Net Terms 35 - use Payment Terms
16 Deprecated Net Terms 75 - use Payment Terms
17 Deprecated Net Terms 90 - use Payment Terms
18 Deprecated Net Terms 120 - use Payment Terms
19 Deprecated Net Terms 25 - use Payment Terms
26 Direct Debit
48 Tokenized ACH Payment
payment_src_description string   No

For electronic payment transactions, the granular type of the source of the payment (e.g. American Express). For external payment transactions, it returns the description of the payment source, if previously provided
payment_src_suffix string   No

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 50 No

Client-defined unique identifier used to track related system actions
seq_statement_id string   No

The unique sequential statement number.
payment_method_no long 22 No

Aria-assigned sequence number for this payment method.
client_payment_method_id string   No

The client-defined identifier of the payment method used for payment.
reason_code long   No

Client-defined reason code for the transaction
reason_description string   No

Client-defined reason code description
payment_option string 7 No

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'

Allowed values:

Value Description
Methods  
Terms  
client_payment_term_id string 32 No

Client Payment Term ID from Payment Terms configuration.
payment_terms_name string 50 No

Payment Terms Name from Payment Terms configuration.
payment_terms_no long 22 No

Payment Terms Number from Payment Terms configuration.
ean_gln_num string 50 No

'EAN or GLN Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
ean_gln_requisition_num string 50 No

'EAN or GLN Requisition Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
bill_email string 50 No

Email of the billing contact.
payment_terms_type string 50 No

Payment Terms Type from Payment Terms configuration.

Allowed values:

Value Description
EAN/GLN  
Net Terms  
payment_src_cc_prefix string 6 No

The first 6 digit of the credit card number of the payment.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.