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": "5dfe2cf9-b6a9-4fa8-9fe5-092613398a01",
"_parent_id": "b20768b8-b451-4e0f-bd3a-882c88b69458",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e49d17c7-5eb9-4120-99d3-b47aca0d0e6e",
"company_id": "4005cb24-f2d7-4224-9f2e-717068bc20ed",
"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": "71808289-8bf7-478a-9559-c38107862337",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3044bb03-2427-4346-ae26-5a9390bc2f8f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "260f981e-20f8-4a13-a2ff-540cdba6d1d1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e7ae4985-fc04-4b6d-a75b-fe1b0fda72b8",
"company_code": "sample string 5",
"company": {
"id": "380f8609-aff2-4625-be4e-9e1cf99e1611",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-06T00:04:56.4173539+00:00",
"sales_territory_id": "9029f7f6-dcb2-46bb-a9ed-5936e6d44b4d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "706a0151-6db9-4d73-8e5f-f4dafdd66d63",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "753c8dc7-541e-43bd-8da6-b73c6b32764c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e8fee89-353a-4bab-b363-f0f65f50c6a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f120c2fa-c4a7-47e9-8b3a-d2d21c4f68fc",
"db_currency_id": "f0b588ed-d755-4614-a415-14f8fefad736",
"db_language_id": "c6e1bdfd-1e04-4a85-8031-1f7710f5ccf0",
"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": "2025-12-06T00:04:56.4329809+00:00"
},
"modified_dateutc": "2025-12-06T00:04:56.4329809+00:00"
},
"marketing_segment_id": "d6ed82d8-2ff4-46d3-a816-913625d86ec3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fbb5f1b6-6e83-449f-9143-060e3eb6929d",
"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": "2a9c4c7f-c4b2-47c6-8f41-8e9627153943",
"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": "4d7d6c5f-c76a-4d30-9713-1ee1d7497ab0",
"db_country_code": "sample string 28",
"feelist_id": "c9db909f-cd88-4621-88c9-e99f7cf150a9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bf351230-afd8-4635-aa11-f898b0d3ff8c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f094edbd-df9e-44d8-b3fd-5a7c3e0e4369",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-06T00:04:56.4329809+00:00",
"db_currency_id": "92d2f687-9ec5-4111-8bb0-83497438a5cd",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5178a3d-9db4-4437-a6f3-21a11d9dfc4c",
"company_type_name": "sample string 32",
"company_type": {
"id": "3fecf8ed-4617-42ea-a76b-6bf3746f3c22",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "977653f1-b8b0-48b3-881c-d9383fcaadfc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "59846ee0-56e6-4d11-8400-364d19893b52",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7f044041-35da-4cbc-aec3-0f401bf80475",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "322cbe76-66a4-4476-8b37-f13789ff48bd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dee1615a-eab7-46b1-84b1-2586b9f7dd30",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-06T00:04:56.4329809+00:00"
},
"company_sector_id": "e059b94c-7b29-4283-a8bc-5ed9b1486d43",
"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": "3ff4fd56-1b04-4639-b612-4fbba92c65a2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6af4486b-469a-4c44-8793-6716f27efa28",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f299e8be-6b79-438a-953e-cd50bc6474d0",
"account_manager_user_code": "sample string 56",
"company_status_id": "effd6845-c198-4ea8-a4d3-e597155c8bf7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-06T00:04:56.4329809+00:00",
"id2": 60
},
"db_language_id": "60e33c57-23f7-4b54-a9be-d203cc162e98",
"db_language_code": "sample string 7",
"db_title_id": "9822206a-c8b9-4b76-8cbd-66b94106c44c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-06T00:04:56.4329809+00:00",
"create_date": "2025-12-06T00:04:56.4329809+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": "2025-12-06T00:04:56.4329809+00:00"
},
"modified_dateutc": "2025-12-06T00:04:56.4329809+00:00",
"id2": 22
}