modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/lib/modern_treasury/models/counterparty_list_params.rb

@@ -31,6 +31,12 @@ module ModernTreasury
       #   @return [String, nil]
       optional :email, String
 
+      # @!attribute external_id
+      #   An optional user-defined 180 character unique identifier.
+      #
+      #   @return [String, nil]
+      optional :external_id, String
+
       # @!attribute legal_entity_id
       #   Filters for counterparties with the given legal entity ID.
       #
@@ -57,7 +63,7 @@ module ModernTreasury
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!method initialize(after_cursor: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {})
+      # @!method initialize(after_cursor: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, external_id: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::CounterpartyListParams} for more details.
       #
@@ -69,6 +75,8 @@ module ModernTreasury
       #
       #   @param email [String] Performs a partial string match of the email field. This is also case insensitiv
       #
+      #   @param external_id [String] An optional user-defined 180 character unique identifier.
+      #
       #   @param legal_entity_id [String] Filters for counterparties with the given legal entity ID.
       #
       #   @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value

data/lib/modern_treasury/models/document.rb

@@ -39,8 +39,8 @@ module ModernTreasury
 
       # @!attribute documentable_type
       #   The type of the associated object. Currently can be one of `payment_order`,
-      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #   `case`, `internal_account`, `decision`, or `external_account`.
+      #   `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
+      #   `internal_account`, `decision`, or `external_account`.
       #
       #   @return [Symbol, ModernTreasury::Models::Document::DocumentableType]
       required :documentable_type, enum: -> { ModernTreasury::Document::DocumentableType }
@@ -166,8 +166,8 @@ module ModernTreasury
       end
 
       # The type of the associated object. Currently can be one of `payment_order`,
-      # `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      # `case`, `internal_account`, `decision`, or `external_account`.
+      # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
+      # `internal_account`, `decision`, or `external_account`.
       #
       # @see ModernTreasury::Models::Document#documentable_type
       module DocumentableType
@@ -180,11 +180,9 @@ module ModernTreasury
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         INTERNAL_ACCOUNT = :internal_account
         ORGANIZATION = :organization
-        PAPER_ITEM = :paper_item
         PAYMENT_ORDER = :payment_order
         TRANSACTION = :transaction
         CONNECTION = :connection
-        CONVERSATION = :conversation
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/modern_treasury/models/document_create_params.rb

@@ -50,11 +50,9 @@ module ModernTreasury
         INCOMING_PAYMENT_DETAILS = :incoming_payment_details
         INTERNAL_ACCOUNTS = :internal_accounts
         ORGANIZATIONS = :organizations
-        PAPER_ITEMS = :paper_items
         PAYMENT_ORDERS = :payment_orders
         TRANSACTIONS = :transactions
         CONNECTIONS = :connections
-        CONVERSATIONS = :conversations
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/modern_treasury/models/document_list_params.rb

@@ -20,8 +20,8 @@ module ModernTreasury
 
       # @!attribute documentable_type
       #   The type of the associated object. Currently can be one of `payment_order`,
-      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #   `case`, `internal_account`, `decision`, or `external_account`.
+      #   `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
+      #   `internal_account`, `decision`, or `external_account`.
       #
       #   @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType, nil]
       optional :documentable_type, enum: -> { ModernTreasury::DocumentListParams::DocumentableType }
@@ -46,8 +46,8 @@ module ModernTreasury
       #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of the associated object. Currently can be one of `payment_order`,
-      # `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      # `case`, `internal_account`, `decision`, or `external_account`.
+      # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
+      # `internal_account`, `decision`, or `external_account`.
       module DocumentableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -58,11 +58,9 @@ module ModernTreasury
         INCOMING_PAYMENT_DETAILS = :incoming_payment_details
         INTERNAL_ACCOUNTS = :internal_accounts
         ORGANIZATIONS = :organizations
-        PAPER_ITEMS = :paper_items
         PAYMENT_ORDERS = :payment_orders
         TRANSACTIONS = :transactions
         CONNECTIONS = :connections
-        CONVERSATIONS = :conversations
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/modern_treasury/models/expected_payment.rb

