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": "7e1d457f-6bd6-4224-9a8b-142d12a36a93",
"_parent_id": "48e0f703-18ab-4f2a-a309-d667336aadc2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8c76fc19-6b74-46c6-88f4-d53f011e6f01",
"company_id": "c89035fe-1d19-489e-ae61-92df973b818c",
"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": "e080d397-f87c-4f31-b948-06c0ca793099",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6083ef59-c50b-4d2d-9410-f03d7452ce03",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2e710c38-2770-4a68-8e96-19f6323dae02",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86e8a3be-3209-4749-ac92-756fe232028d",
"company_code": "sample string 5",
"company": {
"id": "d1700e48-1baa-4045-a137-9df8dccbade5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-29T06:36:20.8838631+00:00",
"sales_territory_id": "d3d2e9f5-fed7-4bb0-8946-a9641b13da24",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "826f9055-ae3a-47be-96cc-2a78d1c7ebec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e20212b0-573a-4f9a-9bf5-ba32599c178a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ad61fd21-505f-432f-b9ec-d816c9d67d50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96f688da-bfad-44ba-a9b7-4645aa3ff742",
"db_currency_id": "0bba5e3b-39f5-47d3-87a6-8dc07eba0577",
"db_language_id": "f12235d7-5506-4f9e-b0ad-27159c0bff84",
"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-09-29T06:36:20.8838631+00:00"
},
"modified_dateutc": "2026-09-29T06:36:20.8838631+00:00"
},
"marketing_segment_id": "0bc8f717-50ba-4d70-ace0-f0d4b54a874b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b299f0da-6a62-440c-9ba2-402d8fccdf2f",
"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": "38e0927d-6aec-4f5f-8ab2-7b092686b81c",
"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": "f58c56cf-a62f-420a-92aa-fb7d8bd7a874",
"db_country_code": "sample string 28",
"feelist_id": "44cbdbae-e82d-4e57-83a1-2012c9011b14",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b53c7e14-128b-4fc5-b6c4-fe9125541a60",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8cb629f5-7d01-4af6-acba-5e04e54520a9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-29T06:36:20.8838631+00:00",
"db_currency_id": "9660319a-7469-4f23-b7f7-60477feb38a1",
"db_currency_code": "sample string 10"
},
"company_type_id": "0f8361e7-3db4-42f9-bcb3-9412f70574e7",
"company_type_name": "sample string 32",
"company_type": {
"id": "e6016fc9-c1c2-42b4-acbf-220200118b01",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f828baf5-45a7-497f-a6d6-a59804e157d5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "50cf486d-69c3-45fa-bdbc-32179ef731af",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "44ec9810-8599-4aee-a31d-30188832e892",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5828ba1b-643d-4944-9b24-b45326ced199",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "df4a0bdc-6982-45b8-bc1f-1249faf5990a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-29T06:36:20.8838631+00:00"
},
"company_sector_id": "0fbfe2fa-c071-4b1c-b4b6-1b9050a44e68",
"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": "c6f9c922-7fdb-4886-92d7-f566a77a42ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "334f2703-e89e-4770-9541-191f97dddf7a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ddb776b3-e0e0-497e-a1f5-3e34402bed36",
"account_manager_user_code": "sample string 56",
"company_status_id": "1106ddd7-86e2-4319-a98e-e03c25bcdbb8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-29T06:36:20.8838631+00:00",
"id2": 60
},
"db_language_id": "806db8be-a713-49db-866c-cd5b2cfe6b5b",
"db_language_code": "sample string 7",
"db_title_id": "4632a4fc-fcca-458d-a39a-0f9af991ffd9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-29T06:36:20.8838631+00:00",
"create_date": "2026-09-29T06:36:20.8838631+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-09-29T06:36:20.8838631+00:00"
},
"modified_dateutc": "2026-09-29T06:36:20.8838631+00:00",
"id2": 22
}