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": "a479142a-1743-490e-8da9-8bec9bf54745",
"_parent_id": "16bd218b-d505-48cf-b3d6-9da511b8c449",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1c79fe36-1ee5-43ee-8202-62a56443a4e2",
"company_id": "85eb9774-e57c-41ed-8fc9-b9c67d3a91fd",
"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": "8c4059c2-26a5-4163-ab2e-086f3430fada",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7db341a2-8d39-44f7-9907-44eba60ab240",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "09d2b3b1-4bc7-40ba-a5c6-1b2e5608bd87",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d20d4526-06c9-402b-b690-0daa9c2d5036",
"company_code": "sample string 5",
"company": {
"id": "0c7161bd-dc5e-4540-ac99-00114f32ad5e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T19:32:11.1088965+00:00",
"sales_territory_id": "fef82ea2-68a5-4dab-abca-3601b3a3a08d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7b834028-9de0-430e-9868-fa90e16c703a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c5d42ca-6e66-40c9-8026-c4a4ba8ed55f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "52b6751a-3de2-4168-ad4a-8540feef59bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30b9d4-e6cb-493a-8ccb-55e6a77e32f4",
"db_currency_id": "ce95f890-499d-4c34-b3f7-88540a9608ed",
"db_language_id": "af6ffa93-cacc-440c-b3f0-96873f0ade7d",
"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-20T19:32:11.1088965+00:00"
},
"modified_dateutc": "2026-08-20T19:32:11.1088965+00:00"
},
"marketing_segment_id": "757730fb-0ee1-4480-8577-6170c16f610e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fca06181-b577-43d3-bd15-c6cbb75137c5",
"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": "6b02e943-f48d-4a2f-958e-3c5c14cab8d2",
"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": "621a3c80-8a3d-4b1e-a768-5f2379b394aa",
"db_country_code": "sample string 28",
"feelist_id": "22e516c1-93f7-4912-b70c-0c39ad4cfdeb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fc43e929-a46e-4481-8188-069dc2b6402a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a4434d74-ec0f-423a-aff3-c247e06369bf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T19:32:11.1088965+00:00",
"db_currency_id": "f1c176cb-8501-492b-851a-30b04249de6a",
"db_currency_code": "sample string 10"
},
"company_type_id": "a40792b7-aae6-4d97-b52a-7931bea46a6c",
"company_type_name": "sample string 32",
"company_type": {
"id": "2cd3a582-8fa1-405a-b8c5-e7e489967502",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5fae143-ccaa-49c5-927b-64202c17fa55",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45f015af-d650-4896-ae4d-ec156a4f81e2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7c03f294-bcfc-4fbd-af88-94b018d02c12",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8eeb4d69-3d43-4669-ab58-099ad333e1ff",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "51c7fd69-9ee0-4d67-8b61-c1670b944c76",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T19:32:11.1088965+00:00"
},
"company_sector_id": "fa2f48ae-d199-44e2-97ec-e6b0f231d613",
"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": "681e353c-53a8-473b-86c3-64c0c075977a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89b61e11-9bb7-4b4a-80aa-bca195899497",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86e5810a-0b99-4004-bf80-8d3086100a3f",
"account_manager_user_code": "sample string 56",
"company_status_id": "3bd3e229-7d3c-4e13-b602-b8bf796d5edf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T19:32:11.1088965+00:00",
"id2": 60
},
"db_language_id": "cf89b038-c9e6-4fe1-9b61-7b1b56782fd8",
"db_language_code": "sample string 7",
"db_title_id": "251e7c5a-54a0-4855-bba8-50d09c5664b0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T19:32:11.1088965+00:00",
"create_date": "2026-08-20T19:32:11.1088965+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-20T19:32:11.1088965+00:00"
},
"modified_dateutc": "2026-08-20T19:32:11.1088965+00:00",
"id2": 22
}