gen_statement_m Sample Call and Response
This example generates a statement for a specific master plan instance (subscription) on an account and requests that Aria email the statement to the appropriate contact. It is based on the gen_statement_m method definition in plsql_m_r73.yml.
This example includes every required field and a representative optional field, the send_email directive, rather than every field the method accepts.
Sample call
{
"rest_call": "gen_statement_m",
"output_format": "json",
"client_no": 6423,
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"acct_no": 3300481,
"master_plan_instance_no": 8891042,
"send_email": "true"
}
The rest_call and output_format fields are not part of the method's own documented arguments. The REST gateway that fronts every Aria Billing Cloud Core API method adds them: rest_call names the method being invoked, and output_format requests a JSON response. The master_plan_instance_no field identifies the subscription for which you generate the statement; this example uses the Aria-assigned numeric identifier rather than the alternative client_master_plan_instance_id field, since only one of the two belongs in a call. Similarly, acct_no is used rather than its alternative, client_acct_id. The send_email field accepts the string values true or false, per the method's Boolean Values legend; setting it to true tells Aria to attempt delivery of the statement by email to the statement contact, the billing contact, or the account contact, in that order of precedence, depending on which of them has an email address on file. This example leaves out client_master_plan_instance_id and client_acct_id, since only one side of each alternative pair belongs in a single call.
Sample response
{
"statement_no": 5512207,
"seq_statement_id": "STMT-2026-0071845",
"error_code": 0,
"error_msg": "OK"
}
An error_code value of zero and an error_msg value of "OK" together indicate that Aria generated and, in this example, emailed the statement successfully. The statement_no field is the Aria-assigned unique numeric identifier of the new statement, and seq_statement_id is its unique sequential identifier. This example leaves out the error_details field entirely, since that field is for internal use only and does not appear in a public response.