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": "a43ffc5b-8a7b-4f5e-8fec-fa54bc978749",
"_parent_id": "04fcb118-1cc2-41fa-9272-944ad6148854",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9be83245-7e63-4d50-b386-128517bfe845",
"company_id": "5ce2ba3e-a4d2-4df2-9bd0-859dc6582ee6",
"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": "ba0276e9-309f-4d3a-b7ed-9c0645591cda",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6332a5d6-ad2b-4def-8b2b-219fb2af9cd0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "396a632e-5030-4a56-b462-a13c39d315ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "342dba36-8ffb-4360-9fc7-41c85217b2ba",
"company_code": "sample string 5",
"company": {
"id": "89a7554d-cec7-46da-a356-892d726ca527",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-13T07:27:19.4384466+00:00",
"sales_territory_id": "9b1cde2e-067b-4983-a747-0795af6456b7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f0901c0d-92f9-489a-a44f-b1470a7955eb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b7ae404-fe2a-4a37-9d5c-9c12b1187fb9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ea5a5702-d7e8-4e84-881c-618ef3614cb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01308b72-5be1-453f-bbd7-522f9bb36ae8",
"db_currency_id": "1e48238d-5577-4d5e-993d-9959fe4a2c46",
"db_language_id": "a995685d-977a-494e-991b-4ca9450939cc",
"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-09-13T07:27:19.4384466+00:00"
},
"modified_dateutc": "2026-09-13T07:27:19.4384466+00:00"
},
"marketing_segment_id": "0e1a6bed-9155-4800-b3a4-0efdd5fba95f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7030fd1f-168e-48f6-8147-2a7ccd3e2371",
"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": "ade10d2b-2380-4de2-a6e3-7f67de4c7598",
"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": "730fb6f7-ddf1-49d4-8099-6c54eee50edd",
"db_country_code": "sample string 28",
"feelist_id": "80214be4-3e15-4343-a76a-1c654064485e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1fca0e89-9f5d-49c5-bb8e-970135663701",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b6f34df4-095e-4f1b-857d-263a27aec7a8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-13T07:27:19.4384466+00:00",
"db_currency_id": "47c6c890-f9a3-45ea-8058-05332c5a52d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "fa6e92fc-2a7b-4464-80a9-d9b3dababf17",
"company_type_name": "sample string 32",
"company_type": {
"id": "e939f1e1-e57b-40ac-b921-d8d8cbe545b1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e70e648-7d2e-4281-b1c6-5abe9aa00b14",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2d88499b-7907-4efe-b8d6-e865dd6e9866",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cf2534a7-4199-4cd5-8c39-63e747355681",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3414c7b4-a7c7-4652-a88a-a23bb4a50434",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e3f44f01-982c-4c1b-bdcb-d94344a568b4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-13T07:27:19.4384466+00:00"
},
"company_sector_id": "84a6b36a-ca36-4c9c-ae0c-3ab3f73f14d8",
"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": "7913ae4c-7b96-49cb-ba75-6673f42f1f76",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6422dd77-2883-47ad-9c6f-c5f4eb7d551f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a28ddbaf-5e76-48aa-a9de-c1749ded3f1a",
"account_manager_user_code": "sample string 56",
"company_status_id": "73cbb0b4-06f7-45a8-b2f9-2167ca3605dc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-13T07:27:19.4384466+00:00",
"id2": 60
},
"db_language_id": "ff8aae3c-cee5-406a-99ea-c6ce69687776",
"db_language_code": "sample string 7",
"db_title_id": "1524cc94-9e9b-4645-88ed-100aa60a4645",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-13T07:27:19.4384466+00:00",
"create_date": "2026-09-13T07:27:19.4384466+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-09-13T07:27:19.4384466+00:00"
},
"modified_dateutc": "2026-09-13T07:27:19.4384466+00:00",
"id2": 22
}