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": "38eb0162-8e73-464c-ae03-e8d73ba458d4",
"_parent_id": "23963c7d-c21f-44e7-be74-d991d95388bb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2f642735-c0c7-4a9c-b8b6-a7e8c432485d",
"company_id": "ee18ed5c-1ecf-4fa9-a571-cfb4db5c9037",
"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": "a82b083d-2d97-45bc-937e-e5e3f42c94ab",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0a665069-a887-4af0-a342-aa186280cddb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "58325520-7ba4-4522-9fd8-4480105d5dbc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a322e404-19e7-40a4-84f7-63b093047342",
"company_code": "sample string 5",
"company": {
"id": "a2181fe3-331a-4ba2-931c-46c3d6bed190",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-08T15:54:46.4373496+00:00",
"sales_territory_id": "65c4286c-018d-494e-9c03-192d2b2cd834",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e305e8ea-6fed-41d9-bf20-b52221d14646",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "089f0504-2f15-4a3f-86ee-09d86f0c0495",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18caa0e6-e8a8-4dbd-a346-a056e25d1956",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f50a43a8-b005-4877-8573-593600fb6955",
"db_currency_id": "595d9d4a-dafc-4f1c-bc0c-7888f598c4b9",
"db_language_id": "c8b7f444-a39c-49fc-83c1-156b75386b6b",
"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-05-08T15:54:46.4373496+00:00"
},
"modified_dateutc": "2026-05-08T15:54:46.4373496+00:00"
},
"marketing_segment_id": "d96bed81-fe9c-41cf-8e34-63eca009a205",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b0064d05-05be-40d7-af66-3b1f904f63ec",
"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": "af8bb4b8-690b-4a91-82c6-e196dce1e047",
"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": "346b6938-5078-4430-9dcd-8214524bc1fb",
"db_country_code": "sample string 28",
"feelist_id": "55d347b3-9f00-4725-ac41-bce64a37fc04",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e13b8324-6af4-413a-9c4d-c2586aad7216",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cdd05122-6964-4a5c-ac73-734ccc89f8f4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-08T15:54:46.4373496+00:00",
"db_currency_id": "e0a120be-4c4d-49fa-8e12-b3c1e50c5ae4",
"db_currency_code": "sample string 10"
},
"company_type_id": "180923e6-9cf9-4079-a59b-435a3dc905c0",
"company_type_name": "sample string 32",
"company_type": {
"id": "08e68be7-0706-400f-8b0a-5f8064ec6f16",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b56925f-69fa-4228-9058-61c555720a90",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a8a42530-547f-4d12-975c-f22bad326a66",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e81d7874-488b-4d9f-ba3a-23ca870a3caf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c9a49f97-a247-4b92-976e-dc769a29e3a6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e9c7318-a1ea-46dd-a806-1f37170faac3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-08T15:54:46.4373496+00:00"
},
"company_sector_id": "dea7e5b5-7f70-4a9c-b109-81190d205d76",
"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": "709058ad-12a3-4f9f-b3f4-f580a54679a2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c798b4e4-5ddb-4098-95d0-5b77cc9cf511",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1d4358ae-c75e-43b7-8087-70f21e2c9189",
"account_manager_user_code": "sample string 56",
"company_status_id": "5cdfe0fd-111b-4f2b-b87e-247a926c94ca",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-08T15:54:46.4373496+00:00",
"id2": 60
},
"db_language_id": "6dce4316-5bb3-4215-9e1a-7ede9eb78e3b",
"db_language_code": "sample string 7",
"db_title_id": "0a2c9dbc-deb7-4b7d-9174-55952b9de7eb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-08T15:54:46.4373496+00:00",
"create_date": "2026-05-08T15:54:46.4373496+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-05-08T15:54:46.4373496+00:00"
},
"modified_dateutc": "2026-05-08T15:54:46.4373496+00:00",
"id2": 22
}