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": "ad738bcf-d347-4e8a-9689-c401e86c071d",
"_parent_id": "62e584fb-867f-43d7-a075-991f140e1c18",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4f1bdaae-6a09-45cf-aacb-62e1c606e938",
"company_id": "c061a512-57e1-473a-8ec9-8520656f082a",
"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": "6c4bd33f-f8ed-4079-af74-1ac76596c8c4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c2983e0f-4eef-498b-8b8b-ed1075bd93db",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a7171297-7191-4867-b13f-a7d04b31767a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fe86e512-c4ff-44fe-bc0f-e2f24b4d8f5c",
"company_code": "sample string 5",
"company": {
"id": "f5b1b583-c807-450a-b1d8-25afbf049ea4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-12T05:24:58.9623641+00:00",
"sales_territory_id": "cae1b0cc-4d34-4202-a2c7-fe05bfe829c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "49b6bf9d-41d4-4961-aeeb-e73cddc15395",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "204b9d80-4fbf-4d12-9160-b02dbb0009b4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc3c2305-646f-4f89-8ce4-42df6a9bff38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13e6a21f-8942-4932-a3ad-18846d53f297",
"db_currency_id": "22d2cb07-a3c2-41fc-a2b8-80e58d263a38",
"db_language_id": "8340b2cd-d6a6-430c-ac61-fa6700204975",
"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-12T05:24:58.9623641+00:00"
},
"modified_dateutc": "2026-09-12T05:24:58.9623641+00:00"
},
"marketing_segment_id": "10eba61d-1c54-44b3-ac10-caab1a62382e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "81610fbb-fa00-47d6-93b5-53e3cf83d4bb",
"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": "6427b9f3-301a-4047-9e32-4018c997ecb7",
"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": "4c113a53-d4f9-4e3a-a6d3-cf83fd1c3553",
"db_country_code": "sample string 28",
"feelist_id": "87e0f0f9-ad38-4a7f-a767-22f24b8d422e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1ca36fa0-8fee-4f59-b136-91c1befd22a9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "298bcb4e-b335-468a-9c74-0b4a1bb1e561",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-12T05:24:58.9623641+00:00",
"db_currency_id": "28e6b17a-d28b-4285-97cd-8d8cb154ae1f",
"db_currency_code": "sample string 10"
},
"company_type_id": "20ee282a-5d92-400b-bb42-e55d8ba2760f",
"company_type_name": "sample string 32",
"company_type": {
"id": "becfef81-90ba-490e-b58e-e2691b41df48",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0ee041f7-2613-43d9-8bfb-825f8c65b2fc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0e6c4108-410c-4c55-90ee-3c1c3f634c43",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f5f349b7-7b63-40e2-84b2-7df3b339a4b5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "64d2db6d-a20b-48c1-ba2e-bcac6bbab9e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a8e842f4-f942-4ea5-97bc-b4e784f8570d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-12T05:24:58.9623641+00:00"
},
"company_sector_id": "be922f53-8edb-4cbd-8bde-9cd8a5450671",
"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": "a0cfd7ab-a923-4f93-ae60-7b9352166c27",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "61783cf2-850c-4aa2-8c32-a5e967cbb495",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e0c6ae33-83f2-4068-aa0d-6cd153e25714",
"account_manager_user_code": "sample string 56",
"company_status_id": "e2ba0b85-19c5-41e2-ada1-b83bdb7cbf8d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-12T05:24:58.9623641+00:00",
"id2": 60
},
"db_language_id": "88b8072e-6ca1-429f-92fb-8a151d543e63",
"db_language_code": "sample string 7",
"db_title_id": "e3d067fa-a925-4f63-b0c2-e674a1610587",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-12T05:24:58.9779931+00:00",
"create_date": "2026-09-12T05:24:58.9779931+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-12T05:24:58.9779931+00:00"
},
"modified_dateutc": "2026-09-12T05:24:58.9779931+00:00",
"id2": 22
}