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": "1249ddc7-abe7-4458-9e20-691520fbc382",
"_parent_id": "b8807ef7-734e-49c9-b1a1-f8816827538e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "daf29ceb-0470-4d3b-953d-05436030a487",
"company_id": "fa480a14-22ce-4064-855b-ccc51cb595b2",
"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": "2c1178be-223e-4b14-9bf8-2d3110ad8cb8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "60ec9e04-2f86-4a14-b3a5-32076316e835",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c80cddaa-e0a8-44cd-85bc-63ed663d7266",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8aebae4f-d7c0-470e-bae4-67c963a6e8e3",
"company_code": "sample string 5",
"company": {
"id": "11364217-4d8a-4552-8580-55721060c65c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-10T23:56:54.9810184+00:00",
"sales_territory_id": "157d6992-5ab8-4a55-860c-c6405f485b42",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2eb73b54-5235-4dca-a326-00e3a7ce125d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4198e22c-dc39-4f98-a7d4-57ed7f21e0f3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fca06b3-c5ce-492f-b4f1-d5ad0988c1cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90958c8b-8722-46a7-bd89-682e458c49a9",
"db_currency_id": "6e53fc09-9f70-4b26-815d-845f9d08e06c",
"db_language_id": "45cad318-448a-4d6c-9b93-581691f48a32",
"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-06-10T23:56:54.9810184+00:00"
},
"modified_dateutc": "2026-06-10T23:56:54.9810184+00:00"
},
"marketing_segment_id": "f8662210-bf1f-4329-947a-401d752f6a70",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f89978dd-2f19-4eea-bcdd-7c42af4e9819",
"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": "51d57827-0238-41bd-b755-0726fef85d06",
"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": "c9c5e773-5359-480a-b4ad-b791e84633a5",
"db_country_code": "sample string 28",
"feelist_id": "c81a84cd-141a-4882-acdf-9dec515a7bf7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4b03258c-3e0c-494d-b521-56e5584472f8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2c19017c-39b0-4877-b203-812b5a60a463",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-10T23:56:54.9810184+00:00",
"db_currency_id": "3ccb9d31-7083-47a3-b9a0-9bf3eb229ba7",
"db_currency_code": "sample string 10"
},
"company_type_id": "b266b884-7f74-42ab-ad7c-ce1c6965f77b",
"company_type_name": "sample string 32",
"company_type": {
"id": "4cc48b4d-abaf-4e55-9bed-1bdb6c7a0cb5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c97dcc09-95b7-445f-8b70-9edfca257133",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a0e3f22a-46fe-490b-8ac2-a809bcf39c28",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bbf02fa8-0021-40d8-a4f5-2025c359ca0b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a698a11a-7ec1-4e11-b321-c8adbd716835",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cefdebb7-408f-495d-bbca-92663884006c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-10T23:56:54.9810184+00:00"
},
"company_sector_id": "755d5068-1990-49a9-bb63-00b6cb1bb3a0",
"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": "a84db59d-cdd4-462e-bee2-bb81437a8ec6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5d58f547-44b9-493d-8fbd-cd41f96d7cdf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "62729695-9937-4f88-adc3-f8e8507595ee",
"account_manager_user_code": "sample string 56",
"company_status_id": "d6efee26-4305-418e-88f5-4a4ecd4443ae",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-10T23:56:54.9810184+00:00",
"id2": 60
},
"db_language_id": "44149032-6911-40c4-9073-c3bdf2d40192",
"db_language_code": "sample string 7",
"db_title_id": "5c58e754-6bf4-4210-b829-9e7dfc2063c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-10T23:56:54.9810184+00:00",
"create_date": "2026-06-10T23:56:54.9810184+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-06-10T23:56:54.9810184+00:00"
},
"modified_dateutc": "2026-06-10T23:56:54.9810184+00:00",
"id2": 22
}