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": "e57a6ca9-8b1b-48bf-8198-1c2c4c71bc9b",
"_parent_id": "9f8f97cc-7c9e-44e7-bb12-560ef056b60e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d3bb6558-8cff-45f3-91d9-d14f8b3bf4db",
"company_id": "2a20d804-e1df-4ba4-bedc-7f5a664f0c1b",
"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": "97d64ae2-a698-48fa-9385-45217f9942f8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a9ddffa0-d53b-4d32-b31e-2e87b4f4aec2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "eefc4ebc-4c4e-43d2-941e-b1bc1bff7cc1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3fdb93e9-1893-4666-a5c5-f5399b2a807e",
"company_code": "sample string 5",
"company": {
"id": "9d4255a0-b266-4ab7-ad99-e2b65908e134",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-03T18:57:10.451304+00:00",
"sales_territory_id": "7dab439f-6784-4f82-969b-a5063c6640bd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8ea17094-2404-4997-aeaa-d00d263b6200",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21a29a2d-95be-445f-8178-8f64c2908aa6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e7406e8c-b7b0-4f61-ab54-bf05c5a304f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58921681-f2b2-4e40-991d-429fb5f1459c",
"db_currency_id": "ba7e5f28-e94f-4088-80f7-a67134c131c3",
"db_language_id": "0d8ef763-1934-446c-9cd5-a2a6cb093ea8",
"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-09-03T18:57:10.451304+00:00"
},
"modified_dateutc": "2026-09-03T18:57:10.451304+00:00"
},
"marketing_segment_id": "d88a629c-9e71-4a40-8b4b-666899247016",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5b55e8a8-b688-4c19-a934-efe0fc590a36",
"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": "192b0a53-5c80-4e61-a0d7-51aebbb12533",
"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": "41dc8d3f-2aa7-450c-bf8e-c8eabf74cda9",
"db_country_code": "sample string 28",
"feelist_id": "e3bb21d5-dce3-47d5-923d-cd4aa40d4dc3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "89908115-07be-473f-86a4-2233a3767ee1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "40ff15ab-c03f-4ca2-a1ec-a973301c7be2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-03T18:57:10.451304+00:00",
"db_currency_id": "3dc2bd6a-7457-4a64-bd68-c05770138136",
"db_currency_code": "sample string 10"
},
"company_type_id": "f8491b25-72d9-4301-913c-2c689772f3d9",
"company_type_name": "sample string 32",
"company_type": {
"id": "df6297a4-fd62-4c90-9858-3f0927e9e4ae",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "302619da-9c8f-423a-9c75-25b1df77d9a9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8aa31c57-04df-4d47-bf17-6b9ff3733298",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8a0c2018-0631-4c35-bf26-a8459c8cb08d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "17b8e21d-1af6-4634-b1e6-5c438dcc750f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8fac938-f173-4490-a337-781acf67fb8f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-03T18:57:10.451304+00:00"
},
"company_sector_id": "d7e06292-dc07-4925-ac02-6e868b0ada23",
"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": "6be1b2a8-8555-4044-93f8-0a737ca6b600",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb73c2b2-c7c5-4643-9109-7b3ec718cb9e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3469b2e9-f39b-4ba5-9535-ad79dea156cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "96369eed-acea-4a6f-86d7-b87efd57d1f9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-03T18:57:10.451304+00:00",
"id2": 60
},
"db_language_id": "adab3c69-e2bb-41a9-8b30-be0fdd329bb5",
"db_language_code": "sample string 7",
"db_title_id": "a81a56ac-c572-4cbd-b5e8-d3e0d50530ec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-03T18:57:10.451304+00:00",
"create_date": "2026-09-03T18:57:10.451304+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-09-03T18:57:10.451304+00:00"
},
"modified_dateutc": "2026-09-03T18:57:10.451304+00:00",
"id2": 22
}