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 | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
![]() |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions |
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. |
receipt_action | hash | |
![]() |
long | Aria-assigned unique identifier for this action type. |
![]() |
string | Name of action type corresponding to the action type ID. |
![]() |
string | Description of action type corresponding to the action type ID. |
![]() |
string | Label of object the action invoked by the API was performed. E.g., Plan No. |
![]() |
string | Identifier of the object that action was performed on corresponding to action_rec_id_label. |
![]() |
string | Date the action occurred |
![]() |
string | The user that invoked the action |
![]() |
string | Label of related detail 1 corresponding to action_rec_id_label. E.g., Plan Units |
![]() |
string | Value corresponding to action_qualifier_1_label |
![]() |
string | Label of related detail 2 corresponding to action_rec_id_label. |
![]() |
string | Value corresponding to action_qualifier_2_label |
![]() |
string | Label of related detail 3 corresponding to action_rec_id_label. |
![]() |
string | Value corresponding to action_qualifier_3_label |
![]() |
string | Label of related detail 4 corresponding to action_rec_id_label. |
![]() |
string | Value corresponding to action_qualifier_4_label |