Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_statement_history_m


Returns the list of all statements in a given billing period on an account for all the master plan instances or on a specific master plan instance on the account.

For information on error messages generated by this API, see get_acct_statement_history_m Error Messages.

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.
  user_id string 32 Account's user ID. Alternative to using acct_no.
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  start_date string 12 Specifies start date. The date is in the format yyyy-mm-dd
  end_date string 12 Specifies end date. The date is in the format yyyy-mm-dd
  include_invoice_activity_eligibility string 5 Specifies whether the statement is eligible to send or not  

Allowable values for include_invoice_activity_eligibility

Values Description
true Checks the eligibility to send email.
false Does not check the eligibility to send email.
null If NULL, defaults to false.
  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.
statements_history hash  
brd_arrow.gif xml_statement_no long The unique xml statement number. This is for xml statements only.
brd_arrow.gif statement_no long The unique statement number. This is sequenced across all statements.
brd_arrow.gif xml_statement_content string The xml statement content.
brd_arrow.gif create_date string The date the account record was created.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif due_date string The date monies are due.
brd_arrow.gif due_date_plus_grace_period string The date monies are due calculated to include any grace period.
brd_arrow.gif new_charges_amount double The monetary amount of new charges detailed in the statement.
brd_arrow.gif new_payments_amount double The monetary amount of any new payments applied in this statement
brd_arrow.gif balance_forward_amount double The monetary amount to apply as balance forward.
brd_arrow.gif total_amount double Total amount of the statement.
brd_arrow.gif is_paid_ind long A boolean value indicating if the statement has been paid.  

Allowable values for is_paid_ind

Values Description
0 0
1 1
brd_arrow.gif invoice_activity_ind long Indicates whether statement can be sent or not.  

Allowable values for invoice_activity_ind

Values Description
0 Statement not eligible to send.
1 Statement eligible to be sent.
brd_arrow.gif seq_statement_id string The unique sequential statement number
brd_arrow.gif  invoice_no long The Aria-assigned unique identifier of a given invoice.
brd_arrow.gif statement_master_plan_instances hash  
brd_arrow.gifbrd_arrow.gif master_plan_instance_no long The Master Subscription plan instance number.
brd_arrow.gifbrd_arrow.gif client_master_plan_instance_id string Client-defined Master plan Subscription plan instance ID.
brd_arrow.gif unapplied_payment_summary double Total of unapplied payments for a given account.
brd_arrow.gif account_balance double Displays the ending account balance at time.
Last modified


This page has no custom tags.


This page has no classifications.