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": "a185b3aa-d3ec-40c3-b5fe-a51d7f802500",
"_parent_id": "60279724-d3d2-4992-880f-a35736f9a622",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b4ac8d52-bf42-4a3f-8650-fa2a667824e3",
"company_id": "902e95d2-822c-4985-a3ef-69b9ea235ceb",
"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": "6cd0d7ea-d3f0-404e-9534-f0c9c1ed009d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2a452bd3-0541-4f4b-8a9d-b6989528307b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ef5fe96a-c32f-465e-b5f2-391aa2051d74",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ae950091-4ff4-4967-b1df-591139d85155",
"company_code": "sample string 5",
"company": {
"id": "85efd922-0975-4f3e-8574-a2a7f366bd78",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-07T21:00:53.0494573+00:00",
"sales_territory_id": "f6f97c5b-fe39-4a5f-9395-faa49d414e13",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6fec4ca5-3b41-4833-9741-1467b9a394f7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08c9c994-68c8-4e38-a679-da53e67b28ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be7a7fee-e869-4efa-ade9-b9e97b808b1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a510ecab-a4da-43f0-a3c1-f25e350bf179",
"db_currency_id": "912caa13-eabc-47c0-97bf-08d3371f27de",
"db_language_id": "f898e68c-a342-4f0f-9daf-e8cb6695d8cb",
"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-10-07T21:00:53.0494573+00:00"
},
"modified_dateutc": "2026-10-07T21:00:53.0494573+00:00"
},
"marketing_segment_id": "2f299a81-8383-4c0f-83fe-86108434aec2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "42a26f94-69de-47b9-bb08-01eeff983b06",
"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": "62045b21-a547-489a-ade0-fde74d045eac",
"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": "a8f18f87-7002-4d71-b6ec-5869cef06445",
"db_country_code": "sample string 28",
"feelist_id": "bb0bdc53-6021-4109-8ba7-2d16ee40bd75",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "05936195-f7a3-4ae5-a6f3-4a497aa68350",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e1c033a2-1703-41d5-b96e-92a8d2565913",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-07T21:00:53.0494573+00:00",
"db_currency_id": "52cc623c-50a0-483c-b5d0-00f4d39f323e",
"db_currency_code": "sample string 10"
},
"company_type_id": "9b7aa4f3-38bd-42c3-904f-4b4704c6e54d",
"company_type_name": "sample string 32",
"company_type": {
"id": "2059dc61-7e9f-4c2d-9942-2fcec8a1267f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6fb90a4-c47b-4b08-a11d-530023a560c0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "465e7409-9f88-43aa-93fd-826bc1ef1d61",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d5364b26-da9e-4741-a9f1-2ea8a71b5385",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8e8d1649-7b27-45c3-b245-bd212c3c60a2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ef99c704-b92e-4a67-8bc3-e97c4808543e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-07T21:00:53.0494573+00:00"
},
"company_sector_id": "3c57b298-4c9f-4cf6-baae-0a0d3beae769",
"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": "1294074a-ed70-418e-88c8-a99fe0534035",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e06a383a-63c6-4528-a41b-bb833ec5e8ae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0024fb9-e884-40d0-955b-a483922f8abf",
"account_manager_user_code": "sample string 56",
"company_status_id": "6a2f1a57-b708-4897-ba6a-301bfb4d6e36",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-07T21:00:53.0494573+00:00",
"id2": 60
},
"db_language_id": "a40bbd98-3a4e-4751-8532-8ef853cf78a9",
"db_language_code": "sample string 7",
"db_title_id": "20e5f924-edfe-4903-ac19-b7560b73aca8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-07T21:00:53.0696023+00:00",
"create_date": "2026-10-07T21:00:53.0696023+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-10-07T21:00:53.0696023+00:00"
},
"modified_dateutc": "2026-10-07T21:00:53.0696023+00:00",
"id2": 22
}