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": "fa6cbabd-9a1f-420f-85f3-002222d2c91b",
"_parent_id": "504a7bd4-a462-4280-af80-d58df1cf79c8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "01eafd93-6051-4208-a616-d602f77391f2",
"company_id": "15faed93-746e-4163-b4ef-e1712e0f1f0f",
"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": "200d2708-fbba-4037-965b-e73f0cad4f0c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4ecb970f-2807-4570-b8d1-82c90ce94d08",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f13bc068-e83e-4c9c-b174-0ea35e433383",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "034aa681-a680-44cf-8cc8-ad972d98f322",
"company_code": "sample string 5",
"company": {
"id": "9d5ab2c8-7b0d-4137-b2bf-ec943b79c315",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T10:32:10.0966759+00:00",
"sales_territory_id": "3b67c4f3-a28e-43a5-817a-ed87f7c8aec2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ebc0e970-c8e1-400b-ba7e-b9df2b51e5f1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2885e702-2252-4d08-9cd4-8286f7b0d9bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1225d7da-61b4-4e24-accd-9219f52dd37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41bdcaf2-0007-430c-9e4a-70bdc6871126",
"db_currency_id": "3bb3d181-5dac-4422-8091-78f4425cf9ba",
"db_language_id": "53eea68c-7cf6-4526-a065-f7015e6ef0c6",
"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-09-22T10:32:10.0966759+00:00"
},
"modified_dateutc": "2026-09-22T10:32:10.0966759+00:00"
},
"marketing_segment_id": "f38a55c3-05e5-41dc-b3ce-d73d647bad8b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "97a4344d-ff03-4bbb-9f8a-c200870613bb",
"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": "5e0df125-e6e4-4eff-887c-d14acb78e006",
"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": "ff9a353b-d773-4552-be66-6f9b491e25aa",
"db_country_code": "sample string 28",
"feelist_id": "2ceb9c0d-831a-43be-92fb-5c1bb70b4e83",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a0c1dc3-e227-4122-aed2-fd5024d486b3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7efe3815-ced1-44fa-a8e9-fbcb42a8ced5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T10:32:10.0966759+00:00",
"db_currency_id": "5a0a7998-9ed8-4c89-9727-d7066b56faa9",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2765106-3db0-42e5-a3d6-c640235730e2",
"company_type_name": "sample string 32",
"company_type": {
"id": "b528c6fa-e706-4127-8acd-2f120862aed0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eeb9fd67-ee10-4018-a2f6-2089450d7308",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b156514c-d955-4fd5-ac35-fe1e6d427885",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58db7a82-3485-4067-a741-6121aec9bafd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "054813fa-6f0b-4694-b56b-84166bd9b8f5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0449243f-6c51-4f36-924b-3b408c49d4e2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T10:32:10.0966759+00:00"
},
"company_sector_id": "3d494f8c-8fbd-45c1-87af-3437ef0d8533",
"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": "286a9047-1e2a-4d7e-8473-b3befcfbf64e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5d3605cf-fe4f-4087-af7c-fd5606dc7054",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a3d5bbca-174c-4c0c-aa5b-2946c6e5e5aa",
"account_manager_user_code": "sample string 56",
"company_status_id": "d13eae6f-f2a9-4327-afba-83e6833e33c4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T10:32:10.0966759+00:00",
"id2": 60
},
"db_language_id": "7151336e-10fe-4eab-b7cf-e9302c1147af",
"db_language_code": "sample string 7",
"db_title_id": "19e41063-66b3-46b3-8c9d-acbe44ba068a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T10:32:10.0966759+00:00",
"create_date": "2026-09-22T10:32:10.0966759+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-09-22T10:32:10.0966759+00:00"
},
"modified_dateutc": "2026-09-22T10:32:10.0966759+00:00",
"id2": 22
}