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": "3b7a3d9d-51a1-442b-a8a8-1d5e94db3f21",
"_parent_id": "ac721d7d-4d0a-404b-9d84-b80c25f365c4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c4fc38bb-47ef-48e4-99f2-0aa16b6b8af2",
"company_id": "edcbc795-90df-4f4b-97e7-78e4227f605a",
"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": "69d696c7-40d5-42e6-b43d-acd84bb5671d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "79213491-a9c5-4bff-9ec4-af751b0ecf51",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1a56641b-21b3-4576-a20d-12b48d08b81f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cb4aa22a-3779-4549-83d2-1c8bd1630d8d",
"company_code": "sample string 5",
"company": {
"id": "daca2912-c822-432e-bd50-a3d554c13f12",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-09T06:49:27.1636817+00:00",
"sales_territory_id": "0df27d1e-9bed-4a1a-b382-0564051f1999",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1cdedc52-8b45-435a-bb6f-77db792c2af9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "948403cb-0837-4118-ac25-a7df956f45ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "97914f7a-da4c-41ba-a640-acb4d9333ea9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "194e4e19-bddc-402b-b973-e444c29af3fe",
"db_currency_id": "e1c6df4f-19bd-4e6a-ba31-6d58e5f88bf3",
"db_language_id": "7be1216a-ffdd-4b97-9389-90630ca3f38a",
"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-01-09T06:49:27.1636817+00:00"
},
"modified_dateutc": "2026-01-09T06:49:27.1636817+00:00"
},
"marketing_segment_id": "5aa8388e-d5fa-4a06-91b8-5fa26b0383c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eaf72429-b699-4a85-8efb-d752e2e6e210",
"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": "e37f4115-f1d3-484d-a941-fa00d879590b",
"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": "044a88f0-9123-46be-9b4f-fca2a584eef4",
"db_country_code": "sample string 28",
"feelist_id": "011090b4-31dc-4b08-98a9-59bf0d585e46",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "19d2ec15-b262-41b7-b6bb-a2b6b5197b23",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "85db625e-4623-4c16-85d5-c7b1377c7125",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-09T06:49:27.1793081+00:00",
"db_currency_id": "24f91189-b09e-448f-b162-f0c2dfdddede",
"db_currency_code": "sample string 10"
},
"company_type_id": "8d6a59b5-cdec-4d9e-a538-1efd416ab28e",
"company_type_name": "sample string 32",
"company_type": {
"id": "a82cfe33-6653-40b2-b736-4968dfb01ad9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d601c455-a800-485c-a9ba-2b227122f389",
"sales_organization_code": "sample string 5"
},
"db_language_id": "64e8be54-9612-4be2-8d56-d15bba416917",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d8560715-dcb8-4c07-8fdf-88154cda447e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a476c0c5-9674-4a61-ad87-b3d01006ac76",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "712f71b5-e018-4793-8816-7f5c44751910",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-09T06:49:27.1793081+00:00"
},
"company_sector_id": "c66372e3-7122-43da-8087-d82dc23089ca",
"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": "5c81ee0b-10f4-4f47-9d65-f80cde85cc4c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a8be9121-eb8d-4e0c-9d6e-5dc7b5699a1e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "97584e05-8cbb-4b06-aca6-190e0ecb2c9a",
"account_manager_user_code": "sample string 56",
"company_status_id": "73e06040-2a80-4371-8c6a-73e733fc7fa3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-09T06:49:27.1793081+00:00",
"id2": 60
},
"db_language_id": "d8af0ad9-63eb-4882-a580-9207ccbde4d6",
"db_language_code": "sample string 7",
"db_title_id": "b965be52-e55b-4dfb-a8eb-9a93a35db862",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-09T06:49:27.1793081+00:00",
"create_date": "2026-01-09T06:49:27.1793081+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-01-09T06:49:27.1793081+00:00"
},
"modified_dateutc": "2026-01-09T06:49:27.1793081+00:00",
"id2": 22
}