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": "0bd3a84f-c6d7-4520-89dd-9c6482d20e47",
"_parent_id": "cbbf1ac9-9af4-483d-8a8c-9903c9c56590",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "36393d4e-8955-4ccc-8958-039f8d30ed44",
"company_id": "c0d5d773-eb7d-40bc-b6fd-51df92984bf7",
"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": "1a413f7d-3ab2-45cf-b2be-e0fcc3c5f355",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1759ba0f-a797-4cc1-88b0-b8d38aed3182",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bc0edcaf-4f22-4d2a-9e64-fe7784b245cc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f5ba779e-1ecb-4943-a091-d5d48957f331",
"company_code": "sample string 5",
"company": {
"id": "b7fa6423-d110-44b3-983c-8498afc5f120",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-14T00:50:29.466931+00:00",
"sales_territory_id": "869ec04a-b2fb-4ca6-800b-2344c0bc6489",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "592fde45-b0b9-4741-96cc-1bfb667a8a19",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4de2f1fb-1695-462e-a097-b6afd4ba03f6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d24c1a5-971d-4d34-a941-8916d8f2d66f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "edead05d-2753-4705-ad2d-725cb3ed5196",
"db_currency_id": "049df0bd-082f-4e1c-8af6-07bff6c6a620",
"db_language_id": "69b09c63-0851-48b3-955e-4200b3ad98f8",
"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-03-14T00:50:29.466931+00:00"
},
"modified_dateutc": "2026-03-14T00:50:29.466931+00:00"
},
"marketing_segment_id": "22157f2f-f12e-4425-ba9b-fbeaf68edd05",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "26176b2f-0d69-484d-867a-12954341905e",
"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": "1b348170-537c-4cad-8083-609ae78c5252",
"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": "4c79a908-3334-400c-bd93-ae7a3584f517",
"db_country_code": "sample string 28",
"feelist_id": "ef3a27e8-5fb6-4069-b233-3705bdff8e35",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c00e1424-f78b-42f1-98dc-4b9c1a7ce6ef",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1d9caeb3-3afa-41a8-acbd-206afda293ec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-14T00:50:29.466931+00:00",
"db_currency_id": "69934b3c-975b-4275-816d-5831836eb3ac",
"db_currency_code": "sample string 10"
},
"company_type_id": "368b28a9-988f-46c9-a31c-b56ced6047d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "df2e173e-51c3-42d0-9a9c-355a1c036b15",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7daf14ba-0251-4025-9234-0017c9e28120",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3574b9ad-8390-43b3-88a2-ed16fb364015",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "150b433d-2d76-4c8e-b13e-dfda4301eff7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f0a1f3d5-96e4-4e3f-9f7c-0fb65f5f8f14",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad51ad7d-9c35-4dd2-8fba-ad37027e42df",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-14T00:50:29.466931+00:00"
},
"company_sector_id": "6ea2edbb-0e88-4550-bc66-cf6914676d3a",
"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": "ab7251d1-3fb7-4af4-9304-77ff098b1063",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2d7522d2-e8a3-46af-9512-c9239f20112b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "924bc4ea-0b6a-46d4-9d93-e0f402faf223",
"account_manager_user_code": "sample string 56",
"company_status_id": "a355b8e9-a706-440b-bca2-e71a56d077d9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-14T00:50:29.466931+00:00",
"id2": 60
},
"db_language_id": "53a3c420-d0b0-45c4-9f35-943893fd4fdf",
"db_language_code": "sample string 7",
"db_title_id": "568ede91-5eff-4da2-b3d5-430f9ea97fa8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-14T00:50:29.466931+00:00",
"create_date": "2026-03-14T00:50:29.466931+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-03-14T00:50:29.466931+00:00"
},
"modified_dateutc": "2026-03-14T00:50:29.466931+00:00",
"id2": 22
}