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": "a2705d09-5d1e-4e45-b173-478bc55992ff",
"_parent_id": "bb9b8f96-f26d-403c-a032-2b42cda81a10",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9e21f0ec-0266-4588-8431-e2a2ad49e356",
"company_id": "0aca924c-d911-407e-8ef6-f4260f302446",
"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": "3b4717fa-025d-449f-8cf4-fa14dcfa5535",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "368a8d4c-90c0-4777-82f1-70a74ca36f1f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e68afef4-6d76-4e09-91af-e8f8f20fbe95",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "812e4e11-7ded-4e6f-80a7-00a29b1af965",
"company_code": "sample string 5",
"company": {
"id": "fad5b3e3-93f9-4ca0-a80b-ec08c49c51be",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-31T16:25:46.9964731+00:00",
"sales_territory_id": "c30abf67-afda-4805-8678-11831a1022d3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "909e5550-8f56-49e7-8428-fa15a5d62519",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aa6e51bc-b852-4e1c-ab01-a3f2c8eb62fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bbeb230b-ce75-42c3-bc55-228082760ca1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a5ad069-5a7b-4a55-95d7-eb127bb39024",
"db_currency_id": "db63a311-1a27-4dfa-89e4-fe5b20f3c401",
"db_language_id": "2f89bc67-4ce7-4aaa-b5a0-7b2004ffa1c8",
"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": "2025-08-31T16:25:46.9964731+00:00"
},
"modified_dateutc": "2025-08-31T16:25:46.9964731+00:00"
},
"marketing_segment_id": "0cb718c4-f16b-4b8a-ada3-7fd32757531f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "39f3ab50-00f1-438f-8b33-e347fb5eb7f6",
"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": "edb280a7-a448-4091-9564-a874b61a8252",
"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": "7a8a7f1a-5700-4a57-bfb9-5013c9eb5d46",
"db_country_code": "sample string 28",
"feelist_id": "2ff3f754-eec2-4c38-875e-143b770abf9e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "64238d74-4316-4445-9698-4189fb05ff38",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0e4874cc-21f5-442c-9d65-ee0ac657d60f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-31T16:25:46.9964731+00:00",
"db_currency_id": "41961c5f-0dbc-4c9f-92fc-5c88aca04ad2",
"db_currency_code": "sample string 10"
},
"company_type_id": "2c00d32b-99cc-4194-9d12-dc0c351b981b",
"company_type_name": "sample string 32",
"company_type": {
"id": "12ca9bfe-f8ea-4519-82d4-f8e846a342d7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d69d67b5-5067-4e9c-b402-84e23b2482ba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "89b4372d-9276-49d9-964a-8cef829c2a12",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c576d978-af5b-4fa1-8d01-d47314dcb7db",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "98030cae-3218-4a25-ac52-83839516a1ef",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "725a6f3a-2b5b-421c-9266-0dc1ed0137b6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-31T16:25:46.9964731+00:00"
},
"company_sector_id": "0520f581-a5b9-48d4-afb1-2a23cb922bbf",
"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": "c0b717d2-8b50-46af-9cdc-78a01761cfc9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "278f2084-13e7-4b4f-bd03-b70e49a6739d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "67b09918-dce0-4cc1-ba1b-834f1df7654a",
"account_manager_user_code": "sample string 56",
"company_status_id": "252ba093-7330-48ce-884a-d3bec3e602ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-31T16:25:46.9964731+00:00",
"id2": 60
},
"db_language_id": "0cb45a9e-02e9-400e-a662-67759fe812de",
"db_language_code": "sample string 7",
"db_title_id": "e1a306ba-1160-4267-a674-516baa51b609",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-31T16:25:46.9964731+00:00",
"create_date": "2025-08-31T16:25:46.9964731+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": "2025-08-31T16:25:46.9964731+00:00"
},
"modified_dateutc": "2025-08-31T16:25:46.9964731+00:00",
"id2": 22
}