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": "c164619b-63f0-4be9-a1c7-245b0fd2669b",
"_parent_id": "8af648c6-f258-4d0c-bb96-9b0c485677a6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "27e83488-e151-49fb-a142-4726637df33b",
"company_id": "4e788790-7a45-4ce1-9c20-6b433325f9c5",
"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": "fb03b588-4e6a-46f6-80c7-26804b84f9e9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "39d3176e-f792-45f1-bce4-2849e9227896",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "da078180-79f2-41a7-a20a-a28093197924",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "27106ac9-0195-4414-8b66-67d0dd865411",
"company_code": "sample string 5",
"company": {
"id": "03d8a22a-e994-402a-ae92-da04c74111f6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-25T22:53:01.2842193+00:00",
"sales_territory_id": "4f3ce728-30c5-41af-a50f-1656d35e01c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cdd77814-42c9-4d7c-a7ab-866d05b80fad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e91647d-3836-489d-ace7-e605d1cbb152",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "82767174-0dba-476d-8e48-e7dd0de256dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f4b8de5-9e76-466c-887f-8550ecf96b49",
"db_currency_id": "7914fae9-185e-4e90-b4bc-91b989256eed",
"db_language_id": "3aea0fa6-89e4-4c5b-b078-78795dfb52e0",
"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-25T22:53:01.2842193+00:00"
},
"modified_dateutc": "2026-07-25T22:53:01.2842193+00:00"
},
"marketing_segment_id": "14165b48-4c75-4238-bbc7-8b58fc733309",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d471ac78-982b-437a-a95f-34b5c0fb6425",
"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": "5cdbca7f-89c1-470b-902d-a26ad8cd5655",
"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": "e66f008e-cad2-4453-8bcc-1e31b70ee434",
"db_country_code": "sample string 28",
"feelist_id": "6fbae4e0-a523-477e-8d3a-565374ecc0ea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "af1458d0-feb8-4219-90f2-ef4c9d80dfb0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "41d6708b-78f5-4497-99a0-bab8dedce858",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-25T22:53:01.2842193+00:00",
"db_currency_id": "0ce28e45-d1e3-4330-b218-8f8a8ef2faf0",
"db_currency_code": "sample string 10"
},
"company_type_id": "cf7e8f05-16d7-43d6-b12f-4ed7b703ed79",
"company_type_name": "sample string 32",
"company_type": {
"id": "1d9a690a-6b92-444d-9355-159db9ea9e54",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "601d1f14-d2c7-4bdf-befc-7e90c0b1a0df",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e54c1b7a-8e46-49c1-8bba-31d7cf8c40cb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "368408c7-bac0-48e5-b895-399ad15c26e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "012ee8d1-b181-471f-b8bc-88c2efa5ced1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "61a58372-bd56-46f5-b8e6-71274fc23d59",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-25T22:53:01.2842193+00:00"
},
"company_sector_id": "366f510c-0203-4780-9527-dcc8da8cb5e8",
"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": "54162dad-9b32-4091-b9ff-d5ecd993472f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c26549a1-0152-4bd5-9e34-a5702ae94c92",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d40965bd-8f97-430d-94ed-88901558fce2",
"account_manager_user_code": "sample string 56",
"company_status_id": "b9ce342a-9326-4b81-b434-30e562c2de75",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-25T22:53:01.2842193+00:00",
"id2": 60
},
"db_language_id": "3b7c44bc-2dec-4959-8412-c6e3a685a586",
"db_language_code": "sample string 7",
"db_title_id": "a6470b72-6f0e-431a-8d84-284574aef2dd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-25T22:53:01.2842193+00:00",
"create_date": "2026-07-25T22:53:01.2842193+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-25T22:53:01.2842193+00:00"
},
"modified_dateutc": "2026-07-25T22:53:01.2842193+00:00",
"id2": 22
}