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": "0c2f7d73-5ec8-4d22-b84b-f3624dd1e223",
"_parent_id": "ecc7a1cf-e5d9-4849-8858-c446c2ee6d3a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f5c8cb20-7508-4a15-aa0c-b37a75da9a51",
"company_id": "6f69efef-772b-4fc2-bf76-7909ac4b6d88",
"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": "ba1c187c-9b1c-4247-935d-5880b715708c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2fc8357e-5d4e-4e9b-8a37-706ef9ba2c99",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6f41e00c-8210-4d48-ad2b-076d21a7a2c4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8cb5784b-8d3f-45c5-97ad-ee7ba09061d5",
"company_code": "sample string 5",
"company": {
"id": "f1909fb4-345f-4e08-8e8d-dcf3a138d72c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-18T17:55:06.019245+00:00",
"sales_territory_id": "c262376a-633d-4eb6-aa90-a31527231957",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "41640fb4-621d-443b-9371-6d293b3726ca",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "79434b34-a888-4874-af52-dfd999039a37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0358d234-aaa6-4f8f-b890-3c74f6c7b651",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2692cbe2-1d9d-4b60-a641-55b06255982d",
"db_currency_id": "883f91ba-e0f3-49ba-892d-c57997f4eb28",
"db_language_id": "1201b31c-b269-4634-b13f-e573f012390c",
"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-18T17:55:06.019245+00:00"
},
"modified_dateutc": "2026-08-18T17:55:06.019245+00:00"
},
"marketing_segment_id": "051b4549-f5f2-43c7-9f3f-ab2c5ed0eccf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "572c0d94-51bd-4d85-ad5f-2442a1c6656d",
"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": "715360f2-5857-421b-b0ee-f0131e4d9697",
"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": "90eaa994-9bc6-4704-aa01-ff57cf1c962a",
"db_country_code": "sample string 28",
"feelist_id": "a92504dd-056f-4249-bb3e-2cf5f1313a85",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "63781bc4-decc-405b-b75c-092d9ba4e67b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "823b6323-abb3-4c25-b1ed-5303d575c4b2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-18T17:55:06.019245+00:00",
"db_currency_id": "02162c81-fac0-43e2-b823-e4f1d468c949",
"db_currency_code": "sample string 10"
},
"company_type_id": "59dd10a4-cf8c-429a-83d3-b6782cf89f27",
"company_type_name": "sample string 32",
"company_type": {
"id": "61e96d1b-d8e9-48fd-a96d-94944b4f7738",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6681f2ac-5e83-4aea-b9b0-cb05cba1f778",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6723b734-aadc-4be4-bf28-f74ddff679ef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7036eed0-3895-48e2-a939-532ec3e11f69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7faf22c7-ee2e-4902-a4b4-0902763dbe5a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f1fa7c4-bae0-416e-a006-828be90cd51b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-18T17:55:06.019245+00:00"
},
"company_sector_id": "d57be9c0-9760-43ce-a517-48b9b057adda",
"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": "778d166a-d2bd-4376-aeda-d822d9c9b6ee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e1ce95a3-0398-4b3d-a192-b07362ecdf71",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ecc6b1e2-4792-4980-ac68-35c4126fab6d",
"account_manager_user_code": "sample string 56",
"company_status_id": "e2503618-4d75-4956-b1c2-7a6eb5f0ec99",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-18T17:55:06.019245+00:00",
"id2": 60
},
"db_language_id": "fb68e935-7e64-41bb-839a-22302b7f5d90",
"db_language_code": "sample string 7",
"db_title_id": "b17cbc68-ab29-4e4a-a010-54880f14ac35",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-18T17:55:06.019245+00:00",
"create_date": "2026-08-18T17:55:06.019245+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-18T17:55:06.019245+00:00"
},
"modified_dateutc": "2026-08-18T17:55:06.019245+00:00",
"id2": 22
}