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": "9a610bcc-b8a3-4e8f-9c9a-efb96f2eac68",
"_parent_id": "f92e063b-ac35-42fa-b481-53e58a66e3fe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "16561261-5e0b-41f1-8647-3a1d01214a7e",
"company_id": "1d408199-41af-4802-85e9-28205a3d1801",
"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": "29de1756-7f30-4790-b196-c88d3366382b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9210f3c1-e7cc-4675-97ed-e6eed3b2ec89",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5c0d3c08-2ca2-42ab-9539-af49e4269d02",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e15b8af7-180f-4b78-901d-3de24b930973",
"company_code": "sample string 5",
"company": {
"id": "6051a45f-63da-456d-b436-cca4c86507bb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-12T18:57:44.7731813+00:00",
"sales_territory_id": "d0d46c60-77a2-4dff-b951-bf15074bcbcf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9541053b-ce19-429e-b906-b4946f41e801",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "47836f73-14b2-47e9-8b04-7c9875df62af",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc0b8913-285a-4d58-8714-99080791d951",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4552230-d97e-4623-aa64-44385e814a44",
"db_currency_id": "848fbab3-c8b8-4d8b-b71e-c6aca33b7596",
"db_language_id": "846658e6-860f-4cae-8f12-5f6830129bd7",
"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-09-12T18:57:44.7731813+00:00"
},
"modified_dateutc": "2026-09-12T18:57:44.7731813+00:00"
},
"marketing_segment_id": "dbfc336e-a37f-4306-97ed-1266eadef4be",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a8b815db-731d-4160-845f-3665e87c42da",
"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": "8ebca4f3-1d91-43fb-88c3-b8dc17d88683",
"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": "a6140074-8be5-4b22-8add-5f6ec94e3aa7",
"db_country_code": "sample string 28",
"feelist_id": "8ea78a3d-f861-457a-aed8-a5b7a57e8076",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f78befa0-7c94-4312-a8f2-9f68f8fbdbfd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a02ef044-69a2-494a-912b-d8ce73422592",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-12T18:57:44.7731813+00:00",
"db_currency_id": "79c619d8-6d7d-4391-b214-2f9eb10ade48",
"db_currency_code": "sample string 10"
},
"company_type_id": "d71813d9-c8d4-4c7a-98fd-b666680a3e9c",
"company_type_name": "sample string 32",
"company_type": {
"id": "dfa64c0b-178c-4e69-be0f-9aa3155a2bc8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6c2a3a62-aebf-4f13-958f-a8f9633a0501",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5ad8c353-bc0b-4122-aee3-b597f69813b7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fb52bdea-73ae-45c1-b0c8-2838e2636d72",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a3b9c6db-7b7f-4f65-bb61-b31b49656a0e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9af399ea-3bd8-4991-aae2-8b410c65576e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-12T18:57:44.7731813+00:00"
},
"company_sector_id": "4d39e0e7-d9a7-4ca8-b515-118b42dc5305",
"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": "777809cf-0e09-48e0-ab3c-6b9678e67b86",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bc1179c0-6521-4f25-9c30-67690790b2c1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9a951418-29a9-456c-b97a-ea011f12a132",
"account_manager_user_code": "sample string 56",
"company_status_id": "bf170145-1b82-4e86-b350-dfbd08f7b90a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-12T18:57:44.7731813+00:00",
"id2": 60
},
"db_language_id": "e205e801-8f36-496c-85ca-1939c88f1386",
"db_language_code": "sample string 7",
"db_title_id": "99cbaa2f-bf83-4254-b489-e5c0c3a027cc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-12T18:57:44.7731813+00:00",
"create_date": "2026-09-12T18:57:44.7731813+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-09-12T18:57:44.7731813+00:00"
},
"modified_dateutc": "2026-09-12T18:57:44.7731813+00:00",
"id2": 22
}