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": "7f433285-991a-489d-81d0-95d6d9d6f661",
"_parent_id": "1316dbd9-d569-494d-945f-f7e74b77ebc6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "49555923-137f-41fd-8af3-614c7894d694",
"company_id": "144ed339-5034-4908-b2c3-4f457a505042",
"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": "776e2b8e-4382-4211-9a1a-09c2933665aa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0043bed3-9b55-4428-b048-afe67435c4a3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d1f61ced-c77a-4dc6-ad29-cbed2445d94b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3b94cdd9-1856-4fc9-ae8e-e8cc79e063bb",
"company_code": "sample string 5",
"company": {
"id": "229be1c7-4ab7-43d8-b727-57dd906b0b2c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-06T21:00:09.6339852+00:00",
"sales_territory_id": "75630d8d-6b14-4e07-a7f8-cbe80c457810",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f0e09150-7f3c-4f14-ac7c-d935a33ad3bc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "13efec92-1f2b-418c-8308-580b61fc053b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "104875f5-a7e5-4771-b24e-182506643510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "955b7ff3-e2f8-4809-80a3-92017c3142ef",
"db_currency_id": "99c32f72-b290-45e8-82ce-5b74f5dbffab",
"db_language_id": "6c36efd2-c943-46d9-91cc-d2bd05d7bd67",
"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-01-06T21:00:09.6496095+00:00"
},
"modified_dateutc": "2026-01-06T21:00:09.6496095+00:00"
},
"marketing_segment_id": "ad850aba-d972-4e0a-a682-678749d232d7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c25c870-15c1-4dcd-8441-84c0fd84968e",
"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": "c2be78ac-eced-4765-be91-42ccb931d4ac",
"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": "ef3b9beb-a58c-4c4f-917d-958dea979cbf",
"db_country_code": "sample string 28",
"feelist_id": "b38baf36-e869-4a1a-8c44-8dd1e19dde65",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7582f3a9-ec46-4a2e-ae0a-5a1c563c26c5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9641faf8-8702-44a9-a718-2121d5f881b9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-06T21:00:09.6496095+00:00",
"db_currency_id": "70082a11-80c7-406e-bf9a-c497418a8d14",
"db_currency_code": "sample string 10"
},
"company_type_id": "0acb2cbb-9ebe-49c0-893e-50cce7a8dcd7",
"company_type_name": "sample string 32",
"company_type": {
"id": "14931a8c-0037-4085-9621-01ebc1f32c32",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b67e962-231e-4e59-aa7f-7ca5e42bda24",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6c9e4105-83f4-4a71-9319-d7eb7e9f2273",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c3f4dd5e-30d4-413c-b0d5-7498ddf939d7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4714f7c9-61c3-4210-b316-e021dfe8d79a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3de26d94-bc4a-441b-9ee9-13be8223abee",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-06T21:00:09.6496095+00:00"
},
"company_sector_id": "e457cce1-2dc0-4c17-8ee3-cfc36164068d",
"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": "6cd5a35a-47b7-4f77-898e-f023f74c6470",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8d447343-7a5e-4921-871f-4ddf7d962899",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51b6b28c-be58-49e2-8dfe-794c2e0e6379",
"account_manager_user_code": "sample string 56",
"company_status_id": "66581958-a026-4f0f-9e9e-7a7562b9ac94",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-06T21:00:09.6496095+00:00",
"id2": 60
},
"db_language_id": "a6e317cb-d395-4829-8b4a-7ddc329e9a4e",
"db_language_code": "sample string 7",
"db_title_id": "9aea456e-4896-4694-9e97-36cd96c7be3a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-06T21:00:09.6496095+00:00",
"create_date": "2026-01-06T21:00:09.6496095+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-01-06T21:00:09.6496095+00:00"
},
"modified_dateutc": "2026-01-06T21:00:09.6496095+00:00",
"id2": 22
}