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": "000e36b2-2bef-4b6b-a000-a9c0441997e9",
"_parent_id": "c8f22e04-4c7a-4445-9687-da444f4ff586",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "38f089a4-b01f-4276-b469-7bb0a5c7a657",
"company_id": "6db291d3-9b46-4408-bc5a-4117505ad917",
"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": "fca5bd68-7c56-458c-82d9-69dbcb8cab2d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "76d3aef4-2ab0-4dd8-b9ae-cc3ccd1d1ca8",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d450d087-237c-4853-adc0-7d649fd4e52f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bd2ad80e-251e-4469-a08f-2a4689676d66",
"company_code": "sample string 5",
"company": {
"id": "d75de4f1-5581-46a6-acf5-2600cc670dd6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-15T04:51:45.0615917+00:00",
"sales_territory_id": "279e5954-bfc2-4262-b617-885aa42d6a19",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9c0b2c14-b9b4-46ed-a569-04535cc18443",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "307e3cb3-9528-4f54-929f-62eb2d9e25be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f99a16aa-33f9-4d86-8da9-8d8fc231fefc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88dcbd79-495e-4809-8910-9f52c42854bd",
"db_currency_id": "80f3021e-0e3a-4bd9-9c3c-89b43e8f8f58",
"db_language_id": "03ad7a52-d1f9-4cfc-bafc-5c73882c7f46",
"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-15T04:51:45.0615917+00:00"
},
"modified_dateutc": "2026-09-15T04:51:45.0615917+00:00"
},
"marketing_segment_id": "ce592ab3-d957-4db3-bafd-b6ffedabcff6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "40d8b702-67b6-462f-8d94-5656d72fcc7f",
"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": "ba3680a7-5ab1-4497-bbc7-50bed4f7dbf6",
"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": "91e96850-dd9e-407e-af5b-ae6ee666501d",
"db_country_code": "sample string 28",
"feelist_id": "84393669-5b52-421f-8c42-c66c9a3eecf6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d9552a62-4e30-4b18-b6e9-3e500bd8d6c4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "41d8ae39-c15e-4c9e-ab49-bdcc56cffffc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-15T04:51:45.0615917+00:00",
"db_currency_id": "be862116-aede-41f0-8b6a-f8ae0d9afdc7",
"db_currency_code": "sample string 10"
},
"company_type_id": "11c69bb4-2543-494d-b8de-f770a8d8d694",
"company_type_name": "sample string 32",
"company_type": {
"id": "14498c7e-63fa-4975-a423-10fb2d459675",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "46811c8f-5dec-4a0c-9a61-adb35ca0ddce",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a1cd5688-c48d-4013-b6d4-e2ddc5a2f075",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e5acf914-71e7-48e7-b48c-bc5704583352",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "50198324-8f11-40d3-848c-ac759ed64730",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d05d7e6b-4cb4-4f72-bda3-469386df735c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-15T04:51:45.0615917+00:00"
},
"company_sector_id": "89b8d930-026f-4e32-b7dd-c44250badbeb",
"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": "247e5a3d-93c7-4155-b124-522b30abfe52",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "69221e77-9572-45e4-b91f-ecbadab6011e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0e02f52a-c46b-4aec-b9f3-1f86fcf96f18",
"account_manager_user_code": "sample string 56",
"company_status_id": "e973c316-0af9-44e3-ba65-5c8d1c49c1ee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-15T04:51:45.0615917+00:00",
"id2": 60
},
"db_language_id": "397ea1c6-582b-4535-8483-059074cb0ec1",
"db_language_code": "sample string 7",
"db_title_id": "920795d6-3f78-4c5c-ac17-79ddda1f4072",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-15T04:51:45.0615917+00:00",
"create_date": "2026-09-15T04:51:45.0615917+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-15T04:51:45.0615917+00:00"
},
"modified_dateutc": "2026-09-15T04:51:45.0615917+00:00",
"id2": 22
}