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": "54eccffb-599a-4fd6-af98-042261af90d9",
"_parent_id": "4cb5d0b8-64be-400a-b9c4-583407dc7dfe",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b25db866-eef8-4955-851e-0cfbd8b30765",
"company_id": "1966059c-7a63-4ce9-ba7e-1cc841c70b19",
"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": "47bb8472-5f87-4b8c-b07b-78651e1e7e06",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eb3d0570-103f-4b35-98bd-c0ef9b85a75e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a356d129-1b66-4ea5-b950-fbdefe84e3e5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0b5f4270-b3d7-4b35-8ecc-203ddebcefe3",
"company_code": "sample string 5",
"company": {
"id": "d655bb51-bf8e-4948-bdf0-6708e200abc7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-22T22:15:17.90924+00:00",
"sales_territory_id": "333827b8-1f7d-4fd2-8628-58439e05416d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1857b1e2-8f29-4bce-a666-0bf3de099b4a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a860958-d670-4284-bb41-8c66bf5e2b07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d111095d-085c-4974-ae0d-cb3189e916cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c6da4786-fbc0-4918-a035-2f79c99079cc",
"db_currency_id": "a1091a19-df62-4a89-b376-f84ca85d3fa2",
"db_language_id": "4a19271a-60dc-4304-ae73-2d8ad4c655df",
"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-07-22T22:15:17.90924+00:00"
},
"modified_dateutc": "2026-07-22T22:15:17.90924+00:00"
},
"marketing_segment_id": "88b18876-595f-4327-b536-587aef332f14",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9e3e4594-1767-4599-8c54-e6ceef7cedb8",
"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": "29215fe5-f334-43f4-92bb-723b9d5d8454",
"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": "3d15a620-8338-4861-ba12-f55bdb51188f",
"db_country_code": "sample string 28",
"feelist_id": "14e36861-bc54-486a-a7ef-149f8ce89673",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a3d09cc2-d750-4a8b-a3f8-4458048e764f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "367d96dd-bbf2-4b64-9277-6b8b595cb544",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-22T22:15:17.90924+00:00",
"db_currency_id": "8d1b5e0e-28dc-45f0-84a6-f16c2565b0bd",
"db_currency_code": "sample string 10"
},
"company_type_id": "99791c42-be15-4781-b4f2-08b2e6af7047",
"company_type_name": "sample string 32",
"company_type": {
"id": "da8ed53d-2b69-426c-bf47-a9dd2b07d903",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0df1e9e9-798f-4e42-8662-de1d1c6682c4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7cfe7dbe-fc66-4e37-aab1-0286d2b10eb9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "086690ec-8ddb-43d3-953e-cfd1a4255e38",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f260e473-080d-4d02-8c1d-e5858f0d7ae8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c271107e-5556-4fb0-a454-ef752cb7b7eb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-22T22:15:17.90924+00:00"
},
"company_sector_id": "2437b092-ac5f-4586-98fe-6b28e7db1f8a",
"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": "7c6cb457-3982-4ea0-9d97-a05543bd445a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb1bac1f-f021-4971-a964-32774cb63206",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3a98e130-f749-4d96-a535-cd4fa77804c0",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ae619eb-416d-4ba1-aa39-0bcc46a2e172",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-22T22:15:17.90924+00:00",
"id2": 60
},
"db_language_id": "5f804f9f-7d94-4243-b3d8-506b24ddb686",
"db_language_code": "sample string 7",
"db_title_id": "d68f2a76-a73d-4484-bbb2-e831aa98d5f0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-22T22:15:17.90924+00:00",
"create_date": "2026-07-22T22:15:17.90924+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-07-22T22:15:17.90924+00:00"
},
"modified_dateutc": "2026-07-22T22:15:17.90924+00:00",
"id2": 22
}