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": "9f661f86-911f-494a-9e38-dec877fc9cd8",
"_parent_id": "359532d5-56c2-4148-a6ac-a783e4ead986",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f2309524-26cd-4d87-a62a-55a94295b4cf",
"company_id": "b8d47c3a-32ba-4fc5-8972-ba79d050a4a8",
"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": "7e7453bd-5d1a-41d1-b36a-9ff4ae9cfc14",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "797c674d-f933-45d7-aa30-7c1ff37de9e8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0bac11a8-9e74-4c78-98bd-067fa88f45da",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e4a159d9-cc2d-442b-847f-4c71e0dc6bb9",
"company_code": "sample string 5",
"company": {
"id": "101cdf8c-ac94-49d8-8a96-d0626513fa79",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-31T19:30:04.0553383+00:00",
"sales_territory_id": "2d2e1e67-9c5d-45eb-93f0-958f6dddaa5b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b0c02c26-0925-427e-9a7c-36684f38de2d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffebb08b-5e76-429f-8a5b-f1ec09a293b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e3531492-6431-4e38-9065-dd78c0c78f3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0abdec70-bb6b-46e9-999f-ac1cbe16928c",
"db_currency_id": "ceb8d91b-b3f9-4682-9bda-86c8ce55abe6",
"db_language_id": "09290950-2913-4ff1-b61b-60d6b998d68f",
"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-31T19:30:04.0553383+00:00"
},
"modified_dateutc": "2026-07-31T19:30:04.0553383+00:00"
},
"marketing_segment_id": "ae3a2dd2-ce2e-409f-aa43-11a1a99799ba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1905ce4e-96f1-4522-bf81-972163e0b5dd",
"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": "4c065e18-dd41-4860-922c-a6247fc49a40",
"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": "a5e198a6-76b9-4fbc-b6e3-928f7741528b",
"db_country_code": "sample string 28",
"feelist_id": "d8e3a442-1e0e-480b-b15e-49bd71b36677",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4abc42a2-9374-4fb1-b179-eb4be533f105",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8210c487-a334-4575-ace8-a72423e06642",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-31T19:30:04.0553383+00:00",
"db_currency_id": "25f34f50-0b83-4415-b649-895387412a90",
"db_currency_code": "sample string 10"
},
"company_type_id": "27865cec-7057-4119-b1ab-5f6ecf0a3759",
"company_type_name": "sample string 32",
"company_type": {
"id": "592ab1f3-9e28-4d42-8b3b-835335c458c2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb366143-397f-44e5-9e1a-485a07e59ca0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8383b60b-3784-4f25-829d-0958d5453de9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0bde5ccb-1904-4ad7-9fe0-df21150df252",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "34cf1d3a-8aa6-49b0-bd17-ff41c760d5fc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "51920d97-d8ff-496f-9a9a-fc4684762385",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-31T19:30:04.0553383+00:00"
},
"company_sector_id": "12147d26-c34d-4e71-ad3a-96ddf5036d55",
"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": "75c4cb49-aeb8-48c4-b51b-044934166b5e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ece9ed04-e40f-41b0-b7aa-4f2e3ea9323f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "96b8895d-fa67-45a7-9020-4f60d1dc6f21",
"account_manager_user_code": "sample string 56",
"company_status_id": "3972d735-b4d9-4cf7-b988-36f25f263193",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-31T19:30:04.0553383+00:00",
"id2": 60
},
"db_language_id": "3465518a-de93-4296-ac08-bb68fb7e790f",
"db_language_code": "sample string 7",
"db_title_id": "79d1c1c2-8523-46b0-8cf3-f5a5f176cff1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-31T19:30:04.0553383+00:00",
"create_date": "2026-07-31T19:30:04.0553383+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-31T19:30:04.0553383+00:00"
},
"modified_dateutc": "2026-07-31T19:30:04.0553383+00:00",
"id2": 22
}