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": "fb2e0871-5409-4227-8ec0-14e82aa290d6",
"_parent_id": "cc9c9356-df7c-40a8-8c8b-8eb135449b19",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a6a4eb3b-15c9-4b57-8674-7a80b40098b1",
"company_id": "7e82dd53-3d91-4b38-839d-38f86812417e",
"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": "4d45491d-8706-4e59-a95c-1e4845f5dba0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c0e3783d-d65f-41bb-8ab2-c6eea4e6b80f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "77657e66-7dfb-4dfa-928b-03b35bf13bf1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d10bc9a8-c2d2-4a4b-9f4a-9d82978eaff4",
"company_code": "sample string 5",
"company": {
"id": "8a1fb3ce-b6ed-41f1-a43c-c5f667ba0f3d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-11T00:54:04.8580511+00:00",
"sales_territory_id": "145f6af8-3aa8-47bb-b888-893a33c9aec9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eeef111a-9a7a-4ce0-9cac-25e2f02a5075",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3328192a-35de-4d36-a3e1-9599c16f3e27",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dfdef9da-c3ed-42ff-88e9-657911d45c6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "846af2bd-9e9c-4069-9476-dc6046b31d1d",
"db_currency_id": "e7008abf-2f23-4fd5-a0ca-24df4e5af2ea",
"db_language_id": "b45c85cc-bc3b-4b85-8e20-cb38fedcc2da",
"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": "2025-07-11T00:54:04.8580511+00:00"
},
"modified_dateutc": "2025-07-11T00:54:04.8580511+00:00"
},
"marketing_segment_id": "b0c237b9-a195-458e-bf2f-3c1735957e0f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2cf6506c-9f15-4ab8-9436-50029856f591",
"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": "a9322242-eb22-42db-a749-e0490bd412be",
"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": "0d203a3a-65fc-4431-ada9-aa1723ad4aad",
"db_country_code": "sample string 28",
"feelist_id": "0e446fb2-235f-45ae-a515-117de63a03f5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "82d24cb9-f6c8-4e90-938e-2de9ba58a389",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b9ad40ec-da07-4941-8581-978c8c75edcb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-11T00:54:04.8736776+00:00",
"db_currency_id": "98d337d4-dc6b-4130-8c5b-2983b81ea2d7",
"db_currency_code": "sample string 10"
},
"company_type_id": "fea6431a-cb33-451f-8953-455460317e77",
"company_type_name": "sample string 32",
"company_type": {
"id": "588f9e1b-2220-4579-8ba6-d4f34bee2843",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c284302c-21d9-49e9-875c-6e2403476c1e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "13d5cfa0-85cf-41f4-8269-3b8206f039f5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "639b1a43-ad11-49f2-88a9-7ddcc8e9ed9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a6a82dd1-41f4-4d04-a2f8-7de0e32a9192",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b337fe91-4224-4c7b-ad74-c96800479546",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-11T00:54:04.8736776+00:00"
},
"company_sector_id": "d312d9bb-b3ae-4c04-9a57-8f4719978b79",
"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": "bc34f15c-9887-48b4-900f-96e7499311f6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b266951-bbaa-4293-9327-a197ad21ca8c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bed5ac89-2f94-49a2-bc01-4065ab0aaa43",
"account_manager_user_code": "sample string 56",
"company_status_id": "26f69ec9-82fb-4c11-87eb-3946cad7a77d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-11T00:54:04.8736776+00:00",
"id2": 60
},
"db_language_id": "f15bd8cb-e5a2-4ec4-8b1b-b0387e13d6c6",
"db_language_code": "sample string 7",
"db_title_id": "3fc9357f-9b21-4ee1-9c3f-6cbc36e8c598",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-11T00:54:04.8736776+00:00",
"create_date": "2025-07-11T00:54:04.8736776+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": "2025-07-11T00:54:04.8736776+00:00"
},
"modified_dateutc": "2025-07-11T00:54:04.8736776+00:00",
"id2": 22
}