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": "95dd686e-3d83-4663-915e-bac079a0a1f2",
"_parent_id": "daef71b8-2cba-420b-b88a-0d6e48021172",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0e17bb18-1fff-4025-a730-c0857c2cc78b",
"company_id": "eb1ff9de-3721-422a-ae4e-119ca3510aaa",
"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": "00540fd2-1093-4f54-9f8c-728bf100d8e5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e514f32e-651a-4472-b54e-5215a813a05b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "63294202-eeeb-45b4-90b2-fa7594ab5ab5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd9d0596-fe9d-4298-88ef-39b22a010f32",
"company_code": "sample string 5",
"company": {
"id": "d00ce296-a17a-4180-8345-93a560b53e91",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-08T07:37:25.4390439+00:00",
"sales_territory_id": "0a0da1b7-1845-43eb-94c0-4f3961696343",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "acb77977-f9f3-410c-b1b3-770b95330856",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1ac494cd-a836-45fb-b968-b22553868331",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "baf6d6cc-9431-4729-a08e-02c6d6ddfcb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ca9ac9-9080-4530-b6ba-a9b09a5729d4",
"db_currency_id": "832587fc-bf14-4aba-bdfe-6993de06aaa3",
"db_language_id": "9cc571b7-a57c-4ca3-a35c-33e4764005a1",
"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-07-08T07:37:25.4390439+00:00"
},
"modified_dateutc": "2026-07-08T07:37:25.4390439+00:00"
},
"marketing_segment_id": "295a386e-bb83-4ba8-84e5-0d11bedafbb5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f4c32653-6dba-431c-96d7-f0b2efcf21e1",
"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": "bb750d5b-503f-4d19-9e5c-881f02741f5f",
"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": "edb3e35a-7f20-4ea5-8b1f-35e971964472",
"db_country_code": "sample string 28",
"feelist_id": "57d95594-1e08-4bb3-96d8-87f0b66c90ba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18bcd217-070e-48ff-9ae9-9a0983c931fc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dbcfaf44-64ba-45ca-a41a-659aafbd9c9a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-08T07:37:25.4390439+00:00",
"db_currency_id": "b9683d60-f018-433c-8526-3370e58ba3fa",
"db_currency_code": "sample string 10"
},
"company_type_id": "9ef8c111-1ceb-4aa3-a5ea-ffc8c09abdbf",
"company_type_name": "sample string 32",
"company_type": {
"id": "5980397b-461a-4837-af79-085d76c59bc3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef6e2fd8-bcdc-40ea-be21-0c7edee95fc9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e10bbb6e-4371-4d69-b37b-1edfd9a8c753",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e0a406e3-3055-4c6c-b92c-b400017653c2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d3f86950-2a3e-4012-a4d7-360924175f45",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4ea68ea9-52c8-4eec-bf92-d4519c5f7aaa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-08T07:37:25.4390439+00:00"
},
"company_sector_id": "10e2d4a5-4b6f-4a91-9e14-a26356c4902e",
"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": "6b66fc05-3cb4-4fc5-928c-0fceb01d20e6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a7daf70e-9df7-401b-a8e0-32a0834a0731",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b3193ff9-6b6e-41b2-81be-5c7bc3ec3330",
"account_manager_user_code": "sample string 56",
"company_status_id": "c6440378-e64a-4194-abd7-d3d788ae247e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-08T07:37:25.4390439+00:00",
"id2": 60
},
"db_language_id": "adb0d42a-1973-43ac-80e6-84ed75337395",
"db_language_code": "sample string 7",
"db_title_id": "4e9dd49e-9d7a-4a38-ba3c-4e6b962c09b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-08T07:37:25.4390439+00:00",
"create_date": "2026-07-08T07:37:25.4390439+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-07-08T07:37:25.4390439+00:00"
},
"modified_dateutc": "2026-07-08T07:37:25.4390439+00:00",
"id2": 22
}