modern_treasury 0.26.0 → 0.28.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.
Files changed (216) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +71 -0
  3. data/README.md +4 -4
  4. data/lib/modern_treasury/client.rb +14 -0
  5. data/lib/modern_treasury/internal/transport/base_client.rb +5 -0
  6. data/lib/modern_treasury/internal/util.rb +3 -1
  7. data/lib/modern_treasury/models/bulk_request_create_params.rb +65 -202
  8. data/lib/modern_treasury/models/child_legal_entity.rb +121 -3
  9. data/lib/modern_treasury/models/child_legal_entity_create.rb +35 -1
  10. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +38 -1
  11. data/lib/modern_treasury/models/counterparty_collect_account_params.rb +0 -2
  12. data/lib/modern_treasury/models/counterparty_create_params.rb +38 -14
  13. data/lib/modern_treasury/models/currency.rb +0 -3
  14. data/lib/modern_treasury/models/document.rb +1 -73
  15. data/lib/modern_treasury/models/document_create_params.rb +11 -11
  16. data/lib/modern_treasury/models/document_list_params.rb +11 -11
  17. data/lib/modern_treasury/models/expected_payment.rb +2 -3
  18. data/lib/modern_treasury/models/expected_payment_create_params.rb +2 -3
  19. data/lib/modern_treasury/models/expected_payment_list_params.rb +3 -16
  20. data/lib/modern_treasury/models/expected_payment_type.rb +1 -13
  21. data/lib/modern_treasury/models/expected_payment_update_params.rb +2 -3
  22. data/lib/modern_treasury/models/external_account_create_params.rb +0 -13
  23. data/lib/modern_treasury/models/external_account_verify_params.rb +0 -11
  24. data/lib/modern_treasury/models/external_account_verify_response.rb +0 -11
  25. data/lib/modern_treasury/models/hold_list_params.rb +8 -11
  26. data/lib/modern_treasury/models/identification_create_request.rb +75 -0
  27. data/lib/modern_treasury/models/incoming_payment_detail.rb +15 -14
  28. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +11 -7
  29. data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +15 -12
  30. data/lib/modern_treasury/models/internal_account.rb +12 -12
  31. data/lib/modern_treasury/models/internal_account_create_params.rb +37 -33
  32. data/lib/modern_treasury/models/internal_account_list_params.rb +0 -11
  33. data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +0 -11
  34. data/lib/modern_treasury/models/internal_accounts/balance_report.rb +15 -6
  35. data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb +20 -11
  36. data/lib/modern_treasury/models/invoice.rb +25 -1
  37. data/lib/modern_treasury/models/invoice_create_params.rb +3 -4
  38. data/lib/modern_treasury/models/invoice_update_params.rb +3 -4
  39. data/lib/modern_treasury/models/ledger_account_settlement_update_params.rb +10 -1
  40. data/lib/modern_treasury/models/ledger_balance.rb +22 -1
  41. data/lib/modern_treasury/models/ledger_entry.rb +10 -1
  42. data/lib/modern_treasury/models/ledger_entry_create_request.rb +19 -10
  43. data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb +69 -10
  44. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +10 -1
  45. data/lib/modern_treasury/models/legal_entity.rb +121 -3
  46. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +14 -1
  47. data/lib/modern_treasury/models/legal_entity_association.rb +2 -3
  48. data/lib/modern_treasury/models/legal_entity_create_params.rb +34 -1
  49. data/lib/modern_treasury/models/legal_entity_update_params.rb +34 -1
  50. data/lib/modern_treasury/models/legal_entity_update_status_params.rb +46 -0
  51. data/lib/modern_treasury/models/payment_order.rb +9 -10
  52. data/lib/modern_treasury/models/payment_order_create_async_params.rb +4 -18
  53. data/lib/modern_treasury/models/payment_order_create_params.rb +15 -29
  54. data/lib/modern_treasury/models/payment_order_list_params.rb +0 -11
  55. data/lib/modern_treasury/models/payment_order_subtype.rb +2 -3
  56. data/lib/modern_treasury/models/payment_order_type.rb +2 -14
  57. data/lib/modern_treasury/models/payment_order_update_params.rb +4 -18
  58. data/lib/modern_treasury/models/payment_reference.rb +5 -5
  59. data/lib/modern_treasury/models/reconciliation_rule.rb +3 -16
  60. data/lib/modern_treasury/models/return_object.rb +11 -8
  61. data/lib/modern_treasury/models/routing_detail.rb +0 -13
  62. data/lib/modern_treasury/models/routing_detail_create_params.rb +0 -13
  63. data/lib/modern_treasury/models/routing_number_lookup_request.rb +0 -11
  64. data/lib/modern_treasury/models/third_party_verification.rb +2 -0
  65. data/lib/modern_treasury/models/transaction.rb +17 -20
  66. data/lib/modern_treasury/models/transaction_create_params.rb +23 -25
  67. data/lib/modern_treasury/models/validation_validate_routing_number_params.rb +0 -2
  68. data/lib/modern_treasury/models/virtual_account_create_params.rb +0 -13
  69. data/lib/modern_treasury/models.rb +2 -0
  70. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  71. data/lib/modern_treasury/resources/expected_payments.rb +3 -3
  72. data/lib/modern_treasury/resources/holds.rb +3 -3
  73. data/lib/modern_treasury/resources/incoming_payment_details.rb +7 -3
  74. data/lib/modern_treasury/resources/internal_accounts.rb +8 -6
  75. data/lib/modern_treasury/resources/invoices.rb +2 -2
  76. data/lib/modern_treasury/resources/ledger_account_settlements.rb +3 -1
  77. data/lib/modern_treasury/resources/legal_entities.rb +33 -2
  78. data/lib/modern_treasury/resources/payment_orders.rb +3 -3
  79. data/lib/modern_treasury/resources/transactions.rb +5 -3
  80. data/lib/modern_treasury/version.rb +1 -1
  81. data/lib/modern_treasury.rb +1 -0
  82. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +104 -522
  83. data/rbi/modern_treasury/models/child_legal_entity.rbi +452 -5
  84. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +68 -0
  85. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +74 -0
  86. data/rbi/modern_treasury/models/counterparty_collect_account_params.rbi +0 -10
  87. data/rbi/modern_treasury/models/counterparty_create_params.rbi +74 -65
  88. data/rbi/modern_treasury/models/currency.rbi +0 -3
  89. data/rbi/modern_treasury/models/document.rbi +0 -87
  90. data/rbi/modern_treasury/models/document_create_params.rbi +22 -22
  91. data/rbi/modern_treasury/models/document_list_params.rbi +22 -22
  92. data/rbi/modern_treasury/models/expected_payment.rbi +2 -4
  93. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +2 -4
  94. data/rbi/modern_treasury/models/expected_payment_list_params.rbi +3 -61
  95. data/rbi/modern_treasury/models/expected_payment_type.rbi +1 -18
  96. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +2 -4
  97. data/rbi/modern_treasury/models/external_account_create_params.rbi +0 -65
  98. data/rbi/modern_treasury/models/external_account_verify_params.rbi +0 -55
  99. data/rbi/modern_treasury/models/external_account_verify_response.rbi +0 -55
  100. data/rbi/modern_treasury/models/hold_list_params.rbi +8 -13
  101. data/rbi/modern_treasury/models/identification_create_request.rbi +375 -0
  102. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +17 -43
  103. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +12 -27
  104. data/rbi/modern_treasury/models/incoming_payment_detail_list_params.rbi +20 -33
  105. data/rbi/modern_treasury/models/internal_account.rbi +14 -55
  106. data/rbi/modern_treasury/models/internal_account_create_params.rbi +60 -77
  107. data/rbi/modern_treasury/models/internal_account_list_params.rbi +0 -55
  108. data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +0 -55
  109. data/rbi/modern_treasury/models/internal_accounts/balance_report.rbi +17 -7
  110. data/rbi/modern_treasury/models/internal_accounts/balance_report_create_params.rbi +31 -15
  111. data/rbi/modern_treasury/models/invoice.rbi +27 -3
  112. data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -6
  113. data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -6
  114. data/rbi/modern_treasury/models/ledger_account_settlement_update_params.rbi +10 -0
  115. data/rbi/modern_treasury/models/ledger_balance.rbi +21 -3
  116. data/rbi/modern_treasury/models/ledger_entry.rbi +10 -0
  117. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +26 -10
  118. data/rbi/modern_treasury/models/ledger_transaction_create_partial_post_params.rbi +89 -13
  119. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +10 -0
  120. data/rbi/modern_treasury/models/legal_entity.rbi +451 -5
  121. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +18 -3
  122. data/rbi/modern_treasury/models/legal_entity_association.rbi +2 -4
  123. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +68 -0
  124. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +68 -0
  125. data/rbi/modern_treasury/models/legal_entity_update_status_params.rbi +96 -0
  126. data/rbi/modern_treasury/models/payment_order.rbi +30 -32
  127. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +6 -73
  128. data/rbi/modern_treasury/models/payment_order_create_params.rbi +28 -95
  129. data/rbi/modern_treasury/models/payment_order_list_params.rbi +0 -55
  130. data/rbi/modern_treasury/models/payment_order_subtype.rbi +3 -4
  131. data/rbi/modern_treasury/models/payment_order_type.rbi +2 -16
  132. data/rbi/modern_treasury/models/payment_order_update_params.rbi +6 -73
  133. data/rbi/modern_treasury/models/payment_reference.rbi +24 -24
  134. data/rbi/modern_treasury/models/reconciliation_rule.rbi +3 -43
  135. data/rbi/modern_treasury/models/return_object.rbi +33 -29
  136. data/rbi/modern_treasury/models/routing_detail.rbi +0 -59
  137. data/rbi/modern_treasury/models/routing_detail_create_params.rbi +0 -65
  138. data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +0 -55
  139. data/rbi/modern_treasury/models/third_party_verification.rbi +10 -0
  140. data/rbi/modern_treasury/models/transaction.rbi +24 -35
  141. data/rbi/modern_treasury/models/transaction_create_params.rbi +33 -72
  142. data/rbi/modern_treasury/models/validation_validate_routing_number_params.rbi +0 -10
  143. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +0 -65
  144. data/rbi/modern_treasury/models.rbi +3 -0
  145. data/rbi/modern_treasury/resources/bulk_requests.rbi +3 -2
  146. data/rbi/modern_treasury/resources/expected_payments.rbi +3 -6
  147. data/rbi/modern_treasury/resources/holds.rbi +3 -5
  148. data/rbi/modern_treasury/resources/incoming_payment_details.rbi +10 -2
  149. data/rbi/modern_treasury/resources/internal_accounts.rbi +15 -8
  150. data/rbi/modern_treasury/resources/invoices.rbi +4 -6
  151. data/rbi/modern_treasury/resources/ledger_account_settlements.rbi +4 -0
  152. data/rbi/modern_treasury/resources/legal_entities.rbi +31 -0
  153. data/rbi/modern_treasury/resources/payment_orders.rbi +9 -12
  154. data/rbi/modern_treasury/resources/transactions.rbi +11 -7
  155. data/sig/modern_treasury/models/bulk_request_create_params.rbs +45 -207
  156. data/sig/modern_treasury/models/child_legal_entity.rbs +179 -2
  157. data/sig/modern_treasury/models/child_legal_entity_create.rbs +21 -0
  158. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -0
  159. data/sig/modern_treasury/models/counterparty_collect_account_params.rbs +0 -4
  160. data/sig/modern_treasury/models/counterparty_create_params.rbs +21 -26
  161. data/sig/modern_treasury/models/currency.rbs +0 -6
  162. data/sig/modern_treasury/models/document.rbs +0 -57
  163. data/sig/modern_treasury/models/document_create_params.rbs +22 -22
  164. data/sig/modern_treasury/models/document_list_params.rbs +22 -22
  165. data/sig/modern_treasury/models/expected_payment_list_params.rbs +0 -22
  166. data/sig/modern_treasury/models/expected_payment_type.rbs +0 -22
  167. data/sig/modern_treasury/models/external_account_create_params.rbs +0 -26
  168. data/sig/modern_treasury/models/external_account_verify_params.rbs +0 -22
  169. data/sig/modern_treasury/models/external_account_verify_response.rbs +0 -22
  170. data/sig/modern_treasury/models/identification_create_request.rbs +150 -0
  171. data/sig/modern_treasury/models/incoming_payment_detail.rbs +7 -16
  172. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +7 -12
  173. data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +9 -12
  174. data/sig/modern_treasury/models/internal_account.rbs +5 -22
  175. data/sig/modern_treasury/models/internal_account_create_params.rbs +22 -33
  176. data/sig/modern_treasury/models/internal_account_list_params.rbs +0 -22
  177. data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +0 -22
  178. data/sig/modern_treasury/models/internal_accounts/balance_report.rbs +9 -4
  179. data/sig/modern_treasury/models/internal_accounts/balance_report_create_params.rbs +17 -8
  180. data/sig/modern_treasury/models/invoice.rbs +18 -3
  181. data/sig/modern_treasury/models/ledger_account_settlement_update_params.rbs +5 -0
  182. data/sig/modern_treasury/models/ledger_balance.rbs +18 -3
  183. data/sig/modern_treasury/models/ledger_entry.rbs +5 -0
  184. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +14 -5
  185. data/sig/modern_treasury/models/ledger_transaction_create_partial_post_params.rbs +42 -8
  186. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +5 -0
  187. data/sig/modern_treasury/models/legal_entity.rbs +179 -2
  188. data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +10 -3
  189. data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -0
  190. data/sig/modern_treasury/models/legal_entity_update_params.rbs +21 -0
  191. data/sig/modern_treasury/models/legal_entity_update_status_params.rbs +43 -0
  192. data/sig/modern_treasury/models/payment_order.rbs +10 -10
  193. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +0 -26
  194. data/sig/modern_treasury/models/payment_order_create_params.rbs +22 -48
  195. data/sig/modern_treasury/models/payment_order_list_params.rbs +0 -22
  196. data/sig/modern_treasury/models/payment_order_subtype.rbs +4 -6
  197. data/sig/modern_treasury/models/payment_order_type.rbs +0 -22
  198. data/sig/modern_treasury/models/payment_order_update_params.rbs +0 -26
  199. data/sig/modern_treasury/models/payment_reference.rbs +10 -10
  200. data/sig/modern_treasury/models/reconciliation_rule.rbs +0 -22
  201. data/sig/modern_treasury/models/return_object.rbs +18 -12
  202. data/sig/modern_treasury/models/routing_detail.rbs +0 -26
  203. data/sig/modern_treasury/models/routing_detail_create_params.rbs +0 -26
  204. data/sig/modern_treasury/models/routing_number_lookup_request.rbs +0 -22
  205. data/sig/modern_treasury/models/third_party_verification.rbs +4 -1
  206. data/sig/modern_treasury/models/transaction.rbs +7 -26
  207. data/sig/modern_treasury/models/transaction_create_params.rbs +14 -27
  208. data/sig/modern_treasury/models/validation_validate_routing_number_params.rbs +0 -4
  209. data/sig/modern_treasury/models/virtual_account_create_params.rbs +0 -26
  210. data/sig/modern_treasury/models.rbs +2 -0
  211. data/sig/modern_treasury/resources/incoming_payment_details.rbs +2 -0
  212. data/sig/modern_treasury/resources/internal_accounts.rbs +3 -2
  213. data/sig/modern_treasury/resources/ledger_account_settlements.rbs +1 -0
  214. data/sig/modern_treasury/resources/legal_entities.rbs +8 -0
  215. data/sig/modern_treasury/resources/transactions.rbs +2 -1
  216. metadata +5 -2
