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": "d8963ecf-786f-416c-8f3a-ac09279b123c",
"_parent_id": "0671e2b8-36f5-48a5-9751-e612b94072f6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2318f91e-0cb3-4917-8e54-b8cef59e69dc",
"company_id": "8d8e197f-dcd4-4d39-88db-0b32d828f353",
"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": "7418f665-347c-470c-bc1a-b1303e9694fe",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "16168617-9351-442d-af8c-b3e7a66153d3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "60bde8b8-7f2c-4915-a318-8299234cb986",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ebb5432f-41bd-444b-99b4-6372972c4462",
"company_code": "sample string 5",
"company": {
"id": "c0e16583-dccb-4862-8eaf-bb1af8caffaf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:53.180295+00:00",
"sales_territory_id": "6e3abcf1-afb6-4390-87c7-e29a5539f4a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "01704dbb-ccce-4401-83cc-0d18dc597144",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ecb8796a-3032-40fe-a7f8-babfc5cd358d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8cbd4d7b-f199-4450-8a15-9e1d037466e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "814c52e0-8279-40d5-add7-6c71fae333c6",
"db_currency_id": "3cce4e59-f352-43ad-a626-fa8a7979f4c0",
"db_language_id": "c4ce26ba-0db6-423e-9511-78912d2b896e",
"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-02T03:48:53.180295+00:00"
},
"modified_dateutc": "2026-06-02T03:48:53.180295+00:00"
},
"marketing_segment_id": "7623ef37-81ca-466e-999d-d414894bb8e9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e597ca26-13ee-42ee-bfcd-c193dbffc822",
"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": "52a9836d-9d28-43bf-991a-752626f44c1d",
"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": "24b614dc-569a-4198-83a2-2f02c057102d",
"db_country_code": "sample string 28",
"feelist_id": "4d797cdb-721c-46b2-8cd0-3333bd00ef91",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e1bb0e0-d98f-41cc-a2d1-f15417d45e07",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c405bb8a-d722-4a44-84ad-7c365321cb0d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:53.180295+00:00",
"db_currency_id": "62f3cfff-2f97-47ab-8312-0b10fb8e323c",
"db_currency_code": "sample string 10"
},
"company_type_id": "dec1b055-c848-42f8-b24a-98026830bfce",
"company_type_name": "sample string 32",
"company_type": {
"id": "ac42828d-6fb4-4b66-b3e1-cd92c6cb9790",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6232138c-d8ae-44f0-bc7b-bc9d529e23c2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "608c4144-8a57-4107-bfb7-f4b88fb4127a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5263e350-87d9-4e95-85d3-fb6b40a902e3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9dbe02b0-79c2-4a2c-9db8-4c7b8536826a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "561d803b-d376-423d-9bfb-bd4b599ffc30",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:53.180295+00:00"
},
"company_sector_id": "3212a87d-02fb-4643-a865-b4e20dffaf60",
"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": "4d8738c4-a0c3-4b67-acce-c47d312206b9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e3f1533f-a22e-4193-8509-507dbf833a35",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "927e86bc-d557-4094-b51d-aea52d7684d8",
"account_manager_user_code": "sample string 56",
"company_status_id": "8377ffb7-3a6d-48e0-a22b-07f3566a518b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:53.180295+00:00",
"id2": 60
},
"db_language_id": "1d95471e-fb6e-4a8f-a7e5-6ad1da70b2c4",
"db_language_code": "sample string 7",
"db_title_id": "8eaf2298-1632-435e-82e1-06b92443f9b6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:53.180295+00:00",
"create_date": "2026-06-02T03:48:53.180295+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-02T03:48:53.180295+00:00"
},
"modified_dateutc": "2026-06-02T03:48:53.180295+00:00",
"id2": 22
}