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": "10e5f7e2-ead6-433e-9633-f6dab0ec19c1",
"_parent_id": "bc9a7a68-d305-464b-96b4-04f6ec43ae76",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9d378c47-4a36-44ca-80ae-52c0f0f856ff",
"company_id": "209894c6-b4ad-42b5-a098-0bab7fe306d7",
"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": "6cadcb85-d0b6-4082-9028-2b66ec350919",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cc00be20-7713-459d-b553-6bbff5347f98",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "94dd88ab-fa2e-46ab-8b7a-37208c94fcde",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6e5d94d0-f362-4e48-866d-c1f9356d8fa5",
"company_code": "sample string 5",
"company": {
"id": "3a9cabe7-02f6-4597-8795-63a5b8c58402",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-15T08:13:47.8821936+00:00",
"sales_territory_id": "ee9a75eb-f4d6-41ae-9fae-34b9fbab99a9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c58b83ff-67ae-4186-ac89-8cf95b5a8334",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "be870a0d-cf79-4f9b-9f56-fe28edda93e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ae3a7c5-6bf8-44af-92c4-f78b7b2b6e9a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c2895e9-468c-4b9c-b3c9-ea632180d487",
"db_currency_id": "a0677919-2f09-4217-83f7-7ac1fe1a5dc8",
"db_language_id": "afa46fa6-d238-4fef-9ab0-ba56af950a1e",
"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-11-15T08:13:47.8978175+00:00"
},
"modified_dateutc": "2025-11-15T08:13:47.8978175+00:00"
},
"marketing_segment_id": "d686f547-94b5-4d90-917c-cdecec4f71b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "308c527d-7444-4b3c-a008-a69b41e2ac5d",
"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": "a8700b36-620b-4cee-99ae-b46bcb7d8ea8",
"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": "ceae1e9d-4365-4bb5-a2cb-f8356ee47df1",
"db_country_code": "sample string 28",
"feelist_id": "6281e93b-5674-453c-8325-e26e0c660159",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3c971ba1-bf02-4671-884b-db3f39007975",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8ef19515-f697-4b42-a642-f737ffe70ce6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-15T08:13:47.8978175+00:00",
"db_currency_id": "e80fb334-2d80-47d4-b9cc-29ed7537e350",
"db_currency_code": "sample string 10"
},
"company_type_id": "0fc8022d-f416-4b61-963d-d1ce7ea6eb61",
"company_type_name": "sample string 32",
"company_type": {
"id": "881e09eb-ae74-4af4-90cc-ed13399a8f79",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a61097c5-92db-49cd-b320-c070f37c1be6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b81b5f8-d16f-4487-b701-aef6b013f7c1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2134af08-7a57-4ddc-b9c1-335587637456",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00244112-f377-4f9f-bb5f-d4fc76a1221a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5ff356df-60a8-4d6d-8a95-ea33316cb509",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-15T08:13:47.8978175+00:00"
},
"company_sector_id": "7e6e2d26-1e4c-44bf-8f57-2ae5787c700f",
"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": "ae4e1398-da9f-478e-bfc6-3d2a8396394d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9e5e921c-0a68-41dc-bb30-82d89a97b39a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4d517c95-52ea-48b1-903b-4f518ab57de2",
"account_manager_user_code": "sample string 56",
"company_status_id": "c34fae7b-e0fb-4b62-bc78-4263d6c0720f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-15T08:13:47.8978175+00:00",
"id2": 60
},
"db_language_id": "3c54d7ea-c2df-49c9-8ca0-3521edc57615",
"db_language_code": "sample string 7",
"db_title_id": "23bc89c5-bbd9-4e8b-a7e7-64d466a7047a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-15T08:13:47.8978175+00:00",
"create_date": "2025-11-15T08:13:47.8978175+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-11-15T08:13:47.8978175+00:00"
},
"modified_dateutc": "2025-11-15T08:13:47.8978175+00:00",
"id2": 22
}