get_acct_groups_by_client_m
Summary
| API Name | get_acct_groups_by_client_m |
|---|---|
| Class | account_services_m |
| Update Version | 3.5 |
Description
Returns the list of account groups associated with a client.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| Start of acct_groups object | ||||
| acct_groups | object | No | ||
| Name | Type | Length | Required | Description |
| ▶group_no | long | No |
The unique ID of the account group |
|
| ▶group_name | string | No |
The name of the account group |
|
| ▶group_desc | string | No |
The long description of the account group |
|
| ▶group_type | string | No |
Whether this is a functional (F) or collections (C) account group |
|
| ▶group_mask | string | No |
The mask used to display the account group on invoices and statements |
|
| ▶group_seq_no | long | No |
The sequential number for display the account groups |
|
| ▶client_acct_group_id | string | No |
The client-assigned group ID |
|
| ▶secondary_batch_sched_grp_no | long | No |
Secondary Batch Schedule Group Number. Defined within the Functional Account Group. If this will be used for a child account, this is inherited from the parent account. |
|
| ▶client_secondary_batch_sched_grp_id | string | No |
Client Defined Secondary Batch Schedule Group ID. Defined within the Functional Account Group. If this will be used for a child account, this is inherited from the parent account. |
|
| End of acct_groups object | ||||