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": "49e53cc5-27d6-4d4c-a4d5-671804331e37",
"_parent_id": "352ca79a-f843-4e15-abe9-20df57121466",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "80536308-ed93-4ea6-9c0f-483ad38ce69c",
"company_id": "c9f66754-0449-4090-b959-79b5888a3029",
"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": "1342ef35-d74d-464a-8135-9efd61d0c032",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "21ce9d82-a816-488e-8666-f74c20be4ebd",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9f9a2858-aeac-4da3-9d7e-9f1dff4e0323",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f17083c9-f680-40d2-984f-85d44187efe6",
"company_code": "sample string 5",
"company": {
"id": "e13e0afb-162d-4ae8-9e28-5f6c0dc743b7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T21:43:43.9990333+00:00",
"sales_territory_id": "4f9f7d14-2bc0-4f4c-9d03-e0938eb6cc0a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50f804f8-70c1-426b-afae-81c67a27705d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd5ea7d1-3606-4eab-8f6a-0d7bbe595f8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "17f1314e-ff9e-49fa-867b-0ddca7faccb6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43ed393-29c9-4d93-8d89-8bda8279d3cb",
"db_currency_id": "91151c83-09a3-44ed-aac4-75bde19e7021",
"db_language_id": "26ab9f5c-fac3-4986-9597-97d8c57ce5d9",
"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-21T21:43:43.9990333+00:00"
},
"modified_dateutc": "2026-08-21T21:43:43.9990333+00:00"
},
"marketing_segment_id": "837cf28d-58c9-445c-bd63-ebd8319aa7ba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3cc12051-9b50-4521-b328-a26e87553234",
"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": "7501689b-c8c7-4b49-90d8-2df58fc8108b",
"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": "be61afc5-c961-48e0-9109-c7f41eca35f3",
"db_country_code": "sample string 28",
"feelist_id": "989c4119-dba1-4ce0-acc4-1ad29ee029e3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "05b53446-3e1c-4503-a410-95a92267f6a6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "14d29e09-80a2-4432-991a-e036b1421a5c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T21:43:43.9990333+00:00",
"db_currency_id": "905e0359-604e-4e07-9f49-0dd566278aad",
"db_currency_code": "sample string 10"
},
"company_type_id": "4be15100-77cd-405d-8e13-8e34409e4515",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc718b0b-4c68-4478-86c8-0fa67f416846",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14b34cd1-8434-4b52-84f6-e656c56b8a48",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1236f7d3-48bb-4f50-9755-90d3028dbcbb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "603ae4fe-d239-4c22-9896-94f1cb7ce8eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "77dc576b-bc50-4d4f-949e-01e09e4c3436",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bf4682b0-20ee-436d-9128-bbb3f911af84",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T21:43:43.9990333+00:00"
},
"company_sector_id": "7053a739-7bdd-47e9-8ee5-226c9be28306",
"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": "6e94115f-6349-4766-8625-b394c8946a96",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "554c9281-0446-4f56-b77f-6f3c394795b6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3bbeed56-66df-4781-86a7-043ca126151e",
"account_manager_user_code": "sample string 56",
"company_status_id": "1046fc7a-b377-4002-abd0-7845cddcd981",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T21:43:43.9990333+00:00",
"id2": 60
},
"db_language_id": "c00ecb68-56e8-46a8-9f4f-e87b0a9bfd4b",
"db_language_code": "sample string 7",
"db_title_id": "fe721805-2672-493b-bbd0-651ef59228e0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T21:43:43.9990333+00:00",
"create_date": "2026-08-21T21:43:43.9990333+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-21T21:43:43.9990333+00:00"
},
"modified_dateutc": "2026-08-21T21:43:43.9990333+00:00",
"id2": 22
}