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": "92d9a69c-b09a-49c6-a45b-d94105dc2bdb",
"_parent_id": "0913f4d9-d8e2-4962-9e72-562193010523",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "951006fb-8b8f-4b31-9250-2b09a6d353ef",
"company_id": "213b3b50-feec-49ce-820c-9d239f996cc4",
"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": "f2407226-7c4a-485c-8994-eb2b9b7ee8ec",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3b164c2f-ac0e-447b-b299-4219a2aef888",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "67e27686-0209-4acb-81d9-8ba900f96f5f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "50c43dae-580e-412b-95c3-2064f6ca1991",
"company_code": "sample string 5",
"company": {
"id": "13f3c3ba-3177-45b7-814b-bb647ba6ae61",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-03T17:44:39.2315417+00:00",
"sales_territory_id": "4e11e0b3-af33-4038-9198-d8d8864fcd92",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "04bb7c5e-9ab5-47a0-b503-52a2d26ea21c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88ebf56b-fd52-4ffb-a31d-2f6d88101f2b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5f209281-f295-4e2c-b564-01fc1a619bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12e2e663-a400-4052-9ea0-135179bb4535",
"db_currency_id": "c9b1e66c-47ec-4ec3-993c-904c35f21e05",
"db_language_id": "006490ae-0cb5-4058-90d9-dbbe688c07fc",
"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-08-03T17:44:39.2315417+00:00"
},
"modified_dateutc": "2025-08-03T17:44:39.2315417+00:00"
},
"marketing_segment_id": "f6ba9082-411d-48aa-baaf-3a93b13b871a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2f43e3eb-797c-4e37-9270-c726f86fcb04",
"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": "1d7e34f7-febc-4720-b82b-0b0fe228c0e3",
"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": "d4e502ce-ae61-4060-aee2-f2d1c311472e",
"db_country_code": "sample string 28",
"feelist_id": "a9053f2e-29cb-47e8-b957-5cb5f21b656e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "90680b38-0098-48f5-9e08-6852d7af5e29",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1e7462ab-d4c9-47ba-8cf4-53df379239b7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-03T17:44:39.2315417+00:00",
"db_currency_id": "cf9eec77-0a3c-47b2-bf33-d14f6a28a33e",
"db_currency_code": "sample string 10"
},
"company_type_id": "d5482196-0ea9-45a6-85b8-0b5cd2417a99",
"company_type_name": "sample string 32",
"company_type": {
"id": "d48e51d6-d4de-42e7-9ad5-9666cadfa65f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "706807d6-704d-476f-9f9b-09d91c917f94",
"sales_organization_code": "sample string 5"
},
"db_language_id": "721bb870-857f-43a5-a258-ebe692661e56",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e8a90b21-f757-4d27-99e5-43d202d6d8a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6880d2fc-9b0c-45dc-9ebd-435d6e76d6a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e263a77b-6b03-4b69-825c-0242032d7d1b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-03T17:44:39.2315417+00:00"
},
"company_sector_id": "1d650dbe-0034-4b5c-97d9-5f47e7f0fbc4",
"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": "21502b95-0f8e-4603-9805-7a0949a9e708",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0272a070-f183-4165-9c30-b5adfbab56a5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "87deca58-edf7-4506-a361-5a8169a7dda6",
"account_manager_user_code": "sample string 56",
"company_status_id": "dc0f3a8d-d987-44e7-ab98-e014a29e9316",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-03T17:44:39.2315417+00:00",
"id2": 60
},
"db_language_id": "6a4ead94-037b-49c2-a46d-c8d4a546ef7c",
"db_language_code": "sample string 7",
"db_title_id": "baf51f09-e9ec-400c-ab42-fb4844080cf2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-03T17:44:39.2315417+00:00",
"create_date": "2025-08-03T17:44:39.2315417+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-08-03T17:44:39.2315417+00:00"
},
"modified_dateutc": "2025-08-03T17:44:39.2315417+00:00",
"id2": 22
}