gen_statement_m
Summary
| API Name | gen_statement_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.33 |
Description
Generates a statement based on a master plan instance (subscription) on the account. This call can also send the statement to the statement contact's email address on the associated billing group and if statement contact is not specified or email address on the statement contact is not specified then to the associated billing group's primary payment method billing contact's email address. If email address for associated billing group's primary payment method is not specified then to the account contact's email address. Please note: If there is more than one invoice for a master plan instance that has not been included in an statement, an error will occur. If the send_email field is set to true and an email address either on statement contact or on billing contact associated with the primary payment on the associated billing group or on account contact is not found then an error will occur.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||
| master_plan_instance_no | long | 22 | Yes |
The unique identifier for the master plan instance Alternative required field: client_master_plan_instance_id |
||||||
| client_master_plan_instance_id | string | 100 | Yes |
Client-defined unique identifier for the master plan instance Alternative required field: master_plan_instance_no |
||||||
| send_email | string | No |
A boolean directive to send the statement via email to the account holder. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| statement_no | long | No |
The unique statement number. |
|
| seq_statement_id | string | No |
The unique sequential statement number. |
|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |