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": "bcd765a5-8918-45ea-903a-b2027edd684c",
"_parent_id": "d4afbd74-7b50-47fa-8939-2a438c4a6294",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d1b965cd-1e06-4042-8f48-18cb0f589761",
"company_id": "24dd57bf-7df7-411e-bc21-9f587609d965",
"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": "7576e935-2513-462a-ac08-7ff5ddec18b5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2cb11c8a-5b39-4094-801f-46d9fc554526",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4ac80675-b3ec-4efc-b0d6-8c73a6ef9e7d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "227ab60d-9a78-4bd9-9b32-7b4d0ea7e295",
"company_code": "sample string 5",
"company": {
"id": "28ae72e6-1b1c-465c-85a4-aee2ab775c8f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-16T21:19:41.0211385+00:00",
"sales_territory_id": "5b3f1bef-24de-4c8a-91c7-a615b99e939f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f31ffd04-4f90-49c9-8777-4e679bcdbf0c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "505dc7c6-9c07-43f9-b919-5a3521996459",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2653327-41e3-4109-ab37-3c3b731a1f42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d2678e6-28bb-49f2-916e-3749f3d8933d",
"db_currency_id": "0b2a636f-16ac-426d-826f-71fdf1726daa",
"db_language_id": "f5bec0f9-b3d8-442d-beda-5386084bbc35",
"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-07-16T21:19:41.0211385+00:00"
},
"modified_dateutc": "2026-07-16T21:19:41.0211385+00:00"
},
"marketing_segment_id": "27849ec7-edd2-47f7-be2a-a4e7920fa73e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e141d219-6204-4be0-b2e4-2cb495985939",
"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": "36b55230-63ea-4a9d-88bb-27f3c4203a6d",
"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": "8a822a23-affa-4397-82a1-bd49976262da",
"db_country_code": "sample string 28",
"feelist_id": "181c7d28-781c-4bfa-9715-45a04a8ed6ce",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5088433e-b569-4485-9323-3618ef48971b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e01f02a5-fd9b-42d8-a4f1-3320432ee3cc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-16T21:19:41.0211385+00:00",
"db_currency_id": "c1438cdb-e77e-42f1-8a13-30fab9e06ab4",
"db_currency_code": "sample string 10"
},
"company_type_id": "b0b3b251-950e-4c64-b649-7572d31a7db8",
"company_type_name": "sample string 32",
"company_type": {
"id": "9bdfb1dc-c6b5-4bc8-bf51-9dfe8a64cb6a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9ff2f3d1-3dce-487b-8569-a6e8eeb7a47f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ef55b30c-3aff-4d2e-8530-4275af28018e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "53d4ab12-e949-40f3-b61c-85ab28945ff4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e90a09f-64a9-4dda-8571-15abe071b47c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "87467afe-4d7c-4413-8e22-3f66edeb7c16",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-16T21:19:41.0211385+00:00"
},
"company_sector_id": "74ce0baa-1227-4f33-926c-1e01b43a5414",
"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": "71e376f4-301f-4c3a-8db8-11d509a35f31",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bad644e6-80c2-4476-8f5e-29bf743be1fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "63107ebe-58ac-4d3c-b6b3-e116e7899646",
"account_manager_user_code": "sample string 56",
"company_status_id": "e2acd112-d894-4798-9ad7-856cc1f07150",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-16T21:19:41.0211385+00:00",
"id2": 60
},
"db_language_id": "f16dc1b0-dfea-46e0-a5a7-272a7b748f5c",
"db_language_code": "sample string 7",
"db_title_id": "27389805-66e8-429b-a8c3-0ddd328d767b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-16T21:19:41.0211385+00:00",
"create_date": "2026-07-16T21:19:41.0211385+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-07-16T21:19:41.0211385+00:00"
},
"modified_dateutc": "2026-07-16T21:19:41.0211385+00:00",
"id2": 22
}