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": "6e1e0dfe-8297-4a85-95a9-a708bd4f68bd",
"_parent_id": "81370f63-6be7-446a-903d-97c4f85e1247",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fb8353b6-0c20-49d8-8c5d-0306ebb6f079",
"company_id": "2721e82c-3fa4-409e-81cf-ab781d9de7c3",
"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": "61ec94cf-e556-4840-8ad5-da1227e685ba",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "249e39b7-4679-4209-a5ad-b5a61e53ddd5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "355d7eb6-04d6-44d9-a3e3-169b3ef0703b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b2514ce9-579d-4696-9fab-6c100d771dcf",
"company_code": "sample string 5",
"company": {
"id": "1c073665-4137-402e-9158-c387462b8681",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-11T17:19:59.0846722+00:00",
"sales_territory_id": "58672ec9-2bd4-4ca6-926a-5a398ba912ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4df28315-66e2-44ff-a0fe-d50b2aab2b6e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57b92c75-3b28-444c-8780-9f6c2e395435",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d4b7d79-2b4a-493c-9117-a0271a37441e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03414e26-4bb1-4036-9e95-e4e873099428",
"db_currency_id": "f7512e0e-674a-4a32-8806-45aaa8992273",
"db_language_id": "bf50c982-7023-4356-9865-ee9bd7e24ac7",
"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-11T17:19:59.0846722+00:00"
},
"modified_dateutc": "2026-06-11T17:19:59.0846722+00:00"
},
"marketing_segment_id": "8066d84f-113b-4a24-97c5-26559ca194af",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "128f6f00-7ade-42b9-8371-f8fa99846652",
"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": "269cc7df-853b-4f7f-ba59-c28c6b367533",
"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": "51dac170-cc2f-4bb3-9798-4a3f87bbffd5",
"db_country_code": "sample string 28",
"feelist_id": "c7dc5bf3-8ac8-4a9f-8f2d-2e396adbc1d2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c59de5f-f420-4a0d-b9a7-06d2af1d7aec",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7b17f022-71ec-4f95-ac78-8de20a62d7ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-11T17:19:59.0846722+00:00",
"db_currency_id": "88ac6445-5d89-4651-877c-ed74e4b6cf8c",
"db_currency_code": "sample string 10"
},
"company_type_id": "11e9e31d-bfdc-425b-bce8-55a43211b27d",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc1e0203-e1ed-4a6d-98d1-7fd6d5b37473",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c4b9789-a1ab-4f62-80e7-47e15c4c9aab",
"sales_organization_code": "sample string 5"
},
"db_language_id": "70312ab6-6a3b-42bf-9d1a-7702410e8923",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3aeefa08-475b-4774-974a-3e2370ca3fde",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aeaa0a61-ea93-4f20-8222-98fb83aa2724",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7ba4b27c-39a4-4f37-9d94-e44a8da2edc8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-11T17:19:59.0846722+00:00"
},
"company_sector_id": "2b37a2e6-bdbc-4ad6-b0f1-1b3224a8c36e",
"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": "a36a67f0-467d-4fc6-8e20-879e3dbdd55d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "66dda6fa-460f-40bb-8b05-356bb28ccd4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ad3def4c-6855-41ce-8df4-fc2b45f23dfa",
"account_manager_user_code": "sample string 56",
"company_status_id": "20c201ef-5065-481d-9bb3-20bb8e9ef82b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-11T17:19:59.0846722+00:00",
"id2": 60
},
"db_language_id": "91be967f-15f5-460c-a9a7-dae22892c789",
"db_language_code": "sample string 7",
"db_title_id": "d838e3b0-2450-45f4-a5c0-5de0f1c0fb89",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-11T17:19:59.0846722+00:00",
"create_date": "2026-06-11T17:19:59.0846722+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-11T17:19:59.0846722+00:00"
},
"modified_dateutc": "2026-06-11T17:19:59.0846722+00:00",
"id2": 22
}