get_invoice_details_m Sample Call and Response
This example retrieves the itemized line items, tax breakdown, and header details of a specific invoice, based on the plsql_m_r73.yml definition file for Aria release 73.
This example includes every required field and a representative set of commonly used optional fields, not every field the method accepts. The sample response shows an invoice with a recurring plan charge, a usage overage charge, and a tax line, along with two associated tax detail records; it does not cover payment installment schedules, since this invoice is paid in full on a single due date rather than through a payment plan.
Sample call
{
"rest_call": "get_invoice_details_m",
"output_format": "json",
"client_no": 100234,
"auth_key": "8f3d9c2e1b7a4f6d9e0c1a2b3d4e5f60",
"acct_no": 300118842,
"invoice_no": 8820441,
"master_plan_instance_no": 550219
}
The rest_call and output_format fields are envelope fields added by the REST layer; they are not part of the method's own documented arguments. For the account identifier, this example uses acct_no rather than its alternative, client_acct_id. The invoice_no field is required and identifies the invoice being retrieved. The optional master_plan_instance_no field narrows the returned line items to those associated with one master subscription plan instance; its alternative, client_master_plan_instance_id, is not used here. The locale_no and locale_name fields, which control the language of the returned text, are left out of this example.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"invoice_line_details": [
{
"line_no": 1,
"service_no": 41200,
"service_name": "Business Voice Unlimited",
"units": 1,
"rate_per_unit": 149.00,
"amount": 149.00,
"description": "Monthly recurring charge for Business Voice Unlimited",
"plan_no": 5521,
"plan_name": "Business Voice Unlimited",
"client_sku": "SKU-VOICE-UNL",
"client_service_id": "SVC-VOICE-01",
"client_plan_id": "PLAN-VOICE-UNL",
"plan_instance_no": 771034,
"client_plan_instance_id": "PI-ACME-VOICE-01",
"rate_schedule_no": 9001,
"client_rate_schedule_id": "RS-VOICE-STD-01",
"tax_related_ind": 0,
"custom_rate_ind": 0
},
{
"line_no": 2,
"service_no": 41205,
"service_name": "Data Overage",
"units": 25.5,
"rate_per_unit": 2.00,
"amount": 51.00,
"description": "Data usage overage charges for May 2026",
"usage_type_no": 12,
"usage_type_cd": "DATA_GB",
"plan_no": 5533,
"plan_name": "Business Data 500GB",
"client_sku": "SKU-DATA-500",
"client_service_id": "SVC-DATA-01",
"client_plan_id": "PLAN-DATA-500",
"plan_instance_no": 771035,
"client_plan_instance_id": "PI-ACME-DATA-01",
"tax_related_ind": 0,
"custom_rate_ind": 0
},
{
"line_no": 3,
"service_no": 90001,
"service_name": "Sales Tax",
"amount": 12.00,
"description": "State and local sales tax",
"tax_related_ind": 1,
"custom_rate_ind": 0
}
],
"tax_details": [
{
"tax_detail_line": 3,
"seq_num": 3,
"taxed_seq_num": 1,
"debit": 9.00,
"tax_authority_level": 1,
"tax_rate": 6.00,
"orig_was_tax_inclusive": 0,
"tax_srv_tax_type_id": "STATE_SALES_TAX",
"tax_srv_tax_type_desc": "State Sales Tax",
"tax_srv_cat_text": "Sales and Use Tax",
"tax_srv_juris_nm": "California",
"tax_srv_tax_sum_text": "CA State Sales Tax 6.00 percent"
},
{
"tax_detail_line": 3,
"seq_num": 3,
"taxed_seq_num": 2,
"debit": 3.00,
"tax_authority_level": 0,
"tax_rate": 2.00,
"orig_was_tax_inclusive": 0,
"tax_srv_tax_type_id": "FED_EXCISE_TAX",
"tax_srv_tax_type_desc": "Federal Communications Excise Tax",
"tax_srv_cat_text": "Communications Tax",
"tax_srv_juris_nm": "United States",
"tax_srv_tax_sum_text": "US Federal Excise Tax 2.00 percent"
}
],
"custom_status_label": "Reviewed",
"custom_status_desc": "Invoice reviewed and approved by billing operations before dispatch.",
"client_notes": "Quarterly service renewal invoice.",
"invoice_type_cd": "F",
"billing_group_no_2": 62110,
"client_billing_group_no": "BG-ACME-MAIN",
"acct_locale_name": "English (United States)",
"acct_locale_no_2": 1,
"rb_flag": 0,
"rb_status": "False",
"is_pending_ind_2": 0,
"overall_bill_from_date": "2026-05-01",
"overall_bill_thru_date": "2026-05-31",
"recurring_bill_from_date": "2026-05-01",
"recurring_bill_thru_date": "2026-05-31",
"usage_from_date": "2026-05-01",
"usage_to_date": "2026-05-31"
}
An error_code value of 0 and an error_msg value of “OK” indicate the call succeeded. The invoice_line_details array would contain one entry for every line item on the invoice; this example shows three entries, a recurring plan charge, a usage overage charge, and the resulting tax line, to illustrate the range of charge types this array can hold. The tax_details array would contain one entry for every tax jurisdiction applied to the invoice; this example shows two entries, a state sales tax and a federal excise tax, both tied back to the tax line through tax_detail_line and taxed_seq_num. The invoice_type_cd value of “F” indicates a full invoice; the other allowable values are “O” for an order-based invoice and “P” for a prorated invoice. The rb_flag value of 0 and rb_status value of “False” indicate this invoice is not a rebill. This example uses the non-deprecated billing_group_no_2, is_pending_ind_2, and acct_locale_no_2 fields instead of their deprecated counterparts, billing_group_no, is_pending_ind, and acct_locale_no, and uses overall_bill_from_date, overall_bill_thru_date, recurring_bill_from_date, and recurring_bill_thru_date instead of the deprecated from_date and to_date fields. This example leaves out the orig_invoice_no field, since this invoice has no predecessor, the invoice_payment_plan_details array and each line's installment_schedule_details array and latest_installment_no field, since this invoice is not on a payment plan, and several line-level fields that do not apply to these particular charges, such as order_no, item_no, credit_reason_cd, proration_factor, po_num, and the service-location and rebill fields. The nonpublic error_details field is also left out.