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": "9f09fbe0-da0f-42b8-80ce-f47b7af450d1",
"_parent_id": "9b7a38a8-13d4-4031-a5a2-165dd9264a00",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "57107f56-7885-4a93-b326-19606ad783bb",
"company_id": "2a20dbf0-fdf3-445f-b9e1-881ff3870fa1",
"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": "ba1d9704-1dbc-4521-9e2a-066b22b40ea1",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bbd080da-d669-4fcc-9adb-ea573d889a06",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cab6ac22-a35d-4661-9bdd-e3ccd7fa5e3e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b2991e79-7904-42eb-a0ee-111651a86b8a",
"company_code": "sample string 5",
"company": {
"id": "eef436e9-cecc-4992-90a2-e8e2a2175da8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-03T20:50:37.7367129+00:00",
"sales_territory_id": "0a3a5dae-90fa-469d-a6c2-603b93411fd1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ba3a80a-9f8a-4e86-a53f-0b733e6b661e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9ed86d45-034c-468a-91a1-a6ac9f679b68",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df98918e-f77d-44af-992b-427983e85a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "566941aa-2355-4b11-ac90-41d342f59b98",
"db_currency_id": "43b2234b-9198-418d-b426-2084e51292f9",
"db_language_id": "49fb28dd-6cf5-472e-aa11-c6733b470ba5",
"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-06-03T20:50:37.7367129+00:00"
},
"modified_dateutc": "2026-06-03T20:50:37.7367129+00:00"
},
"marketing_segment_id": "5eb6994a-4c80-4d04-9cec-a2fec5f24543",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "10e65285-53d2-48b3-8b89-e25e92c0bb58",
"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": "c3c1d60d-1138-41b3-962a-8a4e77abbd9d",
"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": "233a8579-c24a-4090-91b4-fecf91aaadf2",
"db_country_code": "sample string 28",
"feelist_id": "49df91f5-d43e-4768-8405-0500d233b109",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fc73eb68-fc61-408e-bed9-4835d54882bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "45286d08-2f87-4376-b3a7-8d762b91bc71",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-03T20:50:37.7367129+00:00",
"db_currency_id": "26c93ed7-442c-4016-8591-e5eb1775ad9a",
"db_currency_code": "sample string 10"
},
"company_type_id": "f82ccaa8-5135-4308-bdb6-1c66c1cbcde1",
"company_type_name": "sample string 32",
"company_type": {
"id": "4699b09e-5718-4638-82b4-ad88e57cf938",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e7c0e8d-c268-45ee-bbd6-b81a993338b0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9d7766d5-c680-4b96-bf27-fc90b8b950a9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6b79b889-7fff-4530-9180-5ea6ff1bafe4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fc83336b-fb85-4ab0-9864-8f5af03d1bde",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "189502cb-b7ec-4ff1-8c59-0527267785d6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-03T20:50:37.7367129+00:00"
},
"company_sector_id": "87065ebb-8593-4203-bc22-14ff3e1503c9",
"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": "fa27198c-f7c1-42c5-9f5f-7530644ef7e2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6444cbe8-b0c1-41d1-9b56-0182b0f8c981",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "365af22b-b384-4613-8aed-8ee514d7bf26",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3a2c3a1-99e6-400f-a5d6-f08af2ba1288",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-03T20:50:37.7367129+00:00",
"id2": 60
},
"db_language_id": "9d180d57-1f9d-4d6b-8f31-ac8b5f893e17",
"db_language_code": "sample string 7",
"db_title_id": "11eb2055-381d-4949-a777-2c452e94d75a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-03T20:50:37.7367129+00:00",
"create_date": "2026-06-03T20:50:37.7367129+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-06-03T20:50:37.7367129+00:00"
},
"modified_dateutc": "2026-06-03T20:50:37.7367129+00:00",
"id2": 22
}