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": "071ad534-95fc-45bf-b8c2-ae1a19b7824f",
"_parent_id": "48438264-4aa0-4fc8-9faa-a4e8fec56bf9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bfdc2894-2d87-471c-96a9-dcd2ace92aec",
"company_id": "d20336f8-11cd-4a5b-a37b-46fc546e28be",
"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": "a6b83ec7-0949-4cfa-bc10-9c619d32ff0a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "21b40aa7-6e83-4547-b909-46bdbc136467",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4f64c073-e7c8-4bd9-889f-f83b827b4dcb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "52a64ddb-f35b-4f65-a471-4fe4fa5841eb",
"company_code": "sample string 5",
"company": {
"id": "e5f073ed-6da8-4108-b406-fc5f870ce751",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-20T14:36:11.9573698+00:00",
"sales_territory_id": "46adea19-acde-4c7c-8825-ca55af44fb34",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "020bd936-08a9-4c70-bdde-0aa3df829866",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93ab1841-953b-46e4-893e-602e3ca804bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6701b7ed-0355-4891-8552-dbffa7fb26c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb871481-084a-4832-95d7-46f3e73a316b",
"db_currency_id": "f19a185e-bb38-45af-9521-a61e099949c9",
"db_language_id": "48d391f0-4e55-4919-bbcf-f5d4e699d09c",
"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-20T14:36:11.9573698+00:00"
},
"modified_dateutc": "2026-05-20T14:36:11.9573698+00:00"
},
"marketing_segment_id": "7644e88a-adc9-4ee8-b653-bf746dbf75d3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d609d74e-9266-4e53-8614-02ad64156a33",
"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": "2c26f4fd-9baf-4643-9596-a3f220aaa7ac",
"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": "0d812738-331b-402c-bf38-ec06cb45c476",
"db_country_code": "sample string 28",
"feelist_id": "96374e21-7ce4-42ec-afee-c45d9965b629",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2b91307f-44c2-4769-8561-86dcd62f8855",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1a4482c2-c67a-4f42-8b63-ba4c1af3f236",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-20T14:36:11.9573698+00:00",
"db_currency_id": "3fa9ba96-8473-4c49-b591-88ba784f9627",
"db_currency_code": "sample string 10"
},
"company_type_id": "a6254586-3cd0-4170-a4b7-4aee1d0a9644",
"company_type_name": "sample string 32",
"company_type": {
"id": "f03e19b1-a3e1-4112-afb7-dd7d073065ad",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4e96d647-4021-455c-bdf0-e92ab63cbe41",
"sales_organization_code": "sample string 5"
},
"db_language_id": "741cbf52-c7ad-4a4a-af3c-76be172f3bfa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f6c13732-8b06-4c65-a7e9-6c8340a2558a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "889d7261-4617-4965-ba22-9a051f7553d9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6c7664ff-ed29-4fac-be59-6b35a4343da0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-20T14:36:11.9573698+00:00"
},
"company_sector_id": "d18ea4e9-7bc0-4a8e-96fe-8173d8ab0288",
"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": "2a4eb976-6f50-4aab-b96d-2521c236d709",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "61619180-de8f-4be0-9f00-4e2d962d9d91",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d7ad0fd5-4809-4ac0-a35c-8eab06850be2",
"account_manager_user_code": "sample string 56",
"company_status_id": "e20e71da-0e03-45c7-9608-a13d2425c27b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-20T14:36:11.9573698+00:00",
"id2": 60
},
"db_language_id": "f0b10ceb-9244-4df4-94d9-2448b749abaa",
"db_language_code": "sample string 7",
"db_title_id": "b8973a38-3b4d-49b0-a299-db66e12b2c9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-20T14:36:11.9573698+00:00",
"create_date": "2026-05-20T14:36:11.9573698+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-20T14:36:11.9573698+00:00"
},
"modified_dateutc": "2026-05-20T14:36:11.9573698+00:00",
"id2": 22
}