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": "93725c41-1c00-46c4-a850-17e01713baca",
"_parent_id": "06d2fe0b-17e9-4275-aad1-4a0b5d8641db",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "19e0a982-ef25-4d84-91be-311bf9cf43c0",
"company_id": "6562b6d5-6401-4ce6-8e0d-e451d61749c2",
"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": "d3f79978-9812-425f-8df8-9161089a346c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6243c6d4-01dd-463e-9b9d-0c508445ee78",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "67992064-b961-458e-850d-a2105e74821a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2917a0ab-22f6-46d4-9860-c91d3c429ab3",
"company_code": "sample string 5",
"company": {
"id": "364f5770-cdb2-44bd-b064-44b4df1af14f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-10T06:55:45.6255453+00:00",
"sales_territory_id": "3e9d5335-c3b1-4482-9c47-df227f36a5a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d67fc078-42f2-426a-9c65-59945874b141",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9c60fab-9270-46b4-bb3c-809fe95bcf54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "906a08cc-adc2-42b5-9c7d-ba9ca1542507",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6067b857-202a-47c3-9e9c-48f458aa6250",
"db_currency_id": "d0a8edb9-a7ba-41f0-8452-31a222a859c3",
"db_language_id": "9aaec315-9f1d-4d54-a59f-8ffbaab16cca",
"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-10T06:55:45.6255453+00:00"
},
"modified_dateutc": "2026-09-10T06:55:45.6255453+00:00"
},
"marketing_segment_id": "3c2b7edc-8dd5-4f32-85ca-192897a238ef",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "86e2f539-c118-4887-8b9b-cd215b5d001a",
"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": "3671bf91-5e2b-4a71-83ff-5c86226ad3ad",
"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": "af9df075-c12b-47ff-acf8-b695f0101db4",
"db_country_code": "sample string 28",
"feelist_id": "db3bc374-fd0c-48c5-9114-9145a4bb0875",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2c246c9d-bec2-470d-8882-f16f339ffa7a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "00209fa2-8f9f-428d-8ead-b06a9e3f2430",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-10T06:55:45.6255453+00:00",
"db_currency_id": "844ef48f-7d79-4a4a-9c73-c23664632346",
"db_currency_code": "sample string 10"
},
"company_type_id": "b7975e3a-7cde-4e89-b23d-fb2881baf268",
"company_type_name": "sample string 32",
"company_type": {
"id": "f143b719-130d-43a5-bfa7-c868f7777c57",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2bc8e99c-a34c-4240-beab-b8e2e5a47539",
"sales_organization_code": "sample string 5"
},
"db_language_id": "021695f9-4180-4c04-8c65-d9952216b987",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58beb0e5-6d4f-42c7-8104-e6ffc70aedbe",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e29ff747-d243-41df-96d6-652838dea764",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f25be348-70ea-4204-af46-028181db7b3a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-10T06:55:45.6255453+00:00"
},
"company_sector_id": "af058e76-2095-4d28-ab03-74f8f55fd8f0",
"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": "c0348f8f-e001-4ba0-8eef-158388450766",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c1119daa-d3d1-4cf6-a938-bef1cbc92c41",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "942a0915-57ec-41ff-9777-d262b0138343",
"account_manager_user_code": "sample string 56",
"company_status_id": "240f2d82-8a36-4d2b-84df-68afb7f24284",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-10T06:55:45.6255453+00:00",
"id2": 60
},
"db_language_id": "aec71262-df7c-4712-a1c4-f8a05721949c",
"db_language_code": "sample string 7",
"db_title_id": "fd29151b-f675-488d-ba83-ccbd037e231b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-10T06:55:45.6255453+00:00",
"create_date": "2026-09-10T06:55:45.6255453+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-10T06:55:45.6255453+00:00"
},
"modified_dateutc": "2026-09-10T06:55:45.6255453+00:00",
"id2": 22
}