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": "092aa490-d665-4138-873f-ca5df2e05918",
"_parent_id": "130b547c-d932-4911-911a-fb76e90c91a9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "96a27bf3-3693-4a48-9584-2787033c9ca4",
"company_id": "cecf6d6e-b372-4141-b8c6-e4dfc8c896f9",
"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": "b2a6ee33-d9c4-40c1-9dc8-ad4539524a20",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3a862d94-4616-45e1-8cde-2a2a7e2f7680",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4b7f3fd3-d5d3-42bd-8506-8ae50d8d21bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a7d76e3-2a1e-49d6-afdc-d06e8464c1ed",
"company_code": "sample string 5",
"company": {
"id": "81f45cf5-e937-4067-aba5-af815d938bb8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-17T16:14:53.627137+00:00",
"sales_territory_id": "106178f2-de79-4182-a177-994922df688a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4fe96651-72a6-4202-a6b1-e12cf408e988",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c8d2543-3fba-4436-98c1-ffbdb992aaa1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c125ce2-e696-4c00-a636-ad4740fc6979",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3498a34-288f-4fcb-8035-ac1824a39fe4",
"db_currency_id": "f3a90cf5-235c-4e58-82ba-18f5525bb474",
"db_language_id": "869c6f15-d92b-4fda-9100-5afacf4e5657",
"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-17T16:14:53.627137+00:00"
},
"modified_dateutc": "2026-04-17T16:14:53.627137+00:00"
},
"marketing_segment_id": "e502a55e-1202-4ccf-becf-8095e23a1f5b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b7272d74-440a-404c-8cd0-35b2c541d49b",
"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": "a9d4f68d-f464-4e56-b639-32a3618d5efc",
"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": "24a844cb-349d-4990-9ef5-58eb927e646d",
"db_country_code": "sample string 28",
"feelist_id": "d17f509a-c90a-4f4a-a2d9-9450ad1475c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "62c189e6-93f4-4d32-9dad-fa35a17b3890",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ba55b595-dd0a-41cb-ac19-347142097028",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-17T16:14:53.6427823+00:00",
"db_currency_id": "613725c5-dadb-435c-b807-6f08ee9abf0d",
"db_currency_code": "sample string 10"
},
"company_type_id": "62f6e546-3177-4d2c-be40-f368ca2099bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "ecec77e3-070c-47c3-93e1-9b833b4fc235",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a0c2ce9-6c02-4a16-ac8c-b21b291e8320",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3dd7cff5-d0f4-428e-8267-30039806ea27",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c95fad91-5c43-4adf-8772-9e7051a3a5ba",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "239a1847-3d07-4e76-8875-e7a321fbaffb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "14946b04-46cf-49a0-8bd7-1520965d58dc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-17T16:14:53.6427823+00:00"
},
"company_sector_id": "f2eac1e9-ac5f-4495-8036-8dbeb0f430c0",
"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": "7d4d9b72-6be1-41a1-a735-8fc8fd6d0b9b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "71831da8-4b84-4c4f-a380-c5481efd4764",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c0e2220d-63a3-4264-ab0f-21c28b050e65",
"account_manager_user_code": "sample string 56",
"company_status_id": "8884de9a-f130-48fc-bd17-b9e13eb8307d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-17T16:14:53.6427823+00:00",
"id2": 60
},
"db_language_id": "6ef36381-3d1c-4bd6-8e9c-ba761f0fa571",
"db_language_code": "sample string 7",
"db_title_id": "00bf3472-8e00-421f-a148-a890c1a98ef9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-17T16:14:53.6427823+00:00",
"create_date": "2026-04-17T16:14:53.6427823+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-17T16:14:53.6427823+00:00"
},
"modified_dateutc": "2026-04-17T16:14:53.6427823+00:00",
"id2": 22
}