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. | |
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. |
acct_groups | hash | |
![]() |
long | The unique ID of the account group |
![]() |
string | The name of the account group |
![]() |
string | The long description of the account group |
![]() |
string | Whether this is a functional (F) or collections (C) account group |
![]() |
string | The mask used to display the account group on invoices and statements |
![]() |
long | The sequential number for display the account groups |
![]() |
string | The client-assigned group ID |