get_legal_entity_m
Summary
| API Name | get_legal_entity_m |
|---|---|
| Class | administration_services_m |
| Update Version | 10.0 |
Description
Use this API to retrieve a list of existing legal entities for a given client
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
| Start of legal_entity_array object | ||||
| legal_entity_array | object | No |
Array to specify information pertaining to which legal entity / entities will be returned. REST input arrays should passed in the following format:legal_entity_array[0][legal_entity_no]=123&legal_entity_array[1][legal_entity_no]=234 |
|
| Name | Type | Length | Required | Description |
| ▶legal_entity_no | long | 32 | No |
Aria-assigned legal entity identification number. This field dictates which legal entity data will be displayed below. Alternative field: client_legal_entity_id or legal_entity_name |
| ▶client_legal_entity_id | string | 300 | No |
Client-assigned unique identifier for the legal entity. Alternative field: legal_entity_no or legal_entity_name |
| ▶legal_entity_name | string | 300 | No |
Client-assigned descriptor of the legal entity. Alternative field: legal_entity_no or client_legal_entity_id |
| End of legal_entity_array object | ||||
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| Start of legal_entity object | ||||
| legal_entity | object | No |
The legal_entity associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶legal_entity_no | long | 32 | Yes |
Aria-assigned legal entity identification number. |
| ▶legal_entity_name | string | 300 | Yes |
Client-assigned descriptor of the legal entity. |
| ▶client_legal_entity_id | string | 300 | Yes |
Client-assigned unique identifier for the legal entity. |
| ▶legal_entity_registration_no | string | 30 | No |
Client-defined legal entity registration number. |
| ▶legal_entity_vat_registration_no | string | 30 | No |
Client-defined value-added tax registration number. |
| ▶legal_entity_address1 | string | 300 | No |
Address line one for the legal entity contact. |
| ▶legal_entity_address2 | string | 300 | No |
Address line two for the legal entity contact. |
| ▶legal_entity_address3 | string | 300 | Yes |
Address line three for the legal entity contact. |
| ▶legal_entity_city | string | 300 | No |
City for the legal entity contact. |
| ▶legal_entity_state_prov | string | 10 | No |
State or Province code for the legal entity contact. |
| ▶legal_entity_locality | string | 300 | No |
Locality for the legal entity contact address. |
| ▶legal_entity_postal_code | string | 15 | No |
Postal code for the legal entity contact. |
| ▶legal_entity_country | string | 3 | No |
Country code for the legal entity contact. |
| ▶legal_entity_currency | string | 3 | No |
The currency for the legal entity. This value impacts reporting at the legal entity level as all account currencies are converted into this functional currency for Legal Entity reporting purposes. |
| ▶legal_entity_email | string | 254 | No |
Email address for the legal entity contact. |
| End of legal_entity object | ||||