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": "971639b1-5c34-46ff-816b-f70365b30d21",
"_parent_id": "c55d8fa3-a5be-4fff-ba99-9420e8fe03f0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d7aae5e5-d7da-4467-95ca-48178dc59fe5",
"company_id": "1b783a13-a79a-4b54-bc7a-ba8a21de26b4",
"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": "e6770dc7-a604-4361-9807-39b7426c10b5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a753fbc8-ee77-4016-bf7a-bd8bf05e9ab4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2077f556-137a-4585-993f-50c7d4bd6263",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fb650f36-9d3a-4287-ab7e-39387e395b5c",
"company_code": "sample string 5",
"company": {
"id": "5b7d9bf4-81b1-494f-a19c-294ac665b185",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T05:36:04.2402877+00:00",
"sales_territory_id": "482bef5e-4c71-4681-b825-4ca46d5a151d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "60dd3917-e8ac-4980-ab80-37879f50b007",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fc538d57-a529-47b8-ae3d-ac25f9eb35b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2fc1bd69-3b81-4782-9ffc-0e644cfc9d5c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52998a02-4e97-4343-84da-996837c916a7",
"db_currency_id": "26b82996-b2ce-4a61-8bc7-3358b8763d55",
"db_language_id": "6b0b8a13-5615-47e2-a439-d79bf2b48818",
"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-06-25T05:36:04.2402877+00:00"
},
"modified_dateutc": "2026-06-25T05:36:04.2402877+00:00"
},
"marketing_segment_id": "d316efd4-04fe-4c46-9324-ae1db6018356",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6b9a05e5-0b88-4dfb-bfe4-96559637d083",
"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": "4d68cc42-df88-4daa-b27c-caee08b62b00",
"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": "18c41fc4-deaf-4b8c-b726-efca172a1cf4",
"db_country_code": "sample string 28",
"feelist_id": "50bdaf0f-58e3-4d32-bd99-3ec81910ec15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "27089af1-7b1f-4bb4-80f9-442ddf87e7ae",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2e366d92-2837-4507-865a-07e0e6c96fb4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T05:36:04.2402877+00:00",
"db_currency_id": "9bee27d8-dc23-4d81-b929-c41a59d706d9",
"db_currency_code": "sample string 10"
},
"company_type_id": "63a78ee1-e618-4d07-9bf0-adfc713f9723",
"company_type_name": "sample string 32",
"company_type": {
"id": "18872b9b-4011-463c-9108-a464a45786b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dcdc152c-1f9d-4ead-83e2-b29a072090b4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "32ee39dd-3802-402d-b873-77a8852b0004",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d6c2f074-6400-4170-80be-ed580c1847d4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "30837776-686f-4869-b6be-59dc077b9dc5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1aa9b39b-9170-4cfa-b67a-86c034952091",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T05:36:04.2402877+00:00"
},
"company_sector_id": "2a0186d1-2fd5-41e1-a9d3-8b3823a6f50f",
"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": "e133e83f-6c79-4f33-b3d0-08199fd3330b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "296db7c2-777f-4400-81c5-dc9f0e4d4934",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1022483-0fa6-42ea-8281-84df2ca12a1c",
"account_manager_user_code": "sample string 56",
"company_status_id": "31fe57bc-a4b7-4ff6-813f-08f4a1023bf8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T05:36:04.2402877+00:00",
"id2": 60
},
"db_language_id": "19a03d22-9dbb-437f-a13b-249486916360",
"db_language_code": "sample string 7",
"db_title_id": "fc92b66c-c9ca-4b89-bcb2-4564be200490",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T05:36:04.2402877+00:00",
"create_date": "2026-06-25T05:36:04.2402877+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-06-25T05:36:04.2402877+00:00"
},
"modified_dateutc": "2026-06-25T05:36:04.2402877+00:00",
"id2": 22
}