get_acct_preview_statement_m
Summary
| API Name | get_acct_preview_statement_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.33 |
Description
Generates account's preview statement based on provided master plan instance.
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 | No |
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 |
||||||||
| alt_stmt_template_no | double | 22 | No |
The statement template to use when generating a statement in a format other than account statement template |
||||||||
| auto_skip_to_next_bill_date | long | 1 | No |
Preview either prior period not billed statement or current period statement when called during bill lag days Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| 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. |
|
| out_statement | string | No |
The returned account statement. |
|
| mime_type | string | No |
MIME type for statement encoding. |