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": "cc8adab1-e442-4222-b547-0429426d6c07",
"_parent_id": "e34b38ae-bb18-4bc2-89a9-4b2c8c81cea1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "340f2808-0377-4a93-ba90-087b66ca50f4",
"company_id": "0d90fb7c-1cb5-44a9-a49d-92c34edd9ce6",
"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": "2f9b6f7b-89c5-4a49-8a06-a522ed6f1d37",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "37b06df1-c90a-45ef-97b7-99fc10ac6eab",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2e8d3869-3b95-421e-a160-bc0146e5a00a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6ff805fb-54db-4628-bd11-f6bd2a6bfcf2",
"company_code": "sample string 5",
"company": {
"id": "e5b055fe-4b09-40b7-8f5c-fc16dd052696",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-11T20:57:22.570551+00:00",
"sales_territory_id": "58b7c4ee-018a-4855-9038-de0b1251871e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4a2f403-5f2e-481a-ab7a-7a293201cd89",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "417fc508-cba1-44e1-a275-f0480624cc90",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "49124e92-405a-4ffd-847d-e564d57c0934",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f0dfd03-f439-46e4-9612-725cfd001d68",
"db_currency_id": "ef9dc977-4d87-426e-aaec-480a1a214600",
"db_language_id": "dc165d9a-a1af-4afb-bd36-3123e795809f",
"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": "2025-11-11T20:57:22.570551+00:00"
},
"modified_dateutc": "2025-11-11T20:57:22.570551+00:00"
},
"marketing_segment_id": "47164765-8733-4b78-85a4-394a2b5491ff",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2e0b759f-0643-45f2-aa96-85b6c1dcfc83",
"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": "c8f5fbdb-7d9e-49b7-9ae1-6843d0e60d44",
"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": "8107c5c7-cb9a-44f8-a8d3-d7a375cad116",
"db_country_code": "sample string 28",
"feelist_id": "fc49501f-f0fc-450d-a0b3-e58b8e65d684",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f992bb5e-a304-44ca-a17c-03971f398fe5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3b013ad4-1fb7-4d28-ae05-4d4297baa911",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-11T20:57:22.570551+00:00",
"db_currency_id": "6ae06d77-88b3-4d55-b18b-bbe663dfddc8",
"db_currency_code": "sample string 10"
},
"company_type_id": "3439c429-01f9-4dd9-bd42-f00fe7dd4f5b",
"company_type_name": "sample string 32",
"company_type": {
"id": "db7e8be3-fe58-4578-9708-cf0dc93610b9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ccebad90-3f57-4438-b290-50d3b6d6546e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cbc9df10-f3a6-4222-b330-b292ae394939",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b5ab64a-cc92-4057-a40c-6a11e280522a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0ef46323-4e53-49f8-ab0e-e39975d17f96",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "43bd6185-2d0c-481d-bb9b-a29c83034811",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-11T20:57:22.570551+00:00"
},
"company_sector_id": "406e5515-1e9e-474e-996a-706c9b12a68c",
"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": "dac3a8b3-0df2-4300-87e9-4392d3415c6f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4cf9b365-e101-4187-b8ac-1bdf81e01714",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e0940442-2da4-4842-9ef7-25b66c03821a",
"account_manager_user_code": "sample string 56",
"company_status_id": "809ad964-c772-4233-a7fe-f5482c2de4fe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-11T20:57:22.570551+00:00",
"id2": 60
},
"db_language_id": "a313a318-b2f0-4e30-814f-0a9f635482f8",
"db_language_code": "sample string 7",
"db_title_id": "79def3fd-6b95-46ce-ac68-dd6f46c5e747",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-11T20:57:22.570551+00:00",
"create_date": "2025-11-11T20:57:22.570551+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": "2025-11-11T20:57:22.570551+00:00"
},
"modified_dateutc": "2025-11-11T20:57:22.570551+00:00",
"id2": 22
}