get_acct_charges_paid_status_m Guide
- Last updated
-
-
Save as PDF
-
The get_acct_charges_paid_status_m API returns the list of charges with balance/paid info to pay/unpay.
|
API Specification:
|
get_acct_charges_paid_status_m |
|
Required Fields:
|
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <charge_level_type>
- <charge_retrieval_type>d
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <charge_level_type> |
Determines whether to return charges at invoice level (along with non-invoice charges) or invoice lines level.
Allowable Values
| Values |
Description |
| 1 |
Returns charges at invoice level and other non-invoice charges (like balance transfers, dunning charges). |
| 2 |
Returns charges at the invoice line level. |
|
| <charge_retrieval_type> |
Determines whether to return the charges to be paid or unpaid.
Allowable Values
| Values |
Description |
| 1 |
Retrieve charges that are due for payment. |
| 2 |
Retrieve charges that were previously paid and are eligible to be unpaid. When this value is used, either 'invoice_no' or 'payment_transaction_id' must be provided. When both value is provided 'invoice_no' takes the precedence. |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<auth_key>, <client_no |
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)
|
<charge_retrieval_type>, <invoice_no>, <payment_transaction_id> |
1016: invalid input
Additional Comments: This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.
|
<charge_level_type>, <charge_retrieval_type> |
1110: "Inputs Conflict: " [input_field_name_1]+ " conflicts with "+ [input_field_name_2] + {repeat " and/or " +[input_field_name_n] }+ ", some_variable_text_stating_what_is_in_conflict."
|
<charge_level_type>, <master_plan_instance_no>, <cdid>, <charge_retrieval_type>, <payment_transaction_id>, <acct_no> |
2010: The payment ID is not valid or is not associated with account number.
|
<payment_transaction_id>, <acct_no> |
3004: Invoice does not exist
|
<invoice_no> |
5067: limit must be between 1 and 999.
|
<limit> |
5068: offset must be greater than or equal to zero.
|
<offset> |
14053: Invalid Master Plan Instance number
|
<master_plan_instance_no> |
14054: Invalid client Master Plan Instance identifier
|
<cdid> |
