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": "5b5e0636-3300-457d-871c-93ba891c14e8",
"_parent_id": "dc7d48e0-53fb-4744-99a6-ae5ff4ec617d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b7f5757b-e568-4f46-9b56-5d14353d1884",
"company_id": "11f55cde-399e-4f2f-a608-ca6c1c8c97e3",
"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": "3bd2903b-bfcf-4428-9643-76c236000ee2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6bf8f9ba-e353-4ac4-8efd-576b4700cf7e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "dffdb19d-8a39-4538-b70e-9d5a282685d0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "80af29fe-6f32-4a21-a52b-49e864a89d2d",
"company_code": "sample string 5",
"company": {
"id": "844458e8-7f00-4a60-bbfa-a68068b9ca2a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-17T12:37:54.8037475+00:00",
"sales_territory_id": "0d885f47-6638-4b49-8195-1839880788a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b9e8eb6f-a352-42de-970c-ef2a7ac7605d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "83fa5f6f-7a60-4425-bbca-897a562856f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e340848-a614-4ce8-ba56-9b06c0c8b159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f795b24-344d-47c9-931b-29b315b7dc99",
"db_currency_id": "f2b995e0-213e-45c7-b845-b82a86ef735f",
"db_language_id": "0e76eda3-f93d-4141-8f1f-5d61828cd03b",
"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-17T12:37:54.8037475+00:00"
},
"modified_dateutc": "2026-05-17T12:37:54.8037475+00:00"
},
"marketing_segment_id": "17298d7c-8b9a-4888-9556-f81ea51b9c0f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "37ceb1a3-e11d-4c1c-a5be-946e4a768dd7",
"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": "26306c6a-95c3-434c-b7c9-cee8c55ccdb0",
"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": "1d253092-8a5c-4141-8dbd-bd9d6c24386f",
"db_country_code": "sample string 28",
"feelist_id": "ff47516d-6d45-4597-8b41-8002269457f3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8a34ffa7-d2b9-42f4-88ad-77c7aea0669d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5147ecb3-8b0c-4f05-9e97-7cb23b0ee4f9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-17T12:37:54.8037475+00:00",
"db_currency_id": "9aa0dc1a-2364-4255-b959-eefe2d978b47",
"db_currency_code": "sample string 10"
},
"company_type_id": "9b2386d2-8f6b-4a9b-9d91-413d2fa0315f",
"company_type_name": "sample string 32",
"company_type": {
"id": "2ea78d6c-65f6-4183-92c3-a771a7eb47a8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d4b8f55-f091-47c3-aa0e-d8827c9523d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8a419a6c-f55c-4528-9899-353eb0fa93e2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7223911-1070-43e1-8e97-d2635ea9e0ec",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "be5552a7-b06d-42f3-a3ae-b51a1785e35c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1852e82b-27bf-4087-94c8-5900424fbbb6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-17T12:37:54.8037475+00:00"
},
"company_sector_id": "9e771868-3666-4836-b2d2-9c7f697da8e3",
"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": "e049a6ed-67f9-4dce-9ce3-486d4909617d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1e8335bd-7e63-45d8-a9ef-2f019b935e04",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "359ef87e-b62b-4946-b0de-6efa6f9fb8fe",
"account_manager_user_code": "sample string 56",
"company_status_id": "ac8321dc-1e15-40a5-aba3-663d5b5984ee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-17T12:37:54.8037475+00:00",
"id2": 60
},
"db_language_id": "d59d8725-ebe5-4dde-9c89-3ca4ef4dd41b",
"db_language_code": "sample string 7",
"db_title_id": "f5263039-4fc5-4ad5-900c-e1b0ec9f7fd9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-17T12:37:54.8037475+00:00",
"create_date": "2026-05-17T12:37:54.8037475+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-17T12:37:54.8037475+00:00"
},
"modified_dateutc": "2026-05-17T12:37:54.8037475+00:00",
"id2": 22
}