@@ -59,6 +59,15 @@ module ModernTreasury
59
59
  # @return [Symbol, ModernTreasury::Models::Currency]
60
60
  required :currency, enum: -> { ModernTreasury::Currency }
61
61
 
62
+ # @!attribute debitable
63
+ # Whether this account can receive ACH debits. Only applicable to accounts created
64
+ # under a Modern Treasury PSP connection, or `null` for Bring Your Own Bank
65
+ # accounts. Defaults to `false`. Configurable only on creation. Please reach out
66
+ # to your customer success manager to enable this capability for your connection.
67
+ #
68
+ # @return [Boolean, nil]
69
+ required :debitable, ModernTreasury::Internal::Type::Boolean, nil?: true
70
+
62
71
  # @!attribute external_id
63
72
  # An optional user-defined 180 character unique identifier.
64
73
  #
@@ -150,7 +159,7 @@ module ModernTreasury
150
159
  # @return [String, nil]
151
160
  required :vendor_id, String, nil?: true
152
161
 
153
- # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, contra_ledger_account_id:, counterparty_id:, created_at:, currency:, external_id:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, status:, updated_at:, vendor_id:)
162
+ # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, contra_ledger_account_id:, counterparty_id:, created_at:, currency:, debitable:, external_id:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, status:, updated_at:, vendor_id:)
154
163
  # Some parameter documentations has been truncated, see
