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
{
"id": "369ae7d4-6bec-49af-a043-3767cd245e59",
"_parent_id": "4cb3333b-f451-4c23-b013-094fe136241e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6d075efe-4ee4-405e-bb6f-0389a86e7249",
"company_id": "afeba569-bca4-4413-bc87-318e02c7bb5b",
"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": "f779a3f8-595f-4757-bc13-ec590039e1c3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7812547e-016f-481a-a4a6-96d8ac6024aa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bf12523a-d94c-495a-a392-9b3667aa18b1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "efc71fef-e0e3-4fc2-bef1-adf5bef09d54",
"company_code": "sample string 5",
"company": {
"id": "7b8f0d14-030d-4cfa-8b7a-7c9a5f40f1a8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-19T11:38:23.0241197+00:00",
"sales_territory_id": "c8b49fea-6fa3-4b2b-9891-a2f2070ac77d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6ac7271c-60a9-4d2a-9080-e07733359b91",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8155f2a-7a35-4181-9953-555177f110e0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e5c407b-3982-4693-b140-9bb7b00cc73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f4b2d19-7997-462b-9fe8-3accaf8ee186",
"db_currency_id": "712a3c7b-f807-4c13-9b0a-d4ba0c11fc26",
"db_language_id": "7691b345-b6ed-4161-b77d-375dad51a407",
"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-11-19T11:38:23.0241197+00:00"
},
"modified_dateutc": "2026-11-19T11:38:23.0241197+00:00"
},
"marketing_segment_id": "f998a3a1-270b-4a5e-af17-6303d0373050",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "51ec3a91-cadb-4e4c-a1dd-816a7ba0d9e7",
"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": "7ed8dd4c-096a-4c46-b704-93c6de2368d4",
"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": "6f6943de-72c8-4c10-907b-34d130ba2fed",
"db_country_code": "sample string 28",
"feelist_id": "00d990fe-30a5-485d-bae0-6b8155921450",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "736142b4-0498-42d1-8c4c-f2af75d41775",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4aba8702-f39e-473a-b41b-2ac25943cf25",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-19T11:38:23.0241197+00:00",
"db_currency_id": "5e142fe1-f1b1-4a27-9bc8-6460d56ed73d",
"db_currency_code": "sample string 10"
},
"company_type_id": "c1299749-b348-44a8-b050-d860116e3283",
"company_type_name": "sample string 32",
"company_type": {
"id": "b2a5074e-e359-4f2f-bbf3-49fcdf108b15",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73931863-884e-446f-9c7c-b71efd226105",
"sales_organization_code": "sample string 5"
},
"db_language_id": "19d3b9d5-acbd-49c7-94db-54f1fc12286e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f9eb81c3-330c-4cb5-9f65-c03c67b512da",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dc84f764-cf47-40fe-836f-c7e6f7b05f82",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bd8e518d-b9c5-423f-9fd3-51495a5698fb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-19T11:38:23.0241197+00:00"
},
"company_sector_id": "aee00340-76e4-483e-90cc-a90628e083b7",
"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": "ff19fbe2-a894-4636-8d33-c669e612723a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b0074ab-bc28-4f93-b9b9-96fdbbd2ac6e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0b1faa07-074a-40bd-9414-3ebec28ed89b",
"account_manager_user_code": "sample string 56",
"company_status_id": "13b06981-cfc1-4953-ad19-4e7b344ecb78",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-19T11:38:23.0241197+00:00",
"id2": 60
},
"db_language_id": "85cc95b5-67b0-4458-85f7-1a98f2c9e825",
"db_language_code": "sample string 7",
"db_title_id": "311fea2c-3144-4e2e-9b8f-9035af5a0ad6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-19T11:38:23.0438586+00:00",
"create_date": "2026-11-19T11:38:23.0438586+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-11-19T11:38:23.0438586+00:00"
},
"modified_dateutc": "2026-11-19T11:38:23.0438586+00:00",
"id2": 22
}