Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_statement_history_m
get_acct_statement_history_m
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 |
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. | ||||||||
| OR | ||||||||||||
| user_id | string | 32 | Account's user ID. Alternative to using acct_no. | |||||||||
| OR | ||||||||||||
| client_acct_id | string | 50 | Client-defined account identifier. | |||||||||
| master_plan_instance_no | long | 22 | The Master Subscription plan instance number. | |||||||||
| OR | ||||||||||||
| 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
|
|||||||||
| 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. |
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 | |||||||
| xml_statement_no |
long | The unique xml statement number. This is for xml statements only. | ||||||
| statement_no |
long | The unique statement number. This is sequenced across all statements. | ||||||
| xml_statement_content |
string | The xml statement content. | ||||||
| create_date |
string | The date the account record was created. | ||||||
| currency_cd |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | ||||||
| due_date |
string | The date monies are due. | ||||||
| due_date_plus_grace_period |
string | The date monies are due calculated to include any grace period. | ||||||
| new_charges_amount |
double | The monetary amount of new charges detailed in the statement. | ||||||
| new_payments_amount |
double | The monetary amount of any new payments applied in this statement | ||||||
| balance_forward_amount |
double | The monetary amount to apply as balance forward. | ||||||
| total_amount |
double | Total amount of the statement. | ||||||
| is_paid_ind |
long | A boolean value indicating if the statement has been paid.
Allowable values for is_paid_ind
|
||||||
| invoice_activity_ind |
long | Indicates whether statement can be sent or not.
Allowable values for invoice_activity_ind
|
||||||
| seq_statement_id |
string | The unique sequential statement number | ||||||
| invoice_no |
long | The Aria-assigned unique identifier of a given invoice. | ||||||
| statement_master_plan_instances |
hash | |||||||
| master_plan_instance_no |
long | The Master Subscription plan instance number. | ||||||
| client_master_plan_instance_id |
string | Client-defined Master plan Subscription plan instance ID. | ||||||
| unapplied_payment_summary |
double | Total of unapplied payments for a given account. | ||||||
| account_balance |
double | Displays the ending account balance at time. |
- © Copyright 2022 Aria Developer Central