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": "a4345063-95ac-4c38-ab16-467bc60163d6",
"_parent_id": "9331d544-fa4b-4e4d-aad9-67abb40eda1b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b332d4ef-9544-4852-8be9-733fcf3af8e1",
"company_id": "64346f27-328c-461d-a5d0-49563326d193",
"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": "3fe33c29-fcec-4562-92c8-692a5fceb3c8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8ea771f8-5de5-42d7-8682-cc75e8812707",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cb550dad-5af1-4361-9fbd-79e1048ed365",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7fdefa47-e10b-4d91-8005-43bfc846a7c4",
"company_code": "sample string 5",
"company": {
"id": "69e32b79-8806-43e5-ac76-8f67aa4fbead",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-04T12:42:48.9370105+00:00",
"sales_territory_id": "a2185cee-c1f9-4bc8-ad84-acb4222a71e2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9fd00555-2ebb-4d06-b8b8-9dfc5acedddf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "46b9dbea-4e9c-4471-8639-5071223ebe6e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a6865158-5730-4db8-8c9b-32f9677cfd4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ba325fe-b29f-4b70-acdb-b2ff8cd9c4cd",
"db_currency_id": "1d12bdef-6166-4b46-9305-7e8e7eb398c1",
"db_language_id": "5816f4b6-9791-4f0b-80c9-5e791390c900",
"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-08-04T12:42:48.9370105+00:00"
},
"modified_dateutc": "2026-08-04T12:42:48.9370105+00:00"
},
"marketing_segment_id": "7947a211-c2fa-43b6-a61a-f85bfa570312",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6ad94428-71c0-4324-a38e-f66a34aaa681",
"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": "502647f2-eb4e-46df-9b0e-491c28187316",
"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": "2bca42f5-802a-438f-a41e-a508a12a7907",
"db_country_code": "sample string 28",
"feelist_id": "5e24b264-4595-4b39-be4e-c535abed9961",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5ebc29bb-2d18-41fb-8364-001259ced6f8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "19977364-8b8f-41ff-8e7e-2c7abd6359c4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-04T12:42:48.9370105+00:00",
"db_currency_id": "a771ff44-982d-410d-be2f-bcef6990d34b",
"db_currency_code": "sample string 10"
},
"company_type_id": "a2929abc-99b9-4f2a-b552-8dc6d47e7361",
"company_type_name": "sample string 32",
"company_type": {
"id": "7e879d9a-f7a1-40db-9774-a6272df3b355",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4aea8c25-85c0-4ced-9943-f129b9f7a9a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ee4dfefe-7e4e-4dd6-b320-2adcd6d08b6d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8da42419-ea7a-45dc-8c7e-050d78381b10",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9999f496-b707-4ee3-ad54-0e60780f8056",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7c5e7f2a-376b-45d8-8408-19d3d329ad62",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-04T12:42:48.9370105+00:00"
},
"company_sector_id": "7c242f88-1aee-4aae-80fd-96f60df51041",
"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": "8e6ddc4a-30a7-485e-a68c-31bbdc10a29f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3db5b3aa-575f-4a71-b66b-2dcb4d1dd13d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0250e531-836e-4357-8c79-41f6f3084d9b",
"account_manager_user_code": "sample string 56",
"company_status_id": "375e0a7e-a4a3-4390-bdf8-7e0d0818e931",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-04T12:42:48.9370105+00:00",
"id2": 60
},
"db_language_id": "996a20ae-c9dc-49be-a4ea-754115aad120",
"db_language_code": "sample string 7",
"db_title_id": "6b4fa581-c461-4a13-ab66-46f0653b8115",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-04T12:42:48.9370105+00:00",
"create_date": "2026-08-04T12:42:48.9370105+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-08-04T12:42:48.9370105+00:00"
},
"modified_dateutc": "2026-08-04T12:42:48.9370105+00:00",
"id2": 22
}