get_acct_billing_group_details_m Sample Call and Response
This example retrieves the full details of one billing group on an account, including its statement contact and the master plan instances associated with it. It is based on the get_acct_billing_group_details_m method definition in plsql_m_r73.yml.
This example includes every required field along with the billing_group_no field used to identify the billing group. It leaves out client_receipt_id and the deprecated billing_groups array, both described in the prose notes below.
Sample call
{
"rest_call": "get_acct_billing_group_details_m",
"output_format": "json",
"client_no": 6423,
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"acct_no": 3300481,
"billing_group_no": 771002
}
The rest_call and output_format fields are added by the REST gateway that fronts every Aria Billing Cloud Core API method, not by the method itself. The acct_no field identifies the account, using the Aria-assigned numeric identifier rather than its alternative, client_acct_id. The billing_group_no field identifies the specific billing group to retrieve; it belongs to a group of four mutually exclusive alternatives, plan_instance_no, client_plan_instance_id, billing_group_no, and client_billing_group_id, of which this example supplies only billing_group_no. This example omits the optional client_receipt_id field, which would let you pass a client-defined identifier to help correlate this call with related system actions in your own logs.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"billing_group_details": {
"billing_group_no": 771002,
"billing_group_name": "Corporate HQ Billing",
"billing_group_description": "Primary billing group for corporate headquarters",
"client_billing_group_id": "BG-HQ-001",
"status": 1,
"notify_template_group": 12,
"statement_template": 4,
"credit_note_template": 7,
"payment_option": "Methods",
"primary_payment_method_no": 550301,
"client_primary_payment_method_id": "PM-CC-0042",
"backup_payment_method_no": 550302,
"client_backup_payment_method_id": "PM-CC-0043",
"stmt_first_name": "Elena",
"stmt_last_name": "Martins",
"stmt_company_name": "Martins Consulting LLC",
"stmt_address1": "482 Birchwood Lane",
"stmt_city": "Austin",
"stmt_state_prov": "TX",
"stmt_country": "US",
"stmt_postal_cd": "78701",
"stmt_phone": "512-555-0134",
"stmt_email": "billing@martinsconsulting.com",
"master_plans_summary": [
{
"plan_instance_no": 8891042,
"client_plan_instance_id": "SUB-STD-0042"
},
{
"plan_instance_no": 8891099,
"client_plan_instance_id": "SUB-ADDON-0042"
}
],
"credit_memo_template": 9,
"rebill_template": 11
},
"payment_methods_summary": [
{
"pay_method_name": "Corporate Visa",
"payment_method_no": 550301,
"client_payment_method_id": "PM-CC-0042",
"pay_method_type": 1,
"bill_first_name": "Elena",
"bill_last_name": "Martins",
"bill_company_name": "Martins Consulting LLC",
"bill_address1": "482 Birchwood Lane",
"bill_city": "Austin",
"bill_state_prov": "TX",
"bill_country": "US",
"bill_postal_cd": "78701",
"cc_expire_mm": 11,
"cc_expire_yyyy": 2028,
"suffix": "4242"
},
{
"pay_method_name": "Backup Mastercard",
"payment_method_no": 550302,
"client_payment_method_id": "PM-CC-0043",
"pay_method_type": 1,
"bill_first_name": "Elena",
"bill_last_name": "Martins",
"bill_company_name": "Martins Consulting LLC",
"bill_address1": "482 Birchwood Lane",
"bill_city": "Austin",
"bill_state_prov": "TX",
"bill_country": "US",
"bill_postal_cd": "78701",
"cc_expire_mm": 3,
"cc_expire_yyyy": 2027,
"suffix": "8891"
}
]
}
An error_code value of zero and an error_msg value of "OK" together indicate that Aria retrieved the billing group details successfully. The billing_group_details field is a single object rather than an array, because the call identifies exactly one billing group by billing_group_no; nested inside it, master_plans_summary is a genuine array, since a billing group can have more than one master plan instance assigned to it, and this example shows two. The payment_option value of "Methods" indicates that this billing group is configured to bill through payment methods, such as the credit cards shown here, rather than through payment terms, such as a physical check; the other allowed value is "Terms". The payment_methods_summary array shows both the primary and backup payment method on this billing group; a real billing group could have just one or, in principle, more entries. This example leaves out the deprecated billing_groups array (superseded by billing_group_details), leaves out the collection_group_bg_info and bg_einvoicing_field_list arrays for brevity, and leaves out the error_details field entirely, since that field is for internal use only.