@@ -65,6 +65,12 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil]
       required :direction, enum: -> { ModernTreasury::ExpectedPayment::Direction }, nil?: true
 
+      # @!attribute external_id
+      #   An optional user-defined 180 character unique identifier.
+      #
+      #   @return [String, nil]
+      required :external_id, String, nil?: true
+
       # @!attribute internal_account_id
       #   The ID of the Internal Account for the expected payment.
       #
@@ -173,7 +179,7 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!method initialize(id:, amount_lower_bound:, amount_upper_bound:, counterparty_id:, created_at:, currency:, date_lower_bound:, date_upper_bound:, description:, direction:, internal_account_id:, ledger_transaction_id:, live_mode:, metadata:, object:, reconciliation_filters:, reconciliation_groups:, reconciliation_method:, reconciliation_rule_variables:, remittance_information:, statement_descriptor:, status:, transaction_id:, transaction_line_item_id:, type:, updated_at:)
+      # @!method initialize(id:, amount_lower_bound:, amount_upper_bound:, counterparty_id:, created_at:, currency:, date_lower_bound:, date_upper_bound:, description:, direction:, external_id:, internal_account_id:, ledger_transaction_id:, live_mode:, metadata:, object:, reconciliation_filters:, reconciliation_groups:, reconciliation_method:, reconciliation_rule_variables:, remittance_information:, statement_descriptor:, status:, transaction_id:, transaction_line_item_id:, type:, updated_at:)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::ExpectedPayment} for more details.
       #
@@ -197,6 +203,8 @@ module ModernTreasury
       #
       #   @param direction [Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
       #
+      #   @param external_id [String, nil] An optional user-defined 180 character unique identifier.
+      #
       #   @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
       #
       #   @param ledger_transaction_id [String, nil] The ID of the ledger transaction linked to the expected payment.

data/lib/modern_treasury/models/expected_payment_create_params.rb

@@ -58,6 +58,12 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil]
       optional :direction, enum: -> { ModernTreasury::ExpectedPaymentCreateParams::Direction }, nil?: true
 
+      # @!attribute external_id
+      #   An optional user-defined 180 character unique identifier.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
       # @!attribute internal_account_id
       #   The ID of the Internal Account for the expected payment.
       #
@@ -70,8 +76,8 @@ module ModernTreasury
       #   creation will fail. The resulting ledger transaction will mirror the status of
       #   the expected payment.
       #
-      #   @return [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction, nil]
-      optional :ledger_transaction, -> { ModernTreasury::ExpectedPaymentCreateParams::LedgerTransaction }
+      #   @return [ModernTreasury::Models::LedgerTransactionCreateRequest, nil]
+      optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }
 
       # @!attribute ledger_transaction_id
       #   Either ledger_transaction or ledger_transaction_id can be provided. Only a
@@ -141,7 +147,7 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
       optional :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
 
-      # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
+      # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::ExpectedPaymentCreateParams} for more details.
       #
@@ -161,9 +167,11 @@ module ModernTreasury
       #
       #   @param direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
       #
+      #   @param external_id [String, nil] An optional user-defined 180 character unique identifier.
+      #
       #   @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
       #
-      #   @param ledger_transaction [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction] Specifies a ledger transaction object that will be created with the expected pay
+      #   @param ledger_transaction [ModernTreasury::Models::LedgerTransactionCreateRequest] Specifies a ledger transaction object that will be created with the expected pay
       #
       #   @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
       #
@@ -197,232 +205,6 @@ module ModernTreasury
         #   @return [Array<Symbol>]
       end
 