155
164
  # {ModernTreasury::Models::InternalAccount} for more details.
156
165
  #
@@ -172,6 +181,8 @@ module ModernTreasury
172
181
  #
173
182
  # @param currency [Symbol, ModernTreasury::Models::Currency] The currency of the account.
174
183
  #
184
+ # @param debitable [Boolean, nil] Whether this account can receive ACH debits. Only applicable to accounts created
185
+ #
175
186
  # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
176
187
  #
177
188
  # @param ledger_account_id [String, nil] If the internal account links to a ledger account in Modern Treasury, the id of
@@ -288,7 +299,6 @@ module ModernTreasury
288
299
  ACH = :ach
289
300
  AU_BECS = :au_becs
290
301
  BACS = :bacs
291
- BASE = :base
292
302
  BOOK = :book
293
303
  CARD = :card
294
304
  CHATS = :chats
@@ -296,28 +306,18 @@ module ModernTreasury
296
306
  CROSS_BORDER = :cross_border
297
307
  DK_NETS = :dk_nets
298
308
  EFT = :eft
299
- ETHEREUM = :ethereum
300
309
  GB_FPS = :gb_fps
301
- HU_ICS = :hu_ics
302
- INTERAC = :interac
303
310
  MASAV = :masav
304
311
  MX_CCEN = :mx_ccen
