Class: LockstepSdk::FinancialAccountBalanceHistoryModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/financial_account_balance_history_model.rb

Overview

Represents a balance for a financial account for a given period of time.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ FinancialAccountBalanceHistoryModel

Initialize the FinancialAccountBalanceHistoryModel using the provided prototype



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 25

def initialize(params = {})
    @financial_account_balance_history_id = params.dig(:financial_account_balance_history_id)
    @group_key = params.dig(:group_key)
    @financial_account_id = params.dig(:financial_account_id)
    @app_enrollment_id = params.dig(:app_enrollment_id)
    @financial_year = params.dig(:financial_year)
    @period_number = params.dig(:period_number)
    @period_start_date = params.dig(:period_start_date)
    @period_end_date = params.dig(:period_end_date)
    @status = params.dig(:status)
    @balance = params.dig(:balance)
    @balance_type = params.dig(:balance_type)
    @balance_type_name = params.dig(:balance_type_name)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
end

Instance Attribute Details

#app_enrollment_id ⇒ Uuid

Returns The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.

Returns:

  • (Uuid) —

    The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.



58
59
60
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 58

def app_enrollment_id
  @app_enrollment_id
end

#balance ⇒ Double

Returns The current or end balance of this period.

Returns:

  • (Double) —

    The current or end balance of this period.



82
83
84
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 82

def balance
  @balance
end

#balance_type ⇒ FinancialAccountBalanceType

Returns Financial Account Balance Types.

Returns:

  • (FinancialAccountBalanceType) —

    Financial Account Balance Types



86
87
88
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 86

def balance_type
  @balance_type
end

#balance_type_name ⇒ String

Returns The name of the BalanceType for this record.

Returns:

  • (String) —

    The name of the BalanceType for this record.



90
91
92
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 90

def balance_type_name
  @balance_type_name
end

#created ⇒ Date-time

Returns The date on which this financial account balance history record was created.

Returns:

  • (Date-time) —

    The date on which this financial account balance history record was created.



94
95
96
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 94

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID number of the user who created this financial account balance history.

Returns:

  • (Uuid) —

    The ID number of the user who created this financial account balance history.



98
99
100
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 98

def created_user_id
  @created_user_id
end

#financial_account_balance_history_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.



46
47
48
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 46

def 
  @financial_account_balance_history_id
end

#financial_account_id ⇒ Uuid

Returns The id of the Financial Account that this balance history is for.

Returns:

  • (Uuid) —

    The id of the Financial Account that this balance history is for.



54
55
56
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 54

def 
  @financial_account_id
end

#financial_year ⇒ Int32

Returns The financial year that this period falls under.

Returns:

  • (Int32) —

    The financial year that this period falls under



62
63
64
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 62

def financial_year
  @financial_year
end

#group_key ⇒ Uuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid) —

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



50
51
52
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 50

def group_key
  @group_key
end

#modified ⇒ Date-time

Returns The date on which this financial account balance history record was modified.

Returns:

  • (Date-time) —

    The date on which this financial account balance history record was modified.



102
103
104
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 102

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID number of the user who most recently modified this financial account balance history.

Returns:

  • (Uuid) —

    The ID number of the user who most recently modified this financial account balance history.



106
107
108
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 106

def modified_user_id
  @modified_user_id
end

#period_end_date ⇒ Date-time

Returns The end date of this period.

Returns:

  • (Date-time) —

    The end date of this period.



74
75
76
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 74

def period_end_date
  @period_end_date
end

#period_number ⇒ Int32

Returns The period number (1-12 or 1-13) that this balance history is for.

Returns:

  • (Int32) —

    The period number (1-12 or 1-13) that this balance history is for



66
67
68
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 66

def period_number
  @period_number
end

#period_start_date ⇒ Date-time

Returns The start date of this period.

Returns:

  • (Date-time) —

    The start date of this period.



70
71
72
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 70

def period_start_date
  @period_start_date
end

#status ⇒ String

Returns The status of this period. The status should be Closed if the books for this period have been closed, if not the status should be Open. The status can also be Deleted if there was a recalculation that needed to occur, for example due to a change in financial year settings.

Returns:

  • (String) —

    The status of this period. The status should be Closed if the books for this period have been closed, if not the status should be Open. The status can also be Deleted if there was a recalculation that needed to occur, for example due to a change in financial year settings.



78
79
80
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 78

def status
  @status
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 110

def as_json(options={})
    {
        'financialAccountBalanceHistoryId' => @financial_account_balance_history_id,
        'groupKey' => @group_key,
        'financialAccountId' => @financial_account_id,
        'appEnrollmentId' => @app_enrollment_id,
        'financialYear' => @financial_year,
        'periodNumber' => @period_number,
        'periodStartDate' => @period_start_date,
        'periodEndDate' => @period_end_date,
        'status' => @status,
        'balance' => @balance,
        'balanceType' => @balance_type,
        'balanceTypeName' => @balance_type_name,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



133
134
135
 
# File 'lib/lockstep_sdk/models/financial_account_balance_history_model.rb', line 133

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end