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. |
invoice_no |
long |
The Aria-assigned unique identifier of a given invoice. |
outacct_no |
long |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
outclient_acct_id |
string |
This is the client-assigned identifier for the account. |
billing_group_no |
long |
The billing group number mapped against each master plan. |
client_billing_group_id |
string |
Client-defined billing group ID. |
master_plan_no |
long |
Aria-assigned plan number for the Master Plan Instance input filter. |
master_plan_name |
string |
The name of the master plan for the Master Plan Instance input filter. |
currency_cd |
string |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
bill_date |
string |
The date the invoice was billed. |
paid_date |
string |
The date the invoice was paid. |
amount |
double |
Debit amount applied by the invoice. |
credit |
double |
Credit amount applied by the invoice. |
recurring_bill_from |
string |
The recurring bill-from date. |
recurring_bill_thru |
string |
The recurring bill-through date. |
usage_bill_from |
string |
The usage bill from date. |
usage_bill_thru |
string |
The usage bill-through date of the invoice. |
is_voided_ind |
long |
A boolean value indicating if the invoice has been voided.
Allowable values for is_voided_ind:
Values |
Description |
0 |
0 |
1 |
1 |
|
client_master_plan_id |
string |
The client_plan_id of the given Master Plan Instance input filter. |
invoice_type_cd |
string |
This field identifies the type of the invoice generated
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 |
|
orig_invoice_no |
long |
The Aria generated unique invoice number of the original invoice. This field is populated on rebill invoices. |
rb_no |
long |
The Aria generated unique invoice number for the rebill invoice. This field is populated on the original invoice. |
rb_reason_cd |
long |
The Client-defined reason code for the rebill. |
rb_comments |
string |
Explanatory text for the rebill. |
rb_flag |
long |
Rebill indicator.
Allowable values for rb_flag:
Values |
Description |
1 |
Invoice is a rebill. |
0 or NULL |
Invoice is not a rebill. |
|
rb_status |
string |
Indicates whether the current invoice has been rebilled.
Allowable values for rb_status:
Values |
Description |
True |
Rebilled |
False |
Not rebilled |
|
recurring_bill_from_date |
string |
The recurring bill-from date. |
recurring_bill_thru_date |
string |
The recurring bill-through date. |