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, description: OMIT, total_tax_rate: OMIT, effective_tax_rate: OMIT, company: 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.

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

    The tax rate’s description.

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

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

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

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

    Indicates whether or not this object has been deleted in the third party platform.

  • 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



65
66
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
93
94
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 65

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, description: OMIT,
               total_tax_rate: OMIT, effective_tax_rate: OMIT, company: 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
  @description = description if description != OMIT
  @total_tax_rate = total_tax_rate if total_tax_rate != OMIT
  @effective_tax_rate = effective_tax_rate if effective_tax_rate != OMIT
  @company = company if company != 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,
    "description": description,
    "total_tax_rate": total_tax_rate,
    "effective_tax_rate": effective_tax_rate,
    "company": company,
    "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



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

def additional_properties
  @additional_properties
end

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

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

Returns:



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

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.



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

def created_at
  @created_at
end

#description ⇒ String (readonly)

Returns The tax rate’s description.

Returns:

  • (String) —

    The tax rate’s description.



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

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.



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

def effective_tax_rate
  @effective_tax_rate
end

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

Returns:

  • (Hash{String => Object}) 


39
40
41
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 39

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

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.



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

def modified_at
  @modified_at
end

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

Returns:



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

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.



21
22
23
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.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.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



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

def remote_was_deleted
  @remote_was_deleted
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).



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

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:



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
134
135
136
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 100

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?)
  description = parsed_json["description"]
  total_tax_rate = parsed_json["total_tax_rate"]
  effective_tax_rate = parsed_json["effective_tax_rate"]
  if parsed_json["company"].nil?
    company = nil
  else
    company = parsed_json["company"].to_json
    company = Merge::Accounting::TaxRateCompany.from_json(json_object: company)
  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,
    description: description,
    total_tax_rate: total_tax_rate,
    effective_tax_rate: effective_tax_rate,
    company: company,
    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) 


151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 151

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.description&.is_a?(String) != false || raise("Passed value for field obj.description 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.company.nil? || Merge::Accounting::TaxRateCompany.validate_raw(obj: obj.company)
  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) 


141
142
143
 
# File 'lib/merge_ruby_client/accounting/types/tax_rate.rb', line 141

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