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. | |
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 | 12 | 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. |
statement_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 |
![]() | string | The status of the statment. Allowable Values |
![]() | string | Indicates the date on which it is sent. |