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": "c7da86e3-ce8a-4322-b90b-c216a2c8dca9",
"_parent_id": "1bb847d7-b42a-4006-bc8b-aa0e878821aa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e66c37d0-3be3-442f-a230-dba73f979e55",
"company_id": "71635947-19f5-4ac0-8f74-bd27ce0bf38e",
"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": "2ac32cd0-6314-4a24-8f5e-0a3457b41e13",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2210097a-2d10-4be2-a172-b291caf86feb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0839f2d1-f191-4327-8037-4f9e01b966b7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2e06b6ad-3462-4e58-8244-f988a8983ed4",
"company_code": "sample string 5",
"company": {
"id": "b68f1cd5-a191-4a98-8b52-008a1d0593c0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T15:41:21.9097628+00:00",
"sales_territory_id": "21fcfc0b-521a-4be3-a576-18cc0983ad26",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aa16d370-fd94-46ec-8ee6-b49c1f45a327",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb1c06e9-86c0-4624-a656-016aab17a453",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c3abe60f-47bc-40f8-a6a2-e3203f32d32a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdbf065c-03c5-4e57-b56e-cb488d958efd",
"db_currency_id": "a1726a54-6ac9-4387-a695-1627396766bf",
"db_language_id": "baa6934d-493a-48d2-8782-6c1edc0ec8a1",
"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-21T15:41:21.9097628+00:00"
},
"modified_dateutc": "2026-05-21T15:41:21.9097628+00:00"
},
"marketing_segment_id": "facda0c2-fb67-41af-9fd2-e2e137f0a4da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0c97afc6-348d-4f32-b426-eebc8c34e80d",
"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": "718d1096-9dd3-4e5e-aeb2-cc6e9152082a",
"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": "7fb21017-2783-48e9-8bcd-78f5611eae35",
"db_country_code": "sample string 28",
"feelist_id": "c7db20fd-48d2-434b-8558-1a9eedc5774c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f239d379-28ce-4b4b-860a-f710685406c1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "db922884-e9e1-4289-b59f-9fc7083f4e9a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T15:41:21.9097628+00:00",
"db_currency_id": "1381c1c9-8b8b-4a7b-b8c1-b0edb2161e43",
"db_currency_code": "sample string 10"
},
"company_type_id": "e31df497-b034-4f05-8cf4-6e4d65e0cc8a",
"company_type_name": "sample string 32",
"company_type": {
"id": "57a1bd6c-7b28-4ca3-8aa7-66059e830dff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57e25c34-485f-4396-9d05-a1a337f1bcb7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cb6a7ddd-cfb5-4c93-9bae-0358b4698444",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4ac4aa2e-d446-423c-802c-a337240adbd0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4d7eccd8-743b-4ca2-9f35-4998cc58598f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a8d5e55c-cbc7-481f-b4bd-1ca2b324c0f1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T15:41:21.9097628+00:00"
},
"company_sector_id": "6b9a6594-dd24-4bae-9c4f-4801a2711160",
"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": "e4adfb86-7bfa-44b4-8266-ff3e274429cb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "06fc612b-47d3-416a-a4e6-2ab87fe51f04",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fca5bb82-6cc7-4790-b385-aa78f713d517",
"account_manager_user_code": "sample string 56",
"company_status_id": "cc38123f-916e-4f8f-ad66-0ab81e039197",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T15:41:21.9097628+00:00",
"id2": 60
},
"db_language_id": "b76e6497-a929-4862-b33b-909b5cab0c77",
"db_language_code": "sample string 7",
"db_title_id": "f2b7ded2-a6bf-4003-b649-1a4aed18c68b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T15:41:21.9097628+00:00",
"create_date": "2026-05-21T15:41:21.9097628+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-21T15:41:21.9097628+00:00"
},
"modified_dateutc": "2026-05-21T15:41:21.9097628+00:00",
"id2": 22
}