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": "9b4ae80e-7bb4-492a-a9a0-248e7f606f79",
"_parent_id": "77957198-9ed6-4d7d-a3c9-bf81328f4d27",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1cf67764-1ed2-4091-9098-8f5a1979876d",
"company_id": "c4b4fa42-f92b-4574-a67f-20ca1c9fdcf8",
"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": "55536502-c0f9-470c-a058-d7392136258d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3242183f-1a98-4339-b702-5947170776de",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4f2f01b6-4506-405e-83d4-a1d68acc6629",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "80ea25bd-57ff-4466-b005-8b91bf71420a",
"company_code": "sample string 5",
"company": {
"id": "6c3802f8-6ec0-4fa8-bd87-95b0d53bcac9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T12:49:12.2738646+00:00",
"sales_territory_id": "1166ce07-1951-4952-8b4a-ff145644fc15",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e9fe23dd-62bc-40d3-a4a0-3c12505ca825",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d236d6ba-e861-428b-a454-b41fac8f4848",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0792b4b7-d4f7-427e-be2f-a5d03e9d4afc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a946d44b-8bf0-4499-99f8-6434ed971d60",
"db_currency_id": "698bb773-c847-40ef-aafa-6ee3688725b8",
"db_language_id": "e45cc766-7f85-44eb-ab1a-b018a01989e4",
"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-15T12:49:12.2738646+00:00"
},
"modified_dateutc": "2026-07-15T12:49:12.2738646+00:00"
},
"marketing_segment_id": "6e29264f-ce2e-4fce-8668-7a2920fab2aa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4afbd135-8906-45db-a307-ca50f3d24945",
"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": "b53cb72a-c512-4a88-ad57-2ad754abb0c0",
"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": "84a0a563-186a-468f-aaaa-4bd6b34022c0",
"db_country_code": "sample string 28",
"feelist_id": "1ec0fa39-982f-4781-9554-018c46fa104a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "83b19c44-5d68-4da8-b888-78550c2223e0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8d0279c9-6db7-408f-b8c6-28196acfef54",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T12:49:12.2738646+00:00",
"db_currency_id": "00070ea4-e842-409f-94eb-6cd70a4f952d",
"db_currency_code": "sample string 10"
},
"company_type_id": "32a6cb6a-cf46-4737-9eb0-1d62791c972a",
"company_type_name": "sample string 32",
"company_type": {
"id": "8cfd2ac2-8c8e-4f00-972d-36f23776329a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c05982d8-ff36-4b4f-ad9c-b7305b647807",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8f73bb6b-f6f2-475f-86a7-8469c0d347aa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d4424ede-2d18-4df0-989d-af822f16a916",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7afc657d-0d11-497d-a189-f51c2eada1a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ebddae38-194c-4181-8727-74bc395ef09c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T12:49:12.2738646+00:00"
},
"company_sector_id": "9a349187-64df-4a0f-bedf-dc3f6364474d",
"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": "a31c1f48-6997-4d0c-8fe5-11cfc846d11d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6bc83ff0-e593-482f-9132-65d371e34f63",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "67bb4dcd-bfa7-45e9-9c0a-6e5a5b7f0b29",
"account_manager_user_code": "sample string 56",
"company_status_id": "f8f58bf6-769b-4bb0-82aa-219ca92213d9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T12:49:12.2738646+00:00",
"id2": 60
},
"db_language_id": "f305e52a-d54e-4a7b-834d-5edd61d77baf",
"db_language_code": "sample string 7",
"db_title_id": "4bfa8d28-b0a8-4830-b8a4-f5c0b769815b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T12:49:12.2738646+00:00",
"create_date": "2026-07-15T12:49:12.2738646+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-15T12:49:12.2738646+00:00"
},
"modified_dateutc": "2026-07-15T12:49:12.2738646+00:00",
"id2": 22
}