get_payments_on_invoice_m Guide
- Last updated
-
-
Save as PDF
Returns a list of payments that are applied against a given invoice.
| API Specification: |
get_payments_on_invoice_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <invoice_no>
|
Error Codes:
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1008: no line items provided
Associated Inputs: invoice_no
Additional Comments: There are no payments on the invoice.
|
<invoice_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
2001: transaction does not exist
Associated Inputs: invoice_no
|
<invoice_no> |
Additional Guidance
Output Fields
| Field Name |
Notes |
| <transaction_type> |
Allowable values
| Values |
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 |
| 7 (Deprecated) |
Out-of-band Electronic Credit |
| -7 (Deprecated) |
Voided Out-of-band Electronic Credit |
| 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 Disbursement |
| -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 |
| 24 |
Credit memo line |
| -24 |
Voided credit memo line |
|
| <is_voided> |
Allowable values
| Values |
Description |
| true |
true |
| false |
false |
|
| <payment_type> |
Allowable values
| Values |
Description |
| -1 |
External Payment |
| 0 |
Other |
| 1 |
Credit card |
| 2 |
Electronic Check (ACH) |
| 3 |
Pre-paid |
| 4 |
Net terms 30 |
| 5 |
Net terms 10 |
| 6 |
Net terms 15 |
| 7 |
Net terms 60 |
| 8 |
Click&Buy |
| 9 |
Net Terms 0 |
| 10 |
PayByCash |
| 11 |
PayPal Express Checkout |
| 12 |
Net Terms 45 |
| 13 |
Tokenized Credit Card |
| 14 |
Purchase Power |
| 15 |
Net Terms 35 |
| 16 |
Net Terms 75 |
| 17 |
Net Terms 90 |
| 18 |
Net Terms 120 |
| 19 |
Net Terms 25 |
| 26 |
Direct Debit |
|
| <payment_option> |
Allowable values
| Values |
Description |
| Methods |
Methods |
| Terms |
Terms |
|
| <payment_terms_type> |
Allowable values
| Values |
Description |
| EAN/GLN |
EAN/GLN |
| Net Terms |
Net Terms |
|
