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": "bf23d682-c93e-4923-9fed-46d04195ef1f",
"_parent_id": "70835d89-53f2-491d-b88b-bf0f3ebc332d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f0eae9f8-6ade-458c-a48c-9f74d43a51ae",
"company_id": "1314be15-9d04-4ce0-b018-917a9e87984c",
"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": "bb387095-c843-4252-9d75-451de6d22553",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a3cad98a-6b89-4aae-97a8-94ea8723208b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e6ec8b45-432a-46de-8683-f5318599176b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "76e61579-b870-448d-93ba-a670a843b111",
"company_code": "sample string 5",
"company": {
"id": "1878e760-7224-40f2-88be-c5d81ddf4d9b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-01T08:05:14.9853034+00:00",
"sales_territory_id": "b857af0c-4375-43df-b260-de20da7e4ec2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0343b288-b50d-49dc-b322-10005b83ace4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4e10eb1-e38d-43c3-a008-e2a205436dfd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14f80cf8-6cfe-4b4c-9cdf-215a40bb8d11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a7c9289-01d1-47ac-9429-edb0cb1183bb",
"db_currency_id": "e0d7e6d0-60a3-4567-894a-385c64030baf",
"db_language_id": "109ecebd-b527-4f63-99ed-5a39a209d5ac",
"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-01T08:05:14.9853034+00:00"
},
"modified_dateutc": "2026-07-01T08:05:14.9853034+00:00"
},
"marketing_segment_id": "fac77209-d5f0-4ec4-83a6-112adaaec800",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3821c3af-0cdb-4a18-a009-63573f8eeb16",
"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": "61aedf74-792c-4d6a-ac4b-476e5288d188",
"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": "9d81ad58-d31b-46bd-989c-14e2361f0586",
"db_country_code": "sample string 28",
"feelist_id": "5fab2307-bf5a-4e06-aeb9-7eb52a0abbf9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d7d8323e-3f05-4664-be86-10932f1efd11",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "339e5e31-f878-4802-aa5f-bf8c958adfe5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-01T08:05:14.9853034+00:00",
"db_currency_id": "1add03b7-a99c-4a17-92d9-4ff2541fcf6d",
"db_currency_code": "sample string 10"
},
"company_type_id": "93ad7fe2-d67a-4324-92d3-b84debae8fef",
"company_type_name": "sample string 32",
"company_type": {
"id": "fd5a0454-ba68-431f-a213-db62cfc6f304",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e225c4c4-e877-4fce-8c91-c55cb768b959",
"sales_organization_code": "sample string 5"
},
"db_language_id": "94d77b61-06ea-4eff-afbb-9edac4a9e6ef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62e2c485-af32-49f8-ba89-e1f0ac96dc65",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aef47d67-6517-41d0-8faf-e6aa4e8c1645",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "35ad9d01-740d-44ad-b070-b2da51ef6fca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-01T08:05:14.9853034+00:00"
},
"company_sector_id": "10cb1de0-8242-4411-9307-ed27770c2769",
"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": "13fd5818-2195-4148-9ced-a7c170efeab5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a54f3af3-89b7-4f78-a393-1f09555aaed1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "18bb5848-3cf8-4119-a3b3-16be9be82b95",
"account_manager_user_code": "sample string 56",
"company_status_id": "d390ebbc-abaa-4752-936e-11b97d828626",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-01T08:05:14.9853034+00:00",
"id2": 60
},
"db_language_id": "675cc1ac-b8fa-42ca-952a-e60d71a946b0",
"db_language_code": "sample string 7",
"db_title_id": "c6835e73-9bf8-425e-b2c0-21b4a4a8d5f4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-01T08:05:14.9853034+00:00",
"create_date": "2026-07-01T08:05:14.9853034+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-01T08:05:14.9853034+00:00"
},
"modified_dateutc": "2026-07-01T08:05:14.9853034+00:00",
"id2": 22
}