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": "105bdee2-a655-405d-bda3-15e0530ec1e7",
"_parent_id": "e7a248e2-6dc8-400e-8eea-6acf5e1c0a6b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c2d2d86c-0953-4890-b40c-2df872f927b2",
"company_id": "151b195b-5c31-4972-b559-3f0b171e6b79",
"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": "f873dbcb-19d9-462b-bb80-1483e972460e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ba6edc90-dd4f-42e0-80c0-e47639184ae6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0f616450-7813-4c30-8c6a-924f91142b99",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a7e66d30-52db-4774-bcef-2517a5ebcf4a",
"company_code": "sample string 5",
"company": {
"id": "71f27b82-c1ef-4bb2-a841-a8c3d7383147",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T00:04:10.9180094+00:00",
"sales_territory_id": "699c2822-6ed5-4c2f-9015-686cb8ad1cef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "67006486-4d24-4e2f-9673-e06605476fec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3042441e-fcbf-4fba-acc8-cc2f80361ae1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e0bdbb7b-1054-44e8-878a-6851cc175184",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19b9f39f-282e-46f9-acbb-726e9443edee",
"db_currency_id": "df1d033b-6a4a-482a-8590-4cd1279f54d0",
"db_language_id": "b9ed98ef-2596-42a8-863d-b33fc1f155e2",
"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-14T00:04:10.9180094+00:00"
},
"modified_dateutc": "2026-06-14T00:04:10.9180094+00:00"
},
"marketing_segment_id": "2f23fa75-3d5e-470c-a45c-05f9a808e369",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "894dede9-3226-4526-940f-ee3b2444ab63",
"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": "1b341ce1-feae-4a67-8096-cc6632a8b861",
"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": "42c5b91f-99c1-4984-9305-313b45ee9b90",
"db_country_code": "sample string 28",
"feelist_id": "f2de5528-6d30-44e2-ad67-2810ede1dd7d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d81e3bc0-6019-4847-a496-ed233203f8e3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "98213207-f064-4729-98bf-8cd13c558318",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T00:04:10.9180094+00:00",
"db_currency_id": "2247372c-f415-4403-befa-a093c294e61b",
"db_currency_code": "sample string 10"
},
"company_type_id": "f218bd37-8f31-468a-9f72-29b4ec17fdcd",
"company_type_name": "sample string 32",
"company_type": {
"id": "3d293baa-134b-4049-bf59-18b96444476d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a06cbbd2-8883-435b-9ab8-5ff9236bf42c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0291227a-babe-4e11-91ad-fb6f2f600a39",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "25a86586-cd2b-4b24-843a-0f35deefd6b6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "26065587-5ed7-4f25-a65a-068f69ffba53",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c57b1106-9b42-488f-b21b-0e561a6053aa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T00:04:10.9180094+00:00"
},
"company_sector_id": "ab50d2f6-04e1-458a-8bb3-53fd17a679ef",
"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": "ac70232d-8ef0-4904-b47f-4e0e424fcc60",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f290a58e-8cb3-4e9d-b247-21ea4ba42a70",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e674bc45-b254-45b5-994f-50993b497985",
"account_manager_user_code": "sample string 56",
"company_status_id": "7cf434b3-f12e-4ea8-8e16-f71260fd4549",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T00:04:10.9180094+00:00",
"id2": 60
},
"db_language_id": "66708ac5-9c13-4225-80fb-e8910a48702a",
"db_language_code": "sample string 7",
"db_title_id": "193cec36-bdaa-4b8c-96dc-8e1e6b02578e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T00:04:10.9180094+00:00",
"create_date": "2026-06-14T00:04:10.9180094+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-14T00:04:10.9180094+00:00"
},
"modified_dateutc": "2026-06-14T00:04:10.9180094+00:00",
"id2": 22
}