Generates a statement based on a master plan instance on the account. This call can also send the statement to the statement contact's email address on the associated billing group. If statement contact (or statement contact email) is not specified, the system will try to email:
- the associated billing group's primary payment method billing contact, then
- the account contact.
If the system fails to find an email address, the statement will be created but not sent.
Please note: If there are multiple invoices for a master plan instance that have not been included in an statement, an error will occur.
For information on error messages generated by this API, see gen_statement_m Error Messages.
|Req||Field Name||Field Type||Max Length||Description|
|client_no||long||22||Aria-assigned unique identifier indicating the Aria client providing service to this account.|
|auth_key||string||32||Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.|
|acct_no||long||22||Aria-assigned account identifier. This value is unique across all Aria-managed accounts.|
|client_acct_id||string||50||Client-defined account identifier.|
|master_plan_instance_no||long||22||The unique identifier for the master plan instance|
|client_master_plan_instance_id||string||100||Client-defined unique identifier for the master plan instance|
A boolean directive to send the statement via email to the account holder.
Allowable values for send_email:
|alt_caller_id||string||30||Person or process that submitted the API call. This can be someone's user ID, or the name of an application.|
|optional_transaction_qualifiers||array||Array of additional values you can associate with this API call.|
|qualifier_name||string||100||Name of the field you want to associate with this API call.|
|qualifier_value||string||100||Corresponding value of the field you want to associate with this API call.|
|Field Name||Field Type||Description|
|statement_no||long||The unique statement number.|
|seq_statement_id||string||The unique sequential statement number.|
|error_code||long||Aria-assigned error identifier. 0 indicates no error.|
|error_msg||string||Description of any error that occurred. "OK" if there was no error.|