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": "c4358fc4-eca9-4a8e-9b81-00678dcee96b",
"_parent_id": "5cfc6acc-ee0e-4957-b6d5-1dda24badc86",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "eaab7caf-60a1-4413-8f50-294e1c65d64d",
"company_id": "6bc9e9ef-26f3-4c17-aab6-b9491f9147b6",
"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": "dd234cd1-6e92-4ca4-bb1e-a066770d5f1c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3674ecdf-f692-4f11-96b1-d052a0a317eb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "95bf110d-0dfb-45c8-890b-1cc29be56e8e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "66b87359-ee20-4c4c-9c13-3eb9afc7314c",
"company_code": "sample string 5",
"company": {
"id": "7e195331-a493-46c8-b1db-27a51a3554b2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-27T08:37:57.6322415+00:00",
"sales_territory_id": "8e213a88-f1ab-46af-85fa-d9d8d412d1a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1c05771f-bba8-48f5-8703-276a1b7a595b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "007ab49a-7f24-47e5-9a5b-70e706203369",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "549946c5-34e4-49bf-9e01-2d399cf2c9b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5bbc0ec2-1d3a-4d9e-aba3-3feef33d97ba",
"db_currency_id": "c461f7ab-ab92-4dbf-9a30-0a5bac8969e3",
"db_language_id": "d0c60314-6686-4a82-84a2-66c9408c1824",
"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": "2025-12-27T08:37:57.6478644+00:00"
},
"modified_dateutc": "2025-12-27T08:37:57.6478644+00:00"
},
"marketing_segment_id": "1465c5ec-99b6-4e66-80f0-b1ef7680e72f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7c1ca6e5-56cb-4143-80a7-652f0720b83b",
"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": "77fc9d4f-991d-4647-97ea-16eb925173d5",
"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": "d7353434-bfdf-4df3-b51e-569319f6e984",
"db_country_code": "sample string 28",
"feelist_id": "bc7850b6-fdb1-4c4a-8a64-797c1002aee8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d287050c-7d0a-4acc-8f8f-08be209ec959",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "56146fa8-d76f-453a-b4c5-f3dc04c12fa4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-27T08:37:57.6478644+00:00",
"db_currency_id": "4c27828d-904e-4db0-b498-d3e895beece0",
"db_currency_code": "sample string 10"
},
"company_type_id": "e6349aaa-a76c-4c50-9653-6d144e1785d0",
"company_type_name": "sample string 32",
"company_type": {
"id": "9b2631fb-92c0-4a4d-80aa-3e9dfa4137be",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce06d4f7-eb66-441c-b45b-a0c86d88137f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e88c744e-852f-4845-8a27-7de7fe397176",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "63654630-2e76-4708-b29d-5c45f0d53273",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "516fc3ec-3fc0-4740-99b0-98ea8e9c3bc6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bc10d5ce-13be-4c47-b77f-6b44ad16e9d6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-27T08:37:57.6478644+00:00"
},
"company_sector_id": "2302bbc2-1a43-41e8-88bb-d4e9769301f4",
"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": "ba0c323e-fbcd-4538-a718-bc33840f3cd3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "61fdc2ad-eaca-4078-9048-7752364dc259",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c76d0b4-3bab-4c4e-bed3-5545f11ffee4",
"account_manager_user_code": "sample string 56",
"company_status_id": "53c46ec2-e645-4306-9226-e26e7010bffd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-27T08:37:57.6478644+00:00",
"id2": 60
},
"db_language_id": "d8937852-086a-4070-aaf3-a2c93b98041a",
"db_language_code": "sample string 7",
"db_title_id": "870f384d-27f4-41bb-863a-a201539206f7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-27T08:37:57.6478644+00:00",
"create_date": "2025-12-27T08:37:57.6478644+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": "2025-12-27T08:37:57.6478644+00:00"
},
"modified_dateutc": "2025-12-27T08:37:57.6478644+00:00",
"id2": 22
}