Description

Gets a summary of invoice details for all accounts matching specified query

Inputs

Name	Type	Length	Required	Description
username	string	30	No	DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool.
password	string	1000	No	DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool.
client_no	long	12	Yes	Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key	string	32	Yes	Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
limit	long	12	No	The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records.
offset	long	12	No	The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.
query_string	string	1000	Yes	The criteria which all returned objects must match. Different objects have a different set of searchable criteria. Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC".

Querystring Keys

Key Name	Description
invoice_no	The Aria assigned ID of the invoice
acct_no	The Aria assigned ID of the account
user_id	The client defined user_id for the account
client_acct_id	Client-specified account identifier
amount
bill_date
due_date
paid_date
balance_forward
total_due
last_updated
aria_statement_no
acct_statement_seq_str
second_acct_statement_seq_str
custom_status_label	Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level
client_notes	Client specific custom invoice notes that can be edited at the invoice or pending invoice level
invoice_type_cd	This field identifies the type of the invoice generated: 'O' - Order based, 'F' - Full (anniversary) invoice and 'P' - Prorated invoice

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error
error_msg	string		No	Textual description of any error that occurred. "OK" if there was no error.
starting_record	long		No	This indicates the number of objects that were (or would be) skipped before beginning output.
total_records	long		No	This is the total number of objects that matched the provided criteria.
Start of invoice_summary_m hash
invoice_summary_m	hash		No	List of invoice_summary_m associated with this method.
Name	Type	Length	Required	Description
▶invoice_no	long		No	The Aria assigned ID of the invoice
▶acct_no	long		No	The Aria assigned ID of the account
▶user_id	string	100	No	The client defined user_id for the account
▶client_acct_id	string		No	Client-specified account identifier
▶amount	double		No
▶bill_date	string		No
▶due_date	string		No
▶paid_date	string		No
▶notify_date	string		No
▶recurring_bill_from_date	string		No	The recurring bill-from date.
▶recurring_bill_thru_date	string		No	The recurring bill-through date.
▶currency_cd	string		No
▶balance_forward	double		No
▶statement_balance_forward	double		No
▶total_due	double		No
▶comments	string		No
▶additional_comments	string		No
▶last_updated	string		No
▶aria_statement_no	long		No
▶acct_statement_seq_str	string		No
▶second_acct_statement_seq_str	string		No
▶voiding_event_no	long		No	The number given for a voided invoice
▶custom_status_label	string		No	Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level
▶client_notes	string		No	Client specific custom invoice notes that can be edited at the invoice or pending invoice level
▶invoice_type_cd	string		No	This field identifies the type of the invoice generated: 'O' - Order based, 'F' - Full (anniversary) invoice and 'P' - Prorated invoice
▶billing_group_no	long		No	Billing group for which the invoice was generated
▶client_billing_group_id	long		No	Client assigned billing group id for which the invoice was generated
▶usage_bill_from_date	string		No	Start date of the period for which usage was billed. The date is in the format yyyy-mm-dd.
▶usage_bill_thru_date	string		No	End date of the period for which usage was billed. The date is in the format yyyy-mm-dd.
▶overall_bill_from_date	string		No	The earliest date for this invoicing period.
▶overall_bill_thru_date	string		No	The latest date for this invoicing period.
End of invoice_summary_m hash