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": "f260ff16-2ae7-4d60-9290-0ef71a872bf0",
"_parent_id": "22166f19-5960-4a3f-bff6-73c019bfcf5e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "18b5eaff-63d4-42cd-a2ca-4eff63635fc7",
"company_id": "d0e6c0ed-3a1a-469b-962f-935fdaa0d82e",
"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": "41ed0721-88c9-472f-a221-3b44a5996864",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d340fb20-5423-4359-9029-a39d920ce757",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f71749ff-867b-4539-8fe7-50bc8941b4d6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8d8ff4a6-9f05-403e-9dba-cabb306fdfda",
"company_code": "sample string 5",
"company": {
"id": "29ddb112-71d9-4c0f-8068-1a5dd07b8474",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-17T03:45:22.7290204+00:00",
"sales_territory_id": "2d62073c-1c04-4749-a2cb-3b0c373baaf4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "480444db-5d7c-4fb6-9cbe-7a697afe9832",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c6957ee3-34c3-4dbe-9822-f6326c72d4ed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ae4fd21-e4c4-48fe-ba3f-e30ca40648ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3465cd0-c990-492c-b733-f071ade22480",
"db_currency_id": "2875d8fa-2df2-4ea0-af19-fccc57814025",
"db_language_id": "9a3c0a77-08f7-4d5e-a682-32a82c9c2768",
"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-04-17T03:45:22.7290204+00:00"
},
"modified_dateutc": "2026-04-17T03:45:22.7290204+00:00"
},
"marketing_segment_id": "d8bc9cb8-99d3-4b88-9d83-582596b2210b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "592c278c-045e-4a23-b786-24176b176343",
"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": "63c129f1-f2af-455b-a785-6e61db344477",
"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": "5143de00-1163-4eea-b58f-c8a9794fa619",
"db_country_code": "sample string 28",
"feelist_id": "c35e7799-227c-4f57-a4d7-49dd10f47752",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "324e311b-5b7d-4dd7-a7b6-65fcb699421f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e72af983-f370-40ce-9ecb-1116c7939b85",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-17T03:45:22.7290204+00:00",
"db_currency_id": "d2ba917f-e271-48e6-b91e-9e4b74499870",
"db_currency_code": "sample string 10"
},
"company_type_id": "190f1567-fcf1-4ae1-9c58-00eeb352f600",
"company_type_name": "sample string 32",
"company_type": {
"id": "94306869-2e4b-4af4-92fa-a030045a121f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7e6c5ce-16c4-4775-b2f6-08e9fc1b5338",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ed90df45-5af5-4b87-81e4-aaca9296b1c1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5386d35e-7b02-489e-8419-ab5021586b44",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7a51c6db-7e49-4271-a7aa-3b99a175a046",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ef2852a-ad72-4cc7-8e36-afeb173331f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-17T03:45:22.7290204+00:00"
},
"company_sector_id": "7a57daa5-e1d9-4841-b0d6-d5b83a0da5bf",
"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": "eaaf98ca-a873-4d76-a84e-c67167de0664",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "536cff71-0f61-482d-a7b0-8a99bed4194b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "617e267c-32ed-4fad-a522-bc1736be6471",
"account_manager_user_code": "sample string 56",
"company_status_id": "6b183884-d92c-4fac-80c7-8cb1d529cd78",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-17T03:45:22.7290204+00:00",
"id2": 60
},
"db_language_id": "61859f2d-38d3-41e6-ad24-97ac949618a2",
"db_language_code": "sample string 7",
"db_title_id": "b4b77a5e-7260-4ac9-8e80-e4261f0fa647",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-17T03:45:22.7290204+00:00",
"create_date": "2026-04-17T03:45:22.7290204+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-04-17T03:45:22.7290204+00:00"
},
"modified_dateutc": "2026-04-17T03:45:22.7290204+00:00",
"id2": 22
}