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": "30431d3e-425c-4b30-8320-e1424aa5443e",
"_parent_id": "8ee2f942-bf5b-4fe0-9859-fe7f7f62491f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "435184a7-4ae3-47e3-9a1a-9aa744702206",
"company_id": "655ed89d-8476-4dfe-9478-9f01752837af",
"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": "0d84b374-a7b8-48ac-8dc6-5c7e6404828c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c3be58b1-cfa7-4475-88fd-3f648bb573ac",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "12063b5f-085b-4690-970b-436a52fa8ebb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86d50eab-0647-4761-8a03-8bbf628e9651",
"company_code": "sample string 5",
"company": {
"id": "6307ec6f-346b-4cbe-8de0-4fc82e21a080",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-27T08:31:38.1337632+00:00",
"sales_territory_id": "af021ec4-454e-4043-bd91-52b5b5b4286c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0481a74c-6716-4f30-9442-9ba9ab3c93df",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df3dc30e-7ac3-4659-8bdb-8470d23e67c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "80e13cf3-39f5-45d7-8d79-3fb29d7f4a39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "635a874b-c46f-4d6b-b855-107f07cc464d",
"db_currency_id": "d26dbede-aec9-4cca-85d8-ef77026ac886",
"db_language_id": "e7968cdc-330b-4ac5-9c02-bbb947e6af52",
"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-06-27T08:31:38.1337632+00:00"
},
"modified_dateutc": "2026-06-27T08:31:38.1337632+00:00"
},
"marketing_segment_id": "db4c9b9f-bd3e-47fa-ae9a-20e248c6fff2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db66298a-0f24-4767-a9d5-7cfdcf967d7f",
"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": "8289b9a4-12e9-4e47-882c-80fb577f2896",
"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": "048391d0-a926-4eb8-89e3-6fdb561bc445",
"db_country_code": "sample string 28",
"feelist_id": "d925684b-d138-450d-9419-013619f7ae69",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1865f0c4-e4fc-4216-8895-0cce05fbcbde",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0858126e-0024-4de5-b721-098e6bb5f1a9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-27T08:31:38.1337632+00:00",
"db_currency_id": "f7d9cd3f-a984-4e96-a010-2129a51ebf11",
"db_currency_code": "sample string 10"
},
"company_type_id": "690aa439-0750-4af1-9960-d8b818a7a868",
"company_type_name": "sample string 32",
"company_type": {
"id": "d488188b-3d90-40a2-acb7-9756625a9c54",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "99ca014f-55fc-422c-ba21-706e695af636",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c590f416-217d-4512-a408-344e42a8548b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "50b51f36-2142-4e73-820c-31fab5534c17",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "36c1d62c-b9d6-41ab-a2be-5cecd3062871",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "aafa2057-620e-45ab-9b0c-c1ed8e16d0f0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-27T08:31:38.1337632+00:00"
},
"company_sector_id": "06adeba1-baff-4d76-855a-9424f0a6bffc",
"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": "df24f299-e169-49d8-90ba-f6a52e7ab062",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3fa18200-47d2-48c5-beaa-fe66d958b98d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e133611-4ec6-4687-ac95-7301dcb39439",
"account_manager_user_code": "sample string 56",
"company_status_id": "53e200a7-a969-4a63-a98c-c906ba3ab1fa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-27T08:31:38.1337632+00:00",
"id2": 60
},
"db_language_id": "6cc1e288-5a17-4f18-8571-6e58658a799f",
"db_language_code": "sample string 7",
"db_title_id": "90abdf8e-1e44-44bc-a2cf-619508533fdc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-27T08:31:38.1337632+00:00",
"create_date": "2026-06-27T08:31:38.1337632+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-06-27T08:31:38.1337632+00:00"
},
"modified_dateutc": "2026-06-27T08:31:38.1337632+00:00",
"id2": 22
}