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": "2c4cb16c-0029-40ae-9bf6-cd2d7e8417e6",
"_parent_id": "ad02c3b1-717a-423d-8a53-b5be47bea56d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ba6745ed-468a-4d31-849b-3bab1984b5f5",
"company_id": "d5bd2d51-031e-4398-ae96-a9b22c292d77",
"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": "9d0b8a1b-e9b9-4d64-ab68-acbf6c3e5b59",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b8c6a83c-1268-4a22-8149-49dfeb323adf",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d67fd41a-6829-41d1-bb4a-f7bb6d140029",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ac8c98c6-5f81-432f-9f1e-d6c78b655ad4",
"company_code": "sample string 5",
"company": {
"id": "c7d5ebff-272d-44a1-922e-005ab8c6deec",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T11:56:14.9842985+00:00",
"sales_territory_id": "0533b81f-652c-4154-ba5f-35693c12f0ff",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c7b5f56f-c270-4288-8700-43d1b37a4a72",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "522dd0f6-0e93-4ea4-822c-5115f9c3517a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d30bac2-0291-4459-b62c-0ea5eda48b20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "20568c1a-e0ec-4716-b210-aea49ad2c4d6",
"db_currency_id": "7fe111dd-0fad-4c6a-9c3e-e2b21d983933",
"db_language_id": "2adc4bec-c947-4c9b-b5ce-fcf02fa3f1ad",
"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-05-21T11:56:14.9842985+00:00"
},
"modified_dateutc": "2026-05-21T11:56:14.9842985+00:00"
},
"marketing_segment_id": "9bde7d24-f3c9-4825-bd10-faea6e7d39d2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6042cd4e-0f4b-4551-b052-940c2ef935eb",
"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": "600b8c22-1106-4870-a126-fe41dcba81a5",
"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": "519d0a5e-409c-4a85-ac40-d5d44dfcaf23",
"db_country_code": "sample string 28",
"feelist_id": "6af090fd-42b0-472b-8240-ca702fe0c6f2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cf8e2eaa-3dfc-479e-960c-459fa23d2338",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "52946924-5310-4872-978a-76e83567dbf1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T11:56:14.9842985+00:00",
"db_currency_id": "763bd350-2ce1-47b6-99c2-ef7a87a4952f",
"db_currency_code": "sample string 10"
},
"company_type_id": "479cab6d-6b47-4da1-bf74-18c97021505e",
"company_type_name": "sample string 32",
"company_type": {
"id": "1ea2e71b-ad45-4933-86ed-61df4d1da01f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f99d641-1314-466b-8186-fb1f72d0f33b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4258874d-b133-4fc7-ab20-ce50fe1e447f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a6a0378d-4de0-49a9-83e2-b33a721800eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "34fd3735-6cfb-4a4e-8579-5666d53f280b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "91d6f066-7e93-45ab-83b8-65ed43787988",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T11:56:14.9842985+00:00"
},
"company_sector_id": "93889644-fe9a-4765-922d-8997ce2b48cd",
"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": "ddf69395-cea9-4d33-bc71-0ded834aa531",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39e6b6f7-2599-4be9-bb6a-840253629221",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f3f48750-acb0-47b3-8fc8-237a63a18bb7",
"account_manager_user_code": "sample string 56",
"company_status_id": "f51a9ea2-a036-4db5-a139-78d5d810a675",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T11:56:14.9842985+00:00",
"id2": 60
},
"db_language_id": "b97e4577-7635-4e4d-9d40-53afc8014f60",
"db_language_code": "sample string 7",
"db_title_id": "4a5d8cbf-fba8-4c93-aadd-c8d6d467f4c0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T11:56:14.9842985+00:00",
"create_date": "2026-05-21T11:56:14.9842985+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-05-21T11:56:14.9842985+00:00"
},
"modified_dateutc": "2026-05-21T11:56:14.9842985+00:00",
"id2": 22
}