modern_treasury 0.1.0.pre.alpha.22 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +38 -0
- data/README.md +1 -1
- data/lib/modern_treasury/client.rb +0 -12
- data/lib/modern_treasury/internal/transport/base_client.rb +1 -1
- data/lib/modern_treasury/internal/type/base_model.rb +4 -4
- data/lib/modern_treasury/models/accounting.rb +30 -0
- data/lib/modern_treasury/models/address.rb +94 -0
- data/lib/modern_treasury/models/address_request.rb +54 -0
- data/lib/modern_treasury/models/bulk_request_create_params.rb +144 -1505
- data/lib/modern_treasury/models/child_legal_entity_create.rb +275 -0
- data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +10 -627
- data/lib/modern_treasury/models/contact_detail.rb +81 -0
- data/lib/modern_treasury/models/contact_detail_create_request.rb +34 -0
- data/lib/modern_treasury/models/counterparty.rb +24 -177
- data/lib/modern_treasury/models/counterparty_create_params.rb +37 -838
- data/lib/modern_treasury/models/counterparty_list_params.rb +9 -1
- data/lib/modern_treasury/models/document.rb +4 -6
- data/lib/modern_treasury/models/document_create_params.rb +0 -2
- data/lib/modern_treasury/models/document_list_params.rb +4 -6
- data/lib/modern_treasury/models/expected_payment.rb +9 -1
- data/lib/modern_treasury/models/expected_payment_create_params.rb +12 -230
- data/lib/modern_treasury/models/expected_payment_list_params.rb +8 -1
- data/lib/modern_treasury/models/expected_payment_update_params.rb +9 -1
- data/lib/modern_treasury/models/external_account.rb +15 -177
- data/lib/modern_treasury/models/external_account_create_params.rb +18 -210
- data/lib/modern_treasury/models/external_account_list_params.rb +9 -1
- data/lib/modern_treasury/models/external_account_update_params.rb +3 -52
- data/lib/modern_treasury/models/foreign_exchange_quote.rb +3 -73
- data/lib/modern_treasury/models/foreign_exchange_rate.rb +71 -0
- data/lib/modern_treasury/models/identification_create_request.rb +86 -0
- data/lib/modern_treasury/models/internal_account.rb +3 -95
- data/lib/modern_treasury/models/internal_account_update_account_capability_params.rb +34 -0
- data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +131 -0
- data/lib/modern_treasury/models/invoice.rb +3 -81
- data/lib/modern_treasury/models/invoice_create_params.rb +3 -83
- data/lib/modern_treasury/models/invoice_update_params.rb +3 -83
- data/lib/modern_treasury/models/ledger_account.rb +9 -141
- data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +3 -182
- data/lib/modern_treasury/models/ledger_account_category.rb +3 -175
- data/lib/modern_treasury/models/ledger_account_category_list_params.rb +9 -5
- data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +4 -2
- data/lib/modern_treasury/models/ledger_account_create_params.rb +2 -105
- data/lib/modern_treasury/models/ledger_account_create_request.rb +113 -0
- data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +6 -360
- data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +6 -360
- data/lib/modern_treasury/models/ledger_balance.rb +45 -0
- data/lib/modern_treasury/models/ledger_balances.rb +38 -0
- data/lib/modern_treasury/models/ledger_entry.rb +3 -183
- data/lib/modern_treasury/models/ledger_entry_create_request.rb +98 -0
- data/lib/modern_treasury/models/ledger_entry_list_params.rb +48 -8
- data/lib/modern_treasury/models/ledger_transaction.rb +14 -6
- data/lib/modern_treasury/models/ledger_transaction_create_params.rb +2 -212
- data/lib/modern_treasury/models/ledger_transaction_create_request.rb +123 -0
- data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +0 -1
- data/lib/modern_treasury/models/ledger_transaction_list_params.rb +44 -7
- data/lib/modern_treasury/models/ledger_transaction_update_params.rb +5 -104
- data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +15 -193
- data/lib/modern_treasury/models/legal_entity_address_create_request.rb +78 -0
- data/lib/modern_treasury/models/legal_entity_association.rb +1 -0
- data/lib/modern_treasury/models/legal_entity_association_create_params.rb +4 -448
- data/lib/modern_treasury/models/legal_entity_create_params.rb +10 -618
- data/lib/modern_treasury/models/legal_entity_update_params.rb +6 -165
- data/lib/modern_treasury/models/line_item.rb +3 -29
- data/lib/modern_treasury/models/payment_action_list_params.rb +1 -0
- data/lib/modern_treasury/models/payment_order.rb +13 -102
- data/lib/modern_treasury/models/payment_order_create_async_params.rb +24 -477
- data/lib/modern_treasury/models/payment_order_create_params.rb +24 -479
- data/lib/modern_treasury/models/payment_order_update_params.rb +21 -248
- data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +3 -232
- data/lib/modern_treasury/models/payment_reference.rb +7 -1
- data/lib/modern_treasury/models/return_list_params.rb +5 -6
- data/lib/modern_treasury/models/return_object.rb +7 -3
- data/lib/modern_treasury/models/routing_detail.rb +3 -93
- data/lib/modern_treasury/models/routing_number_lookup_request.rb +3 -55
- data/lib/modern_treasury/models/transaction.rb +5 -73
- data/lib/modern_treasury/models/transactions/transaction_line_item.rb +0 -1
- data/lib/modern_treasury/models/virtual_account_create_params.rb +3 -117
- data/lib/modern_treasury/models.rb +31 -6
- data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
- data/lib/modern_treasury/resources/counterparties.rb +20 -14
- data/lib/modern_treasury/resources/expected_payments.rb +10 -4
- data/lib/modern_treasury/resources/external_accounts.rb +23 -17
- data/lib/modern_treasury/resources/internal_accounts.rb +34 -0
- data/lib/modern_treasury/resources/invoices.rb +2 -2
- data/lib/modern_treasury/resources/ledger_account_categories.rb +1 -1
- data/lib/modern_treasury/resources/ledger_accounts.rb +1 -1
- data/lib/modern_treasury/resources/ledger_entries.rb +1 -1
- data/lib/modern_treasury/resources/ledger_transactions.rb +5 -5
- data/lib/modern_treasury/resources/legal_entities.rb +4 -4
- data/lib/modern_treasury/resources/legal_entity_associations.rb +1 -1
- data/lib/modern_treasury/resources/payment_orders/reversals.rb +1 -1
- data/lib/modern_treasury/resources/payment_orders.rb +5 -5
- data/lib/modern_treasury/resources/returns.rb +1 -1
- data/lib/modern_treasury/resources/virtual_accounts.rb +1 -1
- data/lib/modern_treasury/version.rb +1 -1
- data/lib/modern_treasury.rb +16 -6
- data/rbi/modern_treasury/client.rbi +0 -9
- data/rbi/modern_treasury/internal/transport/base_client.rbi +1 -1
- data/rbi/modern_treasury/models/accounting.rbi +48 -0
- data/rbi/modern_treasury/models/address.rbi +107 -0
- data/rbi/modern_treasury/models/address_request.rbi +76 -0
- data/rbi/modern_treasury/models/bulk_request_create_params.rbi +701 -3140
- data/rbi/modern_treasury/models/child_legal_entity_create.rbi +511 -0
- data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +17 -1314
- data/rbi/modern_treasury/models/contact_detail.rbi +124 -0
- data/rbi/modern_treasury/models/contact_detail_create_request.rbi +99 -0
- data/rbi/modern_treasury/models/counterparty.rbi +24 -264
- data/rbi/modern_treasury/models/counterparty_create_params.rbi +47 -1718
- data/rbi/modern_treasury/models/counterparty_list_params.rbi +11 -0
- data/rbi/modern_treasury/models/document.rbi +6 -16
- data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
- data/rbi/modern_treasury/models/document_list_params.rbi +6 -16
- data/rbi/modern_treasury/models/expected_payment.rbi +8 -0
- data/rbi/modern_treasury/models/expected_payment_create_params.rbi +12 -419
- data/rbi/modern_treasury/models/expected_payment_list_params.rbi +9 -0
- data/rbi/modern_treasury/models/expected_payment_update_params.rbi +8 -0
- data/rbi/modern_treasury/models/external_account.rbi +15 -244
- data/rbi/modern_treasury/models/external_account_create_params.rbi +20 -400
- data/rbi/modern_treasury/models/external_account_list_params.rbi +11 -0
- data/rbi/modern_treasury/models/external_account_update_params.rbi +4 -86
- data/rbi/modern_treasury/models/foreign_exchange_quote.rbi +4 -99
- data/rbi/modern_treasury/models/foreign_exchange_rate.rbi +96 -0
- data/rbi/modern_treasury/models/identification_create_request.rbi +212 -0
- data/rbi/modern_treasury/models/internal_account.rbi +4 -115
- data/rbi/modern_treasury/models/internal_account_update_account_capability_params.rbi +54 -0
- data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +304 -0
- data/rbi/modern_treasury/models/invoice.rbi +3 -128
- data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -139
- data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -139
- data/rbi/modern_treasury/models/ledger_account.rbi +12 -218
- data/rbi/modern_treasury/models/ledger_account_balance_monitor.rbi +4 -303
- data/rbi/modern_treasury/models/ledger_account_category.rbi +4 -301
- data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi +14 -7
- data/rbi/modern_treasury/models/ledger_account_category_retrieve_params.rbi +6 -3
- data/rbi/modern_treasury/models/ledger_account_create_params.rbi +5 -173
- data/rbi/modern_treasury/models/ledger_account_create_request.rbi +194 -0
- data/rbi/modern_treasury/models/ledger_account_statement_create_response.rbi +8 -612
- data/rbi/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +8 -612
- data/rbi/modern_treasury/models/ledger_balance.rbi +66 -0
- data/rbi/modern_treasury/models/ledger_balances.rbi +75 -0
- data/rbi/modern_treasury/models/ledger_entry.rbi +4 -309
- data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +137 -0
- data/rbi/modern_treasury/models/ledger_entry_list_params.rbi +99 -16
- data/rbi/modern_treasury/models/ledger_transaction.rbi +17 -11
- data/rbi/modern_treasury/models/ledger_transaction_create_params.rbi +5 -383
- data/rbi/modern_treasury/models/ledger_transaction_create_request.rbi +258 -0
- data/rbi/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +0 -5
- data/rbi/modern_treasury/models/ledger_transaction_list_params.rbi +93 -18
- data/rbi/modern_treasury/models/ledger_transaction_update_params.rbi +7 -158
- data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +18 -316
- data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +157 -0
- data/rbi/modern_treasury/models/legal_entity_association.rbi +5 -0
- data/rbi/modern_treasury/models/legal_entity_association_create_params.rbi +9 -917
- data/rbi/modern_treasury/models/legal_entity_create_params.rbi +17 -1297
- data/rbi/modern_treasury/models/legal_entity_update_params.rbi +8 -378
- data/rbi/modern_treasury/models/line_item.rbi +4 -52
- data/rbi/modern_treasury/models/payment_action_list_params.rbi +5 -0
- data/rbi/modern_treasury/models/payment_order.rbi +43 -159
- data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +28 -882
- data/rbi/modern_treasury/models/payment_order_create_params.rbi +28 -887
- data/rbi/modern_treasury/models/payment_order_update_params.rbi +24 -460
- data/rbi/modern_treasury/models/payment_orders/reversal_create_params.rbi +4 -415
- data/rbi/modern_treasury/models/payment_reference.rbi +35 -5
- data/rbi/modern_treasury/models/return_list_params.rbi +6 -11
- data/rbi/modern_treasury/models/return_object.rbi +35 -12
- data/rbi/modern_treasury/models/routing_detail.rbi +4 -113
- data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +4 -87
- data/rbi/modern_treasury/models/transaction.rbi +14 -103
- data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi +0 -5
- data/rbi/modern_treasury/models/virtual_account_create_params.rbi +4 -203
- data/rbi/modern_treasury/models.rbi +36 -6
- data/rbi/modern_treasury/resources/bulk_requests.rbi +2 -2
- data/rbi/modern_treasury/resources/counterparties.rbi +20 -12
- data/rbi/modern_treasury/resources/documents.rbi +2 -2
- data/rbi/modern_treasury/resources/expected_payments.rbi +9 -1
- data/rbi/modern_treasury/resources/external_accounts.rbi +29 -22
- data/rbi/modern_treasury/resources/internal_accounts.rbi +24 -0
- data/rbi/modern_treasury/resources/invoices.rbi +2 -8
- data/rbi/modern_treasury/resources/ledger_account_categories.rbi +7 -3
- data/rbi/modern_treasury/resources/ledger_accounts.rbi +1 -1
- data/rbi/modern_treasury/resources/ledger_entries.rbi +9 -2
- data/rbi/modern_treasury/resources/ledger_transactions.rbi +13 -13
- data/rbi/modern_treasury/resources/legal_entities.rbi +4 -8
- data/rbi/modern_treasury/resources/legal_entity_associations.rbi +1 -2
- data/rbi/modern_treasury/resources/payment_orders/reversals.rbi +1 -1
- data/rbi/modern_treasury/resources/payment_orders.rbi +5 -8
- data/rbi/modern_treasury/resources/returns.rbi +2 -2
- data/rbi/modern_treasury/resources/virtual_accounts.rbi +1 -2
- data/sig/modern_treasury/client.rbs +0 -6
- data/sig/modern_treasury/internal/transport/base_client.rbs +1 -1
- data/sig/modern_treasury/models/accounting.rbs +15 -0
- data/sig/modern_treasury/models/address.rbs +70 -0
- data/sig/modern_treasury/models/address_request.rbs +45 -0
- data/sig/modern_treasury/models/bulk_request_create_params.rbs +88 -1089
- data/sig/modern_treasury/models/child_legal_entity_create.rbs +220 -0
- data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -548
- data/sig/modern_treasury/models/contact_detail.rbs +67 -0
- data/sig/modern_treasury/models/contact_detail_create_request.rbs +43 -0
- data/sig/modern_treasury/models/counterparty.rbs +20 -141
- data/sig/modern_treasury/models/counterparty_create_params.rbs +49 -737
- data/sig/modern_treasury/models/counterparty_list_params.rbs +7 -0
- data/sig/modern_treasury/models/document.rbs +0 -4
- data/sig/modern_treasury/models/document_create_params.rbs +0 -4
- data/sig/modern_treasury/models/document_list_params.rbs +0 -4
- data/sig/modern_treasury/models/expected_payment.rbs +5 -0
- data/sig/modern_treasury/models/expected_payment_create_params.rbs +11 -173
- data/sig/modern_treasury/models/expected_payment_list_params.rbs +7 -0
- data/sig/modern_treasury/models/expected_payment_update_params.rbs +5 -0
- data/sig/modern_treasury/models/external_account.rbs +13 -139
- data/sig/modern_treasury/models/external_account_create_params.rbs +23 -189
- data/sig/modern_treasury/models/external_account_list_params.rbs +7 -0
- data/sig/modern_treasury/models/external_account_update_params.rbs +6 -48
- data/sig/modern_treasury/models/foreign_exchange_quote.rbs +4 -51
- data/sig/modern_treasury/models/foreign_exchange_rate.rbs +50 -0
- data/sig/modern_treasury/models/identification_create_request.rbs +93 -0
- data/sig/modern_treasury/models/internal_account.rbs +4 -71
- data/sig/modern_treasury/models/internal_account_update_account_capability_params.rbs +28 -0
- data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +137 -0
- data/sig/modern_treasury/models/invoice.rbs +4 -68
- data/sig/modern_treasury/models/invoice_create_params.rbs +6 -70
- data/sig/modern_treasury/models/invoice_update_params.rbs +6 -70
- data/sig/modern_treasury/models/ledger_account.rbs +12 -123
- data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +4 -142
- data/sig/modern_treasury/models/ledger_account_category.rbs +4 -142
- data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_create_params.rbs +4 -84
- data/sig/modern_treasury/models/ledger_account_create_request.rbs +89 -0
- data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +8 -284
- data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +8 -284
- data/sig/modern_treasury/models/ledger_balance.rbs +40 -0
- data/sig/modern_treasury/models/ledger_balances.rbs +30 -0
- data/sig/modern_treasury/models/ledger_entry.rbs +4 -142
- data/sig/modern_treasury/models/ledger_entry_create_request.rbs +62 -0
- data/sig/modern_treasury/models/ledger_entry_list_params.rbs +21 -3
- data/sig/modern_treasury/models/ledger_transaction.rbs +5 -2
- data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +4 -165
- data/sig/modern_treasury/models/ledger_transaction_create_request.rbs +109 -0
- data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +0 -2
- data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +21 -5
- data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +6 -67
- data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +9 -144
- data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +68 -0
- data/sig/modern_treasury/models/legal_entity_association.rbs +3 -1
- data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +9 -380
- data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -548
- data/sig/modern_treasury/models/legal_entity_update_params.rbs +12 -168
- data/sig/modern_treasury/models/line_item.rbs +4 -16
- data/sig/modern_treasury/models/payment_action_list_params.rbs +2 -1
- data/sig/modern_treasury/models/payment_order.rbs +22 -69
- data/sig/modern_treasury/models/payment_order_create_async_params.rbs +35 -380
- data/sig/modern_treasury/models/payment_order_create_params.rbs +35 -384
- data/sig/modern_treasury/models/payment_order_update_params.rbs +29 -207
- data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +6 -173
- data/sig/modern_treasury/models/payment_reference.rbs +14 -2
- data/sig/modern_treasury/models/return_list_params.rbs +1 -6
- data/sig/modern_treasury/models/return_object.rbs +15 -10
- data/sig/modern_treasury/models/routing_detail.rbs +4 -71
- data/sig/modern_treasury/models/routing_number_lookup_request.rbs +6 -48
- data/sig/modern_treasury/models/transaction.rbs +8 -53
- data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +0 -2
- data/sig/modern_treasury/models/virtual_account_create_params.rbs +6 -95
- data/sig/modern_treasury/models.rbs +30 -6
- data/sig/modern_treasury/resources/counterparties.rbs +2 -0
- data/sig/modern_treasury/resources/expected_payments.rbs +4 -1
- data/sig/modern_treasury/resources/external_accounts.rbs +6 -4
- data/sig/modern_treasury/resources/internal_accounts.rbs +7 -0
- data/sig/modern_treasury/resources/invoices.rbs +2 -2
- data/sig/modern_treasury/resources/ledger_account_categories.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_accounts.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_transactions.rbs +4 -4
- data/sig/modern_treasury/resources/legal_entities.rbs +4 -4
- data/sig/modern_treasury/resources/legal_entity_associations.rbs +1 -1
- data/sig/modern_treasury/resources/payment_orders/reversals.rbs +1 -1
- data/sig/modern_treasury/resources/payment_orders.rbs +5 -5
- data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -1
- metadata +52 -22
- data/lib/modern_treasury/models/paper_item.rb +0 -178
- data/lib/modern_treasury/models/paper_item_list_params.rb +0 -56
- data/lib/modern_treasury/models/paper_item_retrieve_params.rb +0 -14
- data/lib/modern_treasury/resources/ledger_event_handlers.rb +0 -14
- data/lib/modern_treasury/resources/ledgerable_events.rb +0 -14
- data/lib/modern_treasury/resources/paper_items.rb +0 -68
- data/rbi/modern_treasury/models/paper_item.rbi +0 -204
- data/rbi/modern_treasury/models/paper_item_list_params.rbi +0 -88
- data/rbi/modern_treasury/models/paper_item_retrieve_params.rbi +0 -32
- data/rbi/modern_treasury/resources/ledger_event_handlers.rbi +0 -12
- data/rbi/modern_treasury/resources/ledgerable_events.rbi +0 -12
- data/rbi/modern_treasury/resources/paper_items.rbi +0 -51
- data/sig/modern_treasury/models/paper_item.rbs +0 -122
- data/sig/modern_treasury/models/paper_item_list_params.rbs +0 -54
- data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +0 -15
- data/sig/modern_treasury/resources/ledger_event_handlers.rbs +0 -7
- data/sig/modern_treasury/resources/ledgerable_events.rbs +0 -7
- data/sig/modern_treasury/resources/paper_items.rbs +0 -21
|
@@ -9,8 +9,8 @@ module ModernTreasury
|
|
|
9
9
|
|
|
10
10
|
# @!attribute accounting
|
|
11
11
|
#
|
|
12
|
-
# @return [ModernTreasury::Models::
|
|
13
|
-
optional :accounting, -> { ModernTreasury::
|
|
12
|
+
# @return [ModernTreasury::Models::Accounting, nil]
|
|
13
|
+
optional :accounting, -> { ModernTreasury::Accounting }
|
|
14
14
|
|
|
15
15
|
# @!attribute accounting_category_id
|
|
16
16
|
# @deprecated
|
|
@@ -278,7 +278,7 @@ module ModernTreasury
|
|
|
278
278
|
# Some parameter documentations has been truncated, see
|
|
279
279
|
# {ModernTreasury::Models::PaymentOrderUpdateParams} for more details.
|
|
280
280
|
#
|
|
281
|
-
# @param accounting [ModernTreasury::Models::
|
|
281
|
+
# @param accounting [ModernTreasury::Models::Accounting]
|
|
282
282
|
#
|
|
283
283
|
# @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
284
284
|
#
|
|
@@ -348,31 +348,6 @@ module ModernTreasury
|
|
|
348
348
|
#
|
|
349
349
|
# @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
|
|
350
350
|
|
|
351
|
-
class Accounting < ModernTreasury::Internal::Type::BaseModel
|
|
352
|
-
# @!attribute account_id
|
|
353
|
-
# The ID of one of your accounting categories. Note that these will only be
|
|
354
|
-
# accessible if your accounting system has been connected.
|
|
355
|
-
#
|
|
356
|
-
# @return [String, nil]
|
|
357
|
-
optional :account_id, String, nil?: true
|
|
358
|
-
|
|
359
|
-
# @!attribute class_id
|
|
360
|
-
# The ID of one of the class objects in your accounting system. Class objects
|
|
361
|
-
# track segments of your business independent of client or project. Note that
|
|
362
|
-
# these will only be accessible if your accounting system has been connected.
|
|
363
|
-
#
|
|
364
|
-
# @return [String, nil]
|
|
365
|
-
optional :class_id, String, nil?: true
|
|
366
|
-
|
|
367
|
-
# @!method initialize(account_id: nil, class_id: nil)
|
|
368
|
-
# Some parameter documentations has been truncated, see
|
|
369
|
-
# {ModernTreasury::Models::PaymentOrderUpdateParams::Accounting} for more details.
|
|
370
|
-
#
|
|
371
|
-
# @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
372
|
-
#
|
|
373
|
-
# @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
|
|
374
|
-
end
|
|
375
|
-
|
|
376
351
|
# The party that will pay the fees for the payment order. See
|
|
377
352
|
# https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
|
|
378
353
|
# differences between the options.
|
|
@@ -497,11 +472,15 @@ module ModernTreasury
|
|
|
497
472
|
|
|
498
473
|
# @!attribute contact_details
|
|
499
474
|
#
|
|
500
|
-
# @return [Array<ModernTreasury::Models::
|
|
475
|
+
# @return [Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil]
|
|
501
476
|
optional :contact_details,
|
|
502
|
-
-> {
|
|
503
|
-
|
|
504
|
-
|
|
477
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest] }
|
|
478
|
+
|
|
479
|
+
# @!attribute external_id
|
|
480
|
+
# An optional user-defined 180 character unique identifier.
|
|
481
|
+
#
|
|
482
|
+
# @return [String, nil]
|
|
483
|
+
optional :external_id, String, nil?: true
|
|
505
484
|
|
|
506
485
|
# @!attribute ledger_account
|
|
507
486
|
# Specifies a ledger account object that will be created with the external
|
|
@@ -510,11 +489,8 @@ module ModernTreasury
|
|
|
510
489
|
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
|
511
490
|
# for more details.
|
|
512
491
|
#
|
|
513
|
-
# @return [ModernTreasury::Models::
|
|
514
|
-
optional :ledger_account,
|
|
515
|
-
-> {
|
|
516
|
-
ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount
|
|
517
|
-
}
|
|
492
|
+
# @return [ModernTreasury::Models::LedgerAccountCreateRequest, nil]
|
|
493
|
+
optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }
|
|
518
494
|
|
|
519
495
|
# @!attribute metadata
|
|
520
496
|
# Additional data represented as key-value pairs. Both the key and value must be
|
|
@@ -533,11 +509,8 @@ module ModernTreasury
|
|
|
533
509
|
# @!attribute party_address
|
|
534
510
|
# Required if receiving wire payments.
|
|
535
511
|
#
|
|
536
|
-
# @return [ModernTreasury::Models::
|
|
537
|
-
optional :party_address,
|
|
538
|
-
-> {
|
|
539
|
-
ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::PartyAddress
|
|
540
|
-
}
|
|
512
|
+
# @return [ModernTreasury::Models::AddressRequest, nil]
|
|
513
|
+
optional :party_address, -> { ModernTreasury::AddressRequest }
|
|
541
514
|
|
|
542
515
|
# @!attribute party_identifier
|
|
543
516
|
#
|
|
@@ -573,7 +546,7 @@ module ModernTreasury
|
|
|
573
546
|
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::RoutingDetail]
|
|
574
547
|
}
|
|
575
548
|
|
|
576
|
-
# @!method initialize(account_details: nil, account_type: nil, contact_details: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil)
|
|
549
|
+
# @!method initialize(account_details: nil, account_type: nil, contact_details: nil, external_id: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil)
|
|
577
550
|
# Some parameter documentations has been truncated, see
|
|
578
551
|
# {ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount} for more
|
|
579
552
|
# details.
|
|
@@ -586,15 +559,17 @@ module ModernTreasury
|
|
|
586
559
|
#
|
|
587
560
|
# @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
|
|
588
561
|
#
|
|
589
|
-
# @param contact_details [Array<ModernTreasury::Models::
|
|
562
|
+
# @param contact_details [Array<ModernTreasury::Models::ContactDetailCreateRequest>]
|
|
563
|
+
#
|
|
564
|
+
# @param external_id [String, nil] An optional user-defined 180 character unique identifier.
|
|
590
565
|
#
|
|
591
|
-
# @param ledger_account [ModernTreasury::Models::
|
|
566
|
+
# @param ledger_account [ModernTreasury::Models::LedgerAccountCreateRequest] Specifies a ledger account object that will be created with the external account
|
|
592
567
|
#
|
|
593
568
|
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
594
569
|
#
|
|
595
570
|
# @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
|
|
596
571
|
#
|
|
597
|
-
# @param party_address [ModernTreasury::Models::
|
|
572
|
+
# @param party_address [ModernTreasury::Models::AddressRequest] Required if receiving wire payments.
|
|
598
573
|
#
|
|
599
574
|
# @param party_identifier [String]
|
|
600
575
|
#
|
|
@@ -648,208 +623,6 @@ module ModernTreasury
|
|
|
648
623
|
end
|
|
649
624
|
end
|
|
650
625
|
|
|
651
|
-
class ContactDetail < ModernTreasury::Internal::Type::BaseModel
|
|
652
|
-
# @!attribute contact_identifier
|
|
653
|
-
#
|
|
654
|
-
# @return [String, nil]
|
|
655
|
-
optional :contact_identifier, String
|
|
656
|
-
|
|
657
|
-
# @!attribute contact_identifier_type
|
|
658
|
-
#
|
|
659
|
-
# @return [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType, nil]
|
|
660
|
-
optional :contact_identifier_type,
|
|
661
|
-
enum: -> {
|
|
662
|
-
ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType
|
|
663
|
-
}
|
|
664
|
-
|
|
665
|
-
# @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
|
|
666
|
-
# @param contact_identifier [String]
|
|
667
|
-
# @param contact_identifier_type [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType]
|
|
668
|
-
|
|
669
|
-
# @see ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail#contact_identifier_type
|
|
670
|
-
module ContactIdentifierType
|
|
671
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
672
|
-
|
|
673
|
-
EMAIL = :email
|
|
674
|
-
PHONE_NUMBER = :phone_number
|
|
675
|
-
WEBSITE = :website
|
|
676
|
-
|
|
677
|
-
# @!method self.values
|
|
678
|
-
# @return [Array<Symbol>]
|
|
679
|
-
end
|
|
680
|
-
end
|
|
681
|
-
|
|
682
|
-
# @see ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount#ledger_account
|
|
683
|
-
class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
|
|
684
|
-
# @!attribute currency
|
|
685
|
-
# The currency of the ledger account.
|
|
686
|
-
#
|
|
687
|
-
# @return [String]
|
|
688
|
-
required :currency, String
|
|
689
|
-
|
|
690
|
-
# @!attribute ledger_id
|
|
691
|
-
# The id of the ledger that this account belongs to.
|
|
692
|
-
#
|
|
693
|
-
# @return [String]
|
|
694
|
-
required :ledger_id, String
|
|
695
|
-
|
|
696
|
-
# @!attribute name
|
|
697
|
-
# The name of the ledger account.
|
|
698
|
-
#
|
|
699
|
-
# @return [String]
|
|
700
|
-
required :name, String
|
|
701
|
-
|
|
702
|
-
# @!attribute normal_balance
|
|
703
|
-
# The normal balance of the ledger account.
|
|
704
|
-
#
|
|
705
|
-
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
|
706
|
-
required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
|
|
707
|
-
|
|
708
|
-
# @!attribute currency_exponent
|
|
709
|
-
# The currency exponent of the ledger account.
|
|
710
|
-
#
|
|
711
|
-
# @return [Integer, nil]
|
|
712
|
-
optional :currency_exponent, Integer, nil?: true
|
|
713
|
-
|
|
714
|
-
# @!attribute description
|
|
715
|
-
# The description of the ledger account.
|
|
716
|
-
#
|
|
717
|
-
# @return [String, nil]
|
|
718
|
-
optional :description, String, nil?: true
|
|
719
|
-
|
|
720
|
-
# @!attribute ledger_account_category_ids
|
|
721
|
-
# The array of ledger account category ids that this ledger account should be a
|
|
722
|
-
# child of.
|
|
723
|
-
#
|
|
724
|
-
# @return [Array<String>, nil]
|
|
725
|
-
optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
|
|
726
|
-
|
|
727
|
-
# @!attribute ledgerable_id
|
|
728
|
-
# If the ledger account links to another object in Modern Treasury, the id will be
|
|
729
|
-
# populated here, otherwise null.
|
|
730
|
-
#
|
|
731
|
-
# @return [String, nil]
|
|
732
|
-
optional :ledgerable_id, String
|
|
733
|
-
|
|
734
|
-
# @!attribute ledgerable_type
|
|
735
|
-
# If the ledger account links to another object in Modern Treasury, the type will
|
|
736
|
-
# be populated here, otherwise null. The value is one of internal_account or
|
|
737
|
-
# external_account.
|
|
738
|
-
#
|
|
739
|
-
# @return [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType, nil]
|
|
740
|
-
optional :ledgerable_type,
|
|
741
|
-
enum: -> {
|
|
742
|
-
ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType
|
|
743
|
-
}
|
|
744
|
-
|
|
745
|
-
# @!attribute metadata
|
|
746
|
-
# Additional data represented as key-value pairs. Both the key and value must be
|
|
747
|
-
# strings.
|
|
748
|
-
#
|
|
749
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
750
|
-
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
|
751
|
-
|
|
752
|
-
# @!method initialize(currency:, ledger_id:, name:, normal_balance:, currency_exponent: nil, description: nil, ledger_account_category_ids: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil)
|
|
753
|
-
# Some parameter documentations has been truncated, see
|
|
754
|
-
# {ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount}
|
|
755
|
-
# for more details.
|
|
756
|
-
#
|
|
757
|
-
# Specifies a ledger account object that will be created with the external
|
|
758
|
-
# account. The resulting ledger account is linked to the external account for
|
|
759
|
-
# auto-ledgering Payment objects. See
|
|
760
|
-
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
|
761
|
-
# for more details.
|
|
762
|
-
#
|
|
763
|
-
# @param currency [String] The currency of the ledger account.
|
|
764
|
-
#
|
|
765
|
-
# @param ledger_id [String] The id of the ledger that this account belongs to.
|
|
766
|
-
#
|
|
767
|
-
# @param name [String] The name of the ledger account.
|
|
768
|
-
#
|
|
769
|
-
# @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
|
|
770
|
-
#
|
|
771
|
-
# @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
|
|
772
|
-
#
|
|
773
|
-
# @param description [String, nil] The description of the ledger account.
|
|
774
|
-
#
|
|
775
|
-
# @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
|
|
776
|
-
#
|
|
777
|
-
# @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
|
|
778
|
-
#
|
|
779
|
-
# @param ledgerable_type [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
|
|
780
|
-
#
|
|
781
|
-
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
782
|
-
|
|
783
|
-
# If the ledger account links to another object in Modern Treasury, the type will
|
|
784
|
-
# be populated here, otherwise null. The value is one of internal_account or
|
|
785
|
-
# external_account.
|
|
786
|
-
#
|
|
787
|
-
# @see ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount#ledgerable_type
|
|
788
|
-
module LedgerableType
|
|
789
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
790
|
-
|
|
791
|
-
COUNTERPARTY = :counterparty
|
|
792
|
-
EXTERNAL_ACCOUNT = :external_account
|
|
793
|
-
INTERNAL_ACCOUNT = :internal_account
|
|
794
|
-
VIRTUAL_ACCOUNT = :virtual_account
|
|
795
|
-
|
|
796
|
-
# @!method self.values
|
|
797
|
-
# @return [Array<Symbol>]
|
|
798
|
-
end
|
|
799
|
-
end
|
|
800
|
-
|
|
801
|
-
# @see ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount#party_address
|
|
802
|
-
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
|
803
|
-
# @!attribute country
|
|
804
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
805
|
-
#
|
|
806
|
-
# @return [String, nil]
|
|
807
|
-
optional :country, String, nil?: true
|
|
808
|
-
|
|
809
|
-
# @!attribute line1
|
|
810
|
-
#
|
|
811
|
-
# @return [String, nil]
|
|
812
|
-
optional :line1, String, nil?: true
|
|
813
|
-
|
|
814
|
-
# @!attribute line2
|
|
815
|
-
#
|
|
816
|
-
# @return [String, nil]
|
|
817
|
-
optional :line2, String, nil?: true
|
|
818
|
-
|
|
819
|
-
# @!attribute locality
|
|
820
|
-
# Locality or City.
|
|
821
|
-
#
|
|
822
|
-
# @return [String, nil]
|
|
823
|
-
optional :locality, String, nil?: true
|
|
824
|
-
|
|
825
|
-
# @!attribute postal_code
|
|
826
|
-
# The postal code of the address.
|
|
827
|
-
#
|
|
828
|
-
# @return [String, nil]
|
|
829
|
-
optional :postal_code, String, nil?: true
|
|
830
|
-
|
|
831
|
-
# @!attribute region
|
|
832
|
-
# Region or State.
|
|
833
|
-
#
|
|
834
|
-
# @return [String, nil]
|
|
835
|
-
optional :region, String, nil?: true
|
|
836
|
-
|
|
837
|
-
# @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
|
|
838
|
-
# Required if receiving wire payments.
|
|
839
|
-
#
|
|
840
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
841
|
-
#
|
|
842
|
-
# @param line1 [String, nil]
|
|
843
|
-
#
|
|
844
|
-
# @param line2 [String, nil]
|
|
845
|
-
#
|
|
846
|
-
# @param locality [String, nil] Locality or City.
|
|
847
|
-
#
|
|
848
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
849
|
-
#
|
|
850
|
-
# @param region [String, nil] Region or State.
|
|
851
|
-
end
|
|
852
|
-
|
|
853
626
|
# Either `individual` or `business`.
|
|
854
627
|
#
|
|
855
628
|
# @see ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount#party_type
|
|
@@ -21,9 +21,8 @@ module ModernTreasury
|
|
|
21
21
|
# the ledger transaction cannot be created, then the reversal creation will fail.
|
|
22
22
|
# The resulting ledger transaction will mirror the status of the reversal.
|
|
23
23
|
#
|
|
24
|
-
# @return [ModernTreasury::Models::
|
|
25
|
-
optional :ledger_transaction,
|
|
26
|
-
-> { ModernTreasury::PaymentOrders::ReversalCreateParams::LedgerTransaction }
|
|
24
|
+
# @return [ModernTreasury::Models::LedgerTransactionCreateRequest, nil]
|
|
25
|
+
optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }
|
|
27
26
|
|
|
28
27
|
# @!attribute metadata
|
|
29
28
|
# Additional data represented as key-value pairs. Both the key and value must be
|
|
@@ -38,7 +37,7 @@ module ModernTreasury
|
|
|
38
37
|
#
|
|
39
38
|
# @param reason [Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::Reason] The reason for the reversal. Must be one of `duplicate`, `incorrect_amount`, `in
|
|
40
39
|
#
|
|
41
|
-
# @param ledger_transaction [ModernTreasury::Models::
|
|
40
|
+
# @param ledger_transaction [ModernTreasury::Models::LedgerTransactionCreateRequest] Specifies a ledger transaction object that will be created with the reversal. If
|
|
42
41
|
#
|
|
43
42
|
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
44
43
|
#
|
|
@@ -59,234 +58,6 @@ module ModernTreasury
|
|
|
59
58
|
# @!method self.values
|
|
60
59
|
# @return [Array<Symbol>]
|
|
61
60
|
end
|
|
62
|
-
|
|
63
|
-
class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
|
|
64
|
-
# @!attribute ledger_entries
|
|
65
|
-
# An array of ledger entry objects.
|
|
66
|
-
#
|
|
67
|
-
# @return [Array<ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerEntry>]
|
|
68
|
-
required :ledger_entries,
|
|
69
|
-
-> {
|
|
70
|
-
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerEntry]
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
# @!attribute description
|
|
74
|
-
# An optional description for internal use.
|
|
75
|
-
#
|
|
76
|
-
# @return [String, nil]
|
|
77
|
-
optional :description, String, nil?: true
|
|
78
|
-
|
|
79
|
-
# @!attribute effective_at
|
|
80
|
-
# The timestamp (ISO8601 format) at which the ledger transaction happened for
|
|
81
|
-
# reporting purposes.
|
|
82
|
-
#
|
|
83
|
-
# @return [Time, nil]
|
|
84
|
-
optional :effective_at, Time
|
|
85
|
-
|
|
86
|
-
# @!attribute effective_date
|
|
87
|
-
# The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
|
|
88
|
-
# purposes.
|
|
89
|
-
#
|
|
90
|
-
# @return [Date, nil]
|
|
91
|
-
optional :effective_date, Date
|
|
92
|
-
|
|
93
|
-
# @!attribute external_id
|
|
94
|
-
# A unique string to represent the ledger transaction. Only one pending or posted
|
|
95
|
-
# ledger transaction may have this ID in the ledger.
|
|
96
|
-
#
|
|
97
|
-
# @return [String, nil]
|
|
98
|
-
optional :external_id, String
|
|
99
|
-
|
|
100
|
-
# @!attribute ledgerable_id
|
|
101
|
-
# If the ledger transaction can be reconciled to another object in Modern
|
|
102
|
-
# Treasury, the id will be populated here, otherwise null.
|
|
103
|
-
#
|
|
104
|
-
# @return [String, nil]
|
|
105
|
-
optional :ledgerable_id, String
|
|
106
|
-
|
|
107
|
-
# @!attribute ledgerable_type
|
|
108
|
-
# If the ledger transaction can be reconciled to another object in Modern
|
|
109
|
-
# Treasury, the type will be populated here, otherwise null. This can be one of
|
|
110
|
-
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
|
111
|
-
# reversal.
|
|
112
|
-
#
|
|
113
|
-
# @return [Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerableType, nil]
|
|
114
|
-
optional :ledgerable_type,
|
|
115
|
-
enum: -> {
|
|
116
|
-
ModernTreasury::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerableType
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
# @!attribute metadata
|
|
120
|
-
# Additional data represented as key-value pairs. Both the key and value must be
|
|
121
|
-
# strings.
|
|
122
|
-
#
|
|
123
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
124
|
-
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
|
125
|
-
|
|
126
|
-
# @!attribute status
|
|
127
|
-
# To post a ledger transaction at creation, use `posted`.
|
|
128
|
-
#
|
|
129
|
-
# @return [Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::Status, nil]
|
|
130
|
-
optional :status,
|
|
131
|
-
enum: -> { ModernTreasury::PaymentOrders::ReversalCreateParams::LedgerTransaction::Status }
|
|
132
|
-
|
|
133
|
-
# @!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)
|
|
134
|
-
# Some parameter documentations has been truncated, see
|
|
135
|
-
# {ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction}
|
|
136
|
-
# for more details.
|
|
137
|
-
#
|
|
138
|
-
# Specifies a ledger transaction object that will be created with the reversal. If
|
|
139
|
-
# the ledger transaction cannot be created, then the reversal creation will fail.
|
|
140
|
-
# The resulting ledger transaction will mirror the status of the reversal.
|
|
141
|
-
#
|
|
142
|
-
# @param ledger_entries [Array<ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerEntry>] An array of ledger entry objects.
|
|
143
|
-
#
|
|
144
|
-
# @param description [String, nil] An optional description for internal use.
|
|
145
|
-
#
|
|
146
|
-
# @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
|
|
147
|
-
#
|
|
148
|
-
# @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
|
|
149
|
-
#
|
|
150
|
-
# @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
|
|
151
|
-
#
|
|
152
|
-
# @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
|
|
153
|
-
#
|
|
154
|
-
# @param ledgerable_type [Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
|
|
155
|
-
#
|
|
156
|
-
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
157
|
-
#
|
|
158
|
-
# @param status [Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::Status] To post a ledger transaction at creation, use `posted`.
|
|
159
|
-
|
|
160
|
-
class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
|
|
161
|
-
# @!attribute amount
|
|
162
|
-
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
|
163
|
-
# as 1000. Can be any integer up to 36 digits.
|
|
164
|
-
#
|
|
165
|
-
# @return [Integer]
|
|
166
|
-
required :amount, Integer
|
|
167
|
-
|
|
168
|
-
# @!attribute direction
|
|
169
|
-
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
|
170
|
-
# transaction. A `credit` moves money from your account to someone else's. A
|
|
171
|
-
# `debit` pulls money from someone else's account to your own. Note that wire,
|
|
172
|
-
# rtp, and check payments will always be `credit`.
|
|
173
|
-
#
|
|
174
|
-
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
|
175
|
-
required :direction, enum: -> { ModernTreasury::TransactionDirection }
|
|
176
|
-
|
|
177
|
-
# @!attribute ledger_account_id
|
|
178
|
-
# The ledger account that this ledger entry is associated with.
|
|
179
|
-
#
|
|
180
|
-
# @return [String]
|
|
181
|
-
required :ledger_account_id, String
|
|
182
|
-
|
|
183
|
-
# @!attribute available_balance_amount
|
|
184
|
-
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
|
185
|
-
# account’s available balance. If any of these conditions would be false after the
|
|
186
|
-
# transaction is created, the entire call will fail with error code 422.
|
|
187
|
-
#
|
|
188
|
-
# @return [Hash{Symbol=>Integer}, nil]
|
|
189
|
-
optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
|
190
|
-
|
|
191
|
-
# @!attribute lock_version
|
|
192
|
-
# Lock version of the ledger account. This can be passed when creating a ledger
|
|
193
|
-
# transaction to only succeed if no ledger transactions have posted since the
|
|
194
|
-
# given version. See our post about Designing the Ledgers API with Optimistic
|
|
195
|
-
# Locking for more details.
|
|
196
|
-
#
|
|
197
|
-
# @return [Integer, nil]
|
|
198
|
-
optional :lock_version, Integer, nil?: true
|
|
199
|
-
|
|
200
|
-
# @!attribute metadata
|
|
201
|
-
# Additional data represented as key-value pairs. Both the key and value must be
|
|
202
|
-
# strings.
|
|
203
|
-
#
|
|
204
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
205
|
-
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
|
206
|
-
|
|
207
|
-
# @!attribute pending_balance_amount
|
|
208
|
-
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
|
209
|
-
# account’s pending balance. If any of these conditions would be false after the
|
|
210
|
-
# transaction is created, the entire call will fail with error code 422.
|
|
211
|
-
#
|
|
212
|
-
# @return [Hash{Symbol=>Integer}, nil]
|
|
213
|
-
optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
|
214
|
-
|
|
215
|
-
# @!attribute posted_balance_amount
|
|
216
|
-
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
|
217
|
-
# account’s posted balance. If any of these conditions would be false after the
|
|
218
|
-
# transaction is created, the entire call will fail with error code 422.
|
|
219
|
-
#
|
|
220
|
-
# @return [Hash{Symbol=>Integer}, nil]
|
|
221
|
-
optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
|
222
|
-
|
|
223
|
-
# @!attribute show_resulting_ledger_account_balances
|
|
224
|
-
# If true, response will include the balance of the associated ledger account for
|
|
225
|
-
# the entry.
|
|
226
|
-
#
|
|
227
|
-
# @return [Boolean, nil]
|
|
228
|
-
optional :show_resulting_ledger_account_balances,
|
|
229
|
-
ModernTreasury::Internal::Type::Boolean,
|
|
230
|
-
nil?: true
|
|
231
|
-
|
|
232
|
-
# @!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)
|
|
233
|
-
# Some parameter documentations has been truncated, see
|
|
234
|
-
# {ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction::LedgerEntry}
|
|
235
|
-
# for more details.
|
|
236
|
-
#
|
|
237
|
-
# @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
|
|
238
|
-
#
|
|
239
|
-
# @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
|
|
240
|
-
#
|
|
241
|
-
# @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
|
|
242
|
-
#
|
|
243
|
-
# @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
|
|
244
|
-
#
|
|
245
|
-
# @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
|
|
246
|
-
#
|
|
247
|
-
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
248
|
-
#
|
|
249
|
-
# @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
|
|
250
|
-
#
|
|
251
|
-
# @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
|
|
252
|
-
#
|
|
253
|
-
# @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
|
|
254
|
-
end
|
|
255
|
-
|
|
256
|
-
# If the ledger transaction can be reconciled to another object in Modern
|
|
257
|
-
# Treasury, the type will be populated here, otherwise null. This can be one of
|
|
258
|
-
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
|
259
|
-
# reversal.
|
|
260
|
-
#
|
|
261
|
-
# @see ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction#ledgerable_type
|
|
262
|
-
module LedgerableType
|
|
263
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
264
|
-
|
|
265
|
-
EXPECTED_PAYMENT = :expected_payment
|
|
266
|
-
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
|
267
|
-
PAPER_ITEM = :paper_item
|
|
268
|
-
PAYMENT_ORDER = :payment_order
|
|
269
|
-
RETURN = :return
|
|
270
|
-
REVERSAL = :reversal
|
|
271
|
-
|
|
272
|
-
# @!method self.values
|
|
273
|
-
# @return [Array<Symbol>]
|
|
274
|
-
end
|
|
275
|
-
|
|
276
|
-
# To post a ledger transaction at creation, use `posted`.
|
|
277
|
-
#
|
|
278
|
-
# @see ModernTreasury::Models::PaymentOrders::ReversalCreateParams::LedgerTransaction#status
|
|
279
|
-
module Status
|
|
280
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
281
|
-
|
|
282
|
-
ARCHIVED = :archived
|
|
283
|
-
PENDING = :pending
|
|
284
|
-
POSTED = :posted
|
|
285
|
-
|
|
286
|
-
# @!method self.values
|
|
287
|
-
# @return [Array<Symbol>]
|
|
288
|
-
end
|
|
289
|
-
end
|
|
290
61
|
end
|
|
291
62
|
end
|
|
292
63
|
end
|
|
@@ -113,7 +113,11 @@ module ModernTreasury
|
|
|
113
113
|
CURRENCYCLOUD_PAYMENT_ID = :currencycloud_payment_id
|
|
114
114
|
DC_BANK_TRANSACTION_ID = :dc_bank_transaction_id
|
|
115
115
|
EFT_TRACE_NUMBER = :eft_trace_number
|
|
116
|
+
EVOLVE_CORE_BATCH = :evolve_core_batch
|
|
117
|
+
EVOLVE_CORE_FILE_KEY = :evolve_core_file_key
|
|
118
|
+
EVOLVE_CORE_SEQ = :evolve_core_seq
|
|
116
119
|
EVOLVE_TRANSACTION_ID = :evolve_transaction_id
|
|
120
|
+
FAKE_VENDOR_PAYMENT_ID = :fake_vendor_payment_id
|
|
117
121
|
FEDWIRE_IMAD = :fedwire_imad
|
|
118
122
|
FEDWIRE_OMAD = :fedwire_omad
|
|
119
123
|
FIRST_REPUBLIC_INTERNAL_ID = :first_republic_internal_id
|
|
@@ -146,7 +150,6 @@ module ModernTreasury
|
|
|
146
150
|
PNC_REQUEST_FOR_PAYMENT_ID = :pnc_request_for_payment_id
|
|
147
151
|
PNC_TRANSACTION_REFERENCE_NUMBER = :pnc_transaction_reference_number
|
|
148
152
|
RBC_WIRE_REFERENCE_ID = :rbc_wire_reference_id
|
|
149
|
-
RSPEC_VENDOR_PAYMENT_ID = :rspec_vendor_payment_id
|
|
150
153
|
RTP_INSTRUCTION_ID = :rtp_instruction_id
|
|
151
154
|
SIGNET_API_REFERENCE_ID = :signet_api_reference_id
|
|
152
155
|
SIGNET_CONFIRMATION_ID = :signet_confirmation_id
|
|
@@ -167,6 +170,9 @@ module ModernTreasury
|
|
|
167
170
|
WELLS_FARGO_PAYMENT_ID = :wells_fargo_payment_id
|
|
168
171
|
WELLS_FARGO_TRACE_NUMBER = :wells_fargo_trace_number
|
|
169
172
|
WELLS_FARGO_UETR = :wells_fargo_uetr
|
|
173
|
+
WESTERN_ALLIANCE_PAYMENT_ID = :western_alliance_payment_id
|
|
174
|
+
WESTERN_ALLIANCE_TRANSACTION_ID = :western_alliance_transaction_id
|
|
175
|
+
WESTERN_ALLIANCE_WIRE_CONFIRMATION_NUMBER = :western_alliance_wire_confirmation_number
|
|
170
176
|
|
|
171
177
|
# @!method self.values
|
|
172
178
|
# @return [Array<Symbol>]
|
|
@@ -38,8 +38,8 @@ module ModernTreasury
|
|
|
38
38
|
optional :returnable_id, String
|
|
39
39
|
|
|
40
40
|
# @!attribute returnable_type
|
|
41
|
-
# One of `payment_order`, `
|
|
42
|
-
#
|
|
41
|
+
# One of `payment_order`, `reversal`, or `incoming_payment_detail`. Must be
|
|
42
|
+
# accompanied by `returnable_id`.
|
|
43
43
|
#
|
|
44
44
|
# @return [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType, nil]
|
|
45
45
|
optional :returnable_type, enum: -> { ModernTreasury::ReturnListParams::ReturnableType }
|
|
@@ -58,17 +58,16 @@ module ModernTreasury
|
|
|
58
58
|
#
|
|
59
59
|
# @param returnable_id [String] The ID of a valid returnable. Must be accompanied by `returnable_type`.
|
|
60
60
|
#
|
|
61
|
-
# @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType] One of `payment_order`, `
|
|
61
|
+
# @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType] One of `payment_order`, `reversal`, or `incoming_payment_detail`. Must be accomp
|
|
62
62
|
#
|
|
63
63
|
# @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
|
|
64
64
|
|
|
65
|
-
# One of `payment_order`, `
|
|
66
|
-
#
|
|
65
|
+
# One of `payment_order`, `reversal`, or `incoming_payment_detail`. Must be
|
|
66
|
+
# accompanied by `returnable_id`.
|
|
67
67
|
module ReturnableType
|
|
68
68
|
extend ModernTreasury::Internal::Type::Enum
|
|
69
69
|
|
|
70
70
|
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
|
71
|
-
PAPER_ITEM = :paper_item
|
|
72
71
|
PAYMENT_ORDER = :payment_order
|
|
73
72
|
RETURN = :return
|
|
74
73
|
REVERSAL = :reversal
|