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": "f45ec7c7-a7c8-4429-a55b-81381c530e3f",
"_parent_id": "1f50b8cb-acfc-48f7-b21b-415c76162898",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "61e4b909-2a07-421e-94e1-b6dd3894d237",
"company_id": "b7485df3-3127-4de2-bfe2-d9d6b5c7fe72",
"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": "f95cf8f9-69cb-4885-8faa-1cd756be2314",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "73a644f4-d862-477a-8042-46b9c38428c6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8c1654ca-64a8-4d6d-ab19-0598ea131323",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a4271d1-4756-403f-9645-11ed3cb4e643",
"company_code": "sample string 5",
"company": {
"id": "f2011520-0a45-4577-af2c-6cfe20c83664",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-10T16:23:04.6360394+00:00",
"sales_territory_id": "367d143c-e275-401a-8cab-e7e5fbafe66c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "61cd0475-a529-425b-9df2-8172446fc3b8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3fea3adb-2794-4544-a020-33780a7f17f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2fdb255a-f4a5-4ba8-80dd-71166e8c391b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a1c7ee-a71e-424e-bf72-40f1b0cea3d9",
"db_currency_id": "9c504556-6d9c-4f66-b4e5-7073ad03de99",
"db_language_id": "1b74b1cc-7ff4-498b-8e5c-2c307bcc6aea",
"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-07-10T16:23:04.6360394+00:00"
},
"modified_dateutc": "2026-07-10T16:23:04.6360394+00:00"
},
"marketing_segment_id": "bbf3ba67-a3d7-4274-9b64-9c5622156f62",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ea7840ab-8b74-4dc5-b8dc-42723bb142a9",
"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": "6a5cb1cc-c002-4686-b4b1-8c40c38c8d1c",
"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": "c88d7fe9-1c3f-40ab-9efc-18f2470d6ed2",
"db_country_code": "sample string 28",
"feelist_id": "83e77b9f-b5da-49b9-8405-ddbf82e79fee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "623eb377-7bd7-4ef1-aa3e-4b6b39bbf3f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fb7e2fe2-eb21-488c-80db-c633b778d024",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-10T16:23:04.6360394+00:00",
"db_currency_id": "aa1d5501-6a57-463e-9963-c88131906cdf",
"db_currency_code": "sample string 10"
},
"company_type_id": "0a4a8ba2-b853-4ded-a116-ff147946d7a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "20bb44ed-e5a7-4a5f-b049-e44a7a5a2eb7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "011fa1d7-6c23-4476-8ae1-8a275a5a1af7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "880b9ac7-a6a2-4a8d-9f5f-3d081c3e68e3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "53241154-5aa2-41cf-a473-191137b8bec8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3bdacc24-f228-4f85-bc6a-b58e02afa339",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a6bb28be-91a2-40c8-b60a-7868e6c7490a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-10T16:23:04.6360394+00:00"
},
"company_sector_id": "754d92cd-1c44-4909-bc22-887c927d9252",
"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": "3bb883c4-f9e1-43cd-8f1e-56adbb1d2a9b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a04793e-81da-4860-aafc-b5fab3791572",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e2162cb-4603-46c7-b859-9a64117c9b7d",
"account_manager_user_code": "sample string 56",
"company_status_id": "b8a15b0c-9e3c-4f3b-a495-a1c0f8ef847c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-10T16:23:04.6360394+00:00",
"id2": 60
},
"db_language_id": "628322a4-58e9-45a6-ac46-977b0149a40e",
"db_language_code": "sample string 7",
"db_title_id": "797e7129-55a1-4df9-80c0-167c15bd3f37",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-10T16:23:04.6360394+00:00",
"create_date": "2026-07-10T16:23:04.6360394+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-07-10T16:23:04.6360394+00:00"
},
"modified_dateutc": "2026-07-10T16:23:04.6360394+00:00",
"id2": 22
}