305
312
  NEFT = :neft
306
313
  NICS = :nics
307
314
  NZ_BECS = :nz_becs
308
315
  PL_ELIXIR = :pl_elixir
309
- POLYGON = :polygon
310
- PROVXCHANGE = :provxchange
311
- RO_SENT = :ro_sent
312
316
  RTP = :rtp
313
317
  SE_BANKGIROT = :se_bankgirot
314
- SEN = :sen
315
318
  SEPA = :sepa
316
319
  SG_GIRO = :sg_giro
317
320
  SIC = :sic
318
- SIGNET = :signet
319
- SKNBI = :sknbi
320
- SOLANA = :solana
321
321
  STABLECOIN = :stablecoin
322
322
  WIRE = :wire
323
323
  ZENGIN = :zengin
@@ -7,15 +7,8 @@ module ModernTreasury
7
7
  extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
8
  include ModernTreasury::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute connection_id
11
- # The identifier of the financial institution the account belongs to.
12
- #
13
- # @return [String]
14
- required :connection_id, String
15
-
16
10
  # @!attribute currency
17
- # Either "USD" or "CAD". Internal accounts created at Increase only supports
18
- # "USD".
11
+ # The currency of the internal account. Supports fiat and stablecoin currencies.
19
12
  #
20
13
  # @return [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency]
21
14
  required :currency, enum: -> { ModernTreasury::InternalAccountCreateParams::Currency }
@@ -26,12 +19,6 @@ module ModernTreasury
26
19
  # @return [String]
27
20
  required :name, String
28
21
 
29
- # @!attribute party_name
30
- # The legal name of the entity which owns the account.
31
- #
32
- # @return [String]
33
- required :party_name, String
34
-
35
22
  # @!attribute account_capabilities
36
23
  # An array of AccountCapability objects that list the originating abilities of the
37
24
  # internal account and any relevant information for them.
@@ -47,12 +34,29 @@ module ModernTreasury
47
34
  # @return [Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountType, nil]
48
35
  optional :account_type, enum: -> { ModernTreasury::InternalAccountCreateParams::AccountType }
49
36
 
37
+ # @!attribute connection_id
38
+ # The identifier of the financial institution the account belongs to. If not
39
+ # provided, defaults to the default connection, or the sole connection if only one
40
+ # exists.
41
+ #
42
+ # @return [String, nil]
43
+ optional :connection_id, String
44
+
50
45
  # @!attribute counterparty_id
51
46
  # The Counterparty associated to this account.
52
47
  #
53
48
  # @return [String, nil]
54
49
  optional :counterparty_id, String
55
50
 
51
+ # @!attribute debitable
52
+ # Whether this account can receive ACH debits. Only applicable to accounts created
53
+ # under a Modern Treasury PSP connection, or `null` for Bring Your Own Bank
54
+ # accounts. Defaults to `false`. Configurable only on creation. Please reach out
55
+ # to your customer success manager to enable this capability for your connection.
56
+ #
57
+ # @return [Boolean, nil]
58
+ optional :debitable, ModernTreasury::Internal::Type::Boolean, nil?: true
59
+
56
60
  # @!attribute external_id
57
61
  # An optional user-defined 180 character unique identifier.
58
62
  #
@@ -84,6 +88,12 @@ module ModernTreasury
84
88
  # @return [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress, nil]
85
89
  optional :party_address, -> { ModernTreasury::InternalAccountCreateParams::PartyAddress }
86
90
 
91
+ # @!attribute party_name
92
+ # The legal name of the entity which owns the account.
93
+ #
94
+ # @return [String, nil]
95
+ optional :party_name, String, nil?: true
96
+
87
97
  # @!attribute vendor_attributes
88
98
  # A hash of vendor specific attributes that will be used when creating the account
89
99
  # at the vendor specified by the given connection.
@@ -91,24 +101,24 @@ module ModernTreasury
91
101
  # @return [Hash{Symbol=>String}, nil]
92
102
  optional :vendor_attributes, ModernTreasury::Internal::Type::HashOf[String]
93
103
 
94
- # @!method initialize(connection_id:, currency:, name:, party_name:, account_capabilities: nil, account_type: nil, counterparty_id: nil, external_id: nil, legal_entity_id: nil, metadata: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {})
104
+ # @!method initialize(currency:, name:, account_capabilities: nil, account_type: nil, connection_id: nil, counterparty_id: nil, debitable: nil, external_id: nil, legal_entity_id: nil, metadata: nil, parent_account_id: nil, party_address: nil, party_name: nil, vendor_attributes: nil, request_options: {})
95
105
  # Some parameter documentations has been truncated, see
