get_invoice_summary_m Sample Call and Response
This example queries for a summary of invoices on a specific account across a six-month billing window, based on the get_invoice_summary_m method defined in app_m_r73.yml for the Object Query API. Unlike get_invoice_information_m and get_all_invoice_information_m, this method returns only invoice-level totals and dates, with no nested invoice_line_m array of individual charges.
This example includes every required argument, along with a query_string built from queryable fields that narrows the search to one account and a date range, and a representative pair of invoice summaries. It does not attempt to show every optional field this method can return.
Sample call
{
"rest_call": "get_invoice_summary_m",
"output_format": "json",
"client_no": 60214,
"auth_key": "3f9c2b7a-91de-4a2c-88fb-4e6d0a5c7f21",
"query_string": "acct_no = 30182034 AND bill_date >= \"2026-01-01\" AND bill_date <= \"2026-06-30\"",
"limit": 10,
"offset": 0
}
client_no and auth_key are required identifiers, and query_string is also required for this method, since the shared param_defaults definition marks it nullable false. The query_string in this example uses acct_no and bill_date, both of which carry queryable true directly under invoice_summary_m; other legal filter fields include invoice_no, user_id, client_acct_id, amount, 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, client_notes, and invoice_type_cd. output_format and rest_call are envelope fields added by the REST gateway rather than being part of the method's own documented arguments. limit and offset are optional paging controls.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"starting_record": 0,
"total_records": 3,
"invoice_summary_m": [
{
"invoice_no": 771234,
"acct_no": 30182034,
"user_id": "jrivera_novara",
"client_acct_id": "ACCT-10493",
"invoice_type_cd": "F",
"amount": 128.50,
"bill_date": "2026-06-01",
"due_date": "2026-06-15",
"paid_date": "2026-06-10",
"currency_cd": "USD",
"balance_forward": 0.00,
"total_due": 128.50,
"last_updated": "2026-06-10",
"aria_statement_no": 550991,
"overall_bill_from_date": "2026-06-01",
"overall_bill_thru_date": "2026-06-30"
},
{
"invoice_no": 768840,
"acct_no": 30182034,
"user_id": "jrivera_novara",
"client_acct_id": "ACCT-10493",
"invoice_type_cd": "F",
"amount": 128.50,
"bill_date": "2026-01-01",
"due_date": "2026-01-15",
"paid_date": "2026-01-11",
"currency_cd": "USD",
"balance_forward": 0.00,
"total_due": 128.50,
"last_updated": "2026-01-11",
"aria_statement_no": 548102,
"overall_bill_from_date": "2026-01-01",
"overall_bill_thru_date": "2026-01-31"
}
]
}
An error_code of zero with an error_msg of "OK" indicates the query succeeded. total_records is set to three to show that this account has more invoices within the queried six-month window than this example displays; only the first two entries are shown in invoice_summary_m, and the real array would continue with a third invoice, most likely one of the months falling between the two shown here. Because this method returns only summary-level fields, no invoice_line_m array is present, unlike the line-item detail returned by get_invoice_information_m. This example leaves out voiding_event_no, billing_group_no, and client_billing_group_id, all three of which are explicitly marked queryable false, along with custom_status_label, client_notes, comments, and additional_comments, since neither invoice in this example carries a custom label or comment. The deprecated username and password arguments, which carry a deprecate_version of 5.6 in the shared param_defaults block, are omitted from the sample call for the same reason.