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": "89e9ebaa-b242-46f8-a067-a47aeeef0935",
"_parent_id": "9e8afa17-28bf-4cf6-b5ff-c8045af8f699",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "67f19e0c-cadf-45cf-b6f2-147212c8664f",
"company_id": "4c81ff3f-48b1-471a-afbc-39aa796b6a04",
"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": "73450437-401a-428e-a17d-affe0f3f73d3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d8d6dd7a-2516-49d5-b05d-1196997328ad",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9a485ed8-d6c0-4277-bd7d-1e5a03559dd3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3c513200-de3f-49b4-b902-be54e31dd455",
"company_code": "sample string 5",
"company": {
"id": "6bc2293a-4c0e-4106-a2d3-6ff46369ae9c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-08T23:00:01.8562464+00:00",
"sales_territory_id": "2bb0eec1-3e97-4362-8b3b-0a8948d1d0b9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "96be4ac2-bb86-4d80-80f5-85e0a8676a16",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aeb7a302-0852-48f6-98ad-f5b2b48e1436",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f11e46ac-14e4-4c0b-8f54-454faea21923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "914dd668-89d0-4221-a41b-64b4bd31fb20",
"db_currency_id": "2ebd39e2-1e8a-4da7-876d-a90cb87f38b3",
"db_language_id": "82add0d6-072d-4c72-937a-477d25f75a73",
"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-06-08T23:00:01.8562464+00:00"
},
"modified_dateutc": "2026-06-08T23:00:01.8562464+00:00"
},
"marketing_segment_id": "340d3e41-3484-4f7d-a6f9-2162a4909b60",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cd383865-7cfe-4ce8-8aeb-4e14ee8d51f1",
"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": "d7af4f3a-9b23-4009-9497-b654b834d83f",
"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": "0c40ea2d-5032-44d5-8f84-3c35e763c7aa",
"db_country_code": "sample string 28",
"feelist_id": "b79bdf90-2cc6-4954-b3ae-18e82bd0aeaf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "11f25b89-c074-4258-aa39-f8e1b772a886",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "23dca429-8198-43d8-93dc-5ffdd5cffd4b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-08T23:00:01.8562464+00:00",
"db_currency_id": "3b701299-7d49-419a-9395-1060a01da8df",
"db_currency_code": "sample string 10"
},
"company_type_id": "d6990399-2433-47b6-b33a-ca4e76f52136",
"company_type_name": "sample string 32",
"company_type": {
"id": "69fdd5f6-f86c-4a56-a84c-b8faa268bcb9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "298ba217-26a6-48cb-b075-b26480aabfe7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4cb7e3c0-03e1-4d6f-9234-78c5f83495f2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7b7bba33-d90f-431e-8d97-16e36c3e11e6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "acdac260-32e8-41e2-b6df-3763b6181296",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e5c4d3d-aa9f-4ad9-93cb-58f9943f6c9c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-08T23:00:01.8562464+00:00"
},
"company_sector_id": "551c9cc7-e7d1-491d-88f0-5a30744b3e8d",
"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": "d86b0232-bcbd-4e46-9337-79ff3833a835",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a9757d1-2812-4177-9cc1-d49ea14661a8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "66fb71c7-cb5d-4343-88c8-c8e1c711ee6c",
"account_manager_user_code": "sample string 56",
"company_status_id": "35156d6e-ccc8-4a27-a3f8-e759772ad6f1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-08T23:00:01.8562464+00:00",
"id2": 60
},
"db_language_id": "a2e127ef-f7c4-4a9f-95ef-b38797950616",
"db_language_code": "sample string 7",
"db_title_id": "043a3eb2-e7e1-4c0d-ad76-7ff47cee49ab",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-08T23:00:01.8562464+00:00",
"create_date": "2026-06-08T23:00:01.8562464+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-06-08T23:00:01.8562464+00:00"
},
"modified_dateutc": "2026-06-08T23:00:01.8562464+00:00",
"id2": 22
}