get_invoice_information_m Sample Call and Response
This example queries for full, anniversary-cycle invoices on a specific account, including their line items and line-level tax detail, based on the get_invoice_information_m method defined in app_m_r73.yml for the Object Query API. Unlike get_all_invoice_information_m, this method does not distinguish real from pending invoices; instead, its invoice_type_cd field distinguishes order-based, full anniversary, and prorated invoices.
This example includes every required argument, along with a query_string built from queryable fields, and a representative pair of invoices, each with one line item and one tax line. It does not attempt to show every invoice line item type or every optional field this method can return.
Sample call
{
"rest_call": "get_invoice_information_m",
"output_format": "json",
"client_no": 60214,
"auth_key": "3f9c2b7a-91de-4a2c-88fb-4e6d0a5c7f21",
"query_string": "acct_no = 30182034 AND invoice_type_cd = \"F\" AND bill_date >= \"2026-01-01\"",
"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, invoice_type_cd, and bill_date, all of which carry queryable true directly under invoice_details_m. invoice_type_cd is documented with three values: "O" for order-based, "F" for full anniversary, and "P" for prorated invoices; this example filters on "F" to return only full anniversary-cycle invoices. 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, and client_notes at the invoice level, along with master_plan_instance_id, client_master_plan_instance_id, invoice_transaction_id, and po_num at the invoice-line level. 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_details_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,
"invoice_line_m": [
{
"line_item_no": 1,
"plan_name": "Gold Support Plan",
"plan_no": 140,
"service_name": "Support Services",
"amount": 120.00,
"master_plan_instance_id": 9004471,
"client_master_plan_instance_id": "MPI-NOVARA-01",
"rate_schedule_no": 4415,
"custom_rate_ind": 0,
"tax_inclusive_ind": 0,
"invoice_line_tax_m": [
{
"tax_id": 88213,
"amount": 8.50,
"jurisdiction": "TX State Sales Tax",
"description": "Texas state sales tax",
"is_excluded": 0
}
]
}
]
},
{
"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,
"invoice_line_m": [
{
"line_item_no": 1,
"plan_name": "Gold Support Plan",
"plan_no": 140,
"service_name": "Support Services",
"amount": 120.00,
"master_plan_instance_id": 9004471,
"client_master_plan_instance_id": "MPI-NOVARA-01",
"rate_schedule_no": 4415,
"custom_rate_ind": 0,
"tax_inclusive_ind": 0,
"invoice_line_tax_m": [
{
"tax_id": 88213,
"amount": 8.50,
"jurisdiction": "TX State Sales Tax",
"description": "Texas state sales tax",
"is_excluded": 0
}
]
}
]
}
]
}
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 full anniversary invoices within the queried date range than this example displays; only the first two entries are shown in invoice_details_m, and the real array would continue with a third invoice. Both invoices shown carry the same recurring charge for the Gold Support Plan and the same Texas sales tax line, illustrating a stable recurring billing pattern across anniversary cycles. This example leaves out the deprecated from_date and to_date fields, which carry a deprecate_version of 44 in the yml, and it leaves out voiding_event_no, billing_group_no, and client_billing_group_id, all three of which are explicitly marked queryable false, along with transaction_type on the invoice line, which is also marked queryable false. custom_status_label, client_notes, comments, and additional_comments are also omitted, 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.