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": "e71d7434-0818-47b4-a5fe-1cd35a64a420",
"_parent_id": "c7adbf18-7504-42f0-90a4-30f5e3dc3278",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "981da5de-4344-47f7-b689-5be26ff3a1ed",
"company_id": "cfa1d669-4424-4f6d-82d4-112be7f6097f",
"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": "5a2c4871-549b-483c-af0c-89ea213423f6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "190db6eb-2578-4c36-8475-fbff15cb3316",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8cbc98da-a262-4174-9037-dcf8e25a66d1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "78650081-cfcf-4da4-bd7e-fc314de968de",
"company_code": "sample string 5",
"company": {
"id": "3c3b2cba-3afd-43d1-8383-d23458dae684",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-22T20:29:16.1156124+00:00",
"sales_territory_id": "2c2e1cb2-e3d4-4e96-884c-88e6229cb128",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "14b3fff1-336b-4feb-a7ae-a9d81e93a879",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16b3d38d-ec82-4149-b313-fa66c27df369",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed115598-3f62-4643-ab96-f495c4e2b901",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "786027f9-1050-4e32-a182-ac8bb9c85e62",
"db_currency_id": "cc1dc9d1-ce13-4a8f-9bf5-289b449fd88a",
"db_language_id": "6e15faeb-c889-4f40-ab25-dd3ece44cb01",
"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-06-22T20:29:16.1156124+00:00"
},
"modified_dateutc": "2026-06-22T20:29:16.1156124+00:00"
},
"marketing_segment_id": "cc74996c-4223-493c-890a-7ceb76bfc90e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9581c87c-f915-4afe-87ef-a765c8a01e14",
"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": "c76d35c5-7999-4ff6-83e6-43d9dc4ca3e5",
"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": "7159b70d-d177-496b-b5b2-01d1839ebeaf",
"db_country_code": "sample string 28",
"feelist_id": "17433a08-15ca-4bc0-9f61-aa2d1a108cfc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d0487afc-ff33-4fec-9c67-5da7414bb406",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54b2e3cf-5f1c-428e-b2d4-a14b2812d2e8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-22T20:29:16.1156124+00:00",
"db_currency_id": "9af21316-1428-416e-a236-e77912676de9",
"db_currency_code": "sample string 10"
},
"company_type_id": "8a5255cb-f44a-49ab-a1a9-373157776b4d",
"company_type_name": "sample string 32",
"company_type": {
"id": "57267305-3c78-4d2a-a4a0-49b84d898dc4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a5fc781-a112-4c08-8eba-739ab38cd76d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a28cc0a7-e52a-453c-89fa-e3f3f2eecf3b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f39c6b2-0356-4388-bc18-b025f78446cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "98804c20-08b4-4a20-a682-aa5a14570771",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ee114839-8192-45e3-baa8-3ecfe36f3f48",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-22T20:29:16.1156124+00:00"
},
"company_sector_id": "acc7f3ae-214c-4738-acc4-afd5e07e7422",
"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": "aa82af16-0ed8-43a0-9276-a4e141107d66",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c70d1cba-fd2e-444a-bd0b-e71002b46aab",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4cd4600c-4e6a-4652-9425-3be9d5233952",
"account_manager_user_code": "sample string 56",
"company_status_id": "b95999c4-390c-4e8b-96b7-4e6e85eee57c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-22T20:29:16.1156124+00:00",
"id2": 60
},
"db_language_id": "896cb7c5-3dda-4f0c-89fa-691d58fb4c4c",
"db_language_code": "sample string 7",
"db_title_id": "57f3de0e-9362-4413-9ac8-3875e2391002",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-22T20:29:16.1156124+00:00",
"create_date": "2026-06-22T20:29:16.1156124+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-06-22T20:29:16.1156124+00:00"
},
"modified_dateutc": "2026-06-22T20:29:16.1156124+00:00",
"id2": 22
}