Fetches the details of an Entity by uuid - the AppZen generated unique identifier for this Entity.
For calling the API, you will need the uuid.
Request URI
GET https://api.appzen.com/dictionary-data-services/
entity/{{uuid}}
Header Parameters
Name | Type | Description | Required |
---|---|---|---|
x-api-key | String | The x-api-key provided to authorize the request. | Yes |
customer-id | String | The Customer ID provided to authorize the request. | Yes |
customer-key | String | The Customer Key provided to authorize the request. | Yes |
Path Parameters
Name | Type | Description | Required |
---|---|---|---|
uuid |
String |
Globally unique identifier for an uploaded document |
Yes |
Sample Request
curl -X GET "https://api.appzen.com/dictionary-data-services/entity/75823296-4af2-4475-aafd-461c60c284e7"
-H "accept: application/json"
-H "x-api-key: R7wsFxxxx"
-H "customer-id: 1004xxxx"
-H "customer-key: 15d1xxxx"
-H "Content-Type: application/json"
Sample Response
Success
{
"entity_id": "string",
"entity_name": "string",
"parent_entity_id": "string",
"entity_type": "string",
"appzen_entity_type": "LEGAL_ENTITY",
"entity_alias_name": [
null
],
"addresses": [
{
"address_type": "REMIT_TO",
"address": {
"address_line1": "12345 MARKET STREET",
"address_line2": "SUITE 1234",
"address_line3": "",
"area_code": "415",
"city": "SAN FRANCISCO",
"company": "Preferred Supplier Inc.",
"contact": "Jane Doe",
"country": "US",
"country_iso3": "USA",
"email": "janedoe@supplier.com",
"phone": "4042965282",
"province": "",
"state": "CA",
"zip": "94016"
},
"site_id": "913838",
"site_name": "California HQ",
"custom_json": {
"key1": "value1"
}
}
],
"currency": "string",
"coa_structure": [
"Entity",
"Department",
"Line of Business",
"Future1"
],
"appzen_coa_structure": [
"LEGAL_ENTITY_SEGMENT",
"DEPARTMENT_SEGMENT",
"OTHER_SEGMENT",
"OTHER_SEGMENT"
],
"dataset_lookup_names": {
"coa-look-names": [
"us_lookups",
"",
" ",
"f1_list"
]
},
"optional_segments": [
"Department",
"Future1"
],
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z",
"created_date": "2020-11-01T11:01:00Z",
"updated_date": "2020-11-01T11:01:00Z",
"payment_term_id": "string",
"custom_json": {
"bu_id": 382,
"bu_name": "HR"
}
}
Failure
The request fails if you enter an invalid URL.
{
"timestamp": "2019-01-17T16:12:45.977+0000",
"status": 404,
"error": "Not Found",
"message": "Error code : 17e3338d - The resource you specified cannot be not found"
}
Response Code
Response Code | Description |
200 | The request is successful. |
400 |
The request failed due to a malformed request syntax. Check the requested URL, including the parameters. |
401 |
The request failed due to an authorization issue. For example, the Customer Key could be missing or invalid. |
403 |
The request failed due to a permission issue. The x-api key may not have permission to perform the request. |
404 |
The request failed as the resource is not found. Check the requested URL. |
500 |
The request failed due to an AppZen server issue. |
See Also
Comments
Article is closed for comments.