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
locationName | 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
{ "id": "3c63d706-aa37-475d-a75f-c4874e2f9e65", "_parent_id": "7115e6ce-ad6b-4bad-b325-a88e0e97827b", "_parent_reference_back_office": "sample string 3", "project_status_id": "c8b45cca-1a22-42a0-bb26-fb5c72a3cf90", "company_id": "32db207c-9bff-4e0a-b33b-70ffe57e8281", "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": "46d7bbb6-5ded-4e81-9e82-6c543d77ac2d", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "4490beb1-d3fe-4e26-8ca5-532cf7b6bee8", "contact_reference_back_office": "sample string 20", "contact": { "id": "f7007b8f-b2b8-44b2-b49b-7fa8594fdb25", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "a5175eaf-4b8c-462d-bce3-8acb92da7fdd", "company_code": "sample string 5", "company": { "id": "2ed0d848-10ef-4312-9b4f-1d7bb6fc27ac", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-19T00:15:27.495046+00:00", "sales_territory_id": "2f802f23-c196-45a2-ab41-8ff1bad86fc0", "sales_territory_code": "sample string 9", "sales_territory": { "id": "94bf3cb9-d8d4-4df0-85b5-32bb6a2d483e", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "5c609192-5f98-4454-9314-99eb42327943", "sales_organization_code": "sample string 5", "sales_organization": { "id": "2f9d02fa-f9f8-4b0b-a9da-479b7dadf516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da244e8b-60ad-4e55-8b7f-b8dc778dda56", "db_currency_id": "ccbcf4d0-0780-4dda-b677-0d1fd82c38ee", "db_language_id": "4b262971-c4b3-473d-9ff1-1752bc6e9e0e", "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-07-19T00:15:27.495046+00:00" }, "modified_dateutc": "2025-07-19T00:15:27.495046+00:00" }, "marketing_segment_id": "899f3157-2b1b-4905-a1cf-2b4ace01b875", "marketing_segment_code": "sample string 11", "sales_organization_id": "cf2a85da-e726-4668-be35-89da6b35cc9a", "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": "536c3d04-061e-4a39-a33b-a6619f30c058", "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": "cf03eddc-19d7-4928-af22-711817bdd475", "db_country_code": "sample string 28", "feelist_id": "1477fc34-5ce0-441b-b8a3-fb27fd42e385", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "1a17d08e-353f-4237-a00f-066a88b5b75a", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "a0897426-9e23-48b5-9dd0-d627b13161be", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-19T00:15:27.495046+00:00", "db_currency_id": "9c5b06c1-2066-4468-88b3-2f967f81b4b8", "db_currency_code": "sample string 10" }, "company_type_id": "04bd4f32-ee5a-4886-b5bc-215e3ad401ad", "company_type_name": "sample string 32", "company_type": { "id": "481e9aaf-e7cc-48e2-b286-cd7d461acdad", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "3ab53838-9f37-4aab-9a0d-bc889cd9c989", "sales_organization_code": "sample string 5" }, "db_language_id": "48ea8d7b-c68c-45e6-8b61-708b176faba0", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "15d477a3-6074-4917-90df-1fdb2dfdd0b6", "article_price_label_code": "sample string 37", "db_payment_method_id": "ffd1507b-9a8d-4602-9ce9-ace1321044b9", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "9a8dfa7e-75d3-4a0a-9d77-5dbf073837b4", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-19T00:15:27.495046+00:00" }, "company_sector_id": "79f1e0d4-d1ef-4dfe-9e7a-82869ce319dd", "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": "25c6908e-0472-4ceb-91d2-d66491393011", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "6443998f-3add-478b-ad6a-48de73e5a474", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "a7a24fce-955b-41ae-849e-bbeb78b07a89", "account_manager_user_code": "sample string 56", "company_status_id": "eb109c18-d1c3-4b59-9875-715a8f1183c7", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-19T00:15:27.495046+00:00", "id2": 60 }, "db_language_id": "cd96a992-c6db-4ba3-a2e7-9aecd546de2b", "db_language_code": "sample string 7", "db_title_id": "3b834d73-6b02-47f9-88fc-6e15c1039120", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-19T00:15:27.495046+00:00", "create_date": "2025-07-19T00:15:27.495046+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-07-19T00:15:27.495046+00:00" }, "modified_dateutc": "2025-07-19T00:15:27.5106695+00:00", "id2": 22 }