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": "ddfa2294-b7fe-442a-be9a-ba63a8d7c6f6",
"_parent_id": "aef27d68-819e-4614-9dfc-43456a84ab5d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a9763819-a0de-485c-b267-e6e76240a6a3",
"company_id": "5f1ad187-e3af-4210-bd97-0d8815f5694b",
"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": "c4231c1b-858e-40bf-9817-13567bd96dff",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "be74fe36-b815-41ba-bd96-c2845e910189",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "84a8f22a-182e-487c-a95a-c3ca3d816d6e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e554e20d-b2fb-4908-9244-944e685acfa8",
"company_code": "sample string 5",
"company": {
"id": "076b4181-e397-41d2-b116-014fbdc55d6c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T09:10:05.2046285+00:00",
"sales_territory_id": "ba07e995-1d3f-4f75-a87a-3c453351cd6b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bd2cf01e-4161-4422-b721-101f88265176",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7dfe30d2-8e7d-43cb-818c-87e9bc116e3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c0688f2-4b64-424a-ac05-913dcb4b55f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "988e9773-62f3-41e8-bd20-3aba74b5b960",
"db_currency_id": "eb4e4af7-e72f-4ef2-a991-92725f527b41",
"db_language_id": "8acf2d25-800a-473b-8808-620babbf8caa",
"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-04-18T09:10:05.2046285+00:00"
},
"modified_dateutc": "2026-04-18T09:10:05.2046285+00:00"
},
"marketing_segment_id": "029266b5-2d81-421c-87d0-0efad0cda1b8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2c7dec16-3514-47c9-8043-9c131526144d",
"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": "13d82c00-47d9-4f2e-8333-721b381c2a4f",
"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": "7c0773d7-012c-4cc2-b065-c42ff05fa332",
"db_country_code": "sample string 28",
"feelist_id": "9334678c-8ae2-4191-864e-71d5d285ab23",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e7e216d2-ef5e-47bf-b333-2cb8a374373e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3feb6687-2410-472f-9f14-b27840e99dc7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T09:10:05.2202512+00:00",
"db_currency_id": "f8db85da-76c6-46e1-a004-4e74e0eca085",
"db_currency_code": "sample string 10"
},
"company_type_id": "35b9c43b-fd7b-43ea-a574-55db4a58a8e3",
"company_type_name": "sample string 32",
"company_type": {
"id": "2c5b473a-e965-4c6e-b2be-3b9ee2fbe7df",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eabbeca8-73cb-44e6-a11d-84a7a7805a8f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d79e9cd0-9d29-42de-a802-2a608b0efbda",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fcfc37bd-d480-4589-9e13-b63ccef7b7e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1d8c4bf2-c7a1-450f-968c-ba941a12ba78",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b03e0b77-facd-40c9-bd01-c9e55134b234",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T09:10:05.2202512+00:00"
},
"company_sector_id": "9dfd8895-cb38-41f2-972e-1302636fb3ba",
"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": "4d1fc0a7-dae6-4f8b-a3cf-fbc4d26942fe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ca62a6e-6371-4d90-8810-394c06378af0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4020ace8-65de-4f02-8227-b9d4633cac24",
"account_manager_user_code": "sample string 56",
"company_status_id": "019e4c34-7037-47b1-b1fb-199e0a3e3550",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T09:10:05.2202512+00:00",
"id2": 60
},
"db_language_id": "8cd49001-7efc-41a4-a51d-d14266a62472",
"db_language_code": "sample string 7",
"db_title_id": "66ceb302-a5ec-4bd0-b995-59d1dde0851b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T09:10:05.2202512+00:00",
"create_date": "2026-04-18T09:10:05.2202512+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-04-18T09:10:05.2202512+00:00"
},
"modified_dateutc": "2026-04-18T09:10:05.2202512+00:00",
"id2": 22
}