Search Results for

    Show / Hide Table of Contents

    Class FinancialYearManager

    Financial year manager, to work with financial years, periods, period status and type values

    Inheritance
    System.Object
    FinancialYearManager
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Simplic.Framework.Core
    Assembly: Simplic.Framework.Base.dll
    Syntax
    public class FinancialYearManager

    Methods

    | Improve this Doc View Source

    CopyFinancialYear(FinancialYear, UInt16)

    Copy a financial year object and adjust dates

    Declaration
    public FinancialYear CopyFinancialYear(FinancialYear year, ushort newYear)
    Parameters
    Type Name Description
    FinancialYear year

    Year to copy

    System.UInt16 newYear

    New year

    Returns
    Type Description
    FinancialYear
    | Improve this Doc View Source

    CreateYearPeriods(FinancialYear, Int32, DateTime)

    Creates periods in even parts at the start date for one year. Existing periods will be deleted

    Declaration
    public void CreateYearPeriods(FinancialYear year, int count, DateTime start)
    Parameters
    Type Name Description
    FinancialYear year
    System.Int32 count

    months count must be devided by 12

    System.DateTime start

    start of first period

    | Improve this Doc View Source

    DeleteFinancialYear(Guid)

    Remove a financial year

    Declaration
    public void DeleteFinancialYear(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique year id

    | Improve this Doc View Source

    DeletePeriod(Guid)

    Delete single financial period

    Declaration
    public void DeletePeriod(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique id

    | Improve this Doc View Source

    DeletePeriodStatus(Guid)

    Delete a period status

    Declaration
    public void DeletePeriodStatus(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique status id

    | Improve this Doc View Source

    DeletePeriodType(Guid)

    Remove a period type from the database

    Declaration
    public void DeletePeriodType(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique type id

    | Improve this Doc View Source

    GetAllFinancialYears()

    Get all financial years

    Declaration
    public IEnumerable<FinancialYear> GetAllFinancialYears()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<FinancialYear>

    IEnumerable of financial years

    | Improve this Doc View Source

    GetAllPeriodStatus()

    Get all periods status values

    Declaration
    public IEnumerable<FinancialYearPeriodStatus> GetAllPeriodStatus()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<FinancialYearPeriodStatus>

    IEnumerable of status objects

    | Improve this Doc View Source

    GetAllPeriodType()

    Get all available period types

    Declaration
    public IEnumerable<FinancialYearPeriodType> GetAllPeriodType()
    Returns
    Type Description
    System.Collections.Generic.IEnumerable<FinancialYearPeriodType>

    IEnumerable if period types

    | Improve this Doc View Source

    GetDefaultPeriodStatus()

    Get the default period status

    Declaration
    public FinancialYearPeriodStatus GetDefaultPeriodStatus()
    Returns
    Type Description
    FinancialYearPeriodStatus

    Default period status if found

    | Improve this Doc View Source

    GetFinancialYear(DateTime, Guid)

    Get financial year for a selected date

    Declaration
    public FinancialYear GetFinancialYear(DateTime date, Guid tenantId)
    Parameters
    Type Name Description
    System.DateTime date

    Selected date

    System.Guid tenantId
    Returns
    Type Description
    FinancialYear

    FinancialYear

    | Improve this Doc View Source

    GetFinancialYear(Guid)

    Gets a single financial year by its id

    Declaration
    public FinancialYear GetFinancialYear(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique instance id

    Returns
    Type Description
    FinancialYear

    FinancialYear instance

    | Improve this Doc View Source

    GetFinancialYear(UInt16, Guid)

    Get a single financial year by its start year

    Declaration
    public FinancialYear GetFinancialYear(ushort year, Guid tenantId)
    Parameters
    Type Name Description
    System.UInt16 year
    System.Guid tenantId

    Unique tenant id

    Returns
    Type Description
    FinancialYear

    FinancialYear instance

    | Improve this Doc View Source

    GetPeriod(Guid)

    Get a single financial period instance

    Declaration
    public FinancialYearPeriod GetPeriod(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique id of a period

    Returns
    Type Description
    FinancialYearPeriod

    Instance of a fy period if found, else null

    | Improve this Doc View Source

    GetPeriods(Guid)

    Get an enumerable of financial periods by its year id

    Declaration
    public IEnumerable<FinancialYearPeriod> GetPeriods(Guid yearId)
    Parameters
    Type Name Description
    System.Guid yearId

    Unique year id

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<FinancialYearPeriod>

    IEnumerable of periods

    | Improve this Doc View Source

    GetPeriodStatus(Guid)

    Get a single period status by its id

    Declaration
    public FinancialYearPeriodStatus GetPeriodStatus(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique status id

    Returns
    Type Description
    FinancialYearPeriodStatus

    Status instance if exists

    | Improve this Doc View Source

    GetPeriodType(Guid)

    Get a single period type by its id

    Declaration
    public FinancialYearPeriodType GetPeriodType(Guid id)
    Parameters
    Type Name Description
    System.Guid id

    Unique period type id

    Returns
    Type Description
    FinancialYearPeriodType

    Period type instance of exists

    | Improve this Doc View Source

    GetPeriodType(String)

    Get a single period type by its name

    Declaration
    public FinancialYearPeriodType GetPeriodType(string internName)
    Parameters
    Type Name Description
    System.String internName

    Unique period type intern name

    Returns
    Type Description
    FinancialYearPeriodType

    Period type instance of exists

    | Improve this Doc View Source

    SaveFinancialYear(FinancialYear)

    Save a financial year instance

    Declaration
    public void SaveFinancialYear(FinancialYear year)
    Parameters
    Type Name Description
    FinancialYear year

    Object to save

    | Improve this Doc View Source

    SavePeriod(FinancialYearPeriod)

    Save a financial period instance

    Declaration
    public void SavePeriod(FinancialYearPeriod period)
    Parameters
    Type Name Description
    FinancialYearPeriod period

    Object to save

    | Improve this Doc View Source

    SavePeriodStatus(FinancialYearPeriodStatus)

    Save a status object in the database

    Declaration
    public void SavePeriodStatus(FinancialYearPeriodStatus status)
    Parameters
    Type Name Description
    FinancialYearPeriodStatus status

    Unique status object

    | Improve this Doc View Source

    SavePeriodType(FinancialYearPeriodType)

    Save a period type in the database

    Declaration
    public void SavePeriodType(FinancialYearPeriodType type)
    Parameters
    Type Name Description
    FinancialYearPeriodType type

    Period type instance

    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • CopyFinancialYear(FinancialYear, UInt16)
      • CreateYearPeriods(FinancialYear, Int32, DateTime)
      • DeleteFinancialYear(Guid)
      • DeletePeriod(Guid)
      • DeletePeriodStatus(Guid)
      • DeletePeriodType(Guid)
      • GetAllFinancialYears()
      • GetAllPeriodStatus()
      • GetAllPeriodType()
      • GetDefaultPeriodStatus()
      • GetFinancialYear(DateTime, Guid)
      • GetFinancialYear(Guid)
      • GetFinancialYear(UInt16, Guid)
      • GetPeriod(Guid)
      • GetPeriods(Guid)
      • GetPeriodStatus(Guid)
      • GetPeriodType(Guid)
      • GetPeriodType(String)
      • SaveFinancialYear(FinancialYear)
      • SavePeriod(FinancialYearPeriod)
      • SavePeriodStatus(FinancialYearPeriodStatus)
      • SavePeriodType(FinancialYearPeriodType)
    Back to top Copyright © 2018 SIMPLIC GmbH
    Generated by DocFx