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": "893b034e-05c3-4011-a2ea-a2cdc64a8478",
"_parent_id": "c41cb0f5-fab6-447c-aecd-8cdf207aab00",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9d6889b9-ed40-464b-bd66-1b6549ead0f0",
"company_id": "d01dd9ef-c635-4363-bb13-ec2c7fc03cf2",
"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": "d1836d35-2f44-48b7-8fc8-cbe22e47fd13",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1dd12df6-d395-4d47-8281-5b2ccb691e46",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b723350d-6e1a-4893-8b7a-db654e5b784a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e808e79-21b8-4ec3-916f-92415135c2b4",
"company_code": "sample string 5",
"company": {
"id": "0eb8ad5d-1e52-4069-8f7e-94bd7accee4b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-28T08:40:29.6763216+00:00",
"sales_territory_id": "7b4d55c3-f032-4eef-a7ff-e4473d1b30e2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fed300bf-f7f9-4e37-83d9-575fc3401196",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff740633-8920-4360-aa5f-6de8868273fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4939c36e-30b1-435a-bd8c-880353512afe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08bee0e7-fb17-471f-9ed9-4826df967fa5",
"db_currency_id": "fd4a1ccd-af94-4d88-a60a-742b836150a3",
"db_language_id": "79af537e-7e80-479e-b19a-0e1358a9e1e6",
"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-02-28T08:40:29.6763216+00:00"
},
"modified_dateutc": "2026-02-28T08:40:29.6763216+00:00"
},
"marketing_segment_id": "8767dbb3-76cb-4d38-86e5-939232884ed7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "36b51120-d6be-420d-ac51-1e8bd77cc23a",
"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": "f9357deb-eda4-41ad-b6b6-b065dcd66c05",
"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": "6e1f84c3-3262-405f-b9a3-c86c2e96d40c",
"db_country_code": "sample string 28",
"feelist_id": "13af3274-72c6-4eea-bcec-3fc712765e32",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "046812f1-c551-4310-9ec2-5c927b977223",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3d8caa74-21fe-4277-a7da-9c57f974961a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-28T08:40:29.6763216+00:00",
"db_currency_id": "88edd210-66c1-4b57-a402-a4572687601b",
"db_currency_code": "sample string 10"
},
"company_type_id": "f1286a4c-1d8d-448d-9e6c-ed657a2069bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "69416360-edfa-4008-83f0-32b33a09cd21",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36b84046-f0b3-46e2-8a70-81a6fed55afe",
"sales_organization_code": "sample string 5"
},
"db_language_id": "89d588c5-8f97-4ba3-b926-faacf6872eac",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f348d34-c0f4-45cc-9e7d-39c4eb2914ab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "294024f9-fe96-441c-a7f1-db6e5a29c677",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca1e8ef3-7dec-44da-9fa0-c3295da9eba3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-28T08:40:29.6763216+00:00"
},
"company_sector_id": "89946270-666a-4647-adc8-e203226c0c1b",
"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": "bfdd2ea7-e693-48f1-b77d-b5c463bd8118",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "425e0f8c-648b-4d27-a780-f160c046c172",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e1957417-ee5a-4f7d-88bb-dc26d600ce81",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ff26ab8-4b7e-42d7-831b-748842cd7905",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-28T08:40:29.6763216+00:00",
"id2": 60
},
"db_language_id": "215e8162-9271-482b-8f0d-9207e57495b6",
"db_language_code": "sample string 7",
"db_title_id": "7e4abe75-52a1-4bd3-899c-9277abe4af57",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-28T08:40:29.6763216+00:00",
"create_date": "2026-02-28T08:40:29.6763216+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-02-28T08:40:29.6763216+00:00"
},
"modified_dateutc": "2026-02-28T08:40:29.6763216+00:00",
"id2": 22
}