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": "cf605540-4bfd-46ca-88c3-9bb01261374a",
"_parent_id": "cda40fd9-a6bd-4ea1-84f6-899e10af1be5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "faa58c4f-ad69-4fe3-9164-0708d4edfa6b",
"company_id": "1f186137-7666-49bc-9a72-892e5b12e5c1",
"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": "3c03cdcb-11f4-4c73-8c0c-e315224d5199",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "002b74be-6631-4bcb-91f0-1a48a0d4d242",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "191ebd42-f954-4d08-b0cf-8887b4b89835",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7b0623f7-88bd-4197-a415-cd1091cde17e",
"company_code": "sample string 5",
"company": {
"id": "1048d8f7-c0d7-45d0-89ff-1669ab84c474",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-25T09:13:15.0046175+00:00",
"sales_territory_id": "97d0009f-23ef-4c4c-8a3b-5bf23db9ee09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "584a42dc-40d2-4cfb-b825-b152d47ea2a6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3bf8e408-8c42-4fe5-9ba6-08209142b0f3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47a440a1-c6b2-4485-bcad-7361ff3223a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3af9257-0cac-4adf-a64c-2a6d2b8a987e",
"db_currency_id": "6dcdf587-c75e-419d-979a-401c546be917",
"db_language_id": "c044d500-ae7c-4960-a548-ace4df3e931f",
"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-04-25T09:13:15.0046175+00:00"
},
"modified_dateutc": "2026-04-25T09:13:15.0046175+00:00"
},
"marketing_segment_id": "750b2f80-6678-4d29-a8d6-a02cc07aaadf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "46ce85da-6a8d-4c5d-91b5-81cd4021e04f",
"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": "d4feed8d-ff36-4ce6-97f2-2a2253dff27c",
"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": "6888cbb3-60f2-4cb7-8997-375e0abd6fa9",
"db_country_code": "sample string 28",
"feelist_id": "a48b2b49-de1b-4192-90ca-f8708512bb6e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6161e2b1-892f-48e3-94c8-665d9d492b22",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0088a448-a338-41e3-984f-85420f57473a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-25T09:13:15.0046175+00:00",
"db_currency_id": "6107cc94-caca-4ffe-aa0a-c8f93742ad30",
"db_currency_code": "sample string 10"
},
"company_type_id": "8f065ab9-5202-46b9-89bf-e68fed4c1a00",
"company_type_name": "sample string 32",
"company_type": {
"id": "c37c9f8e-6765-40f1-964a-776ea2f5c32d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0fd11925-142c-4ab8-8b6b-df34ec7260f1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e0d99fe7-7acf-4f7f-afd3-effe51bb0324",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "061dd1e4-24b3-4935-90bc-0a143c14447e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "928f1f13-d2bc-4503-a8bb-7bac8c1a5e79",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3906a8e7-103b-4f61-9bc1-e366dc004959",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-25T09:13:15.0046175+00:00"
},
"company_sector_id": "fe78dbbc-6332-4396-9ba9-b770ced199cf",
"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": "4e47e36d-7a11-4c15-b035-bf99fa21a7cd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ef92654-c347-4468-a57c-2643e641b675",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0398e647-3006-40a6-8299-29a73932144a",
"account_manager_user_code": "sample string 56",
"company_status_id": "b0a1ce1e-d5f3-45c2-ab60-db84de6fd82b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-25T09:13:15.0202239+00:00",
"id2": 60
},
"db_language_id": "aa0127c6-b875-4611-ba39-05ea65411c2c",
"db_language_code": "sample string 7",
"db_title_id": "5cd9080d-16e0-4b6a-8601-0aa1f7393891",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-25T09:13:15.0202239+00:00",
"create_date": "2026-04-25T09:13:15.0202239+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-04-25T09:13:15.0202239+00:00"
},
"modified_dateutc": "2026-04-25T09:13:15.0202239+00:00",
"id2": 22
}