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": "a715adea-70d8-44d0-86cd-7785abafc1ea",
"_parent_id": "79361b52-f0a4-4e92-bd8f-ea2c07af7150",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fa9d5203-54bb-4a97-901e-2106ad4ad153",
"company_id": "64c07c36-66be-48b2-99fe-f11bf29fa248",
"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": "460c5b22-3023-468b-99f6-534fbd6c717f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "746cc9fe-8fd4-4d0d-b746-ed427837ada0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4ea92fd2-8f3d-4452-a92d-e03c202c26a4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "be3a47a3-f7d1-49e3-91ac-de4eb8962716",
"company_code": "sample string 5",
"company": {
"id": "5d0ed322-16ab-4b52-887e-8c369e154d9f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T00:27:51.6396676+00:00",
"sales_territory_id": "a7576e8f-9aa9-4cb3-bb93-64b53919186f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6ecde178-b64e-498e-a124-1e6e7f3ff12a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "48e05af4-c7cc-4707-935a-463e25aacf99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb3468a8-6443-4b58-9731-359a82aa5fd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c1842ca-3c2a-405c-b894-a250124ef76b",
"db_currency_id": "3d855708-5815-4522-9ba2-070bf8d376db",
"db_language_id": "cd085da1-8a76-4cd7-92d0-19119f92d7e5",
"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-10T00:27:51.6396676+00:00"
},
"modified_dateutc": "2026-08-10T00:27:51.6396676+00:00"
},
"marketing_segment_id": "131f49a6-254f-4dde-a48b-a368af843e99",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a8a194e6-8732-4826-b2f9-0d686c04763f",
"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": "c9647de4-0fac-4018-8304-5bcfb70412bd",
"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": "538f3073-4928-4804-87b8-0f6d9e5c9768",
"db_country_code": "sample string 28",
"feelist_id": "833e5abb-e166-4c59-8532-0876483cf27e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fb0dd496-8b34-4ede-82ad-3591dbcb8051",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "88bf634d-d822-4ec4-be6a-9286351b4e17",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T00:27:51.6396676+00:00",
"db_currency_id": "954cb9f7-b431-4c5e-91c9-63a66f5c0d13",
"db_currency_code": "sample string 10"
},
"company_type_id": "b8a353b8-a966-46bf-9030-68475acd83b4",
"company_type_name": "sample string 32",
"company_type": {
"id": "e1d85fe3-167b-41b5-a9e7-ce141d4454fc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4bbaec21-625c-41dc-8d27-dd1fe396139c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4b624b32-6b76-4327-933a-c5e3b89817c0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f0107a68-6f79-4d76-a77c-0bc30c733381",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eb54e7aa-7e2e-45bc-84ed-19b12c4a239a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "53789ac1-64a8-4f36-bca4-410c39b1aa02",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T00:27:51.6396676+00:00"
},
"company_sector_id": "b3dae25d-1420-4f27-9539-6ff45c72fe9a",
"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": "81a432e3-3603-447f-a6db-a386a20944cd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "07aa0511-8d47-457c-add4-fef78eab2588",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "85c2d603-29d1-4ab4-b0ab-639321164213",
"account_manager_user_code": "sample string 56",
"company_status_id": "6bb9c335-74b8-4aa2-9f6d-5eb1e9cabeab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T00:27:51.6396676+00:00",
"id2": 60
},
"db_language_id": "844b03d7-0c7f-4d89-bc42-91ea5de01534",
"db_language_code": "sample string 7",
"db_title_id": "20df175f-60cb-4026-b4e0-4fe57a6c0f5c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T00:27:51.6396676+00:00",
"create_date": "2026-08-10T00:27:51.6396676+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-10T00:27:51.6396676+00:00"
},
"modified_dateutc": "2026-08-10T00:27:51.6396676+00:00",
"id2": 22
}