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": "8639ba6e-774d-4d6b-8e10-0afa4b0d27e8",
"_parent_id": "283c2966-1e19-4efd-a7de-45a53365497d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "3116acc5-7d3e-458a-868d-a2b9ad663545",
"company_id": "abc5ab92-170c-4812-8ec0-b21b501c15d3",
"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": "d47edb38-2cbc-4cfc-8312-4bc9c7371034",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "91919d45-4e89-405b-904f-92fe99151e29",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "03c12f79-45ab-48f9-bd4a-4ee64c298df8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6b6d28be-3fdf-41ed-998d-fd87f182983f",
"company_code": "sample string 5",
"company": {
"id": "dac242ab-a4b3-46c3-aa8c-f7c3fe7a046d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-29T11:57:42.9851013+00:00",
"sales_territory_id": "3417ba3f-a1f4-444a-abae-adbfb8723d41",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "481adaf9-a976-4360-af5e-ab25350d8a3c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5900578-fb8e-4d77-8978-3e44530820a3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3b4b7ead-1379-4ced-9db5-33de6331bd08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d8a3804b-f4e0-40be-b4f1-b5552e973a91",
"db_currency_id": "42efcc5d-e179-449e-9a20-21080f033c66",
"db_language_id": "25655491-ca33-4c5c-b265-23684b30c4e7",
"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-29T11:57:42.9851013+00:00"
},
"modified_dateutc": "2026-07-29T11:57:42.9851013+00:00"
},
"marketing_segment_id": "f02fa320-4917-4da1-809b-ab76590a1ecb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "32429e74-05ff-4fe2-9fc2-43130a9d9739",
"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": "53962ecd-4b6f-4e0d-ac67-f5be9886aa94",
"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": "dca93b1b-b189-4787-9fab-314a04c92e59",
"db_country_code": "sample string 28",
"feelist_id": "1c5a1ff2-2115-41c6-aa39-c6fee50ee0ef",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e3d11459-8cb7-4026-9d59-2ac515219313",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a64d97fb-380d-4fb0-91be-969ceac15e18",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-29T11:57:42.9851013+00:00",
"db_currency_id": "b2292dcc-2e3e-4756-a98f-d9e32d6875c7",
"db_currency_code": "sample string 10"
},
"company_type_id": "3ef28725-3cd1-4232-9953-0fb200a11ded",
"company_type_name": "sample string 32",
"company_type": {
"id": "e14ec448-7e43-48b2-bfdb-3200d186d612",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36b47401-47de-4c87-b7a1-b41466576eb8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a355c2ba-b945-4e9c-b14c-1556d1c9ef40",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b045b656-a12f-48d5-bb0f-f3708b4293dd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "54692cd1-f329-4269-9aba-771e2a611d8b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "49f60ef7-0b55-48cf-abbd-6b4873d10d38",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-29T11:57:42.9851013+00:00"
},
"company_sector_id": "fa1663e9-47a3-474a-b73c-16c457e311c5",
"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": "893fedbe-9c43-419f-9f6d-71310b5400ab",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "86289299-c8b2-4d74-94ff-457bc680baf8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c0285662-ae49-451e-a5d8-8c15978d6d89",
"account_manager_user_code": "sample string 56",
"company_status_id": "ea2b9fbc-4b18-497d-a201-d5f5da782307",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-29T11:57:42.9851013+00:00",
"id2": 60
},
"db_language_id": "5fd16803-5187-4d89-a983-7ce28f14904f",
"db_language_code": "sample string 7",
"db_title_id": "daa78dc5-1746-48cb-b315-0e230e7ac45e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-29T11:57:42.9851013+00:00",
"create_date": "2026-07-29T11:57:42.9851013+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-29T11:57:42.9851013+00:00"
},
"modified_dateutc": "2026-07-29T11:57:42.9851013+00:00",
"id2": 22
}