-      class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute ledger_entries
-        #   An array of ledger entry objects.
-        #
-        #   @return [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry>]
-        required :ledger_entries,
-                 -> {
-                   ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry]
-                 }
-
-        # @!attribute description
-        #   An optional description for internal use.
-        #
-        #   @return [String, nil]
-        optional :description, String, nil?: true
-
-        # @!attribute effective_at
-        #   The timestamp (ISO8601 format) at which the ledger transaction happened for
-        #   reporting purposes.
-        #
-        #   @return [Time, nil]
-        optional :effective_at, Time
-
-        # @!attribute effective_date
-        #   The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-        #   purposes.
-        #
-        #   @return [Date, nil]
-        optional :effective_date, Date
-
-        # @!attribute external_id
-        #   A unique string to represent the ledger transaction. Only one pending or posted
-        #   ledger transaction may have this ID in the ledger.
-        #
-        #   @return [String, nil]
-        optional :external_id, String
-
-        # @!attribute ledgerable_id
-        #   If the ledger transaction can be reconciled to another object in Modern
-        #   Treasury, the id will be populated here, otherwise null.
-        #
-        #   @return [String, nil]
-        optional :ledgerable_id, String
-
-        # @!attribute ledgerable_type
-        #   If the ledger transaction can be reconciled to another object in Modern
-        #   Treasury, the type will be populated here, otherwise null. This can be one of
-        #   payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-        #   reversal.
-        #
-        #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerableType, nil]
-        optional :ledgerable_type,
-                 enum: -> { ModernTreasury::ExpectedPaymentCreateParams::LedgerTransaction::LedgerableType }
-
-        # @!attribute metadata
-        #   Additional data represented as key-value pairs. Both the key and value must be
-        #   strings.
-        #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
-
-        # @!attribute status
-        #   To post a ledger transaction at creation, use `posted`.
-        #
-        #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::Status, nil]
-        optional :status, enum: -> { ModernTreasury::ExpectedPaymentCreateParams::LedgerTransaction::Status }
-
-        # @!method initialize(ledger_entries:, description: nil, effective_at: nil, effective_date: nil, external_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction} for
-        #   more details.
-        #
-        #   Specifies a ledger transaction object that will be created with the expected
-        #   payment. If the ledger transaction cannot be created, then the expected payment
-        #   creation will fail. The resulting ledger transaction will mirror the status of
-        #   the expected payment.
-        #
-        #   @param ledger_entries [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry>] An array of ledger entry objects.
-        #
-        #   @param description [String, nil] An optional description for internal use.
-        #
-        #   @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
-        #
-        #   @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
-        #
-        #   @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
-        #
-        #   @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
-        #
-        #   @param ledgerable_type [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
-        #
-        #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
-        #
-        #   @param status [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::Status] To post a ledger transaction at creation, use `posted`.
-
-        class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute amount
-          #   Value in specified currency's smallest unit. e.g. $10 would be represented
-          #   as 1000. Can be any integer up to 36 digits.
-          #
-          #   @return [Integer]
-          required :amount, Integer
-
-          # @!attribute direction
-          #   One of `credit`, `debit`. Describes the direction money is flowing in the
-          #   transaction. A `credit` moves money from your account to someone else's. A
-          #   `debit` pulls money from someone else's account to your own. Note that wire,
-          #   rtp, and check payments will always be `credit`.
-          #
-          #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
-          required :direction, enum: -> { ModernTreasury::TransactionDirection }
-
-          # @!attribute ledger_account_id
-          #   The ledger account that this ledger entry is associated with.
-          #
-          #   @return [String]
-          required :ledger_account_id, String
-
-          # @!attribute available_balance_amount
-          #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-          #   account’s available balance. If any of these conditions would be false after the
-          #   transaction is created, the entire call will fail with error code 422.
-          #
-          #   @return [Hash{Symbol=>Integer}, nil]
-          optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
-
-          # @!attribute lock_version
-          #   Lock version of the ledger account. This can be passed when creating a ledger
-          #   transaction to only succeed if no ledger transactions have posted since the
-          #   given version. See our post about Designing the Ledgers API with Optimistic
-          #   Locking for more details.
-          #
-          #   @return [Integer, nil]
-          optional :lock_version, Integer, nil?: true
-
-          # @!attribute metadata
-          #   Additional data represented as key-value pairs. Both the key and value must be
-          #   strings.
-          #
-          #   @return [Hash{Symbol=>String}, nil]
-          optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
-
-          # @!attribute pending_balance_amount
-          #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-          #   account’s pending balance. If any of these conditions would be false after the
-          #   transaction is created, the entire call will fail with error code 422.
-          #
-          #   @return [Hash{Symbol=>Integer}, nil]
-          optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
-
-          # @!attribute posted_balance_amount
-          #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-          #   account’s posted balance. If any of these conditions would be false after the
-          #   transaction is created, the entire call will fail with error code 422.
-          #
-          #   @return [Hash{Symbol=>Integer}, nil]
-          optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
-
-          # @!attribute show_resulting_ledger_account_balances
-          #   If true, response will include the balance of the associated ledger account for
-          #   the entry.
-          #
-          #   @return [Boolean, nil]
-          optional :show_resulting_ledger_account_balances,
-                   ModernTreasury::Internal::Type::Boolean,
-                   nil?: true
-
-          # @!method initialize(amount:, direction:, ledger_account_id:, available_balance_amount: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry}
-          #   for more details.
-          #
-          #   @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
-          #
-          #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
-          #
-          #   @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
-          #
-          #   @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
-          #
-          #   @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
-          #
-          #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
-          #
-          #   @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
-          #
-          #   @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
-          #
-          #   @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
-        end
-
-        # If the ledger transaction can be reconciled to another object in Modern
-        # Treasury, the type will be populated here, otherwise null. This can be one of
-        # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-        # reversal.
-        #
-        # @see ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction#ledgerable_type
-        module LedgerableType
-          extend ModernTreasury::Internal::Type::Enum
-
-          EXPECTED_PAYMENT = :expected_payment
-          INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
-          PAPER_ITEM = :paper_item
-          PAYMENT_ORDER = :payment_order
-          RETURN = :return
-          REVERSAL = :reversal
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # To post a ledger transaction at creation, use `posted`.
-        #
-        # @see ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction#status
-        module Status
-          extend ModernTreasury::Internal::Type::Enum
-
-          ARCHIVED = :archived
-          PENDING = :pending
-          POSTED = :posted
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       class LineItem < ModernTreasury::Internal::Type::BaseModel
         # @!attribute amount
         #   Value in specified currency's smallest unit. e.g. $10 would be represented

