Class: Merge::Accounting::TaxRate

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

Overview

# The TaxRate Object

### Description
The `TaxRate` object is used to represent a tax rate.
### Usage Example
Fetch from the `LIST TaxRates` endpoint and view tax rates relevant to a
company.

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, company: OMIT, code: OMIT, name: OMIT, description: OMIT, status: OMIT, country: OMIT, total_tax_rate: OMIT, effective_tax_rate: OMIT, tax_components: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::TaxRate

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.

  • company (Merge::Accounting::TaxRateCompany) (defaults to: OMIT) —

    The subsidiary that the tax rate belongs to (in the case of multi-entity systems).

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

    The tax code associated with this tax rate or group of tax rates from the third-party platform.

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

    The tax rate’s name.

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

    The tax rate’s description.

  • status (Merge::Accounting::Status7D1Enum) (defaults to: OMIT) —

    The tax rate’s status - ‘ACTIVE` if an active tax rate, `ARCHIVED` if not active.

    • ‘ACTIVE` - ACTIVE

    • ‘ARCHIVED` - ARCHIVED

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

    The country the tax rate is associated with.

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

    The tax’s total tax rate - sum of the tax components (not compounded).

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

    The tax rate’s effective tax rate - total amount of tax with compounding.

  • tax_components (Array<Merge::Accounting::TaxRateTaxComponentsItem>) (defaults to: OMIT) —

    The related tax components of the tax rate.

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

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



94
95
96
97
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
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 94

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, company: OMIT, code: OMIT,
               name: OMIT, description: OMIT, status: OMIT, country: OMIT, total_tax_rate: OMIT, effective_tax_rate: OMIT, tax_components: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: 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
  @company = company if company != OMIT
  @code = code if code != OMIT
  @name = name if name != OMIT
  @description = description if description != OMIT
  @status = status if status != OMIT
  @country = country if country != OMIT
  @total_tax_rate = total_tax_rate if total_tax_rate != OMIT
  @effective_tax_rate = effective_tax_rate if effective_tax_rate != OMIT
  @tax_components = tax_components if tax_components != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "company": company,
    "code": code,
    "name": name,
    "description": description,
    "status": status,
    "country": country,
    "total_tax_rate": total_tax_rate,
    "effective_tax_rate": effective_tax_rate,
    "tax_components": tax_components,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.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



61
62
63
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 61

def additional_properties
  @additional_properties
end

#code ⇒ String (readonly)

Returns The tax code associated with this tax rate or group of tax rates from the third-party platform.

Returns:

  • (String) —

    The tax code associated with this tax rate or group of tax rates from the third-party platform.



33
34
35
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 33

def code
  @code
end

#company ⇒ Merge::Accounting::TaxRateCompany (readonly)

Returns The subsidiary that the tax rate belongs to (in the case of multi-entity systems).

Returns:



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

def company
  @company
end

#country ⇒ String (readonly)

Returns The country the tax rate is associated with.

Returns:

  • (String) —

    The country the tax rate is associated with.



44
45
46
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 44

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



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

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The tax rate’s description.

Returns:

  • (String) —

    The tax rate’s description.



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

def description
  @description
end

#effective_tax_rate ⇒ Float (readonly)

Returns The tax rate’s effective tax rate - total amount of tax with compounding.

Returns:

  • (Float) —

    The tax rate’s effective tax rate - total amount of tax with compounding.



48
49
50
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 48

def effective_tax_rate
  @effective_tax_rate
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


57
58
59
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 57

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

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



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

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The tax rate’s name.

Returns:

  • (String) —

    The tax rate’s name.



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

def name
  @name
end

#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)

Returns:



59
60
61
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 59

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



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

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



55
56
57
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 55

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ Merge::Accounting::Status7D1Enum (readonly)

Returns The tax rate’s status - ‘ACTIVE` if an active tax rate, `ARCHIVED` if not active.

  • ‘ACTIVE` - ACTIVE

  • ‘ARCHIVED` - ARCHIVED.

Returns:

  • (Merge::Accounting::Status7D1Enum) —

    The tax rate’s status - ‘ACTIVE` if an active tax rate, `ARCHIVED` if not active.

    • ‘ACTIVE` - ACTIVE

    • ‘ARCHIVED` - ARCHIVED



42
43
44
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 42

def status
  @status
end

#tax_components ⇒ Array<Merge::Accounting::TaxRateTaxComponentsItem> (readonly)

Returns The related tax components of the tax rate.

Returns:



50
51
52
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 50

def tax_components
  @tax_components
end

#total_tax_rate ⇒ Float (readonly)

Returns The tax’s total tax rate - sum of the tax components (not compounded).

Returns:

  • (Float) —

    The tax’s total tax rate - sum of the tax components (not compounded).



46
47
48
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 46

def total_tax_rate
  @total_tax_rate
end

Class Method Details

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

Deserialize a JSON object to an instance of TaxRate

Parameters:

  • json_object (String)

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 139

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?)
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::TaxRateCompany.from_json(json_object: company)
  end
  code = parsed_json["code"]
  name = parsed_json["name"]
  description = parsed_json["description"]
  status = parsed_json["status"]
  country = parsed_json["country"]
  total_tax_rate = parsed_json["total_tax_rate"]
  effective_tax_rate = parsed_json["effective_tax_rate"]
  tax_components = parsed_json["tax_components"]&.map do |item|
    item = item.to_json
    Merge::Accounting::TaxRateTaxComponentsItem.from_json(json_object: item)
  end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    company: company,
    code: code,
    name: name,
    description: description,
    status: status,
    country: country,
    total_tax_rate: total_tax_rate,
    effective_tax_rate: effective_tax_rate,
    tax_components: tax_components,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    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) 


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 203

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.company.nil? || Merge::Accounting::TaxRateCompany.validate_raw(obj: obj.company)
  obj.code&.is_a?(String) != false || raise("Passed value for field obj.code 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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Accounting::Status7D1Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.country&.is_a?(String) != false || raise("Passed value for field obj.country is not the expected type, validation failed.")
  obj.total_tax_rate&.is_a?(Float) != false || raise("Passed value for field obj.total_tax_rate is not the expected type, validation failed.")
  obj.effective_tax_rate&.is_a?(Float) != false || raise("Passed value for field obj.effective_tax_rate is not the expected type, validation failed.")
  obj.tax_components&.is_a?(Array) != false || raise("Passed value for field obj.tax_components 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.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TaxRate to a JSON object

Returns:

  • (String) 


193
194
195
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 193

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