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": "e3aaf437-9479-48a9-9edd-f66539bf5271",
"_parent_id": "f400e37e-4d85-4f45-9cf2-1743b21292a4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b0f5e994-6252-4686-8cb1-82870fadfb2a",
"company_id": "87770e8d-00f1-48b0-8389-4173f3f739d9",
"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": "daa755c6-3b0a-4180-8fe7-a11f663a29d5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6c191bd4-3662-44b8-8818-fc2dc97d87e3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "62520757-e8dc-4d82-b495-7a320bd6f4a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a4c7468d-a18d-409e-9f64-1a9eb3298f62",
"company_code": "sample string 5",
"company": {
"id": "37faab81-8fb9-4593-b23c-2b888a9617b5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T20:18:27.6607647+00:00",
"sales_territory_id": "e8b68dc0-ca13-4976-b37e-b07dcf17f528",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ecdc7f43-f781-447d-bef9-caf7f429bc2d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29c7ab29-1557-4f07-a6f1-793a51c9c3ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2beb619b-2d8e-4037-921c-d83d846ccac3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39bc3d42-4d64-4861-b92f-5c7fdbffa66c",
"db_currency_id": "56f3f826-1f86-4051-8a36-19fa7650862f",
"db_language_id": "ecb7a08c-ab47-4771-92c7-ba9625536de1",
"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-10-02T20:18:27.6607647+00:00"
},
"modified_dateutc": "2025-10-02T20:18:27.6607647+00:00"
},
"marketing_segment_id": "a9402bc6-1f62-4dfe-aaab-d95f42ac3e6b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db6b8c14-b391-47ea-8c8e-20acc2ae180c",
"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": "84f77156-d446-44f7-b830-38076906b864",
"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": "814c3dbe-d114-49ad-a255-2ce83d72371d",
"db_country_code": "sample string 28",
"feelist_id": "b2e2b1f4-a383-46d1-9021-78c8a7787a9b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "97cb6668-9bb1-40d3-810e-0d17ee7168be",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bef2640b-daa3-4442-870e-78559afce0f5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T20:18:27.6607647+00:00",
"db_currency_id": "69791eea-46eb-45ae-8f7a-ec683d784520",
"db_currency_code": "sample string 10"
},
"company_type_id": "626312ee-e2ef-4f6b-be16-9f6df6326814",
"company_type_name": "sample string 32",
"company_type": {
"id": "fc295969-af9a-4d2d-80b7-c5aa8c419239",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1d5f387e-22e7-453e-bfbe-7b0c09c84847",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0cbcb3da-2432-4db5-8cee-d88004418bae",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e02744c0-2a4c-4dab-a18b-78c1bb096fdf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cc6a4456-b816-44a7-b2ef-6dc184db4aa2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5560c6fe-2742-4a61-bbd3-81a06adc87b6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T20:18:27.6607647+00:00"
},
"company_sector_id": "5fb7faae-d6ad-4ba7-a91a-bafaa22ebff3",
"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": "1598081d-8893-474e-b6c9-fdda30963b63",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "edd29c72-8db5-476b-8c76-39f82bf6ad71",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "babb4849-329f-441e-9a11-836572c288d1",
"account_manager_user_code": "sample string 56",
"company_status_id": "1e97c040-f357-435a-b67b-4f025106a430",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T20:18:27.6607647+00:00",
"id2": 60
},
"db_language_id": "6b153dcb-ab2d-4664-866a-2fcfeb7ff13e",
"db_language_code": "sample string 7",
"db_title_id": "009552d3-1717-4999-b48a-265a79b0e01c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T20:18:27.6607647+00:00",
"create_date": "2025-10-02T20:18:27.6607647+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-10-02T20:18:27.6607647+00:00"
},
"modified_dateutc": "2025-10-02T20:18:27.6607647+00:00",
"id2": 22
}