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": "3ffe8a05-30b7-40fa-bfe0-eaec77eabf45",
"_parent_id": "3f0d8b46-0ba0-4e8e-9d73-c5f466a4a1e1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2b294921-cb10-4bb6-87a5-d8217bfb8f2d",
"company_id": "94a497a8-3480-4b99-9c49-e9e2784ec436",
"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": "55155e21-e58d-4ce2-88b7-f2d878b8bff2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9760ffa6-6508-46da-bbbc-6e2315426665",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "246d37f6-1006-4fc7-9a45-0837a534050a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0384df52-057e-46dd-bd3f-b66c5ca96caf",
"company_code": "sample string 5",
"company": {
"id": "ea7c901d-a65d-4ac3-a3d4-9bccea6aec13",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-25T05:35:57.7533665+00:00",
"sales_territory_id": "82082eb8-e600-4147-810c-9776b37572d8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "882c4d6d-863d-46f8-8fde-8b7d067242f5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e090ddf6-d3a9-4906-9150-3322e75b39cf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d90dbe4c-4f9f-45a5-8668-e9965e0acf17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "382cd76a-baf8-4c2a-9ea2-4c73a92d8eeb",
"db_currency_id": "39659de2-b893-4e09-82cc-12654b427d15",
"db_language_id": "bb33d2e5-cf00-4d8b-994f-99f432fb637e",
"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-25T05:35:57.7533665+00:00"
},
"modified_dateutc": "2026-04-25T05:35:57.7533665+00:00"
},
"marketing_segment_id": "056f3bf2-7f9a-4055-8074-10401f3b61b9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "70dd559a-ca7a-406d-8a71-18fece1c75c9",
"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": "f924593a-ec41-43cb-93a2-cde78d691e30",
"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": "9c60cb1c-66a0-49be-954a-ad43c1b4bbb1",
"db_country_code": "sample string 28",
"feelist_id": "f44fa23d-0a23-41a8-8c17-c4bfb950414b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8162becd-405a-42f0-8184-49b1ae47fbc5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "35112a0e-0673-4246-bf87-d42328040fd5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-25T05:35:57.7533665+00:00",
"db_currency_id": "01b234b3-d84e-4833-92d7-c1b619cce18d",
"db_currency_code": "sample string 10"
},
"company_type_id": "ac6650ca-8d04-4c37-93c4-2e2b1de86a1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "13cdf303-1bd1-41d9-8c94-251f83dd9fd0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f2b2910-093f-47f0-800a-ac61155ae9fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a1310c52-9455-4a53-9441-700fdb52fc2e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bd9aeb9e-efde-44b7-b55c-772aca355a8d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2024a004-5dff-439f-98ad-3fbc72424797",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2518a5d7-d242-4f52-b002-682e4a3317dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-25T05:35:57.7689924+00:00"
},
"company_sector_id": "93568c51-f505-4b17-99c8-113fe9027b63",
"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": "3c1fe82c-9dd7-49f5-9dce-5272d43e6076",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "38c5d80b-bfa3-4495-b31d-dfa403a5bf14",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6dd01a46-dc67-47c2-83a5-ed144bda8547",
"account_manager_user_code": "sample string 56",
"company_status_id": "90925efa-7775-4826-9934-5df5e13d68a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-25T05:35:57.7689924+00:00",
"id2": 60
},
"db_language_id": "38701717-7604-43ed-81e0-3c771a12c6d5",
"db_language_code": "sample string 7",
"db_title_id": "97fc7156-c079-4fab-a9f1-bd53969cf3ca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-25T05:35:57.7689924+00:00",
"create_date": "2026-04-25T05:35:57.7689924+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-25T05:35:57.7689924+00:00"
},
"modified_dateutc": "2026-04-25T05:35:57.7689924+00:00",
"id2": 22
}