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": "64ab64b7-cf17-450a-8f32-0121f0e5df90",
"_parent_id": "58a759c2-c169-4f19-ae39-362aa9bd7570",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e1541438-b97e-4588-b1b7-f4a448d866fa",
"company_id": "8ae5f97d-da31-4d07-9dbe-c65335f04d2d",
"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": "e8e5c921-4ced-436e-9196-d94476a35ee9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "196ea4cf-7394-4928-a6a2-f2df17c48005",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7d6ac8d7-a5bd-4a2f-8e73-2fcc83d87ab0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "59a6bdbb-73ec-42f0-9560-cc23f789bf52",
"company_code": "sample string 5",
"company": {
"id": "3a0ef913-0a44-4419-a4b3-6041b481e5ab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T08:16:43.8981902+00:00",
"sales_territory_id": "de7bf195-d596-438a-ba15-09ddb7730aa3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4824a6a0-f8a7-4103-85a7-d2fa6394c70f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea9cf0a2-52e3-4dfc-a1fd-b0e91d5eb246",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a944823-9608-4b25-89dd-43d25c1df38f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce11134e-db7a-4b31-b10e-e9e96315deb9",
"db_currency_id": "ecd6b898-160a-4c1a-b087-1bbdaa91f152",
"db_language_id": "eee1f6d2-8b47-4970-90e6-ed8150172caa",
"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-05-15T08:16:43.8981902+00:00"
},
"modified_dateutc": "2026-05-15T08:16:43.8981902+00:00"
},
"marketing_segment_id": "327e1829-87dc-4289-a845-40695cf77952",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c2b9a1e6-7ab6-4fd5-b4d0-e716014763af",
"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": "658c1196-78f4-4ef2-b7cc-018099e1a0ea",
"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": "ec5511ed-bc18-4905-8bc7-45736a4dad69",
"db_country_code": "sample string 28",
"feelist_id": "40fb85c3-0dfb-47e2-948c-f80d5e0d9ce2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75f65419-a9ee-4f35-be29-408bc73a5ed4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fc431695-c84a-4898-a08d-f2c940239987",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T08:16:43.8981902+00:00",
"db_currency_id": "b39554b2-ff04-4915-9e4f-ad4b4bd22775",
"db_currency_code": "sample string 10"
},
"company_type_id": "0cea3493-d34f-4824-a0b4-43130902dd7a",
"company_type_name": "sample string 32",
"company_type": {
"id": "3cc5bac1-cc3f-4095-9a4b-5e553a95e3c1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4b64c35-d790-4b71-ba3c-992206abc0dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0301a328-ee31-474b-a7af-fbe28b8b2e28",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "39949db2-cc6e-40fc-85e2-04cbec719d6d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b4dfb407-2460-442d-a60e-4c3cd8021bdf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8a7f8ca-d5da-4e1d-9495-c31794900d33",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T08:16:43.8981902+00:00"
},
"company_sector_id": "4d60a2a2-b370-41d7-a9ea-0e134bd87eae",
"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": "53cdf9d6-ddff-4db6-920f-8c4f0d4bb597",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "640ed55d-d5dc-47f8-b463-e65109e95478",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a9892dd4-8573-4eb6-a916-27cc960c2023",
"account_manager_user_code": "sample string 56",
"company_status_id": "72b0377d-ec9c-4161-9645-0dda418592e7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T08:16:43.8981902+00:00",
"id2": 60
},
"db_language_id": "22b828da-a359-4e91-a2fa-cb0e60c19ad1",
"db_language_code": "sample string 7",
"db_title_id": "a1fa089a-1820-4a09-8803-d8b9cf88ecc6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T08:16:43.8981902+00:00",
"create_date": "2026-05-15T08:16:43.8981902+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-05-15T08:16:43.8981902+00:00"
},
"modified_dateutc": "2026-05-15T08:16:43.8981902+00:00",
"id2": 22
}