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": "b89f1096-35bf-476a-b239-c419ee4ffaa6",
"_parent_id": "ca304d0c-f6f3-475b-b5ff-69609a9a7e85",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bf44d02c-f025-4c40-a3ea-ecaedd0b9dbf",
"company_id": "00a106f2-a398-4f5d-8746-a7375ff41470",
"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": "27b76db5-b3c4-4339-af3e-6087dc62099b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b79d19c6-33e8-4ab2-8845-43414661e39f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9f65b52f-a6f6-4708-bf02-b1c9f2da0ff2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "37bb1fa4-bc83-4860-bc9c-d1edbd548afc",
"company_code": "sample string 5",
"company": {
"id": "06d6318a-eeb4-4a1a-8a69-8297967d00aa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-28T08:21:47.8010062+00:00",
"sales_territory_id": "c5470437-267e-4664-bef1-3549a5dd214f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "52f0ad20-1a29-4a60-bc5d-87ca5c90af62",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a10d63b-a66e-457e-baef-1853f3ef7be7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e9d88e6-cd06-478f-b8d1-8eea8da4b5a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fcd5a6ab-ead9-4440-a051-0930bc132afa",
"db_currency_id": "f61c11a1-9e2f-49b6-8359-6219eb00d79d",
"db_language_id": "b84e8156-5099-4609-b939-86f01b79388e",
"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-04-28T08:21:47.8010062+00:00"
},
"modified_dateutc": "2026-04-28T08:21:47.8010062+00:00"
},
"marketing_segment_id": "79a7199b-dd06-4b75-b7a0-ad599db94f50",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "84a127f2-eb2d-41fd-a314-bb2db5162771",
"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": "d884bbec-018b-418c-a6df-659eb3c6c5a2",
"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": "95fd3282-6845-4342-ba6d-1d0ad5d3f9e3",
"db_country_code": "sample string 28",
"feelist_id": "aa7bc7f4-c890-488f-8355-e538dcb91718",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98e9d598-499e-49e4-abe4-58d87ad9fa10",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "45ef61c2-636a-49ae-9612-483016aee0bd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-28T08:21:47.8010062+00:00",
"db_currency_id": "298f5329-16da-4a86-8f99-54a6e280d2b5",
"db_currency_code": "sample string 10"
},
"company_type_id": "0ea30eab-edfb-4f2f-8abf-a65fb4e5ed97",
"company_type_name": "sample string 32",
"company_type": {
"id": "cd4b0ba6-4c7e-4718-8088-76ab1ada5417",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9dec4761-28c5-4ba0-b0e8-1e42b0c8ef6e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "40ac9da0-cd66-4f55-a4bc-7bb20838c2e2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fdbc5dfa-2cd1-4af7-8882-92303271d00d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f4dace52-6dbe-4360-a0a6-5a320a87e1ef",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "856afc13-ed0f-43cc-ae60-c521800e7a5f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-28T08:21:47.8010062+00:00"
},
"company_sector_id": "fdf196d2-7597-47a3-8855-9631ac60b33d",
"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": "b5a0dce2-4811-4cf1-bfb0-044e80958983",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4fbbe858-47e7-4713-a1a2-a94dbd0dbb2f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3388075d-b879-4670-b726-64b18df7d2c8",
"account_manager_user_code": "sample string 56",
"company_status_id": "e68c93d2-6a45-4e05-98b2-0f9aef079966",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-28T08:21:47.8010062+00:00",
"id2": 60
},
"db_language_id": "698f595f-96ed-4db5-89ca-7b2def3646f2",
"db_language_code": "sample string 7",
"db_title_id": "564f2248-622a-4de0-b579-632ed6167b06",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-28T08:21:47.8010062+00:00",
"create_date": "2026-04-28T08:21:47.8010062+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-04-28T08:21:47.8010062+00:00"
},
"modified_dateutc": "2026-04-28T08:21:47.8010062+00:00",
"id2": 22
}