Req | Field Name | Field Type | Max Length | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||||
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||
OR | ||||||||||||
client_acct_id | string | 50 | Client-defined account identifier. | |||||||||
OR | ||||||||||||
user_id | string | 32 | Account's user ID. Alternative to using acct_no. | |||||||||
![]() |
master_plan_instance_id | long | 22 |
You can:
Note:
|
||||||||
OR | ||||||||||||
client_master_plan_instance_id | string | 100 | Client-defined unique identifier for the master plan instance. | |||||||||
start_bill_date | string | 10 | The beginning of the date range to search for account invoices. | |||||||||
end_bill_date | string | 10 | The end of the range to search for invoice history on the account. | |||||||||
include_voided | string | 5 | Include voided invoices in the search results.
Allowable values for include_voided:
|
|||||||||
rb_option | long | 1 | Filters the return results of the api call.
Allowable values for rb_option:
|
|||||||||
Start of <filter_master_plan_instance> array | ||||||||||||
filter_master_plan_instance | array |
Array of MPIs for which you want to get the invoice history. Note:
|
||||||||||
![]() |
string | 100 | Aria-generated unique identifier for the master plan instance. | |||||||||
OR | ||||||||||||
![]() |
string | 100 | Client-defined unique identifier for the master plan instance. | |||||||||
End of <filter_master_plan_instance> array | ||||||||||||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||||
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Field Name | Field Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. | ||||||||||||||
error_msg | string | Description of any error that occurred. "OK" if there was no error. | ||||||||||||||
invoice_hist | hash | Array of invoices. | ||||||||||||||
![]() |
long | The Aria-assigned unique identifier of a given invoice. | ||||||||||||||
![]() |
long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||||||||
![]() |
string | This is the client-assigned identifier for the account. | ||||||||||||||
![]() |
long | The billing group number mapped against each master plan. | ||||||||||||||
![]() |
string | Client-defined billing group ID. | ||||||||||||||
![]() |
long | Aria-assigned plan number for the Master Plan Instance input filter. | ||||||||||||||
![]() |
string | The name of the master plan for the Master Plan Instance input filter. | ||||||||||||||
![]() |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | ||||||||||||||
![]() |
string | The date the invoice was billed. | ||||||||||||||
![]() |
string | The date the invoice was paid. | ||||||||||||||
![]() |
double | Debit amount applied by the invoice. | ||||||||||||||
![]() |
double | Credit amount applied by the invoice. | ||||||||||||||
![]() |
string | The recurring bill-from date. | ||||||||||||||
![]() |
string | The recurring bill-through date. | ||||||||||||||
![]() |
string | The usage bill from date. | ||||||||||||||
![]() |
string | The usage bill-through date of the invoice. | ||||||||||||||
![]() |
long | A boolean value indicating if the invoice has been voided.
Allowable values for is_voided_ind:
|
||||||||||||||
![]() |
string | The client_plan_id of the given Master Plan Instance input filter. | ||||||||||||||
![]() |
string | This field identifies the type of the invoice generated
Allowable values for invoice_type_cd:
|
||||||||||||||
![]() |
long | The Aria generated unique invoice number of the original invoice. This field is populated on rebill invoices. | ||||||||||||||
![]() |
long | The Aria generated unique invoice number for the rebill invoice. This field is populated on the original invoice. | ||||||||||||||
![]() |
long | The Client-defined reason code for the rebill. | ||||||||||||||
![]() |
string | Explanatory text for the rebill. | ||||||||||||||
![]() |
long | Rebill indicator.
Allowable values for rb_flag:
|
||||||||||||||
![]() |
string | Indicates whether the current invoice has been rebilled.
Allowable values for rb_status:
|
||||||||||||||
recurring_bill_from_date | string | The recurring bill-from date. | ||||||||||||||
recurring_bill_thru_date | string | The recurring bill-through date. |