Class: FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request

Inherits:

BaseModel

• Object
• FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request

Defined in:

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

Overview

def initialize: (Hash | FinchAPI::BaseModel) -> void

Instance Attribute Summary

• #limit ⇒ Integer^?

  Number of pay statements to return (defaults to all).

• #offset ⇒ Integer^?

  Index to start from.

• #payment_id ⇒ String

  A stable Finch ‘id` (UUID v4) for a payment.

Instance Method Summary

• #initialize(payment_id:, limit: nil, offset: nil) ⇒ Request constructor

  A new instance of Request.

Constructor Details

#initialize(payment_id:, limit: nil, offset: nil) ⇒ Request

Returns a new instance of Request.

Parameters:

• payment_id (String)
• limit (Integer) (defaults to: nil)
• offset (Integer) (defaults to: nil)

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

def initialize(payment_id:, limit: nil, offset: nil, **) = super

Instance Attribute Details

#limit ⇒ Integer^?

Number of pay statements to return (defaults to all).

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb', line 37

optional :limit, Integer

#offset ⇒ Integer^?

Index to start from.

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb', line 47

optional :offset, Integer

#payment_id ⇒ String

A stable Finch ‘id` (UUID v4) for a payment.

Returns:

• (String)

# File 'lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb', line 31

required :payment_id, String