96
106
  # {ModernTreasury::Models::InternalAccountCreateParams} for more details.
97
107
  #
98
- # @param connection_id [String] The identifier of the financial institution the account belongs to.
99
- #
100
- # @param currency [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency] Either "USD" or "CAD". Internal accounts created at Increase only supports "USD"
108
+ # @param currency [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency] The currency of the internal account. Supports fiat and stablecoin currencies.
101
109
  #
102
110
  # @param name [String] The nickname of the account.
103
111
  #
104
- # @param party_name [String] The legal name of the entity which owns the account.
105
- #
106
112
  # @param account_capabilities [Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>] An array of AccountCapability objects that list the originating abilities of the
107
113
  #
108
114
  # @param account_type [Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountType] The account type, used to provision the appropriate account at the financial ins
109
115
  #
116
+ # @param connection_id [String] The identifier of the financial institution the account belongs to. If not provi
117
+ #
110
118
  # @param counterparty_id [String] The Counterparty associated to this account.
111
119
  #
120
+ # @param debitable [Boolean, nil] Whether this account can receive ACH debits. Only applicable to accounts created
121
+ #
112
122
  # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
113
123
  #
114
124
  # @param legal_entity_id [String] The LegalEntity associated to this account.
@@ -119,17 +129,22 @@ module ModernTreasury
119
129
  #
120
130
  # @param party_address [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress] The address associated with the owner or null.
121
131
  #
132
+ # @param party_name [String, nil] The legal name of the entity which owns the account.
133
+ #
122
134
  # @param vendor_attributes [Hash{Symbol=>String}] A hash of vendor specific attributes that will be used when creating the account
123
135
  #
124
136
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
125
137
 
126
- # Either "USD" or "CAD". Internal accounts created at Increase only supports
127
- # "USD".
138
+ # The currency of the internal account. Supports fiat and stablecoin currencies.
128
139
  module Currency
129
140
  extend ModernTreasury::Internal::Type::Enum
130
141
 
131
142
  USD = :USD
132
143
  CAD = :CAD
144
+ USDC = :USDC
145
+ USDT = :USDT
146
+ PYUSD = :PYUSD
147
+ USDG = :USDG
133
148
 
134
149
  # @!method self.values
135
150
  # @return [Array<Symbol>]
@@ -223,7 +238,6 @@ module ModernTreasury
223
238
  ACH = :ach
224
239
  AU_BECS = :au_becs
225
240
  BACS = :bacs
226
- BASE = :base
227
241
  BOOK = :book
228
242
  CARD = :card
229
243
  CHATS = :chats
@@ -231,28 +245,18 @@ module ModernTreasury
231
245
  CROSS_BORDER = :cross_border
232
246
  DK_NETS = :dk_nets
233
247
  EFT = :eft
234
- ETHEREUM = :ethereum
235
248
  GB_FPS = :gb_fps
236
- HU_ICS = :hu_ics
237
- INTERAC = :interac
238
249
  MASAV = :masav
239
250
  MX_CCEN = :mx_ccen
240
251
  NEFT = :neft
241
252
  NICS = :nics
242
253
  NZ_BECS = :nz_becs
243
254
  PL_ELIXIR = :pl_elixir
244
- POLYGON = :polygon
245
- PROVXCHANGE = :provxchange
246
- RO_SENT = :ro_sent
247
255
  RTP = :rtp
248
256
  SE_BANKGIROT = :se_bankgirot
249
- SEN = :sen
250
257
  SEPA = :sepa
251
258
  SG_GIRO = :sg_giro
252
259
  SIC = :sic
253
- SIGNET = :signet
254
- SKNBI = :sknbi
255
- SOLANA = :solana
256
260
  STABLECOIN = :stablecoin
257
261
  WIRE = :wire
258
262
  ZENGIN = :zengin
@@ -100,7 +100,6 @@ module ModernTreasury
100
100
  ACH = :ach
101
101
  AU_BECS = :au_becs
102
102
  BACS = :bacs
103
- BASE = :base
104
103
  BOOK = :book
105
104
  CARD = :card
106
105
  CHATS = :chats
@@ -108,28 +107,18 @@ module ModernTreasury
108
107
  CROSS_BORDER = :cross_border
109
108
  DK_NETS = :dk_nets
110
109
  EFT = :eft
111
- ETHEREUM = :ethereum
112
110
  GB_FPS = :gb_fps
113
- HU_ICS = :hu_ics
114
- INTERAC = :interac
115
111
  MASAV = :masav
116
112
  MX_CCEN = :mx_ccen
117
113
  NEFT = :neft
118
114
  NICS = :nics
119
115
  NZ_BECS = :nz_becs
120
116
  PL_ELIXIR = :pl_elixir
121
- POLYGON = :polygon
122
- PROVXCHANGE = :provxchange
123
- RO_SENT = :ro_sent
124
117
  RTP = :rtp
125
118
  SE_BANKGIROT = :se_bankgirot
126
- SEN = :sen
127
119
  SEPA = :sepa
128
120
  SG_GIRO = :sg_giro
129
121
  SIC = :sic
130
- SIGNET = :signet
131
- SKNBI = :sknbi
132
- SOLANA = :solana
133
122
  STABLECOIN = :stablecoin
134
123
  WIRE = :wire
135
124
  ZENGIN = :zengin
@@ -91,7 +91,6 @@ module ModernTreasury
91
91
  ACH = :ach
92
92
  AU_BECS = :au_becs
93
93
  BACS = :bacs
94
- BASE = :base
95
94
  BOOK = :book
96
95
  CARD = :card
97
96
  CHATS = :chats
@@ -99,28 +98,18 @@ module ModernTreasury
99
98
  CROSS_BORDER = :cross_border
100
99
  DK_NETS = :dk_nets
101
100
  EFT = :eft
