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": "0aa17db0-bcf9-415c-abb8-becf1e2dca00",
"_parent_id": "5d37e790-49e3-4bf4-aa10-06ac50b653e4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "48769450-b89d-4729-afb1-7cb43b4fb08a",
"company_id": "6e87a731-2356-4bf7-8bed-026c2b68269e",
"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": "c1bf6d16-b2e3-4887-a14d-c9c47f7759d6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6e61132f-a11b-4859-93ab-a1d66f090ff8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a0dbf413-4cb3-486f-9c5a-9a8dfaa46ac5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ffbda83a-7013-4838-9aea-ed632e67d4b8",
"company_code": "sample string 5",
"company": {
"id": "02012667-0388-4c04-8d7d-a507000d0032",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T11:38:52.2678077+00:00",
"sales_territory_id": "d41e5f43-3b5b-4fe7-9b8e-4e01ff6fab96",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eb9271ec-16a8-4443-be3b-aaf5dabd0524",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da658637-daa3-4bf9-b546-ace50194a82f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1cb5c3a0-8ed4-4b7d-bc69-282aa520fd6c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "def820de-f56c-447f-9f70-f6818394611f",
"db_currency_id": "758ad14f-bbca-43f0-b3ac-1561d41c7e37",
"db_language_id": "4e8f8ffd-21e7-442c-bbba-3c4d553ea270",
"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-07-23T11:38:52.2678077+00:00"
},
"modified_dateutc": "2026-07-23T11:38:52.2678077+00:00"
},
"marketing_segment_id": "6ac20af3-22e3-4961-816f-1e5e8527c5d8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ca65093c-ed15-4d6c-ba74-8188905a062c",
"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": "f2fc1475-5124-4741-a440-87fbdde803fd",
"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": "c1f8081c-fa57-4fb7-91a3-2db0a0ce17fa",
"db_country_code": "sample string 28",
"feelist_id": "956b6ccf-9a6b-4139-9052-091e08339315",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "19d5fc51-1d61-4ef4-b639-80c6459b5874",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d5caef13-f0d2-418b-8388-92316832f132",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T11:38:52.2678077+00:00",
"db_currency_id": "ddef5acf-6921-49b8-b72d-c0245585fe21",
"db_currency_code": "sample string 10"
},
"company_type_id": "0094c636-a1ee-4189-b6f9-4f37159d9649",
"company_type_name": "sample string 32",
"company_type": {
"id": "52a6178f-8aac-46da-b4ab-0fcca62d7e2e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cff6ea15-f26d-4f67-a694-133a367cc697",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fb0f6a00-6752-440d-a9f4-76e70d6880d1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "42b2a7db-dc64-4253-b512-6bd0ecf862ba",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5d6b3d7d-700b-4420-a74c-194195ff876b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a1fac3d5-e9e7-4818-8de2-e90836ae1adf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T11:38:52.2678077+00:00"
},
"company_sector_id": "f3ff4a40-f2ef-4adb-aa27-91dbbbc266a2",
"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": "5ebf0590-de0a-49ce-9c09-b362d647deaa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "152dedb2-cf39-40c6-af40-b7de7ec830a5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1dd4c3d-5758-42da-b303-86f5a0f26baa",
"account_manager_user_code": "sample string 56",
"company_status_id": "7e75ff76-a945-449d-8246-3c686d9d1463",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T11:38:52.2678077+00:00",
"id2": 60
},
"db_language_id": "89882ee3-4f26-4b6c-889e-0ccb9195b3b1",
"db_language_code": "sample string 7",
"db_title_id": "96d27c64-2093-4d35-be09-bbd1e8d31386",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T11:38:52.2678077+00:00",
"create_date": "2026-07-23T11:38:52.2678077+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-07-23T11:38:52.2678077+00:00"
},
"modified_dateutc": "2026-07-23T11:38:52.2678077+00:00",
"id2": 22
}