Retrieves an object of the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| _parent_id |
Reference to a parent location |
globally unique identifier | |
| _parent_reference_back_office |
Embedded entity "location" for parent location using ERP PK when adding/updating location |
string | |
| _parent_location |
Embedded entity "location" for parent location when adding/updating location |
location | |
| project_status_id |
Foreign key to project_status_id |
globally unique identifier | |
| company_id |
The company owner of this location |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating location |
string |
Optionally required : company_id, company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating location |
company |
Optionally required : company_id, company_code or company must be provided |
| name |
Name of the location |
string |
Required Max length: 50 |
| extra_information |
extra_information |
string |
Max length: 255 |
| reference_back_office |
The Id/Ref of the back office for this location. Used by Embedded entity |
string |
Max length: 255 |
| street |
Street |
string |
Max length: 100 |
| street_number |
Street number. |
string |
Max length: 50 |
| zip |
Zip code |
string |
Max length: 50 |
| city |
City |
string |
Max length: 50 |
| phone |
Phone number |
string |
Max length: 50 |
|
Email address |
string |
Max length: 250 |
|
| db_country_id |
Foreign key to table Country |
globally unique identifier | |
| db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
| street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
| latitude_decimal |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude_decimal |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| contact_id |
Foreign key of contact for this location |
globally unique identifier | |
| contact_reference_back_office |
Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office |
string | |
| contact |
Embedded entity "contact" when adding/updating location |
contact | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer |
Response Formats
application/json, text/json
Sample:
{
"id": "144753d2-860d-4faa-9ad5-50cb4ce1e427",
"_parent_id": "0ad237b1-d6ba-44d7-aaea-f26555eacf89",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "20b41d8a-5528-4c06-bbb3-49378c3816ec",
"company_id": "69a062b6-f4a8-469f-bf6f-c933bec05baf",
"company_code": "sample string 6",
"name": "sample string 7",
"extra_information": "sample string 8",
"reference_back_office": "sample string 9",
"street": "sample string 10",
"street_number": "sample string 11",
"zip": "sample string 12",
"city": "sample string 13",
"phone": "sample string 14",
"email": "sample string 15",
"db_country_id": "973c4d26-8062-4650-9f43-0d996da68ac5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "940dcb61-eb05-4108-93e0-445a2945d85c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f37e8053-25be-433d-984e-a6cb3809cb14",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5c98224d-f178-4a19-b689-c508d1adb5da",
"company_code": "sample string 5",
"company": {
"id": "b3384a85-6e45-4c2e-af00-45884e171160",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-22T01:35:16.2392314+00:00",
"sales_territory_id": "ad755706-9562-4a05-9d0a-183976a9c310",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8e990a89-1ab0-4d84-ad6a-fbd2b1d21b55",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5858f8e6-8c3d-45ba-9024-2e6398770af2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7472e29d-8e0c-4a7a-ba44-6a12ec97410b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6daa7c45-1536-4e1f-9a1b-cbc88ff5d0ba",
"db_currency_id": "8547d925-d0e5-4c4e-98bd-97cf75325aa1",
"db_language_id": "228ddf8a-f880-412b-a774-a9fdbd037869",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00"
},
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00"
},
"marketing_segment_id": "6015b073-4aa7-4266-a99a-07071b64ba9c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cc7dd344-4d14-4ccc-9f1a-e7bb3c114c81",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "e76b4d2b-ac81-4eea-a46c-da4d9389ec59",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "725ece16-9ac2-4922-bf71-1fa7049b5eec",
"db_country_code": "sample string 28",
"feelist_id": "5cbd0039-e981-4a98-8853-d2eea312745f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e5b3db13-ddd5-4865-8e8e-d9c357429979",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5648f631-2699-4fac-a608-199905800f38",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00",
"db_currency_id": "cb9661d8-90f9-4fab-bcc6-c1a2308db51f",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2eba769-96d4-4399-9cbd-560e38e4fb5f",
"company_type_name": "sample string 32",
"company_type": {
"id": "515039da-f4da-4ecd-a8df-9b0141b3a56a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68c09040-3c22-4bb9-85bd-36410bbd6b49",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e9d630b4-2b7f-4622-bb4c-c6a4812e365f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "20051c49-2f32-4fa6-8718-fe2e4368704e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4d99b3c0-e133-4bec-af99-cb235a193c2d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5f02b4f9-b8bf-43ec-aa68-0f045d8a3a26",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00"
},
"company_sector_id": "22e8521b-555f-48d3-b87c-2093e6f12f97",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "706f68f8-7d30-4091-adb2-4a0339c0899e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6ae9f6e8-631b-40aa-a728-1eec280b0ee5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "171be75f-1f1d-4c59-a6a3-1994555a9363",
"account_manager_user_code": "sample string 56",
"company_status_id": "51c47d48-eff1-4e1d-a0ac-954e2cf7e0a8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00",
"id2": 60
},
"db_language_id": "036986bd-927b-48ea-be74-dee9bd5a86f6",
"db_language_code": "sample string 7",
"db_title_id": "c62cdd4b-4f76-4f6c-9d35-bc06eb67c47f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-22T01:35:16.2392314+00:00",
"create_date": "2025-11-22T01:35:16.2392314+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00"
},
"modified_dateutc": "2025-11-22T01:35:16.2392314+00:00",
"id2": 22
}