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": "f81341d9-cc51-4b34-9e5b-d0a07c2bca89",
"_parent_id": "6791f997-ef7f-4569-99ec-4ccc2d07f0c7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b093a2e6-5dec-4aa2-b4fe-d22af72c7bdb",
"company_id": "8e081b2b-7a02-4f5d-88ad-326f62fcbb93",
"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": "c5da5971-0b31-424d-bbde-c17583e0f0a9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0a055937-a93a-496f-bca1-d97a1f3b234e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2adb59c0-141b-4929-898d-fb9ec208248e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd145612-b56b-41c2-90c0-63d9d456e4d6",
"company_code": "sample string 5",
"company": {
"id": "0812282a-45de-4303-9690-0f65f4b07f35",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T19:59:31.094989+00:00",
"sales_territory_id": "f0feaf2f-64e6-40d1-b72c-f421a0889279",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "faf4889c-d733-4d49-8eea-5531ffd1df6b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "985b8d1c-87b0-4528-898e-e25536de4c14",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e4ad3588-6935-44c2-92b0-a4d00ca67047",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6a30641-0755-4444-9c42-a5f2dd00eac4",
"db_currency_id": "69c91bfc-79b3-4d00-9f42-513819a017ae",
"db_language_id": "c9d87b21-5415-4cf4-b603-7eb53fef5c6b",
"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-20T19:59:31.094989+00:00"
},
"modified_dateutc": "2026-08-20T19:59:31.094989+00:00"
},
"marketing_segment_id": "19843e8e-4481-40b8-907c-007468ca823f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "230e4ae5-cbb8-4676-936c-90f235c35c8c",
"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": "0d88c954-43c7-4263-9942-8b304c24863e",
"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": "7fc61ea0-bbe0-47d7-a669-f253cf8bc17a",
"db_country_code": "sample string 28",
"feelist_id": "aab18e43-3503-459b-bd5d-c6703438a5ac",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "45b71d76-7621-4287-8534-75efbbe46894",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9fbe171e-3897-43bc-8ed3-0ad6d9f57014",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T19:59:31.094989+00:00",
"db_currency_id": "d67f1a63-3e5b-429f-a828-2d49cc091af0",
"db_currency_code": "sample string 10"
},
"company_type_id": "67b2d065-4f01-4229-85a7-3abd47dcc48c",
"company_type_name": "sample string 32",
"company_type": {
"id": "061677ea-cad6-4fbb-a3f1-43859229875e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "77d19496-266f-4cde-9791-fb93a9ad2bbb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5eeb5572-c8a7-44c3-9a2f-bef89df50039",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3991c194-5f63-4e79-abc3-1ad07e2723af",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9266c54e-a889-40b2-b1e1-88cac02bd855",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5fead0fd-fc61-4cf4-9505-cfc8017a0ad7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T19:59:31.094989+00:00"
},
"company_sector_id": "f182fd5a-e6fd-4dc2-845e-b9fe399f7bff",
"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": "559c509b-2a81-4990-b464-33fee2db933c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "faa7c811-3516-4a02-8d8a-f745e3d62284",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25f5f0c1-67b4-4d9a-8794-e62600c99eca",
"account_manager_user_code": "sample string 56",
"company_status_id": "b38e612c-fcdb-43c5-8314-06c40964c3e2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T19:59:31.094989+00:00",
"id2": 60
},
"db_language_id": "6091ed61-3b5b-4304-a103-24f31f87a3a0",
"db_language_code": "sample string 7",
"db_title_id": "141dd3e7-274a-4af1-9316-5eef43b05399",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T19:59:31.094989+00:00",
"create_date": "2026-08-20T19:59:31.094989+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-20T19:59:31.094989+00:00"
},
"modified_dateutc": "2026-08-20T19:59:31.094989+00:00",
"id2": 22
}