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": "c0b024fd-1474-4379-99c6-15c79146b16c",
"_parent_id": "6667170a-815a-422d-b371-43df110d84b6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "69539a50-508e-4e2a-a7ba-7318c3c46774",
"company_id": "87bacac8-3c91-47bc-99b1-5c79533f8609",
"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": "2bbf5216-719d-437b-a144-e3815fe3cc17",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1475ce10-191c-4445-9b9f-97a72dd04e78",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6cfbc2c3-2540-4248-a331-4acd2a5d24df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "591df648-bdc1-43a8-a63b-b56c31d60662",
"company_code": "sample string 5",
"company": {
"id": "45fe09eb-38f5-4bff-8b37-7919bba1ceaa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-01T12:24:34.0631613+00:00",
"sales_territory_id": "f1bf162b-aae2-4540-872a-78d38455dd3e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0a18b58c-c0cf-43f1-baae-8e6f16d35b16",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c2b5489-f5ee-4755-a431-f47c367e789d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4230c3ea-b8c1-4f38-8bc0-b13c6c1a1da9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51d4a375-2068-4514-9f14-3fe561a70c18",
"db_currency_id": "b30754e4-1485-41e9-9d8d-38d2654f57ce",
"db_language_id": "1d2cb2f8-3c9d-4aa7-a1b6-2767f31a7a85",
"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-08-01T12:24:34.0631613+00:00"
},
"modified_dateutc": "2026-08-01T12:24:34.0631613+00:00"
},
"marketing_segment_id": "76b0de49-2742-4ecb-ab72-1d4ef574fd55",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2e342fdb-8ea5-412d-8381-80567024e51f",
"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": "0d4b9ee3-a10b-4dbe-bc0d-55913ec9fcb9",
"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": "7cb1e15c-72e2-4955-a815-373067954e8d",
"db_country_code": "sample string 28",
"feelist_id": "3bfa7aa5-f227-49ff-b185-faeca86eefae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1961bb38-354b-4b36-8dd6-8cf30640c579",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "047e498d-ffd5-4253-b619-5767f56cd37d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-01T12:24:34.0631613+00:00",
"db_currency_id": "752ce9ed-44be-4769-838a-7137496c6213",
"db_currency_code": "sample string 10"
},
"company_type_id": "c77ca091-c3c4-4d01-a359-49bb6efa1b67",
"company_type_name": "sample string 32",
"company_type": {
"id": "b3004854-c39e-4c5b-9761-698376756b4f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f1ddd536-5fbb-490c-9f89-a4e81170ba93",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2989a292-89a0-469b-9bbd-464279f76436",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3123f01c-7871-42d6-91a3-3a6fa322ebfd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "39ad62c5-4278-42f2-ae8e-0c4bfac34a16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b6532cda-d2bf-4d63-a0af-da445481b7c2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-01T12:24:34.0631613+00:00"
},
"company_sector_id": "b3e9d83a-cf5f-4746-939d-3bc52894c3e1",
"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": "3a80bc01-e11b-4110-b075-ca5260e4f8a7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "74683a3e-e083-429a-8e32-f3f89b366985",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "48475a6f-8347-418b-85a3-72962ffd85c1",
"account_manager_user_code": "sample string 56",
"company_status_id": "fa5fec5e-d9a5-4bfe-9b63-7920a4d34650",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-01T12:24:34.0631613+00:00",
"id2": 60
},
"db_language_id": "917bdabf-6ad9-4599-a7e4-031de0eb324c",
"db_language_code": "sample string 7",
"db_title_id": "17e3c59e-803d-4450-9b88-ea075be2e500",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-01T12:24:34.0631613+00:00",
"create_date": "2026-08-01T12:24:34.0631613+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-08-01T12:24:34.0631613+00:00"
},
"modified_dateutc": "2026-08-01T12:24:34.0631613+00:00",
"id2": 22
}