data/lib/modern_treasury/models/expected_payment_list_params.rb

@@ -36,6 +36,11 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::TransactionDirection, nil]
       optional :direction, enum: -> { ModernTreasury::TransactionDirection }
 
+      # @!attribute external_id
+      #
+      #   @return [String, nil]
+      optional :external_id, String
+
       # @!attribute internal_account_id
       #   Specify internal_account_id to see expected_payments for a specific account.
       #
@@ -80,7 +85,7 @@ module ModernTreasury
       #   @return [Time, nil]
       optional :updated_at_upper_bound, Time
 
-      # @!method initialize(after_cursor: nil, counterparty_id: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, direction: nil, internal_account_id: nil, metadata: nil, per_page: nil, status: nil, type: nil, updated_at_lower_bound: nil, updated_at_upper_bound: nil, request_options: {})
+      # @!method initialize(after_cursor: nil, counterparty_id: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, per_page: nil, status: nil, type: nil, updated_at_lower_bound: nil, updated_at_upper_bound: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::ExpectedPaymentListParams} for more details.
       #
@@ -94,6 +99,8 @@ module ModernTreasury
       #
       #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of credit, debit
       #
+      #   @param external_id [String]
+      #
       #   @param internal_account_id [String] Specify internal_account_id to see expected_payments for a specific account.
       #
       #   @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value

data/lib/modern_treasury/models/expected_payment_update_params.rb

@@ -58,6 +58,12 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction, nil]
       optional :direction, enum: -> { ModernTreasury::ExpectedPaymentUpdateParams::Direction }, nil?: true
 
+      # @!attribute external_id
+      #   An optional user-defined 180 character unique identifier.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
       # @!attribute internal_account_id
       #   The ID of the Internal Account for the expected payment.
       #
@@ -122,7 +128,7 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
       optional :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
 
-      # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
+      # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::ExpectedPaymentUpdateParams} for more details.
       #
@@ -142,6 +148,8 @@ module ModernTreasury
       #
       #   @param direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
       #
+      #   @param external_id [String, nil] An optional user-defined 180 character unique identifier.
+      #
       #   @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
       #
       #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s