payrix-api-sdk 1.0.0

data/lib/payrix/models/fees_response.rb

@@ -0,0 +1,859 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # FeesResponse Model.
+  class FeesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :entity
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :forentity
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :org
+
+    # The identifier of the Partition who should pay this Fee on behalf of the
+    # Entity identified in the value of the 'forentity' field. 
+    # This field is optional. If it is set, then the Fee is charged to the whole
+    # Partition instead.
+    # @return [String]
+    attr_accessor :partition
+
+    # The type of the fee.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Fee.** A Standard Fee.
+    # - `2` - **Assessment.** A Third-Party Platform Fee.
+    # </details>
+    # @return [FeeTypeEnum]
+    attr_accessor :type
+
+    # The name of this Fee. 
+    # This field is stored as a text string and must be between 0 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :name
+
+    # A description of this Fee. 
+    # This field is stored as a text string and must be between 0 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :description
+
+    # The schedule that determines when this Fee is triggered to be charged. 
+    # <details>
+    # <summary>Valid Values</summary>
+    #  `1` - **Days.** The Fee is charged every day.
+    #  `2` - **Weeks.** The Fee is charged every week.
+    #  `3` - **Months.** The Fee is charged every month.
+    #  `4` - **Years.** The Fee is charged every year.
+    #  `5` - **Single.** The Fee is a one-off charge.
+    #  `6` - **Auth.** The Fee is triggered at the time of authorization of a
+    # transaction.
+    #  `7` - **Capture.** The Fee triggers at the capture time of a Transaction.
+    #  `8` - **Refund.** The Fee triggers when a refund transaction is
+    # processed.
+    #  `9` - **Board.** The Fee triggers when the Merchant is boarded.
+    #  `10` - **Payout.** The Fee triggers when a payout is processed.
+    #  `11` - **Chargeback.** The Fee triggers when a card chargeback occurs.
+    #  `12` - **Overdraft.** The Fee triggers when an overdraft usage charge
+    # from a bank is levied.
+    #  `13` - **Interchange.** The Fee triggers when interchange default are
+    # assessed for the Transactions of this Merchant.
+    #  `14` - **Processor.** The Fee triggers when the Transactions of this
+    # Merchant are processed by a payment processor.
+    #  `15` - **ACH failure.** The Fee triggers when an automated clearing house
+    # failure occurs.
+    #  `16` - **Account.** The Fee triggers when a bank account is verified.
+    #  `17` - **Sift.** The Fee triggers when a txn uses SIFT for fraud
+    # checking.
+    #  `18` - **Adjustment.** The Fee triggers when an adjustment is created.
+    #  `19` - **Retrieval.** The Fee triggers when a chargeback retrieval is
+    # processed.
+    #  `20` - **Arbitration.** The Fee triggers when a chargeback arbitration is
+    # processed.
+    #  `21` - **eCheck Sale.** The Fee triggers when an eCheck sale is
+    # processed.
+    #  `22` - **eCheck Refund.** The Fee triggers when an eCheck refund is
+    # processed.
+    #  `23` - **eCheck Return.** The Fee triggers when an eCheck txn is returned
+    # because of a failure while processing.
+    #  `24` - **Settlement.** The Fee triggers when a txn is settled.
+    #  `25` - **Misuse.** The Fee triggers when a txn authorization is misused.
+    #  `26` - **Profit share.** The Fee triggers when a profit share is
+    # executed.
+    #  `27` - **Unauth.** The Fee triggers when an auth reversal is created.
+    #  `28` - **Disbursement NOC.** The Fee triggers on Notice Of Change events
+    # for Disbursements.
+    #  `29` - **Transaction NOC.** The Fee triggers on Notice Of Change events
+    # for Transactions.
+    #  `30` - **eCheck failure return.** The Fee triggers when an eCheck txn is
+    # returned due to customer rejection or incorrect account information.
+    #  `31` - **eCheck NSF return.** The Fee triggers when an eCheck txn is
+    # returned due to insufficient funds.
+    #  `32` - **Currency conversion.** The Fee triggers when there is a currency
+    # conversion on a transaction.
+    #  `33` - **Terminal transaction.** The Fee triggers when there is a
+    # transaction processed via a terminal.
+    #  `34` - **Reverse payout.** The Fee triggers when a payout is reversed.
+    #  `35` - **Partial reverse payout.** The Fee triggers when a payout is
+    # partially reversed.
+    #  `43` - **Payment check.** The Fee triggers on a payment check.
+    #  `44` - **Payment update.** The Fee triggers when a payment is updated.
+    #  `45` - **Payment group check.** The Fee triggers on a payment group
+    # check.
+    #  `46` - **Payment group update.** The Fee triggers on a payment group
+    # update.
+    #  `47` - **Entry refund.** The Fee triggers when an entry is refunded.
+    #  `51` - **Statement Payment.** A statement bill was paid.
+    #  `52` - **Merchant Created.** A new Merchant entity has been created, but
+    # not boarded.
+    #  `53` - **Realtime Business Search.** Real-time Business Entity OFAC
+    # Search from Bridger by LexisNexis.
+    #  `54` - **Realtime Member Search.** Real-time Business Entity Managing
+    # Member Personal OFAC Search from Bridger by LexisNexis.
+    #  `55` - **MasterCard MATCH.** Merchant History Check from Mastercard Alert
+    # To Control High-risk Merchants (MATCH) program.
+    #  `56` - **Business Instant ID.** KYB Verification from LexisNexis.
+    #  `57` - **Consumer Instance ID.** KYC Verification from LexisNexis.
+    #  `58` - **ThreatMetrix.** Black List & OFAC Watchlist check from
+    # LexisNexis.
+    #  `59` - **LegitScript Registration.** Merchant Compliance and Risk Rating
+    # Checks.
+    #  `60` - **Equifax Consumer Report.** Business owner's consumer credit
+    # report from Equifax.
+    #  `61` - **CharityCheck.** Business entity nonprofit eligibility
+    # verification from GuideStar.
+    #  `62` - **Internal Decision V2.** Payrix Risk services decision.
+    #  `63` - **TIN Check.** Tax Identification Number matching service for tax
+    # identity management from Sovos.
+    #  `64` - **Equifax Commercial Report.** Entity's commercial credit report
+    # from Equifax.
+    #  `65` - **LegitScript Merchant Check.** Merchant Compliance and Risk
+    # Rating Checks.
+    #  `66` - **Plaid.** Bank account link, info update and verification
+    # services.
+    #  `67` - **Statement Reversal.** A statement eCheck payment was reversed.
+    #  `68` - **GIACT eCheck Verification.** Real-time account status check for
+    # consumer and business bank accounts from gVerify by GIACT.
+    #  `69` - **GIACT Account Verification.** Real-time Business Entity Owner
+    # identity & authorized signer status verification from gAuthenticate by
+    # GIACT.
+    #  `70` - **Boarding Decision.** Merchant boarding decision made by the
+    # platform via risk checks.
+    #  `71` - **Transaction Risk Decision.** Transaction decision made by the
+    # platform via risk checks.
+    #  `72` - **FANF.** Fixed Acquirer Network Fee from Visa for Merchants
+    # processing card-present and card-not-present transactions.
+    #  `73` - **MCLocation.** Merchant Location Fee from Mastercard for
+    # Merchants processing card-present and card-not-present transactions.
+    #  `74` - **VisaIntegrity.** Transaction Integrity Fee from Visa.
+    #  `75` - **SaferPayments: Basic.** PCI DSS Compliance Portal from WorldPay
+    # for Partner and Facilitator Merchant portfolios.
+    #  `76` - **SaferPayments: Managed.** PCI DSS Compliance Managed Services
+    # from WorldPay for Merchants in Partner and Facilitator portfolios.
+    #  `77` - **SaferPayments - PCI Non-Validation.** PCI DSS Compliance Portal
+    # and/or services were provided but the Merchant failed to meet PCI DSS
+    # Compliance.
+    #  `78` - **OMNITOKENS_VOLUME.** Omni-Channel payment tokenization from
+    # WorldPay.
+    #  `79` - **Payout Return.** A Payout Disbursement was returned when
+    # attempted.
+    #  `80` - **Payout Partial Return.** A Payout Disbursement was partially
+    # returned when attempted.
+    #  `81` - **Revenue Share.** A configuration of multiple entities dividing
+    # revenue.
+    #  `82` - **Card Settlement.** The funds from a card payment captured and
+    # authorized in a transaction have been settled.
+    #  `83` - **eCheck Settlement.** The funds from an ACH/eCheck payment used
+    # in a transaction have been settled.
+    #  `84` - **Revenue Share from Card.** Funds have been captured in a Revenue
+    # Share configuration from a card payment transaction.
+    #  `85` - **Revenue Share from eCheck.** Funds have been captured in a
+    # Revenue Share configuration from an ACH / eCheck payment transaction.
+    #  `86` - **Revenue Share Payout.** Funds from a Revenue Share capture have
+    # been settled and disbursed to the applicable entities.
+    #  
+    #  `88` - **PLAID_IDENTITY_MACH** 
+    #  
+    #  `89` - **TXN_PLAID_IDENTITY_MACH** 
+    #  
+    #  `90` - **PLAID_GET_IDENTITY** 
+    #  
+    #  `91` - **TXN_PLAID_GET_IDENTITY** 
+    #  
+    #  `92` - **PLAID_GET_AUTH** 
+    #  
+    #  `93` - **TXN_PLAID_GET_AUTH**
+    #  
+    #  `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.
+    #  
+    #  `200` - **VALUTEC_ESSENTIAL_GIFT. External Fees**
+    #  `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN. External Fees**
+    #  `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE. External Fees**
+    #  `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN. External Fees**
+    #  `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE. External Fees**
+    #  `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN. External Fees**
+    #  `206` - **VALUTEC_TRANSACTION_FEE. External Fees**
+    #  `207` - **VALUTEC_SETUP_FEE. External Fees**
+    #  `208` - **VALUTEC_GIFT_ACH_POOLING. External Fees**
+    #  `209` - **VALUTEC_JUMP_START_KIT. External Fees**
+    #  `210` - **VALUTEC_LAUNCH_BOX_KIT. External Fees**
+    #  `211` - **VALUTEC_500_CUSTOM_CARDS. External Fees**
+    #  `212` - **VALUTEC_MAINTENANCE_FEE. External Fees**
+    #  `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME. External Fees**
+    #  `214` - **EFE_MWC_RESIDUAL_ATELIO** 
+    #  `215` - **EFE_MWC_RESIDUAL_PARAFIN**  
+    #  `216` - **EFE_MWC_BILLING**  
+    #  `217` - **FRAUDSIGHT_CNP_DECISION**  
+    #  `218` - **FRAUDSIGHT_CP_DECISION**  
+    #  `230` - **VALUTEC_OVERAGE_TRANSACTION_FEE. External Fees**  
+    #  `231` - **VALUTEC_STANDARD_MOBILE_PASS_MONTHLY_APPLE. External Fees** 
+    #  `232` - **VALUTEC_NFC_MOBILE_PASS_MONTHLY. External Fees**  
+    #  `233` - **VALUTEC_STANDARD_MOBILE_PASS_MONTHLY_GOOGLE. External Fees**  
+    #  `234` - **VALUTEC_ONLINE_GIFT_WEBSITE_MONTHLY. External Fees**  
+    #  `235` - **VALUTEC_MARKETING_360_MONTHLY. External Fees**  
+    #  `236` - **VALUTEC_ONLINE_GIFT_CARD_VOLUME_FEE. External Fees** 
+    #  `237` - **VALUTEC_SOCIAL_SHARING_MONTHLY. External Fees**  
+    #  `238` - **VALUTEC_DIGICARD_MONTHLY. External Fees**  
+    #  `239` - **VALUTEC_LOYALTY_STANDARD_MONTHLY. External Fees**  
+    #  `240` - **VALUTEC_AUTO_REWARDS_LPR_MONTHLY. External Fees** 
+    #  `241` - **VALUTEC_ONECARD_SETUP_FEE. External Fees**  
+    #  `242` - **VALUTEC_ONECARD_MONTHLY_FEE. External Fees** 
+    #  `243` - **VALUTEC_MONTHLY_FEE_CHOICE. External Fees**  
+    #  `244` - **VALUTEC_SYSTEM_ACCESS. External Fees**  
+    #  `245` - **VALUTEC_TRANSACTION. External Fees**  
+    #  `246` - **VALUTEC_MONTHLY_FEE_LAUNCHBOX. External Fees** 
+    #  `247` - **VALUTEC_MONTHLY_FEE_JUMPSTART**  
+    #  `248` - **VALUTEC_ONECARD_PHYSICAL_FULFILLMENT_FEE. External Fees** 
+    #  `249` - **VALUTEC_ONECARD_VIRTUAL_FULFILLMENT_FEE. External Fees**  
+    #  `250` - **VALUTEC_CUSTOMIZED_REPORTING. External Fees**  
+    #  `251` - **VALUTEC_TRANSACTION_FILE_FEED. External Fees**  
+    #  `252` - **VALUTEC_250_CUSTOM_CARDS. External Fees**  
+    #  `253` - **VALUTEC_1000_CUSTOM_CARDS. External Fees**  
+    #  `254` - **VALUTEC_2500_CUSTOM_CARDS. External Fees**  
+    #  `255` - **VALUTEC_5000_CUSTOM_CARDS. External Fees**  
+    #  `256` - **VALUTEC_10000_CUSTOM_CARDS. External Fees** 
+    #  
+    #  `257` - **VALUTEC_15000_CUSTOM_CARDS. External Fees** 
+    #  
+    #  `258` - **VALUTEC_20000_CUSTOM_CARDS. External Fees** 
+    #  
+    #  `259` - **VALUTEC_25000_CUSTOM_CARDS. External Fees** 
+    #  
+    #  `260` - **VALUTEC_250_EXPRESS_CARDS. External Fees**  
+    #  `261` - **VALUTEC_500_EXPRESS_CARDS. External Fees**  
+    #  `262` - **VALUTEC_1000_EXPRESS_CARD. External FeesS** 
+    #  
+    #  `263` - **VALUTEC_2500_EXPRESS_CARDS. External Fees** 
+    #  
+    #  `264` - **VALUTEC_5000_EXPRESS_CARDS. External Fees** 
+    #  
+    #  `265` - **VALUTEC_10000_EXPRESS_CARDS. External Fees**  
+    #  `266` - **VALUTEC_SPECIALTY_CARDS. External Fees**  
+    #  `267` - **VALUTEC_KEYTAGS. External Fees**  
+    #  `268` - **VALUTEC_SLEEVES_CARRIERS_HANGERS. External Fees**  
+    #  `269` - **VALUTEC_SIGNATURE_PANEL. External Fees**  
+    #  `270` - **VALUTEC_4_4_PRINTING. External Fees**  
+    #  
+    #  `271` - **VALUTEC_SPECIALTY_FINISH. External Fees**  
+    #  `272` - **VALUTEC_PANTONE. External Fees**  
+    #  `273` - **VALUTEC_PIN_SCRATCH. External Fees**  
+    #  `274` - **VALUTEC_MERCHANDISE. External Fees**  
+    #  `275` - **VALUTEC_GIFT_CARD_DESIGN_SETUP_FEE. External Fees**
+    #  `276` - **VALUTEC_SHIPPING_HANDLING. External Fees**  
+    #  `277` - **VALUTEC_RUSH_FEES. External Fees**  
+    #  `278` - **VALUTEC_SEQUENCING. External Fees**  
+    #  `279` - **VALUTEC_WHOLESALE_FULFILLMENT_FEE. External Fees**  
+    #  `280` - **VALUTEC_MISCELLANEOUS_FEES. External Fees**  
+    #  `281` - **VALUTEC_HOSTING_FEE. External Fees**  
+    #  `282` - **VALUTEC_STORECARD_MONTHLY_FEE. External Fees**  
+    #  `283` - **VALUTEC_GIFT_ACH_FEE_MONTHLY. External Fees**  
+    #  `284` - **VALUTEC_ONECARD_MONTHLY_FEE_STORECARD. External Fees**  
+    #  `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY**  
+    #  `401` - **REVBOOST_EMBEDDED_TMS_PPT**
+    #  `402` - **TXN_THREAT_METRIX. External Fees**
+    #  `403` - **THREAT_METRIX_EMAILAGE. External Fees**
+    #  `404` - **THREAT_METRIX_FRAUD_POINT. External Fees**
+    #  `405` - **GIACT_INQUIRY. External Fees**
+    #  `406` - **GIACT_TXN_GAUTHENTICATE. External Fees**
+    #  `407` - **TRULIOO_IDV. External Fees**
+    #  `408` - **TRULIOO_AMLLDV. External Fees**
+    #  `409` - **TRULIOO_BUSINESS_VERIFICATION. External Fees**
+    #  `410` - **THREAT_METRIX_PHONE_FINDER. External Fees**
+    #  `601` - **TIER_NON_QUALIFIED_COUNT**  
+    #  `602` - **TIER_QUALIFIED_COUNT**  
+    #  `603` - **TIER_MID_QUALIFIED_COUNT**  
+    #  `604` - **TIER_HIGH_RISK_COUNT**  
+    #  `605` - **TIER_NON_QUALIFIED_VOLUME**  
+    #  `606` - **TIER_QUALIFIED_VOLUME**  
+    #  `607` - **TIER_MID_QUALIFIED_VOLUME**  
+    #  `608` - **TIER_HIGH_RISK_VOLUME**  
+    #  `701` - **NYCE_PULSE_ANNUAL_FEE**  
+    #  `702` - **PULSE_ANNUAL_FEE**  
+    #  `703` - **CU24_PULSE_ANNUAL_FEE**  
+    #  `704` - **STAR_PULSE_ANNUAL_FEE**  
+    #  `705` - **ACCEL_PULSE_ANNUAL_FEE**  
+    #  `801` - **TPG-IGENICO_LINK_2500**  
+    #  `802` - **TPG-IGENICO_LANE_3600_STD**  
+    #  `803` - **TPG-IGENICO_LANE_3600_DLX**  
+    #  `804` - **TPG-IGENICO_LANE_7000_STD**  
+    #  `805` - **TPG-IGENICO_LANE_7000_DLX**  
+    #  `806` - **TPG-INGENICO_MOVE_5000**  
+    #  `807` - **PAYRIX_EQUIPMENT_SETUP_FEE**  
+    #  </details>
+    # @return [FeeScheduleEnum]
+    attr_accessor :schedule
+
+    # A multiplier that you can use to adjust the schedule set in the 'schedule'
+    # field, if it is set to a duration-based trigger, such as daily, weekly,
+    # monthly, or annually. 
+    # This field is specified as an integer and its value determines how the
+    # interval is multiplied..
+    # @return [Integer]
+    attr_accessor :schedule_factor
+
+    # The date on which charging of the Fee should start. 
+    # The date is specified as an eight digit string in YYYYMMDD format, for
+    # example, '20160120' for January 20, 2016. 
+    # The value of this field must represent a date in the future, or the
+    # present date.
+    # @return [Integer]
+    attr_accessor :start
+
+    # The date on which charging of the Fee should end. 
+    # The date is specified as an eight digit string in YYYYMMDD format, for
+    # example, '20160120' for January 20, 2016. 
+    # The value of this field must represent a date in the future.
+    # @return [Integer]
+    attr_accessor :finish
+
+    # Applies the fee based on the volume of a resource.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Txn.** The total amount of all transactions.
+    # - `2` - **Txn-TaxID.** The total amount of all transactions per entity
+    # EIN/tax ID.
+    # - `3` - **Txn-Merchant.** The total amount of all transactions per entity.
+    # </details>
+    # @return [FeeCollectionEnum]
+    attr_accessor :collection
+
+    # A multiplier that you can use to adjust the set of data to be used in the
+    # collection calculation. 
+    # This field is specified as an integer and its value determines the period
+    # of time to be used.
+    # @return [Integer]
+    attr_accessor :collection_factor
+
+    # The number of days, weeks, months or years to go back when selecting data
+    # for collection calculation.
+    # @return [Integer]
+    attr_accessor :collection_offset
+
+    # Whether to include the current period for the colleciton calculation.
+    # @return [Integer]
+    attr_accessor :collection_include_current
+
+    # The unit of measure for this Fee.
+    # Notes: 
+    #   * Percentage and Surcharge units will only apply to Fee schedules set to
+    # trigger from monetary events, such as an authorization, capture, or
+    # refund.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Percentage.** The Fee is a percentage of the related event
+    # amount, specified in the 'amount' field in basis points.
+    # - `2` - **Fixed Amount.** The Fee is a fixed amount, specified in the
+    # 'amount' field as an integer in cents.
+    # - `3` - **Surcharge.** The Fee is a percentage of the related event amount
+    # as a surcharge (the calculated amount will be based on the assumption that
+    # the related event amount already contains the fee amount in it), specified
+    # in the 'amount' field in basis points.
+    # </details>
+    # @return [FeeUmEnum]
+    attr_accessor :um
+
+    # The total amount of this Fee. 
+    # The units used in this field are determined by the value of the 'um' field
+    # on the Fee. If the 'um' field is set to 'percentage', then this field
+    # specifies the Fee percentage to levy in basis points. If the 'um' field is
+    # set to 'amount', then this field specifies in cents(up to three decimal
+    # points)
+    # @return [Float]
+    attr_accessor :amount
+
+    # The maximum amount to charge for this fee when setting a percent-based
+    # fee. 
+    # * Will be `null` for all other units.
+    # @return [Float]
+    attr_accessor :maximum
+
+    # The currency of the amount in Fees resource. See <a
+    # href="https://www.iban.com/currency-codes" target="_blank">Currency
+    # codes</a>  for all valid values.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # Indicator to extract fee from txn supplied fee. When set, amount will
+    # correspond to the fee amount in the txn and only that amount will be
+    # extractable, anything over that amount will not be extracted.
+    # <details><summary>Valid Values</summary>
+    # - `0` - **Disabled.** Fee will be calculated normally.
+    # - `1` - **Enabled.** Fee will be calculated based on transaction fee.
+    # </details>
+    # @return [TxnFeeEnum]
+    attr_accessor :txn_fee
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[FeeModifiersResponse]]
+    attr_accessor :fee_modifiers
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[FeeRulesResponse]]
+    attr_accessor :fee_rules
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[AssessmentsResponse]]
+    attr_accessor :assessments
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[BillingEventsResponse]]
+    attr_accessor :billing_events
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[EntriesResponse]]
+    attr_accessor :entries
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[PendingEntriesResponse]]
+    attr_accessor :pending_entries
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [Array[StatementEntriesResponse]]
+    attr_accessor :statement_entries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['entity'] = 'entity'
+      @_hash['forentity'] = 'forentity'
+      @_hash['org'] = 'org'
+      @_hash['partition'] = 'partition'
+      @_hash['type'] = 'type'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['schedule'] = 'schedule'
+      @_hash['schedule_factor'] = 'scheduleFactor'
+      @_hash['start'] = 'start'
+      @_hash['finish'] = 'finish'
+      @_hash['collection'] = 'collection'
+      @_hash['collection_factor'] = 'collectionFactor'
+      @_hash['collection_offset'] = 'collectionOffset'
+      @_hash['collection_include_current'] = 'collectionIncludeCurrent'
+      @_hash['um'] = 'um'
+      @_hash['amount'] = 'amount'
+      @_hash['maximum'] = 'maximum'
+      @_hash['currency'] = 'currency'
+      @_hash['txn_fee'] = 'txnFee'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['fee_modifiers'] = 'feeModifiers'
+      @_hash['fee_rules'] = 'feeRules'
+      @_hash['assessments'] = 'assessments'
+      @_hash['billing_events'] = 'billingEvents'
+      @_hash['entries'] = 'entries'
+      @_hash['pending_entries'] = 'pendingEntries'
+      @_hash['statement_entries'] = 'statementEntries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        entity
+        forentity
+        org
+        partition
+        type
+        name
+        description
+        schedule
+        schedule_factor
+        start
+        finish
+        collection
+        collection_factor
+        collection_offset
+        collection_include_current
+        um
+        amount
+        maximum
+        currency
+        txn_fee
+        inactive
+        frozen
+        fee_modifiers
+        fee_rules
+        assessments
+        billing_events
+        entries
+        pending_entries
+        statement_entries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency
+      ]
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, entity = SKIP, forentity = SKIP, org = SKIP,
+                   partition = SKIP, type = FeeTypeEnum::FEE, name = SKIP,
+                   description = SKIP, schedule = SKIP, schedule_factor = SKIP,
+                   start = SKIP, finish = SKIP, collection = SKIP,
+                   collection_factor = SKIP, collection_offset = SKIP,
+                   collection_include_current = SKIP, um = SKIP, amount = SKIP,
+                   maximum = SKIP, currency = SKIP, txn_fee = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, fee_modifiers = SKIP,
+                   fee_rules = SKIP, assessments = SKIP, billing_events = SKIP,
+                   entries = SKIP, pending_entries = SKIP,
+                   statement_entries = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @entity = entity unless entity == SKIP
+      @forentity = forentity unless forentity == SKIP
+      @org = org unless org == SKIP
+      @partition = partition unless partition == SKIP
+      @type = type unless type == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @schedule = schedule unless schedule == SKIP
+      @schedule_factor = schedule_factor unless schedule_factor == SKIP
+      @start = start unless start == SKIP
+      @finish = finish unless finish == SKIP
+      @collection = collection unless collection == SKIP
+      @collection_factor = collection_factor unless collection_factor == SKIP
+      @collection_offset = collection_offset unless collection_offset == SKIP
+      unless collection_include_current == SKIP
+        @collection_include_current =
+          collection_include_current
+      end
+      @um = um unless um == SKIP
+      @amount = amount unless amount == SKIP
+      @maximum = maximum unless maximum == SKIP
+      @currency = currency unless currency == SKIP
+      @txn_fee = txn_fee unless txn_fee == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @fee_modifiers = fee_modifiers unless fee_modifiers == SKIP
+      @fee_rules = fee_rules unless fee_rules == SKIP
+      @assessments = assessments unless assessments == SKIP
+      @billing_events = billing_events unless billing_events == SKIP
+      @entries = entries unless entries == SKIP
+      @pending_entries = pending_entries unless pending_entries == SKIP
+      @statement_entries = statement_entries unless statement_entries == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FeesResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      entity = hash.key?('entity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FeesResponseEntity), hash['entity']
+      ) : SKIP
+      forentity = hash.key?('forentity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FeesResponseForentity), hash['forentity']
+      ) : SKIP
+      org = hash.key?('org') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FeesResponseOrg), hash['org']
+      ) : SKIP
+      partition = hash.key?('partition') ? hash['partition'] : SKIP
+      type = hash['type'] ||= FeeTypeEnum::FEE
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      schedule = hash.key?('schedule') ? hash['schedule'] : SKIP
+      schedule_factor =
+        hash.key?('scheduleFactor') ? hash['scheduleFactor'] : SKIP
+      start = hash.key?('start') ? hash['start'] : SKIP
+      finish = hash.key?('finish') ? hash['finish'] : SKIP
+      collection = hash.key?('collection') ? hash['collection'] : SKIP
+      collection_factor =
+        hash.key?('collectionFactor') ? hash['collectionFactor'] : SKIP
+      collection_offset =
+        hash.key?('collectionOffset') ? hash['collectionOffset'] : SKIP
+      collection_include_current =
+        hash.key?('collectionIncludeCurrent') ? hash['collectionIncludeCurrent'] : SKIP
+      um = hash.key?('um') ? hash['um'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      maximum = hash.key?('maximum') ? hash['maximum'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      txn_fee = hash.key?('txnFee') ? hash['txnFee'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      # Parameter is an array, so we need to iterate through it
+      fee_modifiers = nil
+      unless hash['feeModifiers'].nil?
+        fee_modifiers = []
+        hash['feeModifiers'].each do |structure|
+          fee_modifiers << (FeeModifiersResponse.from_hash(structure) if structure)
+        end
+      end
+
+      fee_modifiers = SKIP unless hash.key?('feeModifiers')
+      # Parameter is an array, so we need to iterate through it
+      fee_rules = nil
+      unless hash['feeRules'].nil?
+        fee_rules = []
+        hash['feeRules'].each do |structure|
+          fee_rules << (FeeRulesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      fee_rules = SKIP unless hash.key?('feeRules')
+      # Parameter is an array, so we need to iterate through it
+      assessments = nil
+      unless hash['assessments'].nil?
+        assessments = []
+        hash['assessments'].each do |structure|
+          assessments << (AssessmentsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      assessments = SKIP unless hash.key?('assessments')
+      # Parameter is an array, so we need to iterate through it
+      billing_events = nil
+      unless hash['billingEvents'].nil?
+        billing_events = []
+        hash['billingEvents'].each do |structure|
+          billing_events << (BillingEventsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      billing_events = SKIP unless hash.key?('billingEvents')
+      # Parameter is an array, so we need to iterate through it
+      entries = nil
+      unless hash['entries'].nil?
+        entries = []
+        hash['entries'].each do |structure|
+          entries << (EntriesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      entries = SKIP unless hash.key?('entries')
+      # Parameter is an array, so we need to iterate through it
+      pending_entries = nil
+      unless hash['pendingEntries'].nil?
+        pending_entries = []
+        hash['pendingEntries'].each do |structure|
+          pending_entries << (PendingEntriesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      pending_entries = SKIP unless hash.key?('pendingEntries')
+      # Parameter is an array, so we need to iterate through it
+      statement_entries = nil
+      unless hash['statementEntries'].nil?
+        statement_entries = []
+        hash['statementEntries'].each do |structure|
+          statement_entries << (StatementEntriesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      statement_entries = SKIP unless hash.key?('statementEntries')
+
+      # Create object from extracted values.
+      FeesResponse.new(id,
+                       created,
+                       modified,
+                       creator,
+                       modifier,
+                       entity,
+                       forentity,
+                       org,
+                       partition,
+                       type,
+                       name,
+                       description,
+                       schedule,
+                       schedule_factor,
+                       start,
+                       finish,
+                       collection,
+                       collection_factor,
+                       collection_offset,
+                       collection_include_current,
+                       um,
+                       amount,
+                       maximum,
+                       currency,
+                       txn_fee,
+                       inactive,
+                       frozen,
+                       fee_modifiers,
+                       fee_rules,
+                       assessments,
+                       billing_events,
+                       entries,
+                       pending_entries,
+                       statement_entries)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FeesResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, entity: #{@entity}, forentity: #{@forentity}, org:"\
+      " #{@org}, partition: #{@partition}, type: #{@type}, name: #{@name}, description:"\
+      " #{@description}, schedule: #{@schedule}, schedule_factor: #{@schedule_factor}, start:"\
+      " #{@start}, finish: #{@finish}, collection: #{@collection}, collection_factor:"\
+      " #{@collection_factor}, collection_offset: #{@collection_offset},"\
+      " collection_include_current: #{@collection_include_current}, um: #{@um}, amount:"\
+      " #{@amount}, maximum: #{@maximum}, currency: #{@currency}, txn_fee: #{@txn_fee}, inactive:"\
+      " #{@inactive}, frozen: #{@frozen}, fee_modifiers: #{@fee_modifiers}, fee_rules:"\
+      " #{@fee_rules}, assessments: #{@assessments}, billing_events: #{@billing_events}, entries:"\
+      " #{@entries}, pending_entries: #{@pending_entries}, statement_entries:"\
+      " #{@statement_entries}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect},"\
+      " entity: #{@entity.inspect}, forentity: #{@forentity.inspect}, org: #{@org.inspect},"\
+      " partition: #{@partition.inspect}, type: #{@type.inspect}, name: #{@name.inspect},"\
+      " description: #{@description.inspect}, schedule: #{@schedule.inspect}, schedule_factor:"\
+      " #{@schedule_factor.inspect}, start: #{@start.inspect}, finish: #{@finish.inspect},"\
+      " collection: #{@collection.inspect}, collection_factor: #{@collection_factor.inspect},"\
+      " collection_offset: #{@collection_offset.inspect}, collection_include_current:"\
+      " #{@collection_include_current.inspect}, um: #{@um.inspect}, amount: #{@amount.inspect},"\
+      " maximum: #{@maximum.inspect}, currency: #{@currency.inspect}, txn_fee:"\
+      " #{@txn_fee.inspect}, inactive: #{@inactive.inspect}, frozen: #{@frozen.inspect},"\
+      " fee_modifiers: #{@fee_modifiers.inspect}, fee_rules: #{@fee_rules.inspect}, assessments:"\
+      " #{@assessments.inspect}, billing_events: #{@billing_events.inspect}, entries:"\
+      " #{@entries.inspect}, pending_entries: #{@pending_entries.inspect}, statement_entries:"\
+      " #{@statement_entries.inspect}>"
+    end
+  end
+end