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.
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 | |
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. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
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 | |
![]() |
long | The unique statement number. |
![]() |
string | The date the account record was created. |
![]() |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
![]() |
string | The date monies are due. |
![]() |
string | The date monies are due calculated to include any grace period. |
![]() |
double | The monetary amount of new charges detailed in the statement. |
![]() |
double | The monetary amount of any new payments applied in this statement |
![]() |
double | The monetary amount to apply as balance forward. |
![]() |
double | Total amount of the statement. |
![]() |
long | A boolean value indicating if the statement has been paid. Allowable Values |
![]() |
long | Indicates whether statement can be sent or not. Allowable Values |
![]() |
string | The unique sequential statement number |
![]() |
long | The Aria-assigned unique identifier of a given invoice. |
![]() |
hash | |
![]() ![]() |
long | The Master Subscription plan instance number. |
![]() ![]() |
string | Client-defined Master plan Subscription plan instance ID. |
![]() |
double | Total of unapplied payments for a given account. |
![]() |
double | Displays the ending account balance at time. |