102
- ETHEREUM = :ethereum
103
101
  GB_FPS = :gb_fps
104
- HU_ICS = :hu_ics
105
- INTERAC = :interac
106
102
  MASAV = :masav
107
103
  MX_CCEN = :mx_ccen
108
104
  NEFT = :neft
109
105
  NICS = :nics
110
106
  NZ_BECS = :nz_becs
111
107
  PL_ELIXIR = :pl_elixir
112
- POLYGON = :polygon
113
- PROVXCHANGE = :provxchange
114
- RO_SENT = :ro_sent
115
108
  RTP = :rtp
116
109
  SE_BANKGIROT = :se_bankgirot
117
- SEN = :sen
118
110
  SEPA = :sepa
119
111
  SG_GIRO = :sg_giro
120
112
  SIC = :sic
121
- SIGNET = :signet
122
- SKNBI = :sknbi
123
- SOLANA = :solana
124
113
  STABLECOIN = :stablecoin
125
114
  WIRE = :wire
126
115
  ZENGIN = :zengin
@@ -19,8 +19,8 @@ module ModernTreasury
19
19
  # @!attribute as_of_time
20
20
  # The time (24-hour clock) of the balance report in local time.
21
21
  #
22
- # @return [Time, nil]
23
- required :as_of_time, Time, nil?: true
22
+ # @return [Time]
23
+ required :as_of_time, Time
24
24
 
25
25
  # @!attribute balance_report_type
26
26
  # The specific type of balance report. One of `intraday`, `previous_day`,
@@ -73,7 +73,7 @@ module ModernTreasury
73
73
  #
74
74
  # @param as_of_date [Date] The date of the balance report in local time.
75
75
  #
76
- # @param as_of_time [Time, nil] The time (24-hour clock) of the balance report in local time.
76
+ # @param as_of_time [Time] The time (24-hour clock) of the balance report in local time.
77
77
  #
78
78
  # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType] The specific type of balance report. One of `intraday`, `previous_day`, `real_ti
79
79
  #
@@ -117,6 +117,13 @@ module ModernTreasury
117
117
  # @return [Integer]
118
118
  required :amount, Integer
119
119
 
120
+ # @!attribute amount_string
121
+ # The amount of the balance as a string, preserving full precision for values that
122
+ # may exceed safe integer limits in some languages.
123
+ #
124
+ # @return [String]
125
+ required :amount_string, String
126
+
120
127
  # @!attribute as_of_date
121
128
  # The date on which the balance became true for the account.
122
129
  #
@@ -181,13 +188,13 @@ module ModernTreasury
181
188
  # @!attribute vendor_code_type
182
189
  # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
183
190
  # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
184
- # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
185
- # `swift`, or `us_bank`.
191
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or
192
+ # `us_bank`.
186
193
  #
187
194
  # @return [String, nil]
188
195
  required :vendor_code_type, String, nil?: true
189
196
 
190
- # @!method initialize(id:, amount:, as_of_date:, as_of_time:, balance_type:, created_at:, currency:, live_mode:, object:, updated_at:, value_date:, vendor_code:, vendor_code_type:)
197
+ # @!method initialize(id:, amount:, amount_string:, as_of_date:, as_of_time:, balance_type:, created_at:, currency:, live_mode:, object:, updated_at:, value_date:, vendor_code:, vendor_code_type:)
191
198
  # Some parameter documentations has been truncated, see
192
199
  # {ModernTreasury::Models::InternalAccounts::BalanceReport::Balance} for more
193
200
  # details.
@@ -196,6 +203,8 @@ module ModernTreasury
196
203
  #
197
204
  # @param amount [Integer] The balance amount.
198
205
  #
206
+ # @param amount_string [String] The amount of the balance as a string, preserving full precision for values that
207
+ #
199
208
  # @param as_of_date [Date, nil] The date on which the balance became true for the account.
200
209
  #
201
210
  # @param as_of_time [Time, nil] The time on which the balance became true for the account.
@@ -72,12 +72,6 @@ module ModernTreasury
72
72
  end
73
73
 
74
74
  class Balance < ModernTreasury::Internal::Type::BaseModel
75
- # @!attribute amount
76
- # The balance amount.
77
- #
78
- # @return [Integer]
79
- required :amount, Integer
80
-
81
75
  # @!attribute balance_type
82
76
  # The specific type of balance reported. One of `opening_ledger`,
83
77
  # `closing_ledger`, `current_ledger`, `opening_available`,
@@ -97,24 +91,39 @@ module ModernTreasury
97
91
  # @!attribute vendor_code_type
98
92
  # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
99
93
  # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
100
- # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
101
- # `swift`, or `us_bank`.
94
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or
95
+ # `us_bank`.
102
96
  #
103
97
  # @return [String, nil]
104
98
  required :vendor_code_type, String, nil?: true
105
99
 
106
- # @!method initialize(amount:, balance_type:, vendor_code:, vendor_code_type:)
100
+ # @!attribute amount
101
+ # The balance amount.
102
+ #
103
+ # @return [Integer, nil]
104
+ optional :amount, Integer
105
+
106
+ # @!attribute amount_string
107
+ # The amount of the balance as a string, preserving full precision for values that
108
+ # may exceed safe integer limits in some languages.
109
+ #
110
+ # @return [String, nil]
111
+ optional :amount_string, String
112
+
113
+ # @!method initialize(balance_type:, vendor_code:, vendor_code_type:, amount: nil, amount_string: nil)
107
114
  # Some parameter documentations has been truncated, see
108
115
  # {ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance}
109
116
  # for more details.
110
117
  #
111
- # @param amount [Integer] The balance amount.
112
- #
113
118
  # @param balance_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType] The specific type of balance reported. One of `opening_ledger`, `closing_ledger`
114
119
  #
115
120
  # @param vendor_code [String] The code used by the bank when reporting this specific balance.
