The get_invoice_history_m API returns the invoice history for a specified master plan instance. The call can return invoices for all billing dates or only invoices for a particular billing date range.
| API Specification: |
get_invoice_history_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id> or <user_id>
- <master_plan_instance_id> or <client_master_plan_instance_id>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <master_plan_instance_id> |
You can:
- Pass in the Aria-generated unique identifier for the master plan instance (MPI) to get the invoice history of only that MPI; or
- Pass in -1 to get the invoice history of all MPIs for the specified account.
- If you pass in both a <master_plan_instance_id> and <filter_master_plan_instance> array details, then this API will return the history of all of your specified MPIs.
- If you pass -1 into the <master_plan_instance_id> field and you pass in <filter_master_plan_instance> array details, then this API will return the history of only the MPIs that you specified.
- If you pass -1 into this field, then the following outputs will be empty:<master_plan_no> (deprecated), <master_plan_name> (deprecated), and <client_master_plan_id> (deprecated).
|
| <include_voided> |
Allowable values
| Values |
Description |
| true |
true |
| false |
false |
|
| <rb_option> |
Allowable values
| Values |
Description |
| 0 or NULL |
The account history provided will include all invoices, including rebilled ones. (default) |
| 1 |
The account history provided will include only original invoices and will not return rebill invoices. |
| 2 |
For those invoices that have been rebilled, the account history provided will include only the rebilled ones. |
|
Output Fields
| Field Name |
Notes |
| <is_voided_ind> |
Allowable values for is_voided_ind:
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <invoice_type_cd> |
Allowable values for invoice_type_cd:
| Values |
Description |
| C |
Combined Invoice |
| F |
Anniversary Period Invoice |
| H |
Hybrid Invoice |
| O |
Order based Invoice |
| P |
Non-anniversary Subscription Invoice |
| R |
Rebill Invoice |
|
| <rb_flag> |
Allowable values
| Values |
Description |
| 1 |
Invoice is a rebill. |
| 0 or NULL |
Invoice is not a rebill. |
|
| <rb_status> |
Allowable values
| Values |
Description |
| True |
Rebilled |
| False |
Not rebilled |
|
| <include_payment_plan_info> |
Allowable values
| Values |
Description |
| True |
Include payment plan info. |
| False |
Do not include payment plan info. (default) |
If true, the following fields will be returned with info about any payment plans associated with the invoice:
| Output Field Name |
Description |
| <balance_due> |
Balance due amount. |
| <invoice_payment_plan_info> |
Array of payment plan information related to an invoice. |
| <payment_plan_create_date> |
Date when payment plan created. |
| <payment_plan_no> |
Aria-assigned payment plan no. |
| <client_payment_plan_id> |
Client-defined unique payment plan ID. |
| <invoice_initial_balance> |
The invoice initial balance to be paid at the time of payment plan creation. |
| <invoice_paid_amount> |
The invoice paid amount on a payment plan at the time of the API call. |
| <payment_plan_status> |
Specifies the other status of payment plan (active, completed, or cancelled). |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<auth_key>, <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>, <user_id> |
1024: invalid date format
Additional Comments: All date inputs must be in yyyy-mm-dd format.
|
<start_bill_date>, <end_bill_date> |
1033: a parameter that represents a true or false value contains invalid input
|
<include_voided> |
3097: The rb option is set to an invalid value.
|
<rb_option> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<plan_instance_no>, <master_plan_instance_id>, <filter_plan_instance_no>, <client_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
|
<client_plan_instance_id>, <client_master_plan_instance_id> |
