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": "787e9403-d298-428b-ae1e-9d8bc98f6cca",
"_parent_id": "611f081f-23ff-4773-86b5-b935039396ec",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1dbf0fc8-de4b-47eb-a03f-b446e11a429d",
"company_id": "a1a1cd86-d0aa-48e3-a4c6-80bc692dd96b",
"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": "084b9860-aecf-46e5-92a9-a2889fc5efd5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "01023f63-30ef-4b03-9b4d-e6521a8d2499",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4a18bfb8-b733-443d-8829-742181d35461",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "130f626e-b6c3-4f89-862b-8cdd1f0b1bbc",
"company_code": "sample string 5",
"company": {
"id": "7ca8e920-a763-4959-9df9-5fe01c8110a9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-21T18:01:20.7282927+00:00",
"sales_territory_id": "b390af04-d723-48cb-ad7c-c93111954398",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce258be6-f907-4d49-8fcd-c61100d1f1d4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df7acbac-59b1-4458-9987-b5f56941b1d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e47e8682-eb62-44ad-bf26-9d8c068a85e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51ef255d-aec4-40e0-88cd-f4937c7291a4",
"db_currency_id": "b060a3f4-84ee-4968-a9f4-352d4031fe93",
"db_language_id": "0832423b-8fd1-4c4d-bd55-52716cc39cf5",
"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": "2026-04-21T18:01:20.7282927+00:00"
},
"modified_dateutc": "2026-04-21T18:01:20.7282927+00:00"
},
"marketing_segment_id": "b7962c52-77cc-4cfb-8e41-08589b44197c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "196be944-e83d-4db9-8a09-f4278ec2f8d7",
"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": "7b256216-7231-4f3b-9756-e2e61dca6fe6",
"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": "5e99e2f5-c7c3-4a35-a3e8-89c5655ee60f",
"db_country_code": "sample string 28",
"feelist_id": "8846beb8-d8b0-432b-b50b-4287a4aec9de",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "63fba957-3220-44e4-b115-22c4e2f3f0a8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5207b4f7-6052-4ee0-b07e-03942a5dc52f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-21T18:01:20.7282927+00:00",
"db_currency_id": "cece7144-5c38-49e7-9483-3fde0050cbcd",
"db_currency_code": "sample string 10"
},
"company_type_id": "c74dd042-2eb9-402f-90c6-48932ec372ed",
"company_type_name": "sample string 32",
"company_type": {
"id": "4207018a-1404-469b-a609-756977c5317e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21c74231-9f46-45ea-9948-4420a33594a5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae8ed6ae-fc54-4bcd-a661-b2c4331de2dd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ccf1d752-c207-4dfa-852b-372a145a1fb9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c12f54c0-be5e-4bd2-9391-c47a7d550657",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0301cf3f-c2ad-4e8e-af8e-40279dd0ebd1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-21T18:01:20.7282927+00:00"
},
"company_sector_id": "88400f98-69e3-4ef4-8868-55663e6cc738",
"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": "b31553fe-aa7e-4dda-b18c-abfc8f8cddc4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "85b7bb1e-2f83-4f92-91b2-45cb57759d4d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5d3a5c4f-dfe9-434b-9db5-6aa6f3199331",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d125a42-4637-4b89-bb84-4f2c6c4803f4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-21T18:01:20.7282927+00:00",
"id2": 60
},
"db_language_id": "ecd0cc36-fb8a-4698-9b28-0620a672efcc",
"db_language_code": "sample string 7",
"db_title_id": "74ca021c-7775-4040-a4a5-7fa697fca85b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-21T18:01:20.7282927+00:00",
"create_date": "2026-04-21T18:01:20.7282927+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": "2026-04-21T18:01:20.7282927+00:00"
},
"modified_dateutc": "2026-04-21T18:01:20.7282927+00:00",
"id2": 22
}