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": "ded40ff9-e634-4a6c-8c08-d17412b12c1c",
"_parent_id": "c6a9c10d-5675-4a67-b682-e6a7232bfcd6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5489aa26-8e65-4226-a930-3697ab899b92",
"company_id": "4fc10983-2df3-4472-a30c-05aa6785b959",
"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": "a815a6de-ca50-4acb-80d6-4231abc9118f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "328a3b71-a192-41ae-942e-21a955c7b180",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3926d457-253b-425a-b133-93111fd6c390",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "16e571a3-d01d-4b7e-8123-a2bbb43e132e",
"company_code": "sample string 5",
"company": {
"id": "32ab2e89-c80d-48ce-9521-d98c6b5b941b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-16T13:03:40.0853461+00:00",
"sales_territory_id": "cb426b39-f6c2-474f-aa9f-018618b15880",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a4988e8f-0402-4e64-942c-e47eb6a943c4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a857ff4d-5164-4501-871c-dab06b0feb21",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4fa05c7f-84e7-4344-b3be-bdae7648aac4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3264b7f7-cc3a-483d-a37d-141f7ce64f15",
"db_currency_id": "764542d4-f5db-429f-95ef-1d39aac60435",
"db_language_id": "4b43bf80-5131-489a-87ab-0e42200c29f6",
"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-06-16T13:03:40.0853461+00:00"
},
"modified_dateutc": "2026-06-16T13:03:40.0853461+00:00"
},
"marketing_segment_id": "be06a5f6-8470-41ff-864c-68150e6f04d1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "20b52b02-6ff9-405b-958a-99c4cdfb3559",
"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": "d50231a0-80a4-49d8-9bbb-14c873158c62",
"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": "877a18b2-bc1a-4700-a233-128ab1ae3836",
"db_country_code": "sample string 28",
"feelist_id": "3494c4d9-e55e-4d2e-8be2-5a3bdf344dc4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be260ed5-79d9-4e01-8e13-152dfd129f85",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ffd1cac2-007a-4d3b-b5f1-1fecf75ef659",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-16T13:03:40.0853461+00:00",
"db_currency_id": "607a983b-e04c-4541-b845-9cec3a296b53",
"db_currency_code": "sample string 10"
},
"company_type_id": "c7cbba91-8a36-4a4e-af51-abe7e90cc3fb",
"company_type_name": "sample string 32",
"company_type": {
"id": "041bdc32-270e-468b-a795-fc4d26fe6528",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8fd50fbe-e6d1-4ece-ae83-a8824f5fb92c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "101f1210-0d18-4143-b6e1-dd3fb32f0e58",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f530a71e-76e8-4f36-9d30-473d6ba480ce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "311b257c-6575-4465-b5d0-3f03af84790e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "83b39be8-a4bc-4cf2-b2a4-22f380bace45",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-16T13:03:40.0853461+00:00"
},
"company_sector_id": "3e670c80-20e6-4b68-9ad6-89c65e39d8e7",
"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": "530c80f6-b1d4-47e2-9245-bf8ada136f91",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "abf12788-77b3-45ec-b241-4847c393dc23",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "22049318-7ad7-4896-bb62-bde36aa4d799",
"account_manager_user_code": "sample string 56",
"company_status_id": "6405e61f-3e4f-4d6f-91df-92d1073776af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-16T13:03:40.1009685+00:00",
"id2": 60
},
"db_language_id": "48d581b9-70d0-4c0a-a2c5-c83518776dbf",
"db_language_code": "sample string 7",
"db_title_id": "f4f37354-80c2-4df9-bcc5-5a96f7ed101f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-16T13:03:40.1009685+00:00",
"create_date": "2026-06-16T13:03:40.1009685+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-06-16T13:03:40.1009685+00:00"
},
"modified_dateutc": "2026-06-16T13:03:40.1009685+00:00",
"id2": 22
}