Class: Merge::Accounting::TaxComponent

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

Overview

# The TaxRate Object

### Description
The `TaxComponent` object is used to represent any sub-taxes that make up the
`TaxRate`.
### Usage Example
Fetch from the `LIST TaxRates` endpoint and view tax components relevant to a
tax rate.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, rate: OMIT, is_compound: OMIT, component_type: OMIT, remote_was_deleted: OMIT, additional_properties: nil) ⇒ Merge::Accounting::TaxComponent

Parameters:

  • id (String) (defaults to: OMIT)
  • 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 tax rate’s name.

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

    The tax component’s rate.

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

    Returns True if the tax component is compound, False if not.

  • component_type (Merge::Accounting::ComponentTypeEnum) (defaults to: OMIT) —

    Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax.

    • ‘SALES` - SALES

    • ‘PURCHASE` - PURCHASE

  • 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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 67

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, rate: OMIT,
               is_compound: OMIT, component_type: OMIT, remote_was_deleted: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @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
  @rate = rate if rate != OMIT
  @is_compound = is_compound if is_compound != OMIT
  @component_type = component_type if component_type != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "name": name,
    "rate": rate,
    "is_compound": is_compound,
    "component_type": component_type,
    "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



43
44
45
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 43

def additional_properties
  @additional_properties
end

#component_type ⇒ Merge::Accounting::ComponentTypeEnum (readonly)

Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax.

  • ‘SALES` - SALES

  • ‘PURCHASE` - PURCHASE

Returns:

  • (Merge::Accounting::ComponentTypeEnum) —

    Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax.

    • ‘SALES` - SALES

    • ‘PURCHASE` - PURCHASE



36
37
38
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 36

def component_type
  @component_type
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.



23
24
25
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 23

def created_at
  @created_at
end

#id ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 19

def id
  @id
end

#is_compound ⇒ Boolean (readonly)

Returns True if the tax component is compound, False if not.

Returns:

  • (Boolean) —

    Returns True if the tax component is compound, False if not.



31
32
33
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 31

def is_compound
  @is_compound
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.



25
26
27
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 25

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The tax rate’s name.

Returns:

  • (String) —

    The tax rate’s name.



27
28
29
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 27

def name
  @name
end

#rate ⇒ String (readonly)

Returns The tax component’s rate.

Returns:

  • (String) —

    The tax component’s rate.



29
30
31
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 29

def rate
  @rate
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.



21
22
23
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 21

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



41
42
43
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 41

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of TaxComponent

Parameters:

  • json_object (String)

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 98

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  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"]
  rate = parsed_json["rate"]
  is_compound = parsed_json["is_compound"]
  component_type = parsed_json["component_type"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    rate: rate,
    is_compound: is_compound,
    component_type: component_type,
    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) 


137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 137

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  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.rate&.is_a?(String) != false || raise("Passed value for field obj.rate is not the expected type, validation failed.")
  obj.is_compound&.is_a?(Boolean) != false || raise("Passed value for field obj.is_compound is not the expected type, validation failed.")
  obj.component_type&.is_a?(Merge::Accounting::ComponentTypeEnum) != false || raise("Passed value for field obj.component_type 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 TaxComponent to a JSON object

Returns:

  • (String) 


127
128
129
 
# File 'lib/merge_ruby_client/accounting/types/tax_component.rb', line 127

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