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": "30b18ab8-879a-4e20-a32f-c9e41ec9fbe3",
"_parent_id": "0579afa2-2e7e-4e10-8b2f-d1da238433b2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d8f7c0c7-958f-4db7-a412-ba4d57d46abb",
"company_id": "a28f77af-06df-48ea-8012-8733d7e1a4bb",
"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": "27cf3ebe-99a5-49fc-9446-96d5d72c5610",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e1fa01d0-de40-43e7-9750-0fec4e61c0f9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6f4f0909-5eed-4589-bad5-29332cf25d1f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "109ee501-3e5b-49b6-aebe-eb69dcf0d8b7",
"company_code": "sample string 5",
"company": {
"id": "6f7c9975-2ed2-453c-aac3-ec5c46513226",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-28T04:47:52.0509848+00:00",
"sales_territory_id": "de656b56-b3df-4601-8d47-ef72d188fca2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "72ae1e20-a51d-4ee9-95ce-38717df279b4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f148f7f7-dc6d-438d-88c1-c54aa6a79ab5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4daebaa8-5179-4a0a-9e7f-9a3fc039358d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0452faa-5453-4766-b410-65573f02a255",
"db_currency_id": "bfb487e9-01b6-412c-99d2-f8456cbe2da2",
"db_language_id": "1702ecf4-8cd6-43c2-a0be-8a2517209a0d",
"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-03-28T04:47:52.0509848+00:00"
},
"modified_dateutc": "2026-03-28T04:47:52.0509848+00:00"
},
"marketing_segment_id": "595dcbf5-8915-4a0c-a6e7-518c77c06c25",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0c110be2-1373-4d80-a571-f23f108966af",
"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": "bae71944-c9a1-4ea1-b57b-25e893f99474",
"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": "ddb3c244-e012-47a3-b1f0-bc3518e41de9",
"db_country_code": "sample string 28",
"feelist_id": "7d42b12c-ff10-429c-b076-48107f6f95fc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9b55fb74-76c4-41f7-b885-9d7bb5cb8f33",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bd7290ca-b874-4f61-99b9-1ccbcb324b99",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-28T04:47:52.0665185+00:00",
"db_currency_id": "fcaa8ef6-7967-4309-aa7d-ccdbab848fa4",
"db_currency_code": "sample string 10"
},
"company_type_id": "ff2948fe-f682-4644-9af1-b06787bacdf2",
"company_type_name": "sample string 32",
"company_type": {
"id": "8b44945c-ff6d-4615-8606-559d9d86425f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d8410e6b-471b-4936-8539-424ff67fef3b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a3fb652e-97c1-46aa-a5a6-0a7be7c9d217",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f82e856-5087-4a8a-9121-23129ffb00aa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e7a0fbf9-16a1-46bc-a731-f9a7db278087",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5dd22bb9-ae88-4fa9-88b4-aa0da2ead59b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-28T04:47:52.0665185+00:00"
},
"company_sector_id": "01e503fb-5fa0-428f-935c-f3a73c7270b3",
"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": "7e05bff3-c41f-4ce8-bfb7-ec0149a5f794",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c6a0de28-25a7-4b6b-9f0e-ec0168871ac5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d11f1682-6f50-47ff-8939-0b0779dc44a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "e099c861-c9a4-4b73-9f1f-9bf989bc4f5c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-28T04:47:52.0665185+00:00",
"id2": 60
},
"db_language_id": "9a9054e1-2f01-4b57-9aac-2fccf3eed306",
"db_language_code": "sample string 7",
"db_title_id": "98fe2458-8090-4e40-8072-b95edc4e737e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-28T04:47:52.0665185+00:00",
"create_date": "2026-03-28T04:47:52.0665185+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-03-28T04:47:52.0665185+00:00"
},
"modified_dateutc": "2026-03-28T04:47:52.0665185+00:00",
"id2": 22
}