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": "febfb239-477c-477a-b426-cd59940e0f5d",
"_parent_id": "1bb14b42-e205-48de-8bbd-7a2ab00555ca",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "46d7ab8d-e807-43ca-be61-b333da5048c5",
"company_id": "08ac3247-b2c0-45d4-bc90-232bd7dc6772",
"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": "f0c70cf2-418f-4934-9959-8e4bc35617fb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ab09f729-6240-4f70-8078-d18b5370aa02",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "422e54bc-d8a8-4333-bc99-77b5a3e8f615",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "480e7105-0c25-476b-863b-7d530648da7b",
"company_code": "sample string 5",
"company": {
"id": "44bf807b-1413-4fa7-98dc-176b9fb9fee0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T19:17:22.1491565+00:00",
"sales_territory_id": "e7aff357-7d67-4bd3-af2c-406484d71cce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a59fbbaa-645a-4a96-85ca-ba09d304b9e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41e1bfc0-b82c-4be6-9235-44a01e8f1bce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "51736d19-d7d3-41c3-b6ac-b614bc8ce653",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "edab5f61-1cb3-4dd5-8bce-89596446f40c",
"db_currency_id": "d67b5f70-a17c-4909-9c08-a6b7f27215a5",
"db_language_id": "34b0e567-f664-42de-b3e0-8ac306c25ad8",
"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-17T19:17:22.1491565+00:00"
},
"modified_dateutc": "2026-07-17T19:17:22.1491565+00:00"
},
"marketing_segment_id": "4d53f6a4-f00f-4af5-b5e2-0a9132cc4c0c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b098e54b-c140-4222-93f0-dff04acb529e",
"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": "2548d9e7-7ddf-4d0f-b6d2-d1e51067c0bc",
"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": "0536cf0d-d4c7-4047-ba58-645243623f9c",
"db_country_code": "sample string 28",
"feelist_id": "3feff263-89a0-49fd-a383-cdc6b6b7ae1b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "45b42cb9-ab4e-4307-b7b1-298c74b6e5d0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6776113e-6cd1-4d25-b30b-cd3ffe6d9e0a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T19:17:22.1491565+00:00",
"db_currency_id": "a151cb87-6e90-4473-8d31-67c73268d1d7",
"db_currency_code": "sample string 10"
},
"company_type_id": "de5207e9-8ad5-4dbc-afc4-44ae7900697d",
"company_type_name": "sample string 32",
"company_type": {
"id": "d79ef030-56b7-4e3d-b9fa-66a5c89789bc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "379f2cb1-1fc2-4ba9-9991-950bd8a8c612",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0a4f5b6e-3524-4252-9754-09fd01b34450",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a5555ee9-9a33-4bc1-8303-562029eeccfd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "947b2fd2-9092-44cf-a35b-1f5645c3c91c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "386251c1-d8f3-44c8-b77d-ddd440eb2963",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T19:17:22.1491565+00:00"
},
"company_sector_id": "06fa95ed-f148-4101-bc76-35eb51be766b",
"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": "10cf2389-1212-4cdb-9c40-29490ea5399c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5b778c71-5b20-48d3-ade9-aa4f5c3bd554",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "50ed3c46-8547-4161-9c60-7b67475a3cde",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3100aef-19b1-439a-8a4f-a28aa7ad0945",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T19:17:22.1491565+00:00",
"id2": 60
},
"db_language_id": "11c28139-cd50-4bad-999e-7805b0bfd60f",
"db_language_code": "sample string 7",
"db_title_id": "583dbc53-4dd9-4368-afc0-7be22acac271",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T19:17:22.1491565+00:00",
"create_date": "2026-07-17T19:17:22.1491565+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-17T19:17:22.1491565+00:00"
},
"modified_dateutc": "2026-07-17T19:17:22.1491565+00:00",
"id2": 22
}