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": "0f288a50-c39b-4b0a-8d12-c9c985aff693",
"_parent_id": "d2bcce7a-be5c-4993-aa45-ec3ac13e2897",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "75048b68-8ea8-4c72-b54e-8d2658519240",
"company_id": "ea37edb2-2f9b-4398-9038-85b9104b8098",
"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": "71f82ca9-acce-4b90-9fe0-44fb2c92ffdb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6614413e-247b-4812-bc28-f9abfc580ba3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "14124d0f-a835-4c55-a1f7-c2eb73e32b2a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5a2ca70c-c201-4ac9-b5d6-d88fc0aca2d2",
"company_code": "sample string 5",
"company": {
"id": "31efd522-67f3-4931-8d57-e8cd87a7570a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-29T07:08:11.3827829+00:00",
"sales_territory_id": "92077e09-038f-481a-bd66-d8285513d9af",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e855c126-d6fe-4a51-8e5e-06100f70135f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb0be3ca-5c0e-4b42-9cd5-958641527a5f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ebe64c43-dc08-4d42-9ac4-8ca049c5baf5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e8170fc7-1d70-47ad-9edf-3400ccf457e3",
"db_currency_id": "fbead410-777d-4e62-b9f9-cb6e0fb1bb26",
"db_language_id": "63468a11-5814-4868-aa9c-82d89ea48b3e",
"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-10-29T07:08:11.395808+00:00"
},
"modified_dateutc": "2026-10-29T07:08:11.395808+00:00"
},
"marketing_segment_id": "899d551b-6d6e-4230-90e2-397e1c31c889",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a0399c9e-7eec-432a-b1fd-e68056dfa679",
"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": "4a70e779-bcb3-4be0-98e2-ae1ea35afe84",
"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": "7a19bbbe-177a-449f-8de8-0f74aad74c49",
"db_country_code": "sample string 28",
"feelist_id": "edef9ee8-2619-4ce6-8326-14a138e47142",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "32d228c5-9e75-4d0f-a173-d658a7b77fdd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4ee2e409-c53d-4b9d-8d49-2d4c01290f13",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-29T07:08:11.395808+00:00",
"db_currency_id": "c0ed4743-da63-4277-a0e9-b0359a543c5c",
"db_currency_code": "sample string 10"
},
"company_type_id": "ffbbd44a-5a64-4b38-83a3-be59bf59fe73",
"company_type_name": "sample string 32",
"company_type": {
"id": "9e5de8ab-38ef-4d8b-a19c-ff70efd7f2da",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5a69eca-15d9-4dd0-b79b-596c3707772d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b4d52afa-a1f3-4b6c-922f-bafe10c5fcf3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "11494013-744d-44f1-bc3f-a176a139be8a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3bc0398d-f94b-4822-ae54-d5d64048f58d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3c8d6b21-d3ff-4271-8780-12efaaa7f280",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-29T07:08:11.395808+00:00"
},
"company_sector_id": "8e0836c5-2ef9-44ac-b2f9-ed6b6723018a",
"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": "cd08c4f8-0db2-49c0-b4a9-89e7dfccf90d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "230c4d7f-999a-4f1e-81a9-397f2e9366be",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "acd00b6e-bec3-4c62-8608-d35ed1941b53",
"account_manager_user_code": "sample string 56",
"company_status_id": "f59d9fc2-0d9e-41be-892b-bb28f50b8e43",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-29T07:08:11.395808+00:00",
"id2": 60
},
"db_language_id": "39245db9-e13d-44dc-b8da-786f57a15c6a",
"db_language_code": "sample string 7",
"db_title_id": "98dc71ed-86b5-4a0b-abdb-29af3f55efb1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-29T07:08:11.395808+00:00",
"create_date": "2026-10-29T07:08:11.395808+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-10-29T07:08:11.395808+00:00"
},
"modified_dateutc": "2026-10-29T07:08:11.395808+00:00",
"id2": 22
}