/* * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals. * Lean Algorithmic Trading Engine v2.0. Copyright 2023 QuantConnect Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ using System; using System.Linq; using Python.Runtime; using Newtonsoft.Json; using System.Collections.Generic; using QuantConnect.Data.UniverseSelection; namespace QuantConnect.Data.Fundamental { /// /// An amount representing an agreement for an unconditional promise by the maker to pay the entity (holder) a definite sum of money at a future date(s) within one year of the balance sheet date or the normal operating cycle. Such amount may include accrued interest receivable in accordance with the terms of the note. The note also may contain provisions including a discount or premium, payable on demand, secured, or unsecured, interest bearing or non-interest bearing, among myriad other features and characteristics. This item is typically available for bank industry. /// public class GrossNotesReceivableBalanceSheet : MultiPeriodField { /// /// The default period /// protected override string DefaultPeriod => "TwelveMonths"; /// /// Gets/sets the ThreeMonths period value for the field /// [JsonProperty("3M")] public double ThreeMonths => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_GrossNotesReceivable_ThreeMonths); /// /// Gets/sets the TwelveMonths period value for the field /// [JsonProperty("12M")] public double TwelveMonths => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_GrossNotesReceivable_TwelveMonths); /// /// Returns true if the field contains a value for the default period /// public override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(double), FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_GrossNotesReceivable_TwelveMonths)); /// /// Returns the default value for the field /// public override double Value { get { var defaultValue = FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_BalanceSheet_GrossNotesReceivable_TwelveMonths); if (!BaseFundamentalDataProvider.IsNone(typeof(double), defaultValue)) { return defaultValue; } return base.Value; } } /// /// Gets a dictionary of period names and values for the field /// /// The dictionary of period names and values public override IReadOnlyDictionary GetPeriodValues() { var result = new Dictionary(); foreach (var kvp in new[] { new Tuple("3M",ThreeMonths), new Tuple("12M",TwelveMonths) }) { if(!BaseFundamentalDataProvider.IsNone(typeof(double), kvp.Item2)) { result[kvp.Item1] = kvp.Item2; } } return result; } /// /// Gets the value of the field for the requested period /// /// The requested period /// The value for the period public override double GetPeriodValue(string period) => FundamentalService.Get(TimeProvider.GetUtcNow(), SecurityIdentifier, Enum.Parse($"FinancialStatements_BalanceSheet_GrossNotesReceivable_{ConvertPeriod(period)}")); /// /// Creates a new empty instance /// public GrossNotesReceivableBalanceSheet() { } /// /// Creates a new instance for the given time and security /// public GrossNotesReceivableBalanceSheet(ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) : base(timeProvider, securityIdentifier) { } } }