Class BalanceAnalysis
- Namespace
- PHCBusinessLayer
- Assembly
- PHCBusinessLayer.dll
Class that represents the analysis configuration
public class BalanceAnalysis- Inheritance
-
BalanceAnalysis
Properties
calculationCadence
Sets the cadence for the calculations. Can be monthly, biannual or custom. See CalculationCadence
public CalculationCadence calculationCadence { get; set; }Property Value
Examples
If monthly, the query will return N months with X values starting from the reference date
calculationType
Property that defines the calculation type of the analysis. Can be by issue date, due date or specific date. Basically, the query will look for the movements by the chosen calculation type
public CalculationType calculationType { get; set; }Property Value
customCadenceList
List of custom cadences that are created by the user. See CustomCadence
public List<CustomCadence> customCadenceList { get; set; }Property Value
entity
Entity for which the analysis will be executed. For now, it can be Cc (Customers) or Fc (Suppliers)
public string entity { get; set; }Property Value
entityFilters
Custom filters that the user can create to narrow the values returned by the query
public QueryVO entityFilters { get; set; }Property Value
entityStamp
Holds the selected entity identifier
public string entityStamp { get; set; }Property Value
Examples
If the user chooses the famous Albertino this property stores the Albertino's stamp
exchangeRateAtDate
If true, instead of calculating the exchange by the current date, the analysis looks for the exchange values at the movement date
public bool exchangeRateAtDate { get; set; }Property Value
groupBy
Group by field chosen by the user. See BalanceGroupBy
public BalanceGroupBy groupBy { get; set; }Property Value
ignoreUncollectibleValues
If true, we don't subtract uncollectible values from the balance value
public bool ignoreUncollectibleValues { get; set; }Property Value
referenceDate
This property defines the initial date of the analysis. Only movements that occurred before this date are going to be part of the analysis
public DateTime referenceDate { get; set; }Property Value
shouldDeduceIRS
If true, the IRS value is subtracted from the movement
public bool shouldDeduceIRS { get; set; }Property Value
shouldShowGraphic
If true, the graph will appear and the calculations to get the graph values are going to be made
public bool shouldShowGraphic { get; set; }Property Value
untilDate
If the calculation type is by specific date, this field determines the "end date" of the query. Which means that it creates an interval between the referenceDate and itself. As we're always looking for values that are in the past its value should always be lower than the reference date
public DateTime untilDate { get; set; }