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": "04cd339a-c0ca-4f84-9e6a-7b0f40655b2e",
"_parent_id": "2530be8f-141d-4a13-a7d8-5a0a1169310f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "45cc5dc8-74c6-4aec-883a-6d542ddb7aa7",
"company_id": "df81702d-bbae-4f74-b608-415ca590aba4",
"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": "095e8add-4df1-41a6-96b5-ae9b1b2e9337",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "53a33b60-3d9a-467a-9b19-ac12855a7fc2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "12bdc016-7835-4e6a-873a-8de9f3033b0d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "26847193-72e5-437b-b633-8a6f7f7e79a9",
"company_code": "sample string 5",
"company": {
"id": "3214001e-7cbc-4345-a619-c69b2dd4ac0c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-28T06:44:09.9044261+00:00",
"sales_territory_id": "cf976811-765b-4037-92c9-1123486986b7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4daee94c-ef5c-4c06-92b1-f1152a2ca855",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "608b1ec3-24f7-43a3-affa-6a61fd1c33b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b9e128ac-1b98-4837-8d19-f445c49e35b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "152fd765-cb0b-455d-a88f-bfb1ac739ba8",
"db_currency_id": "3c3b9575-fb65-491f-975e-f823ddc3efde",
"db_language_id": "66e7c2eb-d8ba-4112-8d44-e83aef09bfee",
"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-28T06:44:09.9044261+00:00"
},
"modified_dateutc": "2026-07-28T06:44:09.9044261+00:00"
},
"marketing_segment_id": "0d811510-4257-404a-b968-e57b40994a95",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "727b0113-3336-401e-8853-2ab356e5d47f",
"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": "0080ccab-0a3f-4e8a-9a5f-613da8102273",
"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": "6990078c-cc50-4717-a653-c3135bc154a5",
"db_country_code": "sample string 28",
"feelist_id": "e99daa29-8611-46cc-a465-ad903547d1d1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ce6a27d6-6bcd-45ca-915b-f1785fcf3882",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4f564d5b-fcf6-44a9-ad8b-4a7884a28f35",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-28T06:44:09.9044261+00:00",
"db_currency_id": "ef07b9d1-d048-4968-a275-b6ead9f3cd13",
"db_currency_code": "sample string 10"
},
"company_type_id": "9ed837eb-3640-4975-8cf8-d83ca0495365",
"company_type_name": "sample string 32",
"company_type": {
"id": "c6874445-4fec-4b9c-847a-e32fcfbfbf3d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7875771f-bfb7-4d00-aa68-dc8be868b8c6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cc76d60d-850b-499a-9916-fb43501c5966",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5d28cce3-ee5c-4478-bf96-bf30a93c4f35",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f6dce425-0745-4184-8ef6-e31c2c2b2548",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "43acda6d-5944-4c2f-9aeb-32abc813e10a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-28T06:44:09.9044261+00:00"
},
"company_sector_id": "105b1957-5488-44bb-b6f1-7adb566bba9a",
"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": "f24b249b-6996-4be6-a6f9-96948d12a421",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a61d5f1e-b20a-4299-b661-4ae8d62c1eae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86ab745f-6b07-4ae1-9942-2dcf967e13a7",
"account_manager_user_code": "sample string 56",
"company_status_id": "eb30b5aa-2360-4349-9155-bec391677367",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-28T06:44:09.9044261+00:00",
"id2": 60
},
"db_language_id": "52a22322-bfcd-4b85-a699-50ece66fd5a6",
"db_language_code": "sample string 7",
"db_title_id": "08dfea6c-4556-49ae-bf0c-5f3d5ebc17ec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-28T06:44:09.9200513+00:00",
"create_date": "2026-07-28T06:44:09.9200513+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-28T06:44:09.9200513+00:00"
},
"modified_dateutc": "2026-07-28T06:44:09.9200513+00:00",
"id2": 22
}