Class: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/sandbox/payment_create_params.rb

Defined Under Namespace

Modules: PaymentMethod, Type Classes: Earning, EmployeeDeduction, EmployerContribution, Tax

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) ⇒ Object

Parameters:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
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
134
135
136
137
138
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 37

class PayStatement < FinchAPI::Internal::Type::BaseModel
  # @!attribute individual_id
  #
  #   @return [String]
  required :individual_id, String

  # @!attribute earnings
  #
  #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning>, nil]
  optional :earnings,
           -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning] }

  # @!attribute employee_deductions
  #
  #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction>, nil]
  optional :employee_deductions,
           -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction] }

  # @!attribute employer_contributions
  #
  #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution>, nil]
  optional :employer_contributions,
           -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution] }

  # @!attribute gross_pay
  #
  #   @return [Integer, nil]
  optional :gross_pay, Integer

  # @!attribute net_pay
  #
  #   @return [Integer, nil]
  optional :net_pay, Integer

  # @!attribute payment_method
  #
  #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
  optional :payment_method,
           enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod },
           nil?: true

  # @!attribute taxes
  #
  #   @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax>, nil]
  optional :taxes,
           -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax] }

  # @!attribute total_hours
  #
  #   @return [Float, nil]
  optional :total_hours, Float

  # @!attribute type
  #
  #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
  optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type }, nil?: true

  # @!method initialize(individual_id:, earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
  #   @param individual_id [String]
  #   @param earnings [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning>]
  #   @param employee_deductions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction>]
  #   @param employer_contributions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution>]
  #   @param gross_pay [Integer]
  #   @param net_pay [Integer]
  #   @param payment_method [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
  #   @param taxes [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax>]
  #   @param total_hours [Float]
  #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]

  class Earning < FinchAPI::Internal::Type::BaseModel
    # @!attribute amount
    #
    #   @return [Integer, nil]
    optional :amount, Integer

    # @!attribute hours
    #
    #   @return [Float, nil]
    optional :hours, Float

    # @!attribute name
    #
    #   @return [String, nil]
    optional :name, String

    # @!attribute type
    #
    #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil]
    optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type }

    # @!method initialize(amount: nil, hours: nil, name: nil, type: nil)
    #   @param amount [Integer]
    #   @param hours [Float]
    #   @param name [String]
    #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type]

    # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning#type
    module Type
      extend FinchAPI::Internal::Type::Enum

      BONUS = :bonus
      COMMISSION = :commission
      DOUBLE_OVERTIME = :double_overtime
      OTHER = :other
      OVERTIME = :overtime
      PTO = :pto
      REIMBURSEMENT = :reimbursement
      SALARY = :salary
      SEVERANCE = :severance
      SICK = :sick
      TIPS = :tips
      WAGE = :wage
      TYPE_1099 = :"1099"

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
    # @!attribute amount
    #
    #   @return [Integer, nil]
    optional :amount, Integer

    # @!attribute name
    #
    #   @return [String, nil]
    optional :name, String

    # @!attribute pre_tax
    #
    #   @return [Boolean, nil]
    optional :pre_tax, FinchAPI::Internal::Type::Boolean

    # @!attribute type
    #
    #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type, nil]
    optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type }

    # @!method initialize(amount: nil, name: nil, pre_tax: nil, type: nil)
    #   @param amount [Integer]
    #   @param name [String]
    #   @param pre_tax [Boolean]
    #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type]

    # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#type
    module Type
      extend FinchAPI::Internal::Type::Enum

      TYPE_457 = :"457"
      TYPE_401K = :"401k"
      TYPE_401K_ROTH = :"401k_roth"
      TYPE_401K_LOAN = :"401k_loan"
      TYPE_403B = :"403b"
      TYPE_403B_ROTH = :"403b_roth"
      TYPE_457_ROTH = :"457_roth"
      COMMUTER = :commuter
      CUSTOM_POST_TAX = :custom_post_tax
      CUSTOM_PRE_TAX = :custom_pre_tax
      FSA_DEPENDENT_CARE = :fsa_dependent_care
      FSA_MEDICAL = :fsa_medical
      HSA_POST = :hsa_post
      HSA_PRE = :hsa_pre
      S125_DENTAL = :s125_dental
      S125_MEDICAL = :s125_medical
      S125_VISION = :s125_vision
      SIMPLE = :simple
      SIMPLE_IRA = :simple_ira

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class EmployerContribution < FinchAPI::Internal::Type::BaseModel
    # @!attribute amount
    #
    #   @return [Integer, nil]
    optional :amount, Integer

    # @!attribute name
    #
    #   @return [String, nil]
    optional :name, String

    # @!attribute type
    #
    #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type, nil]
    optional :type,
             enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type }

    # @!method initialize(amount: nil, name: nil, type: nil)
    #   @param amount [Integer]
    #   @param name [String]
    #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type]

    # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#type
    module Type
      extend FinchAPI::Internal::Type::Enum

      TYPE_457 = :"457"
      TYPE_401K = :"401k"
      TYPE_401K_ROTH = :"401k_roth"
      TYPE_401K_LOAN = :"401k_loan"
      TYPE_403B = :"403b"
      TYPE_403B_ROTH = :"403b_roth"
      TYPE_457_ROTH = :"457_roth"
      COMMUTER = :commuter
      CUSTOM_POST_TAX = :custom_post_tax
      CUSTOM_PRE_TAX = :custom_pre_tax
      FSA_DEPENDENT_CARE = :fsa_dependent_care
      FSA_MEDICAL = :fsa_medical
      HSA_POST = :hsa_post
      HSA_PRE = :hsa_pre
      S125_DENTAL = :s125_dental
      S125_MEDICAL = :s125_medical
      S125_VISION = :s125_vision
      SIMPLE = :simple
      SIMPLE_IRA = :simple_ira

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#payment_method
  module PaymentMethod
    extend FinchAPI::Internal::Type::Enum

    CHECK = :check
    DIRECT_DEPOSIT = :direct_deposit
    OTHER = :other

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  class Tax < FinchAPI::Internal::Type::BaseModel
    # @!attribute amount
    #
    #   @return [Integer, nil]
    optional :amount, Integer

    # @!attribute employer
    #
    #   @return [Boolean, nil]
    optional :employer, FinchAPI::Internal::Type::Boolean

    # @!attribute name
    #
    #   @return [String, nil]
    optional :name, String

    # @!attribute type
    #
    #   @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil]
    optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type }

    # @!method initialize(amount: nil, employer: nil, name: nil, type: nil)
    #   @param amount [Integer]
    #   @param employer [Boolean]
    #   @param name [String]
    #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type]

    # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax#type
    module Type
      extend FinchAPI::Internal::Type::Enum

      FEDERAL = :federal
      FICA = :fica
      LOCAL = :local
      STATE = :state

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#type
  module Type
    extend FinchAPI::Internal::Type::Enum

    OFF_CYCLE_PAYROLL = :off_cycle_payroll
    ONE_TIME_PAYMENT = :one_time_payment
    REGULAR_PAYROLL = :regular_payroll

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#earnings ⇒ Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning>?

Returns:



46
47
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 46

optional :earnings,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning] }

#employee_deductions ⇒ Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction>?

Returns:



52
53
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 52

optional :employee_deductions,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction] }

#employer_contributions ⇒ Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution>?

Returns:



58
59
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 58

optional :employer_contributions,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution] }

#gross_pay ⇒ Integer?

Returns:

  • (Integer, nil) 


64
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 64

optional :gross_pay, Integer

#individual_id ⇒ String

Returns:

  • (String) 


41
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 41

required :individual_id, String

#net_pay ⇒ Integer?

Returns:

  • (Integer, nil) 


69
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 69

optional :net_pay, Integer

#payment_method ⇒ Symbol, ...

Returns:



74
75
76
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 74

optional :payment_method,
enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod },
nil?: true

#taxes ⇒ Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax>?

Returns:



81
82
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 81

optional :taxes,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax] }

#total_hours ⇒ Float?

Returns:

  • (Float, nil) 


87
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 87

optional :total_hours, Float

#type ⇒ Symbol, ...

Returns:



92
 
# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 92

optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/finch_api/models/sandbox/payment_create_params.rb', line 151