Class: Merge::Accounting::ReportItem

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/report_item.rb

Overview

# The ReportItem Object

### Description
The `ReportItem` object is used to represent a report item for a Balance Sheet,
Cash Flow Statement or Profit and Loss Report.
### Usage Example
Fetch from the `GET BalanceSheet` endpoint and view the balance sheet's report
items.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, value: OMIT, sub_items: OMIT, company: OMIT, remote_was_deleted: OMIT, additional_properties: nil) ⇒ Merge::Accounting::ReportItem

Parameters:

  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • name (String) (defaults to: OMIT) —

    The report item’s name.

  • value (Float) (defaults to: OMIT) —

    The report item’s value.

  • sub_items (Array<Hash{String => Object}>) (defaults to: OMIT)
  • company (String) (defaults to: OMIT) —

    The company the report item belongs to.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 57

def initialize(remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, value: OMIT, sub_items: OMIT,
               company: OMIT, remote_was_deleted: OMIT, additional_properties: nil)
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @name = name if name != OMIT
  @value = value if value != OMIT
  @sub_items = sub_items if sub_items != OMIT
  @company = company if company != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "name": name,
    "value": value,
    "sub_items": sub_items,
    "company": company,
    "remote_was_deleted": remote_was_deleted
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



37
38
39
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 37

def additional_properties
  @additional_properties
end

#company ⇒ String (readonly)

Returns The company the report item belongs to.

Returns:

  • (String) —

    The company the report item belongs to.



30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 30

def company
  @company
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



20
21
22
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 20

def created_at
  @created_at
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



22
23
24
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 22

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The report item’s name.

Returns:

  • (String) —

    The report item’s name.



24
25
26
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 24

def name
  @name
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



18
19
20
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 18

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



35
36
37
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 35

def remote_was_deleted
  @remote_was_deleted
end

#sub_items ⇒ Array<Hash{String => Object}> (readonly)

Returns:

  • (Array<Hash{String => Object}>) 


28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 28

def sub_items
  @sub_items
end

#value ⇒ Float (readonly)

Returns The report item’s value.

Returns:

  • (Float) —

    The report item’s value.



26
27
28
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 26

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::ReportItem

Deserialize a JSON object to an instance of ReportItem

Parameters:

  • json_object (String)

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 86

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  name = parsed_json["name"]
  value = parsed_json["value"]
  sub_items = parsed_json["sub_items"]
  company = parsed_json["company"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  new(
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    value: value,
    sub_items: sub_items,
    company: company,
    remote_was_deleted: remote_was_deleted,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


123
124
125
126
127
128
129
130
131
132
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 123

def self.validate_raw(obj:)
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.value&.is_a?(Float) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
  obj.sub_items&.is_a?(Array) != false || raise("Passed value for field obj.sub_items is not the expected type, validation failed.")
  obj.company&.is_a?(String) != false || raise("Passed value for field obj.company is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ReportItem to a JSON object

Returns:

  • (String) 


113
114
115
 
# File 'lib/merge_ruby_client/accounting/types/report_item.rb', line 113

def to_json(*_args)
  @_field_set&.to_json
end