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": "ac7a9db3-fb65-4ae1-9311-cbca1c2bb105",
"_parent_id": "f3550357-d448-47b9-a43b-04d72c923a27",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6e9e985e-898d-496e-b754-9a33e5256c88",
"company_id": "58e7c906-3901-427b-b4d5-2a2268d7fb47",
"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": "15aa3abf-05c2-4a9d-af25-4d868e25137c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "66e879e0-088c-4dc6-819f-19aa65757fa1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "dfc345c5-1416-4ae9-9a6e-767f3c042cf0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2d89f7ab-e0f3-459e-9f76-8dd4c551919a",
"company_code": "sample string 5",
"company": {
"id": "4439c725-db94-43d3-837c-9e25b907f293",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-17T22:12:07.1574028+00:00",
"sales_territory_id": "1ba6f701-aa60-4606-b507-91f6b3c2c4f6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "da8b9095-f5db-4e13-b73d-cbf3e5326b91",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5921da33-ea76-4acd-88c2-5a4af4304417",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8de39fba-17fe-4d1b-8a14-4c5b423583c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cded15dc-05a0-4f67-a75d-b598fd411400",
"db_currency_id": "dc738287-bf8b-4224-8789-5633387ee642",
"db_language_id": "2daebcc8-951c-49a2-860d-22a10c7039c2",
"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-12-17T22:12:07.1574028+00:00"
},
"modified_dateutc": "2025-12-17T22:12:07.1574028+00:00"
},
"marketing_segment_id": "3be75530-b7ef-4863-a8c3-c56bbfe796f6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2888fe2b-be40-425a-9155-c81ba085b665",
"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": "02c47146-15fd-45c9-90b1-b222f5be5df0",
"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": "dd808a34-d7f1-4514-b239-a410dcf6bfac",
"db_country_code": "sample string 28",
"feelist_id": "3b838ca3-c4c9-48b5-9fbf-84a1f518bafb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "106554d6-06ef-43fc-9e35-b7e2f3bba908",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54c27711-8b62-434f-bd22-f3814aa47186",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-17T22:12:07.1574028+00:00",
"db_currency_id": "05d1d1d3-f4c8-4bd3-9b56-1bb83a701810",
"db_currency_code": "sample string 10"
},
"company_type_id": "a4ac059d-befa-4883-aff8-1eaba49de1ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "3b2343b0-5790-4606-879d-6c49d78d4dfb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de776c08-3ba5-4108-9782-1c6e1a5be333",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e8005af5-b1f7-4cc5-a160-d16a1a295f6b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bcf7c41f-c992-41b8-afad-d813176938f6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6d510361-4092-455d-9203-6a45dc79947b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7ef6a4a8-441b-4682-984d-6ce6f14f8002",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-17T22:12:07.1574028+00:00"
},
"company_sector_id": "2899385d-c21c-44b1-976b-2e978032323e",
"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": "91abe708-3f71-4984-9a6e-201689da8d07",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3c979192-b5c9-4819-822f-3b18658de8e6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "42125226-75a8-46f4-baec-9c860f51be98",
"account_manager_user_code": "sample string 56",
"company_status_id": "8e7c2d30-0681-4bac-9ba7-0defc257517f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-17T22:12:07.1574028+00:00",
"id2": 60
},
"db_language_id": "b544b98f-231f-4dff-a453-05298625f6bb",
"db_language_code": "sample string 7",
"db_title_id": "bff0e6a5-6adf-4d72-bbcd-84c5c10ded08",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-17T22:12:07.1574028+00:00",
"create_date": "2025-12-17T22:12:07.1574028+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-12-17T22:12:07.1574028+00:00"
},
"modified_dateutc": "2025-12-17T22:12:07.1574028+00:00",
"id2": 22
}