Class: LockstepSdk::FinancialReportModel

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

Overview

Represents a Financial Report

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ FinancialReportModel

Initialize the FinancialReportModel using the provided prototype



27
28
29
30
31
32
33
34
 
# File 'lib/lockstep_sdk/models/financial_report_model.rb', line 27

def initialize(params = {})
    @report_name = params.dig(:report_name)
    @group_key = params.dig(:group_key)
    @report_start_date = params.dig(:report_start_date)
    @report_end_date = params.dig(:report_end_date)
    @report_created_date = params.dig(:report_created_date)
    @rows = params.dig(:rows)
end

Instance Attribute Details

#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).



42
43
44
 
# File 'lib/lockstep_sdk/models/financial_report_model.rb', line 42

def group_key
  @group_key
end

#report_created_date ⇒ Date-time

Returns The created date of the financial report.

Returns:

  • (Date-time) —

    The created date of the financial report



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

def report_created_date
  @report_created_date
end

#report_end_date ⇒ Date-time

Returns The end date of the financial report.

Returns:

  • (Date-time) —

    The end date of the financial report



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

def report_end_date
  @report_end_date
end

#report_name ⇒ String

Returns The name of the report (“*Report Type* for Company”).

Returns:

  • (String) —

    The name of the report (“*Report Type* for Company”)



38
39
40
 
# File 'lib/lockstep_sdk/models/financial_report_model.rb', line 38

def report_name
  @report_name
end

#report_start_date ⇒ Date-time

Returns The start date of the financial report.

Returns:

  • (Date-time) —

    The start date of the financial report



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

def report_start_date
  @report_start_date
end

#rows ⇒ FinancialReportRowModel

Returns The rows of the financial report.

Returns:



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

def rows
  @rows
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



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/lockstep_sdk/models/financial_report_model.rb', line 62

def as_json(options={})
    {
        'reportName' => @report_name,
        'groupKey' => @group_key,
        'reportStartDate' => @report_start_date,
        'reportEndDate' => @report_end_date,
        'reportCreatedDate' => @report_created_date,
        'rows' => @rows,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



75
76
77
 
# File 'lib/lockstep_sdk/models/financial_report_model.rb', line 75

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