Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_preview_statement_m

get_acct_preview_statement_m

Generates account's preview statement based on provided master plan instance.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png master_plan_instance_no long 22 The unique identifier for the master plan instance.
  OR      
  client_master_plan_instance_id string 100 Client-defined unique identifier for the master plan instance.
  alt_stmt_template_no double 22 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 Preview either prior period not billed statement or current period statement when called during bill lag days  

Allowable values for auto_skip_to_next_bill_date:

Values Description
  (Default) Client settings are used
0 Return the preview of the current period, which is yet to be billed due to positive bill lag days.
1 Return the preview of next period, even though the current period is yet to be billed due to positive bill lag days.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
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.
out_statement string The returned account statement.
mime_type string MIME type for statement encoding.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.