116
121
  #
117
122
  # @param vendor_code_type [String, nil] The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk
123
+ #
124
+ # @param amount [Integer] The balance amount.
125
+ #
126
+ # @param amount_string [String] The amount of the balance as a string, preserving full precision for values that
118
127
 
119
128
  # The specific type of balance reported. One of `opening_ledger`,
120
129
  # `closing_ledger`, `current_ledger`, `opening_available`,
@@ -107,6 +107,12 @@ module ModernTreasury
107
107
  # @return [String, nil]
108
108
  required :invoicer_name, String, nil?: true
109
109
 
110
+ # @!attribute issued_at
111
+ # The time at which the invoice was issued.
112
+ #
113
+ # @return [Time, nil]
114
+ required :issued_at, Time, nil?: true
115
+
110
116
  # @!attribute ledger_account_settlement_id
111
117
  # @deprecated
112
118
  #
@@ -161,6 +167,12 @@ module ModernTreasury
161
167
  # @return [String]
162
168
  required :originating_account_id, String
163
169
 
170
+ # @!attribute paid_at
171
+ # The time at which the invoice was paid.
172
+ #
173
+ # @return [Time, nil]
174
+ required :paid_at, Time, nil?: true
175
+
164
176
  # @!attribute payment_effective_date
165
177
  # Date transactions are to be posted to the participants' account. Defaults to the
166
178
  # current business day or the next business day if the current day is a bank
@@ -252,7 +264,13 @@ module ModernTreasury
252
264
  # @return [String, nil]
253
265
  required :virtual_account_id, String, nil?: true
254
266
 
255
- # @!method initialize(id:, amount_paid:, amount_remaining:, contact_details:, counterparty_billing_address:, counterparty_id:, counterparty_shipping_address:, created_at:, currency:, description:, due_date:, expected_payments:, fallback_payment_method:, hosted_url:, invoicer_address:, invoicer_name:, ledger_account_settlement_id:, live_mode:, metadata:, notification_email_addresses:, notifications_enabled:, number:, object:, originating_account_id:, payment_effective_date:, payment_method:, payment_orders:, payment_type:, pdf_url:, receiving_account_id:, recipient_email:, recipient_name:, remind_after_overdue_days:, status:, total_amount:, transaction_line_item_ids:, updated_at:, virtual_account_id:)
267
+ # @!attribute voided_at
268
+ # The time at which the invoice was voided.
269
+ #
270
+ # @return [Time, nil]
271
+ required :voided_at, Time, nil?: true
272
+
273
+ # @!method initialize(id:, amount_paid:, amount_remaining:, contact_details:, counterparty_billing_address:, counterparty_id:, counterparty_shipping_address:, created_at:, currency:, description:, due_date:, expected_payments:, fallback_payment_method:, hosted_url:, invoicer_address:, invoicer_name:, issued_at:, ledger_account_settlement_id:, live_mode:, metadata:, notification_email_addresses:, notifications_enabled:, number:, object:, originating_account_id:, paid_at:, payment_effective_date:, payment_method:, payment_orders:, payment_type:, pdf_url:, receiving_account_id:, recipient_email:, recipient_name:, remind_after_overdue_days:, status:, total_amount:, transaction_line_item_ids:, updated_at:, virtual_account_id:, voided_at:)
256
274
  # Some parameter documentations has been truncated, see
257
275
  # {ModernTreasury::Models::Invoice} for more details.
258
276
  #
@@ -288,6 +306,8 @@ module ModernTreasury
288
306
  #
289
307
  # @param invoicer_name [String, nil] The name of the issuer for the invoice. Defaults to the name of the Organization
290
308
  #
309
+ # @param issued_at [Time, nil] The time at which the invoice was issued.
310
+ #
291
311
  # @param ledger_account_settlement_id [String, nil] The ledger account settlement object linked to the invoice.
292
312
  #
293
313
  # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
@@ -304,6 +324,8 @@ module ModernTreasury
304
324
  #
305
325
  # @param originating_account_id [String] The ID of the internal account the invoice should be paid to.
306
326
  #
327
+ # @param paid_at [Time, nil] The time at which the invoice was paid.
328
+ #
307
329
  # @param payment_effective_date [Date, nil] Date transactions are to be posted to the participants' account. Defaults to the
308
330
  #
309
331
  # @param payment_method [Symbol, ModernTreasury::Models::Invoice::PaymentMethod, nil] When opening an invoice, whether to show the embedded payment UI , automatically
@@ -331,6 +353,8 @@ module ModernTreasury
331
353
  # @param updated_at [Time]
332
354
  #
333
355
  # @param virtual_account_id [String, nil] The ID of the virtual account the invoice should be paid to.
356
+ #
357
+ # @param voided_at [Time, nil] The time at which the invoice was voided.
334
358
 
335
359
  # @see ModernTreasury::Models::Invoice#counterparty_billing_address
336
360
  class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
@@ -141,9 +141,8 @@ module ModernTreasury
141
141
  optional :payment_method, enum: -> { ModernTreasury::InvoiceCreateParams::PaymentMethod }
142
142
 
143
143
  # @!attribute payment_type
144
- # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
145
- # `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
146
- # `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
144
+ # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`,
145
+ # `bacs`, `au_becs`, `neft`, `nics`, `nz_national_clearing_code`, `sic`, `zengin`.
147
146
  #
148
147
  # @return [Symbol, ModernTreasury::Models::PaymentOrderType, nil]
149
148
  optional :payment_type, enum: -> { ModernTreasury::PaymentOrderType }
@@ -221,7 +220,7 @@ module ModernTreasury
221
220
  #
222
221
  # @param payment_method [Symbol, ModernTreasury::Models::InvoiceCreateParams::PaymentMethod] The method by which the invoice can be paid. `ui` will show the embedded payment
