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": "a2762bda-b56e-42bd-851b-cdf037e9723b",
"_parent_id": "f12e7fc8-37aa-4f8f-9d93-032034e57583",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4383723d-3e73-42c2-b6a2-fc1fb5bb8f5c",
"company_id": "c0dfb3d5-f2c0-449b-a489-b0633bd2405a",
"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": "85421fd1-17ae-482b-8e42-9cbe3e8079f8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6f892c07-47af-41e6-865d-246aaac28c1f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3506fe44-e92e-4835-b1ce-aeea22fe9640",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67a74e14-2cf6-4a54-b689-1a3a146c4f2b",
"company_code": "sample string 5",
"company": {
"id": "35c6ee97-60be-400e-a651-5cd429025e21",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-09T21:25:45.6440515+00:00",
"sales_territory_id": "5747372e-c952-4884-a38f-407ac4e85a9e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "167b8107-0370-49fb-8fff-e9dd70e8c4ea",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8502faf9-52ca-4e56-93d1-49727abd9803",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72c3eac5-9fc2-4f8f-a1fb-ccb85a9c02ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b9034b-e79c-4e7b-b25e-ac534ebfcd0a",
"db_currency_id": "ded8d177-b770-4720-88d5-30e5f6632abb",
"db_language_id": "917dc4b0-c465-4e10-981c-60255f85b688",
"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-04-09T21:25:45.6440515+00:00"
},
"modified_dateutc": "2026-04-09T21:25:45.6440515+00:00"
},
"marketing_segment_id": "215a8af4-21a2-499e-b1be-f8fc39ec7cbe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5d7bd7b8-90f9-401f-aa66-46fae5a960b1",
"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": "9843f7eb-4996-4fef-b5a4-cf91475dbd8f",
"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": "dab44fea-f376-4c47-b767-f9a05577140c",
"db_country_code": "sample string 28",
"feelist_id": "16402d94-913e-4b86-a58f-494aaa3ced77",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a8810027-5b66-4fe8-9286-9c6b791a8722",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9801a064-a758-472b-b656-00b3b4018fa8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-09T21:25:45.6440515+00:00",
"db_currency_id": "b6b930c6-78aa-4dce-8324-3f1354e839fe",
"db_currency_code": "sample string 10"
},
"company_type_id": "cae02a51-8ce7-4053-b7cc-09d8e644c18f",
"company_type_name": "sample string 32",
"company_type": {
"id": "a707e93c-062a-4b1a-b702-769f8ac8850f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab88b88e-4ea7-473f-82c2-48ffddf9e3a6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5df5120d-ca6e-4ac5-950b-e7ee04afede2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7b66142e-240e-4e19-8b60-d7b4162abd85",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71111299-5a91-4fd7-bd89-14c970c04e84",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fd47abd8-d337-4246-b250-33a9010baf0f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-09T21:25:45.6440515+00:00"
},
"company_sector_id": "b9ced222-3438-4d32-92b0-700e7f5bdacc",
"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": "d7ee1961-416f-4331-98f1-f32f9b98e6d0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2688a424-0e0d-4bbc-b740-d4bda40cb725",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "987efa88-5101-4dbd-8928-9a318368ac1e",
"account_manager_user_code": "sample string 56",
"company_status_id": "299bfe86-ce90-499a-8fe7-d1cbceb375fb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-09T21:25:45.6440515+00:00",
"id2": 60
},
"db_language_id": "b21e6f15-82e4-4d40-872c-3b2f2b4265a8",
"db_language_code": "sample string 7",
"db_title_id": "2737ef99-861c-4e4a-b03e-e2570f184170",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-09T21:25:45.6440515+00:00",
"create_date": "2026-04-09T21:25:45.6440515+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-04-09T21:25:45.6440515+00:00"
},
"modified_dateutc": "2026-04-09T21:25:45.6440515+00:00",
"id2": 22
}