Class: FinchAPI::Models::HRIS::PaymentListParams

Inherits:

BaseModel

• Object
• BaseModel
• FinchAPI::Models::HRIS::PaymentListParams

Includes:

RequestParameters

Defined in:

lib/finch-api/models/hris/payment_list_params.rb

Instance Attribute Summary

• #end_date ⇒ Date

  The end date to retrieve payments by a company (inclusive) in ‘YYYY-MM-DD` format.

• #start_date ⇒ Date

  The start date to retrieve payments by a company (inclusive) in ‘YYYY-MM-DD` format.

Attributes included from RequestParameters

#request_options

Instance Method Summary

• #initialize(end_date:, start_date:, request_options: {}) ⇒ PaymentListParams constructor

  A new instance of PaymentListParams.

Methods included from RequestParameters

included

Methods inherited from BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, #inspect, known_fields, optional, required, #to_h

Methods included from Converter

#coerce, coerce, #dump, dump, type_info

Constructor Details

#initialize(end_date:, start_date:, request_options: {}) ⇒ PaymentListParams

Returns a new instance of PaymentListParams.

Parameters:

• end_date (Date)
• start_date (Date)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch-api/models/hris/payment_list_params.rb', line 5

def initialize(end_date:, start_date:, request_options: {}, **) = super

Instance Attribute Details

#end_date ⇒ Date

The end date to retrieve payments by a company (inclusive) in ‘YYYY-MM-DD`

format.

Returns:

• (Date)

# File 'lib/finch-api/models/hris/payment_list_params.rb', line 16

required :end_date, Date

#start_date ⇒ Date

The start date to retrieve payments by a company (inclusive) in ‘YYYY-MM-DD`

format.

Returns:

• (Date)

# File 'lib/finch-api/models/hris/payment_list_params.rb', line 23

required :start_date, Date