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": "8cefec41-973b-4209-b336-31e9b802cbce",
"_parent_id": "d36b99ba-f3a2-4415-ab8f-a8bad422d52e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "944d7d20-d855-418e-8870-c0016901079b",
"company_id": "fdecc497-0047-4471-9c53-f6d8a6ce6837",
"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": "48c8e258-6ea9-4734-84c2-22ebc9e9c591",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5b40c5be-d6ee-48a4-a06f-d6208bd1824f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "63271d3f-1d6c-442b-b36f-73bf67037699",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "670d140e-430d-416b-a49a-2bd47ecb638d",
"company_code": "sample string 5",
"company": {
"id": "e2fe02a4-133b-4d68-b7ca-6bb03aa1d776",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-15T08:21:23.6642838+00:00",
"sales_territory_id": "93a0ccc8-85a8-4881-a6de-5b6532d173aa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d50e861c-95d2-4b14-9efd-d37da940bada",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fcc8195-bea5-403c-9dbc-3f44f8eac239",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7f1e947-b069-4468-b6b5-c4a947a6451a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b03d1f1f-5559-4dfc-a57e-dc8bd371d0da",
"db_currency_id": "b5b661be-c4ff-4d77-8d0b-7c53e98f20f9",
"db_language_id": "f6acfaba-9498-4472-bc18-8586fbfb7c8d",
"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-01-15T08:21:23.6642838+00:00"
},
"modified_dateutc": "2026-01-15T08:21:23.6642838+00:00"
},
"marketing_segment_id": "d9ade8d1-11d8-4bfe-8385-15d6e1ab4158",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1e30a13b-e6c2-424e-abfa-5001563a4056",
"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": "f91d544a-6c43-46d5-8f48-a6f5450512f7",
"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": "7a9c1d1c-f955-4650-8742-9703e924a275",
"db_country_code": "sample string 28",
"feelist_id": "5de4c7fa-687c-4449-a432-c0f93befec6c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2a5ab8ac-558d-44ad-8252-6fe4c1887eb1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bc4d2dbb-94d4-4ba8-b5b6-cea91c0e67e8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-15T08:21:23.6642838+00:00",
"db_currency_id": "1ab32808-a28a-40a5-a530-883a0071076f",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4982e2e-0aa2-4ab4-851a-085d10486925",
"company_type_name": "sample string 32",
"company_type": {
"id": "82d31cb2-321f-4e8c-8a36-f6f8f16aac3d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "56b82486-9967-4e17-9e34-366707d24787",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dba78d95-1f35-4a0b-a1c5-73b72e32dca6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62011a55-6d19-46a2-a3a2-eebf2b05d2e6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2ad26f5-40e8-43a7-a451-566d76159bb8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8ad2c81d-6577-476c-85a6-f9442417638c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-15T08:21:23.6642838+00:00"
},
"company_sector_id": "5d9cd25a-a716-4192-87eb-753b7de035cf",
"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": "3dcb2eb5-8107-4f91-82e5-be5d55586ad7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fa511159-ff0b-4370-b1a8-653df32008a4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e618c37f-bd2f-4702-9e2f-4c72faee2c9d",
"account_manager_user_code": "sample string 56",
"company_status_id": "51cea58a-9df4-429b-973f-3e69cf552b21",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-15T08:21:23.6642838+00:00",
"id2": 60
},
"db_language_id": "90e19c94-e734-408a-98aa-e176337923f3",
"db_language_code": "sample string 7",
"db_title_id": "f3a9cc4b-2ebf-415f-987b-29051d801ec8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-15T08:21:23.6642838+00:00",
"create_date": "2026-01-15T08:21:23.6642838+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-01-15T08:21:23.6642838+00:00"
},
"modified_dateutc": "2026-01-15T08:21:23.6642838+00:00",
"id2": 22
}