Class: ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/bulk_request_create_params.rb

Defined Under Namespace

Modules: Type

Instance Attribute 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(amount: , as_of_date: , direction: , internal_account_id: , vendor_code: , vendor_code_type: , metadata: nil, posted: nil, type: nil, vendor_customer_id: nil, vendor_description: nil) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest for more details.

Parameters:

  • amount (Integer) (defaults to: ) —

    Value in specified currency’s smallest unit. e.g. $10 would be represented as 10

  • as_of_date (Date, nil) (defaults to: ) —

    The date on which the transaction occurred.

  • direction (String) (defaults to: ) —

    Either ‘credit` or `debit`.

  • internal_account_id (String) (defaults to: ) —

    The ID of the relevant Internal Account.

  • vendor_code (String, nil) (defaults to: ) —

    When applicable, the bank-given code that determines the transaction’s category.

  • vendor_code_type (String, nil) (defaults to: ) —

    The type of ‘vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • posted (Boolean) (defaults to: nil) —

    This field will be ‘true` if the transaction has posted to the account.

  • type (Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type, nil) (defaults to: nil) —

    The type of the transaction. Examples could be ‘card, `ach`, `wire`, `check`, `r

  • vendor_customer_id (String, nil) (defaults to: nil) —

    An identifier given to this transaction by the bank, often ‘null`.

  • vendor_description (String, nil) (defaults to: nil) —

    The transaction detail text that often appears in on your bank statement and in




# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1243

Instance Attribute Details

#amount ⇒ Integer

Value in specified currency’s smallest unit. e.g. $10 would be represented as 1000.

Returns:

  • (Integer) 


1170
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1170

required :amount, Integer

#as_of_date ⇒ Date?

The date on which the transaction occurred.

Returns:

  • (Date, nil) 


1176
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1176

required :as_of_date, Date, nil?: true

#direction ⇒ String

Either ‘credit` or `debit`.

Returns:

  • (String) 


1182
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1182

required :direction, String

#internal_account_id ⇒ String

The ID of the relevant Internal Account.

Returns:

  • (String) 


1188
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1188

required :internal_account_id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}, nil) 


1211
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1211

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#posted ⇒ Boolean?

This field will be ‘true` if the transaction has posted to the account.

Returns:

  • (Boolean, nil) 


1217
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1217

optional :posted, ModernTreasury::Internal::Type::Boolean

#type ⇒ Symbol, ...

The type of the transaction. Examples could be ‘card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.

Returns:



1224
1225
1226
1227
1228
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1224

optional :type,
enum: -> {
  ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type
},
nil?: true

#vendor_code ⇒ String?

When applicable, the bank-given code that determines the transaction’s category. For most banks this is the BAI2/BTRS transaction code.

Returns:

  • (String, nil) 


1195
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1195

required :vendor_code, String, nil?: true

#vendor_code_type ⇒ String?

The type of ‘vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`, `swift`, `us_bank`, or others.

Returns:

  • (String, nil) 


1204
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1204

required :vendor_code_type, String, nil?: true

#vendor_customer_id ⇒ String?

An identifier given to this transaction by the bank, often ‘null`.

Returns:

  • (String, nil) 


1234
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1234

optional :vendor_customer_id, String, nil?: true

#vendor_description ⇒ String?

The transaction detail text that often appears in on your bank statement and in your banking portal.

Returns:

  • (String, nil) 


1241
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 1241

optional :vendor_description, String, nil?: true