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": "37de00af-5d03-4088-97e5-81fec0d3dcb5",
"_parent_id": "719da704-4980-4c82-87db-635e43f2e140",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6c559b9b-5cea-487f-9c58-8715b4b7813c",
"company_id": "66caa157-0215-4950-9415-ac1f6da36553",
"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": "ec383f19-bd8e-4010-876a-010f93cb25e4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "54a679b6-f6f3-4c0f-ba69-1d2ff4ce937c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a00471c4-401a-49d6-b03d-5e2d7358bd29",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "01d35c2b-636f-496c-aaf3-3c763713fb7d",
"company_code": "sample string 5",
"company": {
"id": "66feee80-4015-42cb-bec6-28d8c7feaf8c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-13T12:22:20.7012451+00:00",
"sales_territory_id": "33c0e970-3c70-4c60-955d-ca9c42669cef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b5f9154f-7ec8-4b73-932b-64f482c7d030",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "92a1a60d-dbbb-4ebe-a07b-4c1ab1841b0f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5b931d51-3611-461e-af31-7724d22ef411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d125afa-9997-4de6-90ee-59fee5ce0306",
"db_currency_id": "d5c7777d-f8e0-49ef-9adc-262e4a2607be",
"db_language_id": "9c9e4b9a-e391-4a60-b010-f507e5ad7d91",
"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": "2025-12-13T12:22:20.7012451+00:00"
},
"modified_dateutc": "2025-12-13T12:22:20.7012451+00:00"
},
"marketing_segment_id": "468388c3-7ad9-4948-b2d1-21c3b8f49f9e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "be9f6cb0-bbe1-4c94-a614-063fb0c85864",
"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": "434fcb0a-193e-4cb2-9e04-3698cec9848c",
"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": "212e1296-08ef-4d56-8d18-57e4b9924fe2",
"db_country_code": "sample string 28",
"feelist_id": "d8cab085-057f-4db9-a753-75fd224fd998",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "509bb3a2-be68-4cb5-99d4-81dc36aa0c43",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d4cd6b4a-6b6c-414a-93c4-e1711f3c0de1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-13T12:22:20.7168684+00:00",
"db_currency_id": "a3269b2b-9513-4061-9622-d458efa78e14",
"db_currency_code": "sample string 10"
},
"company_type_id": "9e8a9cfd-eff7-4ebc-957a-221aa06ba185",
"company_type_name": "sample string 32",
"company_type": {
"id": "27df16be-1e9f-4e44-b8fb-152391660c93",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "52a4e2e0-8d11-4ac2-951c-77658ccd49bb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45978a64-5ae8-4307-a8db-490e5266298d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a29acd5b-430d-4d6e-9e51-e2ff745d0b31",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "73e008f3-5c7f-4201-a413-20a4c23f8e27",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3a4e55e0-2593-42e3-a279-112f4af9264b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-13T12:22:20.7168684+00:00"
},
"company_sector_id": "22caf34b-5c78-4d5b-b57a-5b424dfccee8",
"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": "df2987f7-bb3b-4b66-913c-7ee5315ca7c5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5109fa63-ac1e-42e8-acdf-7999caec10a8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "24f7ffac-93f9-4ba2-a50f-ea0cf589acf7",
"account_manager_user_code": "sample string 56",
"company_status_id": "883e2372-80ff-4191-8bd8-9cc36644c58c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-13T12:22:20.7168684+00:00",
"id2": 60
},
"db_language_id": "cf4948e1-c070-44fc-9f6f-3de78c1e45b4",
"db_language_code": "sample string 7",
"db_title_id": "56828ebc-fa5e-4cae-bd84-8beb9bf3881d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-13T12:22:20.7168684+00:00",
"create_date": "2025-12-13T12:22:20.7168684+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": "2025-12-13T12:22:20.7168684+00:00"
},
"modified_dateutc": "2025-12-13T12:22:20.7168684+00:00",
"id2": 22
}