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": "e9b92cd9-aacd-439f-a15d-086cba31257c",
"_parent_id": "b8008d16-e4b3-420b-9a4b-5c7a68249d23",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a8bcd6c2-47c2-4ec6-bcad-501026c0fdbc",
"company_id": "00d7187d-2189-4954-85a8-062c92d60906",
"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": "0da6545b-91c8-4ef1-8dbf-37c602280b60",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "32f252c3-ebfa-4c16-ba2c-32a338fdc52e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d79b230f-9666-4b67-a373-53baa6a96cf0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ef9fea56-8e71-4fdf-b60f-8b7e6372be0e",
"company_code": "sample string 5",
"company": {
"id": "b5d35f5e-e3eb-45d0-990a-d7bd1bfa4d34",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-08T12:44:33.0546731+00:00",
"sales_territory_id": "0c23ae30-1f69-4358-9e68-efad15195a64",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "66fb7876-50dd-4a7a-a15a-f547e60bfd08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6be35992-e31e-4815-b389-86cf50a7c9f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "763b3303-611e-477e-9aba-81e9f20854d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03eb63dc-77a9-428e-b55c-120c90ccc125",
"db_currency_id": "3b49e34f-4be8-4ff4-b533-0750e9e19eb7",
"db_language_id": "006baee7-5f3e-4c55-aba0-631dd78af485",
"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-08T12:44:33.0546731+00:00"
},
"modified_dateutc": "2026-05-08T12:44:33.0546731+00:00"
},
"marketing_segment_id": "5a873df2-93a7-4d98-90d4-7684d11b1f22",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "21dd200b-236f-4427-8719-924598bb1820",
"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": "3514b23c-ea78-400d-ba34-6e748331db89",
"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": "538b4fdc-7e90-47f0-8024-9a4e950c1279",
"db_country_code": "sample string 28",
"feelist_id": "e292251a-d845-4e4f-84f6-05b1b3ab8190",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "256214f8-cf35-4321-9da4-6d8d18496432",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "037cef34-84b3-490d-a0d2-13d38021ea1a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-08T12:44:33.0546731+00:00",
"db_currency_id": "9bc9cd2d-b0f3-4b36-826f-ba8b15dca319",
"db_currency_code": "sample string 10"
},
"company_type_id": "18defebd-034f-4ab9-a0b8-1896f437f716",
"company_type_name": "sample string 32",
"company_type": {
"id": "6703aba6-437a-4e7e-8518-6916b45989db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5abb1ed7-74fb-4e82-9056-7fd2f6c83628",
"sales_organization_code": "sample string 5"
},
"db_language_id": "05945252-60a4-4ba1-b996-51fb91ca17ba",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c6552ff3-59f6-47b7-92a1-328ee7ae1724",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2ede948f-ef01-43f7-b552-e3cc5685fde6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c28b4b45-28e1-4b03-883d-cd06f7f18d24",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-08T12:44:33.0546731+00:00"
},
"company_sector_id": "c8e1c451-082f-4a5e-927b-294a15e659f1",
"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": "fbd96695-d7b9-40c6-8f9a-43ae6a971738",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b5a8ddec-d4ee-4467-ba81-3fb075b70f2f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a8d6c16e-55bd-4c36-bc27-e318905ee925",
"account_manager_user_code": "sample string 56",
"company_status_id": "1efa7be0-0da5-4354-8ddd-7ccb870a7693",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-08T12:44:33.0546731+00:00",
"id2": 60
},
"db_language_id": "458e278e-2bbc-4286-8553-e44826c01382",
"db_language_code": "sample string 7",
"db_title_id": "b3389a7f-c786-4a5b-8d7e-f5fd026651ef",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-08T12:44:33.0546731+00:00",
"create_date": "2026-05-08T12:44:33.0546731+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-08T12:44:33.0546731+00:00"
},
"modified_dateutc": "2026-05-08T12:44:33.0546731+00:00",
"id2": 22
}