Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_invoice_summary_m
get_invoice_summary_m
get_invoice_summary_m
Table of contents
Gets a summary of invoice details for all accounts matching specified query.
Use this API as an alternative to get_invoice_information_m when filtering out search criteria in very large data sets. For information on error messages generated by this API, see get_invoice_summary_m Error Messages when it becomes available.
Input Arguments
| 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. |
|
query_string | string | 1000 | 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". |
| limit | long | 12 | 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 | The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records. |
Querystring Keys
| Key Name | Description |
|---|---|
| acct_no | The Aria assigned ID of the account |
| client_acct_id | Client-specified account identifier |
| balance_forward | Previous balance on an account that was carried over to the next billing period |
| last_updated | Most recent date on which the invoice was updated |
| paid_date | Date on which the invoice was paid |
| bill_date | The date on which the account was billed for the invoice. Use the format yyyy-mm-dd. |
| due_date | Date on which payment for an invoice was due |
| aria_statement_no | The unique, Aria-assigned statement number with which an invoice is associated |
| acct_statement_seq_str | Client-defined invoice identifier. This may be a combination of elements such as the customer's ISO country code and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering. |
| second_acct_statement_seq_str | Additional client-defined invoice identifier. This may be a combination of elements such as the customer's bank account number and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering. |
| 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: 'C' - Combined Invoice, 'F' - Anniversary Period Invoice, 'H' - Hybrid Invoice, 'O' - Order-based Invoice, 'P' - Non-anniversary Subscription Invoice, and 'R' - Rebill Invoice. |
| billing_group_no | Billing group for which the invoice was generated |
| client_billing_group_id | Client assigned billing group id for which the invoice was generated |
| pay_method_type | Integer values for the Aria supported payment method types. Allowable values are: 1, 0, 1-19 and 26 |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| starting_record | long | This indicates the number of objects that were (or would be) skipped before beginning output. |
| total_records | long | This is the total number of objects that matched the provided criteria. |
| invoice_summary_m | hash | Summarized invoice information for any accounts matching the query |
 invoice_no |
long | The Aria assigned ID of the invoice. The API returns data when you pass a real invoice_no. But when you pass a pending invoice_no, API does not return data. |
| acct_no |
long | The Aria assigned ID of the account |
| client_acct_id |
string | Client-specified account identifier |
| amount |
double | Total amount charged for the invoice |
| bill_date |
string | The date on which the account was billed for an invoice. The date is in the format yyyy-mm-dd. |
| due_date |
string | Date on which payment for an invoice was due |
| paid_date |
string | Date on which the invoice was paid |
| notify_date |
string | Date on which the statement was sent to the account holder |
| recurring_bill_from_date |
string | The recurring bill-from date. |
| recurring_bill_thru_date |
string | The recurring bill-through date. |
| currency_cd |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
| balance_forward |
double | Previous balance on an account that was carried over to the next billing period |
| statement_balance_forward |
double | Balance on a statement that reflects all activity dated between from_date and to_date |
| total_due |
double | Total balance due on the invoice |
| comments |
string | Any client-defined comments entered on an invoice by a CSR (Customer Service Representative) or by the system, if any |
| additional_comments |
string | Comments entered by a CSR when placing an order or passed into the order_comments field in the create_order_m API. |
| last_updated |
string | Most recent date on which the invoice was updated |
| user_id |
The client defined user_id for the account | |
| aria_statement_no |
long | The unique, Aria-assigned statement number with which an invoice is associated |
| acct_statement_seq_str |
string | An alternate statement number, which may be a combination of elements such as the account's ISO country code and the statement number depending on your client configuration. Please contact Aria Customer Support for information and setup related to alternate statement numbering. |
| second_acct_statement_seq_str |
string | An additional alternate statement number, which may be a combination of elements such as the account's ISO country code and the customer's bank account number depending on your client configuration. Please contact Aria Customer Support for information and setup related to alternate statement numbering. |
| voiding_event_no |
long | The number given for a voided invoice |
| custom_status_label |
string | Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level |
| client_notes |
string | Client specific custom invoice notes that can be edited at the invoice or pending invoice level |
| invoice_type_cd |
string | This field identifies the type of the invoice generated: 'C' - Combined Invoice, 'F' - Anniversary Period Invoice, 'H' - Hybrid Invoice, 'O' - Order based Invoice, ''P' - Non-anniversary Subscription Invoice, 'R' - Rebill Invoice |
| billing_group_no |
long | Billing group for which the invoice was generated |
| client_billing_group_id |
long | Client assigned billing group id for which the invoice was generated |
| usage_bill_from_date |
string | Start date of the period for which usage was billed. The date is in the format yyyy-mm-dd. |
| usage_bill_thru_date |
string | End date of the period for which usage was billed. The date is in the format yyyy-mm-dd. |
| overall_bill_from_date |
string | The earliest date for this invoicing period. |
| overall_bill_thru_date |
string | The latest date for this invoicing period. |
- © Copyright 2023 Aria Developer Central