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": "623554e6-5fcf-41d4-9b0c-ce16dcbb3d29",
"_parent_id": "4faaf3c9-e264-48ee-823d-5c30205c441c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c6ab57f1-8829-4fbd-8de2-4bd7ea26b6a9",
"company_id": "ed1487a0-efd5-43c4-bd69-83993e6faede",
"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": "7bccc4ff-90fc-4092-96f6-ba225047f9a2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "853021f5-646d-4602-b6bb-4a5cc7c7f67d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9614d136-cc2d-4200-87d9-e8bf7800ff84",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d4e2d630-710c-467e-aa0c-f3631c110469",
"company_code": "sample string 5",
"company": {
"id": "172950f0-3fa7-4c41-8f41-2cc1ff75ad6f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-01T13:40:53.7294128+00:00",
"sales_territory_id": "54c5cd6e-7208-4626-a377-ac98618d2534",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1e753442-5f50-487a-bdef-7d9de938c6f1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77f9042c-6af0-40c7-a9dd-f3b7ea5ffad9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d494be2e-6fa0-4509-b4a1-09ea4fb861b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "311aaaf6-9bb4-42c2-b40c-70c81d44caff",
"db_currency_id": "a0c7c136-49ba-43cf-bc59-d14f254b9f43",
"db_language_id": "277ea793-1cba-47c6-a590-4d633cb320db",
"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-01T13:40:53.7294128+00:00"
},
"modified_dateutc": "2026-01-01T13:40:53.7294128+00:00"
},
"marketing_segment_id": "a72ad390-5d70-44e2-bf23-718ec4e7f3c8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "753dca0e-cd53-46d1-942e-6146fa32d8d7",
"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": "39e7ced6-2a0a-42e6-8fa7-4653c8378046",
"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": "690ac8f2-0914-4890-9798-e017bc38854c",
"db_country_code": "sample string 28",
"feelist_id": "759fd305-18f5-4b7e-9fb3-0039f0dabe9f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "085495b0-4b5e-48a9-8c80-f0bedbde1d10",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "defd6231-423b-414d-a6ed-aaeac5129ea2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-01T13:40:53.7294128+00:00",
"db_currency_id": "2cf3c851-fd99-4044-9a00-66af7f4138f4",
"db_currency_code": "sample string 10"
},
"company_type_id": "4e8bc368-bd7e-4331-a813-d65d3106e941",
"company_type_name": "sample string 32",
"company_type": {
"id": "d1d09da3-3937-4a7b-b00e-5ea0d06f5697",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b8b1d75-74b6-47b6-862e-bd41a7dbe1a0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5170a737-311c-4bcb-adec-2c421f17be00",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f04e36a8-3bfe-4e5d-a99b-1f51d7e9ac9c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "004c352a-8afa-488e-8d51-ff2da36a33e4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "27b9ee31-08fa-4d02-90cd-2d24936865b5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-01T13:40:53.7294128+00:00"
},
"company_sector_id": "106f3bec-8832-4dc6-81e4-384a8a570246",
"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": "5a31f8dd-c0a3-4ff3-9bca-503b6560fa99",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b37d0b66-3e38-47cb-94b3-c30935b1deb3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5ce50e15-9592-43d9-8a9d-bfbd850dc829",
"account_manager_user_code": "sample string 56",
"company_status_id": "5840c28d-8a9a-4eaa-b9f0-74cb57c9f036",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-01T13:40:53.7294128+00:00",
"id2": 60
},
"db_language_id": "8eefb3bf-26c5-425b-aee0-b23d3a4e6bfd",
"db_language_code": "sample string 7",
"db_title_id": "ef9467b0-8243-455d-a962-1b970847a706",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-01T13:40:53.7294128+00:00",
"create_date": "2026-01-01T13:40:53.7294128+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-01T13:40:53.7294128+00:00"
},
"modified_dateutc": "2026-01-01T13:40:53.7294128+00:00",
"id2": 22
}