The apply_cash_credit_m API applies a cash credit to an account, account-level charge, invoice, or invoice charge.
| API Specification: |
apply_cash_credit_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <credit_reason_cd>
|
Additional Guidance
Output Fields
| Field Name |
Notes |
| transaction_type |
Transaction type to search account history for
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 |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<auth_key>, <client_acct_id>, <client_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)
|
<acct_no>, <client_acct_id> |
2001: transaction does not exist
|
<invoice_no> |
3004: Invoice does not exist
|
<invoice_no> |
20012: invalid credit reason code
|
|
20019: credit amount cannot be negative or zero
|
|
20032: Cash credit amount cannot exceed account balance.
|
|
20033: Credit amount exceeds available unpaid balance.
|
|
