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": "108d5479-261e-4cd6-949b-0b62ba136868",
"_parent_id": "13e9c5de-cc64-4ab4-b757-328f6b62f5aa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b5079286-30ed-4d5f-bbdf-d8aac39f96a2",
"company_id": "40d46bc4-a6d8-4ea4-873d-bcd90a6cb26e",
"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": "e0a72320-a746-42ff-9634-5abf8ff8c93d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a6eaca76-102e-4d8a-b64c-33a0668b1189",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d750019a-44ae-4e57-be38-85a36d395dbf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d65fdaf8-8460-4ae7-8f23-eb6e61738ac5",
"company_code": "sample string 5",
"company": {
"id": "4de01df8-3c44-4e5a-b8cc-a7a3fa71f7cd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T06:11:59.8798682+00:00",
"sales_territory_id": "e9ff60bf-c600-420c-b9d1-21594678223a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c49736c9-2dee-4881-90e6-7539202ea243",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aea45cf5-9db1-4a0f-88e6-c57dfe8681ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8618bcb-1e86-42b4-b165-ce809c843cb6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5e874d-aee0-4783-968c-1641bf1b169e",
"db_currency_id": "6f87780a-3891-42b9-b664-5335ce783a5d",
"db_language_id": "43dfe73c-4afd-4f1a-bbec-4e47e5a209b8",
"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-08-10T06:11:59.8798682+00:00"
},
"modified_dateutc": "2026-08-10T06:11:59.8798682+00:00"
},
"marketing_segment_id": "1d405dc6-f126-4b13-9500-863e080b94ff",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cb141ab6-68ae-437f-a28c-e9152a28ae97",
"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": "1e0dc39c-eb7e-4057-b2b4-fc1c2130d1f9",
"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": "34cb5cc7-ca69-4ea5-929d-64ed38eb4475",
"db_country_code": "sample string 28",
"feelist_id": "f9d6ce6e-ab30-4a24-825a-bcea5a39ab99",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e69e95a-fb2b-46c5-ac11-1d8fb44122f7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4a7fed2c-537d-4da6-9327-d1d2fc280b73",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T06:11:59.8798682+00:00",
"db_currency_id": "b200ab87-1744-4261-8e4f-4bb0d7374b0a",
"db_currency_code": "sample string 10"
},
"company_type_id": "f3c0caca-6732-4697-9f72-e742ccf33ccb",
"company_type_name": "sample string 32",
"company_type": {
"id": "ccd03625-6716-441a-9058-d138e488d9bc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb57be25-98d9-4473-86d3-844995c0b258",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f144c59e-ab29-46e4-a19d-0d2ae0e2a1fa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cf65eb27-b6df-48dd-ab26-b5e2ab7dbc12",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4538cdfe-2306-4638-943f-424c245884d0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "25598073-8d02-491e-8b10-befbfdce893e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T06:11:59.8798682+00:00"
},
"company_sector_id": "b7d927e3-ee8b-4122-ad70-94e12c4d70d3",
"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": "f3fdfa36-408f-448b-bc54-7a6221972b8a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3192aa67-1203-4e3e-800d-57ce7664836f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "62460104-966c-479e-b0fd-37c67ad4a006",
"account_manager_user_code": "sample string 56",
"company_status_id": "a07ce791-985a-49c5-bef3-d8263fe01814",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T06:11:59.8798682+00:00",
"id2": 60
},
"db_language_id": "8a1c004a-1457-404b-aab0-eb80468ae829",
"db_language_code": "sample string 7",
"db_title_id": "98e966e3-7d62-40e3-be9b-18ac15f57ed2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T06:11:59.8798682+00:00",
"create_date": "2026-08-10T06:11:59.8798682+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-08-10T06:11:59.8798682+00:00"
},
"modified_dateutc": "2026-08-10T06:11:59.8798682+00:00",
"id2": 22
}