223
222
  #
224
- # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
223
+ # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`, `ba
225
224
  #
226
225
  # @param receiving_account_id [String] The receiving account ID. Can be an `external_account`.
227
226
  #
@@ -138,9 +138,8 @@ module ModernTreasury
138
138
  optional :payment_method, enum: -> { ModernTreasury::InvoiceUpdateParams::PaymentMethod }
139
139
 
140
140
  # @!attribute payment_type
141
- # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
142
- # `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
143
- # `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
141
+ # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`,
142
+ # `bacs`, `au_becs`, `neft`, `nics`, `nz_national_clearing_code`, `sic`, `zengin`.
144
143
  #
145
144
  # @return [Symbol, ModernTreasury::Models::PaymentOrderType, nil]
146
145
  optional :payment_type, enum: -> { ModernTreasury::PaymentOrderType }
@@ -226,7 +225,7 @@ module ModernTreasury
226
225
  #
227
226
  # @param payment_method [Symbol, ModernTreasury::Models::InvoiceUpdateParams::PaymentMethod] The method by which the invoice can be paid. `ui` will show the embedded payment
228
227
  #
229
- # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
228
+ # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`, `ba
230
229
  #
231
230
  # @param receiving_account_id [String] The receiving account ID. Can be an `external_account`.
232
231
  #
@@ -25,6 +25,13 @@ module ModernTreasury
25
25
  # @return [Hash{Symbol=>String}, nil]
26
26
  optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
27
27
 
28
+ # @!attribute skip_settlement_ledger_transaction
29
+ # It is set to `false` by default. It should be set to `true` when migrating
30
+ # existing settlements.
31
+ #
32
+ # @return [Boolean, nil]
33
+ optional :skip_settlement_ledger_transaction, ModernTreasury::Internal::Type::Boolean, nil?: true
34
+
28
35
  # @!attribute status
29
36
  # To post a pending ledger account settlement, use `posted`. To archive a pending
30
37
  # ledger transaction, use `archived`.
@@ -32,7 +39,7 @@ module ModernTreasury
32
39
  # @return [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status, nil]
33
40
  optional :status, enum: -> { ModernTreasury::LedgerAccountSettlementUpdateParams::Status }
34
41
 
35
- # @!method initialize(id:, description: nil, metadata: nil, status: nil, request_options: {})
42
+ # @!method initialize(id:, description: nil, metadata: nil, skip_settlement_ledger_transaction: nil, status: nil, request_options: {})
36
43
  # Some parameter documentations has been truncated, see
37
44
  # {ModernTreasury::Models::LedgerAccountSettlementUpdateParams} for more details.
38
45
  #
@@ -42,6 +49,8 @@ module ModernTreasury
42
49
  #
43
50
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
44
51
  #
52
+ # @param skip_settlement_ledger_transaction [Boolean, nil] It is set to `false` by default. It should be set to `true` when migrating exist
53
+ #
45
54
  # @param status [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status] To post a pending ledger account settlement, use `posted`. To archive a pending
46
55
  #
47
56
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
@@ -8,11 +8,21 @@ module ModernTreasury
8
8
  # @return [Integer]
9
9
  required :amount, Integer
10
10
 
11
+ # @!attribute amount_string
12
+ #
13
+ # @return [String]
14
+ required :amount_string, String
15
+
11
16
  # @!attribute credits
12
17
  #
13
18
  # @return [Integer]
14
19
  required :credits, Integer
15
20
 
21
+ # @!attribute credits_string
22
+ #
23
+ # @return [String]
24
+ required :credits_string, String
25
+
16
26
  # @!attribute currency
17
27
  # The currency of the ledger account.
18
28
  #
@@ -30,16 +40,27 @@ module ModernTreasury
30
40
  # @return [Integer]
31
41
  required :debits, Integer
32
42
 
33
- # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
43
+ # @!attribute debits_string
44
+ #
45
+ # @return [String]
46
+ required :debits_string, String
47
+
48
+ # @!method initialize(amount:, amount_string:, credits:, credits_string:, currency:, currency_exponent:, debits:, debits_string:)
34
49
  # @param amount [Integer]
35
50
  #
51
+ # @param amount_string [String]
52
+ #
36
53
  # @param credits [Integer]
37
54
  #
55
+ # @param credits_string [String]
56
+ #
38
57
  # @param currency [String] The currency of the ledger account.
39
58
  #
40
59
  # @param currency_exponent [Integer] The currency exponent of the ledger account.
41
60
  #
42
61
  # @param debits [Integer]
62
+ #
63
+ # @param debits_string [String]
43
64
  end
44
65
  end
45
66
  end
@@ -16,6 +16,13 @@ module ModernTreasury
16
16
  # @return [Integer]
17
17
  required :amount, Integer
18
18
 
19
+ # @!attribute amount_string
20
+ # The amount of the ledger entry as a string, preserving full precision for values
21
+ # that may exceed safe integer limits in some languages.
22
+ #
23
+ # @return [String]
24
+ required :amount_string, String
25
+
19
26
  # @!attribute created_at
20
27
  #
21
28
  # @return [Time]
@@ -118,7 +125,7 @@ module ModernTreasury
118
125
  # @return [Time]
119
126
  required :updated_at, Time
120
127
 
121
- # @!method initialize(id:, amount:, created_at:, direction:, discarded_at:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:)
128
+ # @!method initialize(id:, amount:, amount_string:, created_at:, direction:, discarded_at:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:)
122
129
  # Some parameter documentations has been truncated, see
123
130
  # {ModernTreasury::Models::LedgerEntry} for more details.
124
131
  #
@@ -126,6 +133,8 @@ module ModernTreasury
126
133
  #
127
134
  # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
128
135
  #
136
+ # @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
137
+ #
129
138
  # @param created_at [Time]
130
139
  #
131
140
  # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa