modern_treasury 0.1.0.pre.alpha.21 → 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.
Files changed (375) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +65 -0
  3. data/README.md +1 -1
  4. data/lib/modern_treasury/client.rb +0 -12
  5. data/lib/modern_treasury/errors.rb +22 -0
  6. data/lib/modern_treasury/internal/transport/base_client.rb +11 -3
  7. data/lib/modern_treasury/internal/type/array_of.rb +6 -1
  8. data/lib/modern_treasury/internal/type/base_model.rb +81 -27
  9. data/lib/modern_treasury/internal/type/boolean.rb +7 -1
  10. data/lib/modern_treasury/internal/type/converter.rb +42 -34
  11. data/lib/modern_treasury/internal/type/enum.rb +10 -2
  12. data/lib/modern_treasury/internal/type/file_input.rb +6 -1
  13. data/lib/modern_treasury/internal/type/hash_of.rb +6 -1
  14. data/lib/modern_treasury/internal/type/union.rb +12 -7
  15. data/lib/modern_treasury/internal/type/unknown.rb +7 -1
  16. data/lib/modern_treasury/models/accounting.rb +30 -0
  17. data/lib/modern_treasury/models/address.rb +94 -0
  18. data/lib/modern_treasury/models/address_request.rb +54 -0
  19. data/lib/modern_treasury/models/bulk_request_create_params.rb +147 -1383
  20. data/lib/modern_treasury/models/bulk_result.rb +5 -3
  21. data/lib/modern_treasury/models/child_legal_entity_create.rb +275 -0
  22. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +10 -627
  23. data/lib/modern_treasury/models/contact_detail.rb +81 -0
  24. data/lib/modern_treasury/models/contact_detail_create_request.rb +34 -0
  25. data/lib/modern_treasury/models/counterparty.rb +24 -177
  26. data/lib/modern_treasury/models/counterparty_create_params.rb +38 -838
  27. data/lib/modern_treasury/models/counterparty_list_params.rb +9 -1
  28. data/lib/modern_treasury/models/document.rb +4 -6
  29. data/lib/modern_treasury/models/document_create_params.rb +0 -2
  30. data/lib/modern_treasury/models/document_list_params.rb +4 -6
  31. data/lib/modern_treasury/models/expected_payment.rb +9 -1
  32. data/lib/modern_treasury/models/expected_payment_create_params.rb +12 -230
  33. data/lib/modern_treasury/models/expected_payment_list_params.rb +8 -1
  34. data/lib/modern_treasury/models/expected_payment_update_params.rb +9 -1
  35. data/lib/modern_treasury/models/external_account.rb +15 -177
  36. data/lib/modern_treasury/models/external_account_create_params.rb +19 -210
  37. data/lib/modern_treasury/models/external_account_list_params.rb +9 -1
  38. data/lib/modern_treasury/models/external_account_update_params.rb +3 -52
  39. data/lib/modern_treasury/models/foreign_exchange_quote.rb +3 -73
  40. data/lib/modern_treasury/models/foreign_exchange_rate.rb +71 -0
  41. data/lib/modern_treasury/models/identification_create_request.rb +86 -0
  42. data/lib/modern_treasury/models/incoming_payment_detail.rb +1 -0
  43. data/lib/modern_treasury/models/internal_account.rb +122 -71
  44. data/lib/modern_treasury/models/internal_account_create_params.rb +138 -1
  45. data/lib/modern_treasury/models/internal_account_update_account_capability_params.rb +34 -0
  46. data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +131 -0
  47. data/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rb +23 -0
  48. data/lib/modern_treasury/models/invoice.rb +13 -82
  49. data/lib/modern_treasury/models/invoice_create_params.rb +3 -83
  50. data/lib/modern_treasury/models/invoice_update_params.rb +3 -83
  51. data/lib/modern_treasury/models/ledger_account.rb +18 -142
  52. data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +3 -182
  53. data/lib/modern_treasury/models/ledger_account_category.rb +12 -176
  54. data/lib/modern_treasury/models/ledger_account_category_list_params.rb +17 -6
  55. data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +4 -2
  56. data/lib/modern_treasury/models/ledger_account_create_params.rb +2 -105
  57. data/lib/modern_treasury/models/ledger_account_create_request.rb +113 -0
  58. data/lib/modern_treasury/models/ledger_account_list_params.rb +15 -1
  59. data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +6 -360
  60. data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +6 -360
  61. data/lib/modern_treasury/models/ledger_balance.rb +45 -0
  62. data/lib/modern_treasury/models/ledger_balances.rb +38 -0
  63. data/lib/modern_treasury/models/ledger_entry.rb +3 -183
  64. data/lib/modern_treasury/models/ledger_entry_create_request.rb +98 -0
  65. data/lib/modern_treasury/models/ledger_entry_list_params.rb +48 -8
  66. data/lib/modern_treasury/models/ledger_transaction.rb +14 -6
  67. data/lib/modern_treasury/models/ledger_transaction_create_params.rb +2 -212
  68. data/lib/modern_treasury/models/ledger_transaction_create_request.rb +123 -0
  69. data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +0 -1
  70. data/lib/modern_treasury/models/ledger_transaction_list_params.rb +44 -7
  71. data/lib/modern_treasury/models/ledger_transaction_update_params.rb +5 -104
  72. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +15 -193
  73. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +78 -0
  74. data/lib/modern_treasury/models/legal_entity_association.rb +1 -0
  75. data/lib/modern_treasury/models/legal_entity_association_create_params.rb +4 -448
  76. data/lib/modern_treasury/models/legal_entity_create_params.rb +10 -618
  77. data/lib/modern_treasury/models/legal_entity_update_params.rb +6 -165
  78. data/lib/modern_treasury/models/line_item.rb +3 -29
  79. data/lib/modern_treasury/models/payment_action_list_params.rb +1 -0
  80. data/lib/modern_treasury/models/payment_order.rb +34 -111
  81. data/lib/modern_treasury/models/payment_order_create_async_params.rb +32 -484
  82. data/lib/modern_treasury/models/payment_order_create_params.rb +32 -486
  83. data/lib/modern_treasury/models/payment_order_list_params.rb +9 -1
  84. data/lib/modern_treasury/models/payment_order_update_params.rb +30 -255
  85. data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +3 -232
  86. data/lib/modern_treasury/models/payment_reference.rb +11 -2
  87. data/lib/modern_treasury/models/return_create_params.rb +75 -1
  88. data/lib/modern_treasury/models/return_list_params.rb +5 -6
  89. data/lib/modern_treasury/models/return_object.rb +87 -5
  90. data/lib/modern_treasury/models/routing_detail.rb +4 -93
  91. data/lib/modern_treasury/models/routing_detail_create_params.rb +1 -0
  92. data/lib/modern_treasury/models/routing_number_lookup_request.rb +3 -55
  93. data/lib/modern_treasury/models/transaction.rb +6 -73
  94. data/lib/modern_treasury/models/transaction_create_params.rb +9 -1
  95. data/lib/modern_treasury/models/transactions/transaction_line_item.rb +9 -2
  96. data/lib/modern_treasury/models/validation_validate_routing_number_params.rb +1 -0
  97. data/lib/modern_treasury/models/virtual_account_create_params.rb +4 -117
  98. data/lib/modern_treasury/models.rb +31 -24
  99. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  100. data/lib/modern_treasury/resources/counterparties.rb +20 -14
  101. data/lib/modern_treasury/resources/expected_payments.rb +10 -4
  102. data/lib/modern_treasury/resources/external_accounts.rb +23 -17
  103. data/lib/modern_treasury/resources/internal_accounts/balance_reports.rb +2 -2
  104. data/lib/modern_treasury/resources/internal_accounts.rb +37 -1
  105. data/lib/modern_treasury/resources/invoices.rb +2 -2
  106. data/lib/modern_treasury/resources/ledger_account_categories.rb +4 -2
  107. data/lib/modern_treasury/resources/ledger_accounts.rb +6 -2
  108. data/lib/modern_treasury/resources/ledger_entries.rb +1 -1
  109. data/lib/modern_treasury/resources/ledger_transactions.rb +5 -5
  110. data/lib/modern_treasury/resources/legal_entities.rb +4 -4
  111. data/lib/modern_treasury/resources/legal_entity_associations.rb +1 -1
  112. data/lib/modern_treasury/resources/payment_orders/reversals.rb +1 -1
  113. data/lib/modern_treasury/resources/payment_orders.rb +11 -9
  114. data/lib/modern_treasury/resources/returns.rb +4 -2
  115. data/lib/modern_treasury/resources/transactions.rb +3 -1
  116. data/lib/modern_treasury/resources/virtual_accounts.rb +1 -1
  117. data/lib/modern_treasury/version.rb +1 -1
  118. data/lib/modern_treasury.rb +16 -15
  119. data/rbi/modern_treasury/client.rbi +0 -9
  120. data/rbi/modern_treasury/errors.rbi +16 -0
  121. data/rbi/modern_treasury/internal/transport/base_client.rbi +1 -1
  122. data/rbi/modern_treasury/internal/type/boolean.rbi +2 -0
  123. data/rbi/modern_treasury/internal/type/converter.rbi +15 -15
  124. data/rbi/modern_treasury/internal/type/union.rbi +5 -0
  125. data/rbi/modern_treasury/internal/type/unknown.rbi +2 -0
  126. data/rbi/modern_treasury/models/accounting.rbi +48 -0
  127. data/rbi/modern_treasury/models/address.rbi +107 -0
  128. data/rbi/modern_treasury/models/address_request.rbi +76 -0
  129. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +802 -3025
  130. data/rbi/modern_treasury/models/bulk_result.rbi +2 -0
  131. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +511 -0
  132. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +17 -1314
  133. data/rbi/modern_treasury/models/contact_detail.rbi +124 -0
  134. data/rbi/modern_treasury/models/contact_detail_create_request.rbi +99 -0
  135. data/rbi/modern_treasury/models/counterparty.rbi +24 -264
  136. data/rbi/modern_treasury/models/counterparty_create_params.rbi +60 -1726
  137. data/rbi/modern_treasury/models/counterparty_list_params.rbi +11 -0
  138. data/rbi/modern_treasury/models/document.rbi +6 -16
  139. data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
  140. data/rbi/modern_treasury/models/document_list_params.rbi +6 -16
  141. data/rbi/modern_treasury/models/expected_payment.rbi +8 -0
  142. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +12 -419
  143. data/rbi/modern_treasury/models/expected_payment_list_params.rbi +9 -0
  144. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +8 -0
  145. data/rbi/modern_treasury/models/external_account.rbi +15 -244
  146. data/rbi/modern_treasury/models/external_account_create_params.rbi +25 -400
  147. data/rbi/modern_treasury/models/external_account_list_params.rbi +11 -0
  148. data/rbi/modern_treasury/models/external_account_update_params.rbi +4 -86
  149. data/rbi/modern_treasury/models/foreign_exchange_quote.rbi +4 -99
  150. data/rbi/modern_treasury/models/foreign_exchange_rate.rbi +96 -0
  151. data/rbi/modern_treasury/models/identification_create_request.rbi +212 -0
  152. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +5 -0
  153. data/rbi/modern_treasury/models/internal_account.rbi +332 -120
  154. data/rbi/modern_treasury/models/internal_account_create_params.rbi +333 -0
  155. data/rbi/modern_treasury/models/internal_account_update_account_capability_params.rbi +54 -0
  156. data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +304 -0
  157. data/rbi/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbi +37 -0
  158. data/rbi/modern_treasury/models/invoice.rbi +13 -128
  159. data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -139
  160. data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -139
  161. data/rbi/modern_treasury/models/ledger_account.rbi +20 -218
  162. data/rbi/modern_treasury/models/ledger_account_balance_monitor.rbi +4 -303
  163. data/rbi/modern_treasury/models/ledger_account_category.rbi +12 -301
  164. data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi +23 -7
  165. data/rbi/modern_treasury/models/ledger_account_category_retrieve_params.rbi +6 -3
  166. data/rbi/modern_treasury/models/ledger_account_create_params.rbi +5 -173
  167. data/rbi/modern_treasury/models/ledger_account_create_request.rbi +194 -0
  168. data/rbi/modern_treasury/models/ledger_account_list_params.rbi +22 -0
  169. data/rbi/modern_treasury/models/ledger_account_statement_create_response.rbi +8 -612
  170. data/rbi/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +8 -612
  171. data/rbi/modern_treasury/models/ledger_balance.rbi +66 -0
  172. data/rbi/modern_treasury/models/ledger_balances.rbi +75 -0
  173. data/rbi/modern_treasury/models/ledger_entry.rbi +4 -309
  174. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +137 -0
  175. data/rbi/modern_treasury/models/ledger_entry_list_params.rbi +99 -16
  176. data/rbi/modern_treasury/models/ledger_transaction.rbi +17 -11
  177. data/rbi/modern_treasury/models/ledger_transaction_create_params.rbi +5 -383
  178. data/rbi/modern_treasury/models/ledger_transaction_create_request.rbi +258 -0
  179. data/rbi/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +0 -5
  180. data/rbi/modern_treasury/models/ledger_transaction_list_params.rbi +93 -18
  181. data/rbi/modern_treasury/models/ledger_transaction_update_params.rbi +7 -158
  182. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +18 -316
  183. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +157 -0
  184. data/rbi/modern_treasury/models/legal_entity_association.rbi +5 -0
  185. data/rbi/modern_treasury/models/legal_entity_association_create_params.rbi +9 -917
  186. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +17 -1297
  187. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +8 -378
  188. data/rbi/modern_treasury/models/line_item.rbi +4 -52
  189. data/rbi/modern_treasury/models/payment_action_list_params.rbi +5 -0
  190. data/rbi/modern_treasury/models/payment_order.rbi +81 -172
  191. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +42 -891
  192. data/rbi/modern_treasury/models/payment_order_create_params.rbi +42 -896
  193. data/rbi/modern_treasury/models/payment_order_list_params.rbi +14 -0
  194. data/rbi/modern_treasury/models/payment_order_update_params.rbi +43 -469
  195. data/rbi/modern_treasury/models/payment_orders/reversal_create_params.rbi +4 -415
  196. data/rbi/modern_treasury/models/payment_reference.rbi +54 -9
  197. data/rbi/modern_treasury/models/return_create_params.rbi +114 -0
  198. data/rbi/modern_treasury/models/return_list_params.rbi +6 -11
  199. data/rbi/modern_treasury/models/return_object.rbi +165 -16
  200. data/rbi/modern_treasury/models/routing_detail.rbi +9 -113
  201. data/rbi/modern_treasury/models/routing_detail_create_params.rbi +5 -0
  202. data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +4 -87
  203. data/rbi/modern_treasury/models/transaction.rbi +19 -103
  204. data/rbi/modern_treasury/models/transaction_create_params.rbi +8 -0
  205. data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi +8 -5
  206. data/rbi/modern_treasury/models/validation_validate_routing_number_params.rbi +5 -0
  207. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +9 -203
  208. data/rbi/modern_treasury/models.rbi +36 -31
  209. data/rbi/modern_treasury/resources/bulk_requests.rbi +2 -1
  210. data/rbi/modern_treasury/resources/counterparties.rbi +20 -12
  211. data/rbi/modern_treasury/resources/documents.rbi +2 -2
  212. data/rbi/modern_treasury/resources/expected_payments.rbi +9 -1
  213. data/rbi/modern_treasury/resources/external_accounts.rbi +29 -22
  214. data/rbi/modern_treasury/resources/internal_accounts/balance_reports.rbi +7 -3
  215. data/rbi/modern_treasury/resources/internal_accounts.rbi +31 -0
  216. data/rbi/modern_treasury/resources/invoices.rbi +2 -8
  217. data/rbi/modern_treasury/resources/ledger_account_categories.rbi +9 -3
  218. data/rbi/modern_treasury/resources/ledger_accounts.rbi +5 -1
  219. data/rbi/modern_treasury/resources/ledger_entries.rbi +9 -2
  220. data/rbi/modern_treasury/resources/ledger_transactions.rbi +13 -13
  221. data/rbi/modern_treasury/resources/legal_entities.rbi +4 -8
  222. data/rbi/modern_treasury/resources/legal_entity_associations.rbi +1 -2
  223. data/rbi/modern_treasury/resources/payment_orders/reversals.rbi +1 -1
  224. data/rbi/modern_treasury/resources/payment_orders.rbi +16 -17
  225. data/rbi/modern_treasury/resources/returns.rbi +8 -2
  226. data/rbi/modern_treasury/resources/transactions.rbi +3 -0
  227. data/rbi/modern_treasury/resources/virtual_accounts.rbi +1 -2
  228. data/sig/modern_treasury/client.rbs +0 -6
  229. data/sig/modern_treasury/errors.rbs +9 -0
  230. data/sig/modern_treasury/internal/transport/base_client.rbs +1 -1
  231. data/sig/modern_treasury/internal/type/converter.rbs +7 -1
  232. data/sig/modern_treasury/models/accounting.rbs +15 -0
  233. data/sig/modern_treasury/models/address.rbs +70 -0
  234. data/sig/modern_treasury/models/address_request.rbs +45 -0
  235. data/sig/modern_treasury/models/bulk_request_create_params.rbs +99 -999
  236. data/sig/modern_treasury/models/bulk_result.rbs +1 -0
  237. data/sig/modern_treasury/models/child_legal_entity_create.rbs +220 -0
  238. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -548
  239. data/sig/modern_treasury/models/contact_detail.rbs +67 -0
  240. data/sig/modern_treasury/models/contact_detail_create_request.rbs +43 -0
  241. data/sig/modern_treasury/models/counterparty.rbs +20 -141
  242. data/sig/modern_treasury/models/counterparty_create_params.rbs +51 -737
  243. data/sig/modern_treasury/models/counterparty_list_params.rbs +7 -0
  244. data/sig/modern_treasury/models/document.rbs +0 -4
  245. data/sig/modern_treasury/models/document_create_params.rbs +0 -4
  246. data/sig/modern_treasury/models/document_list_params.rbs +0 -4
  247. data/sig/modern_treasury/models/expected_payment.rbs +5 -0
  248. data/sig/modern_treasury/models/expected_payment_create_params.rbs +11 -173
  249. data/sig/modern_treasury/models/expected_payment_list_params.rbs +7 -0
  250. data/sig/modern_treasury/models/expected_payment_update_params.rbs +5 -0
  251. data/sig/modern_treasury/models/external_account.rbs +13 -139
  252. data/sig/modern_treasury/models/external_account_create_params.rbs +25 -189
  253. data/sig/modern_treasury/models/external_account_list_params.rbs +7 -0
  254. data/sig/modern_treasury/models/external_account_update_params.rbs +6 -48
  255. data/sig/modern_treasury/models/foreign_exchange_quote.rbs +4 -51
  256. data/sig/modern_treasury/models/foreign_exchange_rate.rbs +50 -0
  257. data/sig/modern_treasury/models/identification_create_request.rbs +93 -0
  258. data/sig/modern_treasury/models/incoming_payment_detail.rbs +2 -0
  259. data/sig/modern_treasury/models/internal_account.rbs +148 -71
  260. data/sig/modern_treasury/models/internal_account_create_params.rbs +143 -0
  261. data/sig/modern_treasury/models/internal_account_update_account_capability_params.rbs +28 -0
  262. data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +137 -0
  263. data/sig/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbs +10 -0
  264. data/sig/modern_treasury/models/invoice.rbs +9 -68
  265. data/sig/modern_treasury/models/invoice_create_params.rbs +6 -70
  266. data/sig/modern_treasury/models/invoice_update_params.rbs +6 -70
  267. data/sig/modern_treasury/models/ledger_account.rbs +17 -123
  268. data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +4 -142
  269. data/sig/modern_treasury/models/ledger_account_category.rbs +9 -142
  270. data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +12 -5
  271. data/sig/modern_treasury/models/ledger_account_create_params.rbs +4 -84
  272. data/sig/modern_treasury/models/ledger_account_create_request.rbs +89 -0
  273. data/sig/modern_treasury/models/ledger_account_list_params.rbs +16 -0
  274. data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +8 -284
  275. data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +8 -284
  276. data/sig/modern_treasury/models/ledger_balance.rbs +40 -0
  277. data/sig/modern_treasury/models/ledger_balances.rbs +30 -0
  278. data/sig/modern_treasury/models/ledger_entry.rbs +4 -142
  279. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +62 -0
  280. data/sig/modern_treasury/models/ledger_entry_list_params.rbs +21 -3
  281. data/sig/modern_treasury/models/ledger_transaction.rbs +5 -2
  282. data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +4 -165
  283. data/sig/modern_treasury/models/ledger_transaction_create_request.rbs +109 -0
  284. data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +0 -2
  285. data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +21 -5
  286. data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +6 -67
  287. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +9 -144
  288. data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +68 -0
  289. data/sig/modern_treasury/models/legal_entity_association.rbs +3 -1
  290. data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +9 -380
  291. data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -548
  292. data/sig/modern_treasury/models/legal_entity_update_params.rbs +12 -168
  293. data/sig/modern_treasury/models/line_item.rbs +4 -16
  294. data/sig/modern_treasury/models/payment_action_list_params.rbs +2 -1
  295. data/sig/modern_treasury/models/payment_order.rbs +37 -71
  296. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +37 -380
  297. data/sig/modern_treasury/models/payment_order_create_params.rbs +37 -384
  298. data/sig/modern_treasury/models/payment_order_list_params.rbs +9 -0
  299. data/sig/modern_treasury/models/payment_order_update_params.rbs +33 -207
  300. data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +6 -173
  301. data/sig/modern_treasury/models/payment_reference.rbs +22 -4
  302. data/sig/modern_treasury/models/return_create_params.rbs +47 -0
  303. data/sig/modern_treasury/models/return_list_params.rbs +1 -6
  304. data/sig/modern_treasury/models/return_object.rbs +70 -12
  305. data/sig/modern_treasury/models/routing_detail.rbs +6 -71
  306. data/sig/modern_treasury/models/routing_detail_create_params.rbs +2 -0
  307. data/sig/modern_treasury/models/routing_number_lookup_request.rbs +6 -48
  308. data/sig/modern_treasury/models/transaction.rbs +10 -53
  309. data/sig/modern_treasury/models/transaction_create_params.rbs +5 -0
  310. data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +5 -2
  311. data/sig/modern_treasury/models/validation_validate_routing_number_params.rbs +2 -0
  312. data/sig/modern_treasury/models/virtual_account_create_params.rbs +8 -95
  313. data/sig/modern_treasury/models.rbs +30 -24
  314. data/sig/modern_treasury/resources/counterparties.rbs +2 -0
  315. data/sig/modern_treasury/resources/expected_payments.rbs +4 -1
  316. data/sig/modern_treasury/resources/external_accounts.rbs +6 -4
  317. data/sig/modern_treasury/resources/internal_accounts/balance_reports.rbs +1 -1
  318. data/sig/modern_treasury/resources/internal_accounts.rbs +8 -0
  319. data/sig/modern_treasury/resources/invoices.rbs +2 -2
  320. data/sig/modern_treasury/resources/ledger_account_categories.rbs +2 -1
  321. data/sig/modern_treasury/resources/ledger_accounts.rbs +3 -1
  322. data/sig/modern_treasury/resources/ledger_transactions.rbs +4 -4
  323. data/sig/modern_treasury/resources/legal_entities.rbs +4 -4
  324. data/sig/modern_treasury/resources/legal_entity_associations.rbs +1 -1
  325. data/sig/modern_treasury/resources/payment_orders/reversals.rbs +1 -1
  326. data/sig/modern_treasury/resources/payment_orders.rbs +6 -5
  327. data/sig/modern_treasury/resources/returns.rbs +1 -0
  328. data/sig/modern_treasury/resources/transactions.rbs +1 -0
  329. data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -1
  330. metadata +52 -49
  331. data/lib/modern_treasury/models/ledger_event_handler.rb +0 -222
  332. data/lib/modern_treasury/models/ledger_event_handler_create_params.rb +0 -177
  333. data/lib/modern_treasury/models/ledger_event_handler_delete_params.rb +0 -14
  334. data/lib/modern_treasury/models/ledger_event_handler_list_params.rb +0 -58
  335. data/lib/modern_treasury/models/ledger_event_handler_retrieve_params.rb +0 -14
  336. data/lib/modern_treasury/models/ledger_event_handler_variable.rb +0 -59
  337. data/lib/modern_treasury/models/ledgerable_event.rb +0 -92
  338. data/lib/modern_treasury/models/ledgerable_event_create_params.rb +0 -50
  339. data/lib/modern_treasury/models/ledgerable_event_retrieve_params.rb +0 -14
  340. data/lib/modern_treasury/models/paper_item.rb +0 -178
  341. data/lib/modern_treasury/models/paper_item_list_params.rb +0 -56
  342. data/lib/modern_treasury/models/paper_item_retrieve_params.rb +0 -14
  343. data/lib/modern_treasury/resources/ledger_event_handlers.rb +0 -125
  344. data/lib/modern_treasury/resources/ledgerable_events.rb +0 -65
  345. data/lib/modern_treasury/resources/paper_items.rb +0 -68
  346. data/rbi/modern_treasury/models/ledger_event_handler.rbi +0 -322
  347. data/rbi/modern_treasury/models/ledger_event_handler_create_params.rbi +0 -303
  348. data/rbi/modern_treasury/models/ledger_event_handler_delete_params.rbi +0 -32
  349. data/rbi/modern_treasury/models/ledger_event_handler_list_params.rbi +0 -92
  350. data/rbi/modern_treasury/models/ledger_event_handler_retrieve_params.rbi +0 -32
  351. data/rbi/modern_treasury/models/ledger_event_handler_variable.rbi +0 -98
  352. data/rbi/modern_treasury/models/ledgerable_event.rbi +0 -108
  353. data/rbi/modern_treasury/models/ledgerable_event_create_params.rbi +0 -75
  354. data/rbi/modern_treasury/models/ledgerable_event_retrieve_params.rbi +0 -32
  355. data/rbi/modern_treasury/models/paper_item.rbi +0 -204
  356. data/rbi/modern_treasury/models/paper_item_list_params.rbi +0 -88
  357. data/rbi/modern_treasury/models/paper_item_retrieve_params.rbi +0 -32
  358. data/rbi/modern_treasury/resources/ledger_event_handlers.rbi +0 -109
  359. data/rbi/modern_treasury/resources/ledgerable_events.rbi +0 -50
  360. data/rbi/modern_treasury/resources/paper_items.rbi +0 -51
  361. data/sig/modern_treasury/models/ledger_event_handler.rbs +0 -149
  362. data/sig/modern_treasury/models/ledger_event_handler_create_params.rbs +0 -127
  363. data/sig/modern_treasury/models/ledger_event_handler_delete_params.rbs +0 -15
  364. data/sig/modern_treasury/models/ledger_event_handler_list_params.rbs +0 -54
  365. data/sig/modern_treasury/models/ledger_event_handler_retrieve_params.rbs +0 -15
  366. data/sig/modern_treasury/models/ledger_event_handler_variable.rbs +0 -36
  367. data/sig/modern_treasury/models/ledgerable_event.rbs +0 -65
  368. data/sig/modern_treasury/models/ledgerable_event_create_params.rbs +0 -43
  369. data/sig/modern_treasury/models/ledgerable_event_retrieve_params.rbs +0 -15
  370. data/sig/modern_treasury/models/paper_item.rbs +0 -122
  371. data/sig/modern_treasury/models/paper_item_list_params.rbs +0 -54
  372. data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +0 -15
  373. data/sig/modern_treasury/resources/ledger_event_handlers.rbs +0 -37
  374. data/sig/modern_treasury/resources/ledgerable_events.rbs +0 -20
  375. data/sig/modern_treasury/resources/paper_items.rbs +0 -21
@@ -23,7 +23,7 @@ module ModernTreasury
23
23
  # An array of objects where each object contains the input params for a single
24
24
  # `action_type` request on a `resource_type` resource
25
25
  #
26
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
26
+ # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
27
27
  required :resources,
28
28
  -> {
29
29
  ModernTreasury::Internal::Type::ArrayOf[union: ModernTreasury::BulkRequestCreateParams::Resource]
@@ -44,7 +44,7 @@ module ModernTreasury
44
44
  #
45
45
  # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
46
46
  #
47
- # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
47
+ # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
48
48
  #
49
49
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
50
50
  #
@@ -85,7 +85,9 @@ module ModernTreasury
85
85
 
86
86
  variant -> { ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest }
87
87
 
88
- variant -> { ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest }
88
+ variant -> { ModernTreasury::LedgerTransactionCreateRequest }
89
+
90
+ variant -> { ModernTreasury::LedgerAccountCreateRequest }
89
91
 
90
92
  variant -> { ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest }
91
93
 
@@ -135,11 +137,8 @@ module ModernTreasury
135
137
 
136
138
  # @!attribute accounting
137
139
  #
138
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::Accounting, nil]
139
- optional :accounting,
140
- -> {
141
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::Accounting
142
- }
140
+ # @return [ModernTreasury::Models::Accounting, nil]
141
+ optional :accounting, -> { ModernTreasury::Accounting }
143
142
 
144
143
  # @!attribute accounting_category_id
145
144
  # @deprecated
@@ -160,9 +159,9 @@ module ModernTreasury
160
159
  optional :accounting_ledger_class_id, String, nil?: true
161
160
 
162
161
  # @!attribute charge_bearer
163
- # The party that will pay the fees for the payment order. Only applies to wire
164
- # payment orders. Can be one of shared, sender, or receiver, which correspond
165
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
162
+ # The party that will pay the fees for the payment order. See
163
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
164
+ # differences between the options.
166
165
  #
167
166
  # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil]
168
167
  optional :charge_bearer,
@@ -233,11 +232,8 @@ module ModernTreasury
233
232
  # creation will fail. The resulting ledger transaction will mirror the status of
234
233
  # the payment order.
235
234
  #
236
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction, nil]
237
- optional :ledger_transaction,
238
- -> {
239
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction
240
- }
235
+ # @return [ModernTreasury::Models::LedgerTransactionCreateRequest, nil]
236
+ optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }
241
237
 
242
238
  # @!attribute ledger_transaction_id
243
239
  # Either ledger_transaction or ledger_transaction_id can be provided. Only a
@@ -407,13 +403,13 @@ module ModernTreasury
407
403
  #
408
404
  # @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
409
405
  #
410
- # @param accounting [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::Accounting]
406
+ # @param accounting [ModernTreasury::Models::Accounting]
411
407
  #
412
408
  # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
413
409
  #
414
410
  # @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
415
411
  #
416
- # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
412
+ # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
417
413
  #
418
414
  # @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
419
415
  #
@@ -429,7 +425,7 @@ module ModernTreasury
429
425
  #
430
426
  # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ForeignExchangeIndicator, nil] Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`
431
427
  #
432
- # @param ledger_transaction [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction] Specifies a ledger transaction object that will be created with the payment orde
428
+ # @param ledger_transaction [ModernTreasury::Models::LedgerTransactionCreateRequest] Specifies a ledger transaction object that will be created with the payment orde
433
429
  #
434
430
  # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
435
431
  #
@@ -485,36 +481,9 @@ module ModernTreasury
485
481
  # @return [Array<Symbol>]
486
482
  end
487
483
 
488
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#accounting
489
- class Accounting < ModernTreasury::Internal::Type::BaseModel
490
- # @!attribute account_id
491
- # The ID of one of your accounting categories. Note that these will only be
492
- # accessible if your accounting system has been connected.
493
- #
494
- # @return [String, nil]
495
- optional :account_id, String, nil?: true
496
-
497
- # @!attribute class_id
498
- # The ID of one of the class objects in your accounting system. Class objects
499
- # track segments of your business independent of client or project. Note that
500
- # these will only be accessible if your accounting system has been connected.
501
- #
502
- # @return [String, nil]
503
- optional :class_id, String, nil?: true
504
-
505
- # @!method initialize(account_id: nil, class_id: nil)
506
- # Some parameter documentations has been truncated, see
507
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::Accounting}
508
- # for more details.
509
- #
510
- # @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
511
- #
512
- # @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
513
- end
514
-
515
- # The party that will pay the fees for the payment order. Only applies to wire
516
- # payment orders. Can be one of shared, sender, or receiver, which correspond
517
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
484
+ # The party that will pay the fees for the payment order. See
485
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
486
+ # differences between the options.
518
487
  #
519
488
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#charge_bearer
520
489
  module ChargeBearer
@@ -557,240 +526,6 @@ module ModernTreasury
557
526
  # @return [Array<Symbol>]
558
527
  end
559
528
 
560
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#ledger_transaction
561
- class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
562
- # @!attribute ledger_entries
563
- # An array of ledger entry objects.
564
- #
565
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry>]
566
- required :ledger_entries,
567
- -> do
568
- ModernTreasury::Internal::Type::ArrayOf[
569
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry
570
- ]
571
- end
572
-
573
- # @!attribute description
574
- # An optional description for internal use.
575
- #
576
- # @return [String, nil]
577
- optional :description, String, nil?: true
578
-
579
- # @!attribute effective_at
580
- # The timestamp (ISO8601 format) at which the ledger transaction happened for
581
- # reporting purposes.
582
- #
583
- # @return [Time, nil]
584
- optional :effective_at, Time
585
-
586
- # @!attribute effective_date
587
- # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
588
- # purposes.
589
- #
590
- # @return [Date, nil]
591
- optional :effective_date, Date
592
-
593
- # @!attribute external_id
594
- # A unique string to represent the ledger transaction. Only one pending or posted
595
- # ledger transaction may have this ID in the ledger.
596
- #
597
- # @return [String, nil]
598
- optional :external_id, String
599
-
600
- # @!attribute ledgerable_id
601
- # If the ledger transaction can be reconciled to another object in Modern
602
- # Treasury, the id will be populated here, otherwise null.
603
- #
604
- # @return [String, nil]
605
- optional :ledgerable_id, String
606
-
607
- # @!attribute ledgerable_type
608
- # If the ledger transaction can be reconciled to another object in Modern
609
- # Treasury, the type will be populated here, otherwise null. This can be one of
610
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
611
- # reversal.
612
- #
613
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerableType, nil]
614
- optional :ledgerable_type,
615
- enum: -> {
616
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerableType
617
- }
618
-
619
- # @!attribute metadata
620
- # Additional data represented as key-value pairs. Both the key and value must be
621
- # strings.
622
- #
623
- # @return [Hash{Symbol=>String}, nil]
624
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
625
-
626
- # @!attribute status
627
- # To post a ledger transaction at creation, use `posted`.
628
- #
629
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::Status, nil]
630
- optional :status,
631
- enum: -> {
632
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::Status
633
- }
634
-
635
- # @!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)
636
- # Some parameter documentations has been truncated, see
637
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction}
638
- # for more details.
639
- #
640
- # Specifies a ledger transaction object that will be created with the payment
641
- # order. If the ledger transaction cannot be created, then the payment order
642
- # creation will fail. The resulting ledger transaction will mirror the status of
643
- # the payment order.
644
- #
645
- # @param ledger_entries [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry>] An array of ledger entry objects.
646
- #
647
- # @param description [String, nil] An optional description for internal use.
648
- #
649
- # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
650
- #
651
- # @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
652
- #
653
- # @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
654
- #
655
- # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
656
- #
657
- # @param ledgerable_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
658
- #
659
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
660
- #
661
- # @param status [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::Status] To post a ledger transaction at creation, use `posted`.
662
-
663
- class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
664
- # @!attribute amount
665
- # Value in specified currency's smallest unit. e.g. $10 would be represented
666
- # as 1000. Can be any integer up to 36 digits.
667
- #
668
- # @return [Integer]
669
- required :amount, Integer
670
-
671
- # @!attribute direction
672
- # One of `credit`, `debit`. Describes the direction money is flowing in the
673
- # transaction. A `credit` moves money from your account to someone else's. A
674
- # `debit` pulls money from someone else's account to your own. Note that wire,
675
- # rtp, and check payments will always be `credit`.
676
- #
677
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
678
- required :direction, enum: -> { ModernTreasury::TransactionDirection }
679
-
680
- # @!attribute ledger_account_id
681
- # The ledger account that this ledger entry is associated with.
682
- #
683
- # @return [String]
684
- required :ledger_account_id, String
685
-
686
- # @!attribute available_balance_amount
687
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
688
- # account’s available balance. If any of these conditions would be false after the
689
- # transaction is created, the entire call will fail with error code 422.
690
- #
691
- # @return [Hash{Symbol=>Integer}, nil]
692
- optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
693
-
694
- # @!attribute lock_version
695
- # Lock version of the ledger account. This can be passed when creating a ledger
696
- # transaction to only succeed if no ledger transactions have posted since the
697
- # given version. See our post about Designing the Ledgers API with Optimistic
698
- # Locking for more details.
699
- #
700
- # @return [Integer, nil]
701
- optional :lock_version, Integer, nil?: true
702
-
703
- # @!attribute metadata
704
- # Additional data represented as key-value pairs. Both the key and value must be
705
- # strings.
706
- #
707
- # @return [Hash{Symbol=>String}, nil]
708
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
709
-
710
- # @!attribute pending_balance_amount
711
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
712
- # account’s pending balance. If any of these conditions would be false after the
713
- # transaction is created, the entire call will fail with error code 422.
714
- #
715
- # @return [Hash{Symbol=>Integer}, nil]
716
- optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
717
-
718
- # @!attribute posted_balance_amount
719
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
720
- # account’s posted balance. If any of these conditions would be false after the
721
- # transaction is created, the entire call will fail with error code 422.
722
- #
723
- # @return [Hash{Symbol=>Integer}, nil]
724
- optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
725
-
726
- # @!attribute show_resulting_ledger_account_balances
727
- # If true, response will include the balance of the associated ledger account for
728
- # the entry.
729
- #
730
- # @return [Boolean, nil]
731
- optional :show_resulting_ledger_account_balances,
732
- ModernTreasury::Internal::Type::Boolean,
733
- nil?: true
734
-
735
- # @!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)
736
- # Some parameter documentations has been truncated, see
737
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry}
738
- # for more details.
739
- #
740
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
741
- #
742
- # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
743
- #
744
- # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
745
- #
746
- # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
747
- #
748
- # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
749
- #
750
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
751
- #
752
- # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
753
- #
754
- # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
755
- #
756
- # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
757
- end
758
-
759
- # If the ledger transaction can be reconciled to another object in Modern
760
- # Treasury, the type will be populated here, otherwise null. This can be one of
761
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
762
- # reversal.
763
- #
764
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction#ledgerable_type
765
- module LedgerableType
766
- extend ModernTreasury::Internal::Type::Enum
767
-
768
- EXPECTED_PAYMENT = :expected_payment
769
- INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
770
- PAPER_ITEM = :paper_item
771
- PAYMENT_ORDER = :payment_order
772
- RETURN = :return
773
- REVERSAL = :reversal
774
-
775
- # @!method self.values
776
- # @return [Array<Symbol>]
777
- end
778
-
779
- # To post a ledger transaction at creation, use `posted`.
780
- #
781
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction#status
782
- module Status
783
- extend ModernTreasury::Internal::Type::Enum
784
-
785
- ARCHIVED = :archived
786
- PENDING = :pending
787
- POSTED = :posted
788
-
789
- # @!method self.values
790
- # @return [Array<Symbol>]
791
- end
792
- end
793
-
794
529
  class LineItem < ModernTreasury::Internal::Type::BaseModel
795
530
  # @!attribute amount
796
531
  # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -868,13 +603,17 @@ module ModernTreasury
868
603
 
869
604
  # @!attribute contact_details
870
605
  #
871
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail>, nil]
606
+ # @return [Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil]
872
607
  optional :contact_details,
873
- -> do
874
- ModernTreasury::Internal::Type::ArrayOf[
875
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail
876
- ]
877
- end
608
+ -> {
609
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest]
610
+ }
611
+
612
+ # @!attribute external_id
613
+ # An optional user-defined 180 character unique identifier.
614
+ #
615
+ # @return [String, nil]
616
+ optional :external_id, String, nil?: true
878
617
 
879
618
  # @!attribute ledger_account
880
619
  # Specifies a ledger account object that will be created with the external
@@ -883,11 +622,8 @@ module ModernTreasury
883
622
  # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
884
623
  # for more details.
885
624
  #
886
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount, nil]
887
- optional :ledger_account,
888
- -> {
889
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount
890
- }
625
+ # @return [ModernTreasury::Models::LedgerAccountCreateRequest, nil]
626
+ optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }
891
627
 
892
628
  # @!attribute metadata
893
629
  # Additional data represented as key-value pairs. Both the key and value must be
@@ -906,11 +642,8 @@ module ModernTreasury
906
642
  # @!attribute party_address
907
643
  # Required if receiving wire payments.
908
644
  #
909
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::PartyAddress, nil]
910
- optional :party_address,
911
- -> {
912
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::PartyAddress
913
- }
645
+ # @return [ModernTreasury::Models::AddressRequest, nil]
646
+ optional :party_address, -> { ModernTreasury::AddressRequest }
914
647
 
915
648
  # @!attribute party_identifier
916
649
  #
@@ -950,7 +683,7 @@ module ModernTreasury
950
683
  ]
951
684
  end
952
685
 
953
- # @!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)
686
+ # @!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)
954
687
  # Some parameter documentations has been truncated, see
955
688
  # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount}
956
689
  # for more details.
@@ -963,15 +696,17 @@ module ModernTreasury
963
696
  #
964
697
  # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
965
698
  #
966
- # @param contact_details [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail>]
699
+ # @param contact_details [Array<ModernTreasury::Models::ContactDetailCreateRequest>]
967
700
  #
968
- # @param ledger_account [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount] Specifies a ledger account object that will be created with the external account
701
+ # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
702
+ #
703
+ # @param ledger_account [ModernTreasury::Models::LedgerAccountCreateRequest] Specifies a ledger account object that will be created with the external account
969
704
  #
970
705
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
971
706
  #
972
707
  # @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
973
708
  #
974
- # @param party_address [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::PartyAddress] Required if receiving wire payments.
709
+ # @param party_address [ModernTreasury::Models::AddressRequest] Required if receiving wire payments.
975
710
  #
976
711
  # @param party_identifier [String]
977
712
  #
@@ -1025,208 +760,6 @@ module ModernTreasury
1025
760
  end
1026
761
  end
1027
762
 
1028
- class ContactDetail < ModernTreasury::Internal::Type::BaseModel
1029
- # @!attribute contact_identifier
1030
- #
1031
- # @return [String, nil]
1032
- optional :contact_identifier, String
1033
-
1034
- # @!attribute contact_identifier_type
1035
- #
1036
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail::ContactIdentifierType, nil]
1037
- optional :contact_identifier_type,
1038
- enum: -> {
1039
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail::ContactIdentifierType
1040
- }
1041
-
1042
- # @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
1043
- # @param contact_identifier [String]
1044
- # @param contact_identifier_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail::ContactIdentifierType]
1045
-
1046
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail#contact_identifier_type
1047
- module ContactIdentifierType
1048
- extend ModernTreasury::Internal::Type::Enum
1049
-
1050
- EMAIL = :email
1051
- PHONE_NUMBER = :phone_number
1052
- WEBSITE = :website
1053
-
1054
- # @!method self.values
1055
- # @return [Array<Symbol>]
1056
- end
1057
- end
1058
-
1059
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount#ledger_account
1060
- class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
1061
- # @!attribute currency
1062
- # The currency of the ledger account.
1063
- #
1064
- # @return [String]
1065
- required :currency, String
1066
-
1067
- # @!attribute ledger_id
1068
- # The id of the ledger that this account belongs to.
1069
- #
1070
- # @return [String]
1071
- required :ledger_id, String
1072
-
1073
- # @!attribute name
1074
- # The name of the ledger account.
1075
- #
1076
- # @return [String]
1077
- required :name, String
1078
-
1079
- # @!attribute normal_balance
1080
- # The normal balance of the ledger account.
1081
- #
1082
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
1083
- required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
1084
-
1085
- # @!attribute currency_exponent
1086
- # The currency exponent of the ledger account.
1087
- #
1088
- # @return [Integer, nil]
1089
- optional :currency_exponent, Integer, nil?: true
1090
-
1091
- # @!attribute description
1092
- # The description of the ledger account.
1093
- #
1094
- # @return [String, nil]
1095
- optional :description, String, nil?: true
1096
-
1097
- # @!attribute ledger_account_category_ids
1098
- # The array of ledger account category ids that this ledger account should be a
1099
- # child of.
1100
- #
1101
- # @return [Array<String>, nil]
1102
- optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
1103
-
1104
- # @!attribute ledgerable_id
1105
- # If the ledger account links to another object in Modern Treasury, the id will be
1106
- # populated here, otherwise null.
1107
- #
1108
- # @return [String, nil]
1109
- optional :ledgerable_id, String
1110
-
1111
- # @!attribute ledgerable_type
1112
- # If the ledger account links to another object in Modern Treasury, the type will
1113
- # be populated here, otherwise null. The value is one of internal_account or
1114
- # external_account.
1115
- #
1116
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount::LedgerableType, nil]
1117
- optional :ledgerable_type,
1118
- enum: -> {
1119
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount::LedgerableType
1120
- }
1121
-
1122
- # @!attribute metadata
1123
- # Additional data represented as key-value pairs. Both the key and value must be
1124
- # strings.
1125
- #
1126
- # @return [Hash{Symbol=>String}, nil]
1127
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1128
-
1129
- # @!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)
1130
- # Some parameter documentations has been truncated, see
1131
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount}
1132
- # for more details.
1133
- #
1134
- # Specifies a ledger account object that will be created with the external
1135
- # account. The resulting ledger account is linked to the external account for
1136
- # auto-ledgering Payment objects. See
1137
- # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
1138
- # for more details.
1139
- #
1140
- # @param currency [String] The currency of the ledger account.
1141
- #
1142
- # @param ledger_id [String] The id of the ledger that this account belongs to.
1143
- #
1144
- # @param name [String] The name of the ledger account.
1145
- #
1146
- # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
1147
- #
1148
- # @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
1149
- #
1150
- # @param description [String, nil] The description of the ledger account.
1151
- #
1152
- # @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
1153
- #
1154
- # @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
1155
- #
1156
- # @param ledgerable_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
1157
- #
1158
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1159
-
1160
- # If the ledger account links to another object in Modern Treasury, the type will
1161
- # be populated here, otherwise null. The value is one of internal_account or
1162
- # external_account.
1163
- #
1164
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount#ledgerable_type
1165
- module LedgerableType
1166
- extend ModernTreasury::Internal::Type::Enum
1167
-
1168
- COUNTERPARTY = :counterparty
1169
- EXTERNAL_ACCOUNT = :external_account
1170
- INTERNAL_ACCOUNT = :internal_account
1171
- VIRTUAL_ACCOUNT = :virtual_account
1172
-
1173
- # @!method self.values
1174
- # @return [Array<Symbol>]
1175
- end
1176
- end
1177
-
1178
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount#party_address
1179
- class PartyAddress < ModernTreasury::Internal::Type::BaseModel
1180
- # @!attribute country
1181
- # Country code conforms to [ISO 3166-1 alpha-2]
1182
- #
1183
- # @return [String, nil]
1184
- optional :country, String, nil?: true
1185
-
1186
- # @!attribute line1
1187
- #
1188
- # @return [String, nil]
1189
- optional :line1, String, nil?: true
1190
-
1191
- # @!attribute line2
1192
- #
1193
- # @return [String, nil]
1194
- optional :line2, String, nil?: true
1195
-
1196
- # @!attribute locality
1197
- # Locality or City.
1198
- #
1199
- # @return [String, nil]
1200
- optional :locality, String, nil?: true
1201
-
1202
- # @!attribute postal_code
1203
- # The postal code of the address.
1204
- #
1205
- # @return [String, nil]
1206
- optional :postal_code, String, nil?: true
1207
-
1208
- # @!attribute region
1209
- # Region or State.
1210
- #
1211
- # @return [String, nil]
1212
- optional :region, String, nil?: true
1213
-
1214
- # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
1215
- # Required if receiving wire payments.
1216
- #
1217
- # @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
1218
- #
1219
- # @param line1 [String, nil]
1220
- #
1221
- # @param line2 [String, nil]
1222
- #
1223
- # @param locality [String, nil] Locality or City.
1224
- #
1225
- # @param postal_code [String, nil] The postal code of the address.
1226
- #
1227
- # @param region [String, nil] Region or State.
1228
- end
1229
-
1230
763
  # Either `individual` or `business`.
1231
764
  #
1232
765
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount#party_type
@@ -1282,6 +815,7 @@ module ModernTreasury
1282
815
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
1283
816
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
1284
817
  ID_SKNBI_CODE = :id_sknbi_code
818
+ IL_BANK_CODE = :il_bank_code
1285
819
  IN_IFSC = :in_ifsc
1286
820
  JP_ZENGIN_CODE = :jp_zengin_code
1287
821
  MY_BRANCH_CODE = :my_branch_code
@@ -1399,6 +933,12 @@ module ModernTreasury
1399
933
  },
1400
934
  nil?: true
1401
935
 
936
+ # @!attribute external_id
937
+ # An optional user-defined 180 character unique identifier.
938
+ #
939
+ # @return [String, nil]
940
+ optional :external_id, String, nil?: true
941
+
1402
942
  # @!attribute internal_account_id
1403
943
  # The ID of the Internal Account for the expected payment.
1404
944
  #
@@ -1411,11 +951,8 @@ module ModernTreasury
1411
951
  # creation will fail. The resulting ledger transaction will mirror the status of
1412
952
  # the expected payment.
1413
953
  #
1414
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction, nil]
1415
- optional :ledger_transaction,
1416
- -> {
1417
- ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction
1418
- }
954
+ # @return [ModernTreasury::Models::LedgerTransactionCreateRequest, nil]
955
+ optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }
1419
956
 
1420
957
  # @!attribute ledger_transaction_id
1421
958
  # Either ledger_transaction or ledger_transaction_id can be provided. Only a
@@ -1485,7 +1022,7 @@ module ModernTreasury
1485
1022
  # @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
1486
1023
  optional :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
1487
1024
 
1488
- # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil)
1025
+ # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil)
1489
1026
  # Some parameter documentations has been truncated, see
1490
1027
  # {ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest}
1491
1028
  # for more details.
@@ -1506,453 +1043,64 @@ module ModernTreasury
1506
1043
  #
1507
1044
  # @param direction [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
1508
1045
  #
1509
- # @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
1510
- #
1511
- # @param ledger_transaction [ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction] Specifies a ledger transaction object that will be created with the expected pay
1512
- #
1513
- # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
1514
- #
1515
- # @param line_items [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>]
1516
- #
1517
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1518
- #
1519
- # @param reconciliation_filters [Object, nil] The reconciliation filters you have for this payment.
1520
- #
1521
- # @param reconciliation_groups [Object, nil] The reconciliation groups you have for this payment.
1522
- #
1523
- # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil] An array of reconciliation rule variables for this payment.
1524
- #
1525
- # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
1526
- #
1527
- # @param statement_descriptor [String, nil] The statement description you expect to see on the transaction. For ACH payments
1528
- #
1529
- # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil] One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, se
1530
-
1531
- # One of credit or debit. When you are receiving money, use credit. When you are
1532
- # being charged, use debit.
1533
- #
1534
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest#direction
1535
- module Direction
1536
- extend ModernTreasury::Internal::Type::Enum
1537
-
1538
- CREDIT = :credit
1539
- DEBIT = :debit
1540
-
1541
- # @!method self.values
1542
- # @return [Array<Symbol>]
1543
- end
1544
-
1545
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest#ledger_transaction
1546
- class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
1547
- # @!attribute ledger_entries
1548
- # An array of ledger entry objects.
1549
- #
1550
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry>]
1551
- required :ledger_entries,
1552
- -> do
1553
- ModernTreasury::Internal::Type::ArrayOf[
1554
- ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry
1555
- ]
1556
- end
1557
-
1558
- # @!attribute description
1559
- # An optional description for internal use.
1560
- #
1561
- # @return [String, nil]
1562
- optional :description, String, nil?: true
1563
-
1564
- # @!attribute effective_at
1565
- # The timestamp (ISO8601 format) at which the ledger transaction happened for
1566
- # reporting purposes.
1567
- #
1568
- # @return [Time, nil]
1569
- optional :effective_at, Time
1570
-
1571
- # @!attribute effective_date
1572
- # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
1573
- # purposes.
1574
- #
1575
- # @return [Date, nil]
1576
- optional :effective_date, Date
1577
-
1578
- # @!attribute external_id
1579
- # A unique string to represent the ledger transaction. Only one pending or posted
1580
- # ledger transaction may have this ID in the ledger.
1581
- #
1582
- # @return [String, nil]
1583
- optional :external_id, String
1584
-
1585
- # @!attribute ledgerable_id
1586
- # If the ledger transaction can be reconciled to another object in Modern
1587
- # Treasury, the id will be populated here, otherwise null.
1588
- #
1589
- # @return [String, nil]
1590
- optional :ledgerable_id, String
1591
-
1592
- # @!attribute ledgerable_type
1593
- # If the ledger transaction can be reconciled to another object in Modern
1594
- # Treasury, the type will be populated here, otherwise null. This can be one of
1595
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
1596
- # reversal.
1597
- #
1598
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerableType, nil]
1599
- optional :ledgerable_type,
1600
- enum: -> {
1601
- ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerableType
1602
- }
1603
-
1604
- # @!attribute metadata
1605
- # Additional data represented as key-value pairs. Both the key and value must be
1606
- # strings.
1607
- #
1608
- # @return [Hash{Symbol=>String}, nil]
1609
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1610
-
1611
- # @!attribute status
1612
- # To post a ledger transaction at creation, use `posted`.
1613
- #
1614
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::Status, nil]
1615
- optional :status,
1616
- enum: -> {
1617
- ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::Status
1618
- }
1619
-
1620
- # @!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)
1621
- # Some parameter documentations has been truncated, see
1622
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction}
1623
- # for more details.
1624
- #
1625
- # Specifies a ledger transaction object that will be created with the expected
1626
- # payment. If the ledger transaction cannot be created, then the expected payment
1627
- # creation will fail. The resulting ledger transaction will mirror the status of
1628
- # the expected payment.
1629
- #
1630
- # @param ledger_entries [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry>] An array of ledger entry objects.
1631
- #
1632
- # @param description [String, nil] An optional description for internal use.
1633
- #
1634
- # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
1635
- #
1636
- # @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
1637
- #
1638
- # @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
1639
- #
1640
- # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
1641
- #
1642
- # @param ledgerable_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
1643
- #
1644
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1645
- #
1646
- # @param status [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::Status] To post a ledger transaction at creation, use `posted`.
1647
-
1648
- class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
1649
- # @!attribute amount
1650
- # Value in specified currency's smallest unit. e.g. $10 would be represented
1651
- # as 1000. Can be any integer up to 36 digits.
1652
- #
1653
- # @return [Integer]
1654
- required :amount, Integer
1655
-
1656
- # @!attribute direction
1657
- # One of `credit`, `debit`. Describes the direction money is flowing in the
1658
- # transaction. A `credit` moves money from your account to someone else's. A
1659
- # `debit` pulls money from someone else's account to your own. Note that wire,
1660
- # rtp, and check payments will always be `credit`.
1661
- #
1662
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
1663
- required :direction, enum: -> { ModernTreasury::TransactionDirection }
1664
-
1665
- # @!attribute ledger_account_id
1666
- # The ledger account that this ledger entry is associated with.
1667
- #
1668
- # @return [String]
1669
- required :ledger_account_id, String
1670
-
1671
- # @!attribute available_balance_amount
1672
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
1673
- # account’s available balance. If any of these conditions would be false after the
1674
- # transaction is created, the entire call will fail with error code 422.
1675
- #
1676
- # @return [Hash{Symbol=>Integer}, nil]
1677
- optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
1678
-
1679
- # @!attribute lock_version
1680
- # Lock version of the ledger account. This can be passed when creating a ledger
1681
- # transaction to only succeed if no ledger transactions have posted since the
1682
- # given version. See our post about Designing the Ledgers API with Optimistic
1683
- # Locking for more details.
1684
- #
1685
- # @return [Integer, nil]
1686
- optional :lock_version, Integer, nil?: true
1687
-
1688
- # @!attribute metadata
1689
- # Additional data represented as key-value pairs. Both the key and value must be
1690
- # strings.
1691
- #
1692
- # @return [Hash{Symbol=>String}, nil]
1693
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1694
-
1695
- # @!attribute pending_balance_amount
1696
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
1697
- # account’s pending balance. If any of these conditions would be false after the
1698
- # transaction is created, the entire call will fail with error code 422.
1699
- #
1700
- # @return [Hash{Symbol=>Integer}, nil]
1701
- optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
1702
-
1703
- # @!attribute posted_balance_amount
1704
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
1705
- # account’s posted balance. If any of these conditions would be false after the
1706
- # transaction is created, the entire call will fail with error code 422.
1707
- #
1708
- # @return [Hash{Symbol=>Integer}, nil]
1709
- optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
1710
-
1711
- # @!attribute show_resulting_ledger_account_balances
1712
- # If true, response will include the balance of the associated ledger account for
1713
- # the entry.
1714
- #
1715
- # @return [Boolean, nil]
1716
- optional :show_resulting_ledger_account_balances,
1717
- ModernTreasury::Internal::Type::Boolean,
1718
- nil?: true
1719
-
1720
- # @!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)
1721
- # Some parameter documentations has been truncated, see
1722
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry}
1723
- # for more details.
1724
- #
1725
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
1726
- #
1727
- # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
1728
- #
1729
- # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
1730
- #
1731
- # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
1732
- #
1733
- # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
1734
- #
1735
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1736
- #
1737
- # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
1738
- #
1739
- # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
1740
- #
1741
- # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
1742
- end
1743
-
1744
- # If the ledger transaction can be reconciled to another object in Modern
1745
- # Treasury, the type will be populated here, otherwise null. This can be one of
1746
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
1747
- # reversal.
1748
- #
1749
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction#ledgerable_type
1750
- module LedgerableType
1751
- extend ModernTreasury::Internal::Type::Enum
1752
-
1753
- EXPECTED_PAYMENT = :expected_payment
1754
- INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
1755
- PAPER_ITEM = :paper_item
1756
- PAYMENT_ORDER = :payment_order
1757
- RETURN = :return
1758
- REVERSAL = :reversal
1759
-
1760
- # @!method self.values
1761
- # @return [Array<Symbol>]
1762
- end
1763
-
1764
- # To post a ledger transaction at creation, use `posted`.
1765
- #
1766
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction#status
1767
- module Status
1768
- extend ModernTreasury::Internal::Type::Enum
1769
-
1770
- ARCHIVED = :archived
1771
- PENDING = :pending
1772
- POSTED = :posted
1773
-
1774
- # @!method self.values
1775
- # @return [Array<Symbol>]
1776
- end
1777
- end
1778
-
1779
- class LineItem < ModernTreasury::Internal::Type::BaseModel
1780
- # @!attribute amount
1781
- # Value in specified currency's smallest unit. e.g. $10 would be represented
1782
- # as 1000.
1783
- #
1784
- # @return [Integer]
1785
- required :amount, Integer
1786
-
1787
- # @!attribute accounting_category_id
1788
- # The ID of one of your accounting categories. Note that these will only be
1789
- # accessible if your accounting system has been connected.
1790
- #
1791
- # @return [String, nil]
1792
- optional :accounting_category_id, String, nil?: true
1793
-
1794
- # @!attribute description
1795
- # A free-form description of the line item.
1796
- #
1797
- # @return [String, nil]
1798
- optional :description, String, nil?: true
1799
-
1800
- # @!attribute metadata
1801
- # Additional data represented as key-value pairs. Both the key and value must be
1802
- # strings.
1803
- #
1804
- # @return [Hash{Symbol=>String}, nil]
1805
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1806
-
1807
- # @!method initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil)
1808
- # Some parameter documentations has been truncated, see
1809
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem}
1810
- # for more details.
1811
- #
1812
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
1813
- #
1814
- # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
1815
- #
1816
- # @param description [String, nil] A free-form description of the line item.
1817
- #
1818
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1819
- end
1820
- end
1821
-
1822
- class LedgerTransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
1823
- # @!attribute ledger_entries
1824
- # An array of ledger entry objects.
1825
- #
1826
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry>]
1827
- required :ledger_entries,
1828
- -> {
1829
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry]
1830
- }
1831
-
1832
- # @!attribute description
1833
- # An optional description for internal use.
1834
- #
1835
- # @return [String, nil]
1836
- optional :description, String, nil?: true
1837
-
1838
- # @!attribute effective_at
1839
- # The timestamp (ISO8601 format) at which the ledger transaction happened for
1840
- # reporting purposes.
1841
- #
1842
- # @return [Time, nil]
1843
- optional :effective_at, Time
1844
-
1845
- # @!attribute effective_date
1846
- # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
1847
- # purposes.
1848
- #
1849
- # @return [Date, nil]
1850
- optional :effective_date, Date
1851
-
1852
- # @!attribute external_id
1853
- # A unique string to represent the ledger transaction. Only one pending or posted
1854
- # ledger transaction may have this ID in the ledger.
1855
- #
1856
- # @return [String, nil]
1857
- optional :external_id, String
1858
-
1859
- # @!attribute ledgerable_id
1860
- # If the ledger transaction can be reconciled to another object in Modern
1861
- # Treasury, the id will be populated here, otherwise null.
1862
- #
1863
- # @return [String, nil]
1864
- optional :ledgerable_id, String
1865
-
1866
- # @!attribute ledgerable_type
1867
- # If the ledger transaction can be reconciled to another object in Modern
1868
- # Treasury, the type will be populated here, otherwise null. This can be one of
1869
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
1870
- # reversal.
1871
- #
1872
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerableType, nil]
1873
- optional :ledgerable_type,
1874
- enum: -> {
1875
- ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerableType
1876
- }
1877
-
1878
- # @!attribute metadata
1879
- # Additional data represented as key-value pairs. Both the key and value must be
1880
- # strings.
1881
- #
1882
- # @return [Hash{Symbol=>String}, nil]
1883
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1884
-
1885
- # @!attribute status
1886
- # To post a ledger transaction at creation, use `posted`.
1887
- #
1888
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::Status, nil]
1889
- optional :status,
1890
- enum: -> {
1891
- ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::Status
1892
- }
1893
-
1894
- # @!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)
1895
- # Some parameter documentations has been truncated, see
1896
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest}
1897
- # for more details.
1046
+ # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
1898
1047
  #
1899
- # @param ledger_entries [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry>] An array of ledger entry objects.
1048
+ # @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
1900
1049
  #
1901
- # @param description [String, nil] An optional description for internal use.
1050
+ # @param ledger_transaction [ModernTreasury::Models::LedgerTransactionCreateRequest] Specifies a ledger transaction object that will be created with the expected pay
1902
1051
  #
1903
- # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
1052
+ # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
1904
1053
  #
1905
- # @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
1054
+ # @param line_items [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>]
1906
1055
  #
1907
- # @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
1056
+ # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1908
1057
  #
1909
- # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
1058
+ # @param reconciliation_filters [Object, nil] The reconciliation filters you have for this payment.
1910
1059
  #
1911
- # @param ledgerable_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
1060
+ # @param reconciliation_groups [Object, nil] The reconciliation groups you have for this payment.
1912
1061
  #
1913
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1062
+ # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil] An array of reconciliation rule variables for this payment.
1063
+ #
1064
+ # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
1065
+ #
1066
+ # @param statement_descriptor [String, nil] The statement description you expect to see on the transaction. For ACH payments
1067
+ #
1068
+ # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil] One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, se
1069
+
1070
+ # One of credit or debit. When you are receiving money, use credit. When you are
1071
+ # being charged, use debit.
1914
1072
  #
1915
- # @param status [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::Status] To post a ledger transaction at creation, use `posted`.
1073
+ # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest#direction
1074
+ module Direction
1075
+ extend ModernTreasury::Internal::Type::Enum
1076
+
1077
+ CREDIT = :credit
1078
+ DEBIT = :debit
1079
+
1080
+ # @!method self.values
1081
+ # @return [Array<Symbol>]
1082
+ end
1916
1083
 
1917
- class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
1084
+ class LineItem < ModernTreasury::Internal::Type::BaseModel
1918
1085
  # @!attribute amount
1919
1086
  # Value in specified currency's smallest unit. e.g. $10 would be represented
1920
- # as 1000. Can be any integer up to 36 digits.
1087
+ # as 1000.
1921
1088
  #
1922
1089
  # @return [Integer]
1923
1090
  required :amount, Integer
1924
1091
 
1925
- # @!attribute direction
1926
- # One of `credit`, `debit`. Describes the direction money is flowing in the
1927
- # transaction. A `credit` moves money from your account to someone else's. A
1928
- # `debit` pulls money from someone else's account to your own. Note that wire,
1929
- # rtp, and check payments will always be `credit`.
1930
- #
1931
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
1932
- required :direction, enum: -> { ModernTreasury::TransactionDirection }
1933
-
1934
- # @!attribute ledger_account_id
1935
- # The ledger account that this ledger entry is associated with.
1936
- #
1937
- # @return [String]
1938
- required :ledger_account_id, String
1939
-
1940
- # @!attribute available_balance_amount
1941
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
1942
- # account’s available balance. If any of these conditions would be false after the
1943
- # transaction is created, the entire call will fail with error code 422.
1092
+ # @!attribute accounting_category_id
1093
+ # The ID of one of your accounting categories. Note that these will only be
1094
+ # accessible if your accounting system has been connected.
1944
1095
  #
1945
- # @return [Hash{Symbol=>Integer}, nil]
1946
- optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
1096
+ # @return [String, nil]
1097
+ optional :accounting_category_id, String, nil?: true
1947
1098
 
1948
- # @!attribute lock_version
1949
- # Lock version of the ledger account. This can be passed when creating a ledger
1950
- # transaction to only succeed if no ledger transactions have posted since the
1951
- # given version. See our post about Designing the Ledgers API with Optimistic
1952
- # Locking for more details.
1099
+ # @!attribute description
1100
+ # A free-form description of the line item.
1953
1101
  #
1954
- # @return [Integer, nil]
1955
- optional :lock_version, Integer, nil?: true
1102
+ # @return [String, nil]
1103
+ optional :description, String, nil?: true
1956
1104
 
1957
1105
  # @!attribute metadata
1958
1106
  # Additional data represented as key-value pairs. Both the key and value must be
@@ -1961,87 +1109,18 @@ module ModernTreasury
1961
1109
  # @return [Hash{Symbol=>String}, nil]
1962
1110
  optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1963
1111
 
1964
- # @!attribute pending_balance_amount
1965
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
1966
- # account’s pending balance. If any of these conditions would be false after the
1967
- # transaction is created, the entire call will fail with error code 422.
1968
- #
1969
- # @return [Hash{Symbol=>Integer}, nil]
1970
- optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
1971
-
1972
- # @!attribute posted_balance_amount
1973
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
1974
- # account’s posted balance. If any of these conditions would be false after the
1975
- # transaction is created, the entire call will fail with error code 422.
1976
- #
1977
- # @return [Hash{Symbol=>Integer}, nil]
1978
- optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
1979
-
1980
- # @!attribute show_resulting_ledger_account_balances
1981
- # If true, response will include the balance of the associated ledger account for
1982
- # the entry.
1983
- #
1984
- # @return [Boolean, nil]
1985
- optional :show_resulting_ledger_account_balances,
1986
- ModernTreasury::Internal::Type::Boolean,
1987
- nil?: true
1988
-
1989
- # @!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)
1112
+ # @!method initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil)
1990
1113
  # Some parameter documentations has been truncated, see
1991
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry}
1114
+ # {ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem}
1992
1115
  # for more details.
1993
1116
  #
1994
1117
  # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
1995
1118
  #
1996
- # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
1997
- #
1998
- # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
1999
- #
2000
- # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
1119
+ # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
2001
1120
  #
2002
- # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
1121
+ # @param description [String, nil] A free-form description of the line item.
2003
1122
  #
2004
1123
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
2005
- #
2006
- # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
2007
- #
2008
- # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
2009
- #
2010
- # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
2011
- end
2012
-
2013
- # If the ledger transaction can be reconciled to another object in Modern
2014
- # Treasury, the type will be populated here, otherwise null. This can be one of
2015
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
2016
- # reversal.
2017
- #
2018
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest#ledgerable_type
2019
- module LedgerableType
2020
- extend ModernTreasury::Internal::Type::Enum
2021
-
2022
- EXPECTED_PAYMENT = :expected_payment
2023
- INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
2024
- PAPER_ITEM = :paper_item
2025
- PAYMENT_ORDER = :payment_order
2026
- RETURN = :return
2027
- REVERSAL = :reversal
2028
-
2029
- # @!method self.values
2030
- # @return [Array<Symbol>]
2031
- end
2032
-
2033
- # To post a ledger transaction at creation, use `posted`.
2034
- #
2035
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest#status
2036
- module Status
2037
- extend ModernTreasury::Internal::Type::Enum
2038
-
2039
- ARCHIVED = :archived
2040
- PENDING = :pending
2041
- POSTED = :posted
2042
-
2043
- # @!method self.values
2044
- # @return [Array<Symbol>]
2045
1124
  end
2046
1125
  end
2047
1126
 
@@ -2111,6 +1190,12 @@ module ModernTreasury
2111
1190
  },
2112
1191
  nil?: true
2113
1192
 
1193
+ # @!attribute vendor_customer_id
1194
+ # An identifier given to this transaction by the bank, often `null`.
1195
+ #
1196
+ # @return [String, nil]
1197
+ optional :vendor_customer_id, String, nil?: true
1198
+
2114
1199
  # @!attribute vendor_description
2115
1200
  # The transaction detail text that often appears in on your bank statement and in
2116
1201
  # your banking portal.
@@ -2118,7 +1203,7 @@ module ModernTreasury
2118
1203
  # @return [String, nil]
2119
1204
  optional :vendor_description, String, nil?: true
2120
1205
 
2121
- # @!method initialize(amount:, as_of_date:, direction:, internal_account_id:, vendor_code:, vendor_code_type:, metadata: nil, posted: nil, type: nil, vendor_description: nil)
1206
+ # @!method initialize(amount:, as_of_date:, direction:, internal_account_id:, vendor_code:, vendor_code_type:, metadata: nil, posted: nil, type: nil, vendor_customer_id: nil, vendor_description: nil)
2122
1207
  # Some parameter documentations has been truncated, see
2123
1208
  # {ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest}
2124
1209
  # for more details.
@@ -2141,6 +1226,8 @@ module ModernTreasury
2141
1226
  #
2142
1227
  # @param type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type, nil] The type of the transaction. Examples could be `card, `ach`, `wire`, `check`, `r
2143
1228
  #
1229
+ # @param vendor_customer_id [String, nil] An identifier given to this transaction by the bank, often `null`.
1230
+ #
2144
1231
  # @param vendor_description [String, nil] The transaction detail text that often appears in on your bank statement and in
2145
1232
 
2146
1233
  # The type of the transaction. Examples could be
@@ -2209,11 +1296,8 @@ module ModernTreasury
2209
1296
 
2210
1297
  # @!attribute accounting
2211
1298
  #
2212
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Accounting, nil]
2213
- optional :accounting,
2214
- -> {
2215
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Accounting
2216
- }
1299
+ # @return [ModernTreasury::Models::Accounting, nil]
1300
+ optional :accounting, -> { ModernTreasury::Accounting }
2217
1301
 
2218
1302
  # @!attribute accounting_category_id
2219
1303
  # @deprecated
@@ -2241,9 +1325,9 @@ module ModernTreasury
2241
1325
  optional :amount, Integer
2242
1326
 
2243
1327
  # @!attribute charge_bearer
2244
- # The party that will pay the fees for the payment order. Only applies to wire
2245
- # payment orders. Can be one of shared, sender, or receiver, which correspond
2246
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
1328
+ # The party that will pay the fees for the payment order. See
1329
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
1330
+ # differences between the options.
2247
1331
  #
2248
1332
  # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil]
2249
1333
  optional :charge_bearer,
@@ -2505,7 +1589,7 @@ module ModernTreasury
2505
1589
  #
2506
1590
  # @param id [String]
2507
1591
  #
2508
- # @param accounting [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Accounting]
1592
+ # @param accounting [ModernTreasury::Models::Accounting]
2509
1593
  #
2510
1594
  # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
2511
1595
  #
@@ -2513,7 +1597,7 @@ module ModernTreasury
2513
1597
  #
2514
1598
  # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
2515
1599
  #
2516
- # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
1600
+ # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
2517
1601
  #
2518
1602
  # @param counterparty_id [String, nil] Required when receiving_account_id is passed the ID of an external account.
2519
1603
  #
@@ -2573,36 +1657,9 @@ module ModernTreasury
2573
1657
  #
2574
1658
  # @param ultimate_receiving_party_name [String, nil] This represents the identifier by which the merchant is known to the person init
2575
1659
 
2576
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#accounting
2577
- class Accounting < ModernTreasury::Internal::Type::BaseModel
2578
- # @!attribute account_id
2579
- # The ID of one of your accounting categories. Note that these will only be
2580
- # accessible if your accounting system has been connected.
2581
- #
2582
- # @return [String, nil]
2583
- optional :account_id, String, nil?: true
2584
-
2585
- # @!attribute class_id
2586
- # The ID of one of the class objects in your accounting system. Class objects
2587
- # track segments of your business independent of client or project. Note that
2588
- # these will only be accessible if your accounting system has been connected.
2589
- #
2590
- # @return [String, nil]
2591
- optional :class_id, String, nil?: true
2592
-
2593
- # @!method initialize(account_id: nil, class_id: nil)
2594
- # Some parameter documentations has been truncated, see
2595
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Accounting}
2596
- # for more details.
2597
- #
2598
- # @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
2599
- #
2600
- # @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
2601
- end
2602
-
2603
- # The party that will pay the fees for the payment order. Only applies to wire
2604
- # payment orders. Can be one of shared, sender, or receiver, which correspond
2605
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
1660
+ # The party that will pay the fees for the payment order. See
1661
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
1662
+ # differences between the options.
2606
1663
  #
2607
1664
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#charge_bearer
2608
1665
  module ChargeBearer
@@ -2738,13 +1795,17 @@ module ModernTreasury
2738
1795
 
2739
1796
  # @!attribute contact_details
2740
1797
  #
2741
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail>, nil]
1798
+ # @return [Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil]
2742
1799
  optional :contact_details,
2743
- -> do
2744
- ModernTreasury::Internal::Type::ArrayOf[
2745
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail
2746
- ]
2747
- end
1800
+ -> {
1801
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest]
1802
+ }
1803
+
1804
+ # @!attribute external_id
1805
+ # An optional user-defined 180 character unique identifier.
1806
+ #
1807
+ # @return [String, nil]
1808
+ optional :external_id, String, nil?: true
2748
1809
 
2749
1810
  # @!attribute ledger_account
2750
1811
  # Specifies a ledger account object that will be created with the external
@@ -2753,11 +1814,8 @@ module ModernTreasury
2753
1814
  # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
2754
1815
  # for more details.
2755
1816
  #
2756
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount, nil]
2757
- optional :ledger_account,
2758
- -> {
2759
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount
2760
- }
1817
+ # @return [ModernTreasury::Models::LedgerAccountCreateRequest, nil]
1818
+ optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }
2761
1819
 
2762
1820
  # @!attribute metadata
2763
1821
  # Additional data represented as key-value pairs. Both the key and value must be
@@ -2776,11 +1834,8 @@ module ModernTreasury
2776
1834
  # @!attribute party_address
2777
1835
  # Required if receiving wire payments.
2778
1836
  #
2779
- # @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::PartyAddress, nil]
2780
- optional :party_address,
2781
- -> {
2782
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::PartyAddress
2783
- }
1837
+ # @return [ModernTreasury::Models::AddressRequest, nil]
1838
+ optional :party_address, -> { ModernTreasury::AddressRequest }
2784
1839
 
2785
1840
  # @!attribute party_identifier
2786
1841
  #
@@ -2820,7 +1875,7 @@ module ModernTreasury
2820
1875
  ]
2821
1876
  end
2822
1877
 
2823
- # @!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)
1878
+ # @!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)
2824
1879
  # Some parameter documentations has been truncated, see
2825
1880
  # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount}
2826
1881
  # for more details.
@@ -2833,15 +1888,17 @@ module ModernTreasury
2833
1888
  #
2834
1889
  # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
2835
1890
  #
2836
- # @param contact_details [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail>]
1891
+ # @param contact_details [Array<ModernTreasury::Models::ContactDetailCreateRequest>]
2837
1892
  #
2838
- # @param ledger_account [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount] Specifies a ledger account object that will be created with the external account
1893
+ # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
1894
+ #
1895
+ # @param ledger_account [ModernTreasury::Models::LedgerAccountCreateRequest] Specifies a ledger account object that will be created with the external account
2839
1896
  #
2840
1897
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
2841
1898
  #
2842
1899
  # @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
2843
1900
  #
2844
- # @param party_address [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::PartyAddress] Required if receiving wire payments.
1901
+ # @param party_address [ModernTreasury::Models::AddressRequest] Required if receiving wire payments.
2845
1902
  #
2846
1903
  # @param party_identifier [String]
2847
1904
  #
@@ -2895,208 +1952,6 @@ module ModernTreasury
2895
1952
  end
2896
1953
  end
2897
1954
 
2898
- class ContactDetail < ModernTreasury::Internal::Type::BaseModel
2899
- # @!attribute contact_identifier
2900
- #
2901
- # @return [String, nil]
2902
- optional :contact_identifier, String
2903
-
2904
- # @!attribute contact_identifier_type
2905
- #
2906
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail::ContactIdentifierType, nil]
2907
- optional :contact_identifier_type,
2908
- enum: -> {
2909
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail::ContactIdentifierType
2910
- }
2911
-
2912
- # @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
2913
- # @param contact_identifier [String]
2914
- # @param contact_identifier_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail::ContactIdentifierType]
2915
-
2916
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail#contact_identifier_type
2917
- module ContactIdentifierType
2918
- extend ModernTreasury::Internal::Type::Enum
2919
-
2920
- EMAIL = :email
2921
- PHONE_NUMBER = :phone_number
2922
- WEBSITE = :website
2923
-
2924
- # @!method self.values
2925
- # @return [Array<Symbol>]
2926
- end
2927
- end
2928
-
2929
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount#ledger_account
2930
- class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
2931
- # @!attribute currency
2932
- # The currency of the ledger account.
2933
- #
2934
- # @return [String]
2935
- required :currency, String
2936
-
2937
- # @!attribute ledger_id
2938
- # The id of the ledger that this account belongs to.
2939
- #
2940
- # @return [String]
2941
- required :ledger_id, String
2942
-
2943
- # @!attribute name
2944
- # The name of the ledger account.
2945
- #
2946
- # @return [String]
2947
- required :name, String
2948
-
2949
- # @!attribute normal_balance
2950
- # The normal balance of the ledger account.
2951
- #
2952
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
2953
- required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
2954
-
2955
- # @!attribute currency_exponent
2956
- # The currency exponent of the ledger account.
2957
- #
2958
- # @return [Integer, nil]
2959
- optional :currency_exponent, Integer, nil?: true
2960
-
2961
- # @!attribute description
2962
- # The description of the ledger account.
2963
- #
2964
- # @return [String, nil]
2965
- optional :description, String, nil?: true
2966
-
2967
- # @!attribute ledger_account_category_ids
2968
- # The array of ledger account category ids that this ledger account should be a
2969
- # child of.
2970
- #
2971
- # @return [Array<String>, nil]
2972
- optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
2973
-
2974
- # @!attribute ledgerable_id
2975
- # If the ledger account links to another object in Modern Treasury, the id will be
2976
- # populated here, otherwise null.
2977
- #
2978
- # @return [String, nil]
2979
- optional :ledgerable_id, String
2980
-
2981
- # @!attribute ledgerable_type
2982
- # If the ledger account links to another object in Modern Treasury, the type will
2983
- # be populated here, otherwise null. The value is one of internal_account or
2984
- # external_account.
2985
- #
2986
- # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount::LedgerableType, nil]
2987
- optional :ledgerable_type,
2988
- enum: -> {
2989
- ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount::LedgerableType
2990
- }
2991
-
2992
- # @!attribute metadata
2993
- # Additional data represented as key-value pairs. Both the key and value must be
2994
- # strings.
2995
- #
2996
- # @return [Hash{Symbol=>String}, nil]
2997
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
2998
-
2999
- # @!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)
3000
- # Some parameter documentations has been truncated, see
3001
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount}
3002
- # for more details.
3003
- #
3004
- # Specifies a ledger account object that will be created with the external
3005
- # account. The resulting ledger account is linked to the external account for
3006
- # auto-ledgering Payment objects. See
3007
- # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
3008
- # for more details.
3009
- #
3010
- # @param currency [String] The currency of the ledger account.
3011
- #
3012
- # @param ledger_id [String] The id of the ledger that this account belongs to.
3013
- #
3014
- # @param name [String] The name of the ledger account.
3015
- #
3016
- # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
3017
- #
3018
- # @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
3019
- #
3020
- # @param description [String, nil] The description of the ledger account.
3021
- #
3022
- # @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
3023
- #
3024
- # @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
3025
- #
3026
- # @param ledgerable_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
3027
- #
3028
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
3029
-
3030
- # If the ledger account links to another object in Modern Treasury, the type will
3031
- # be populated here, otherwise null. The value is one of internal_account or
3032
- # external_account.
3033
- #
3034
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount#ledgerable_type
3035
- module LedgerableType
3036
- extend ModernTreasury::Internal::Type::Enum
3037
-
3038
- COUNTERPARTY = :counterparty
3039
- EXTERNAL_ACCOUNT = :external_account
3040
- INTERNAL_ACCOUNT = :internal_account
3041
- VIRTUAL_ACCOUNT = :virtual_account
3042
-
3043
- # @!method self.values
3044
- # @return [Array<Symbol>]
3045
- end
3046
- end
3047
-
3048
- # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount#party_address
3049
- class PartyAddress < ModernTreasury::Internal::Type::BaseModel
3050
- # @!attribute country
3051
- # Country code conforms to [ISO 3166-1 alpha-2]
3052
- #
3053
- # @return [String, nil]
3054
- optional :country, String, nil?: true
3055
-
3056
- # @!attribute line1
3057
- #
3058
- # @return [String, nil]
3059
- optional :line1, String, nil?: true
3060
-
3061
- # @!attribute line2
3062
- #
3063
- # @return [String, nil]
3064
- optional :line2, String, nil?: true
3065
-
3066
- # @!attribute locality
3067
- # Locality or City.
3068
- #
3069
- # @return [String, nil]
3070
- optional :locality, String, nil?: true
3071
-
3072
- # @!attribute postal_code
3073
- # The postal code of the address.
3074
- #
3075
- # @return [String, nil]
3076
- optional :postal_code, String, nil?: true
3077
-
3078
- # @!attribute region
3079
- # Region or State.
3080
- #
3081
- # @return [String, nil]
3082
- optional :region, String, nil?: true
3083
-
3084
- # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
3085
- # Required if receiving wire payments.
3086
- #
3087
- # @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
3088
- #
3089
- # @param line1 [String, nil]
3090
- #
3091
- # @param line2 [String, nil]
3092
- #
3093
- # @param locality [String, nil] Locality or City.
3094
- #
3095
- # @param postal_code [String, nil] The postal code of the address.
3096
- #
3097
- # @param region [String, nil] Region or State.
3098
- end
3099
-
3100
1955
  # Either `individual` or `business`.
3101
1956
  #
3102
1957
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount#party_type
@@ -3152,6 +2007,7 @@ module ModernTreasury
3152
2007
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
3153
2008
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
3154
2009
  ID_SKNBI_CODE = :id_sknbi_code
2010
+ IL_BANK_CODE = :il_bank_code
3155
2011
  IN_IFSC = :in_ifsc
3156
2012
  JP_ZENGIN_CODE = :jp_zengin_code
3157
2013
  MY_BRANCH_CODE = :my_branch_code
@@ -3231,6 +2087,7 @@ module ModernTreasury
3231
2087
  RETURNED = :returned
3232
2088
  REVERSED = :reversed
3233
2089
  SENT = :sent
2090
+ STOPPED = :stopped
3234
2091
 
3235
2092
  # @!method self.values
3236
2093
  # @return [Array<Symbol>]
@@ -3298,6 +2155,12 @@ module ModernTreasury
3298
2155
  },
3299
2156
  nil?: true
3300
2157
 
2158
+ # @!attribute external_id
2159
+ # An optional user-defined 180 character unique identifier.
2160
+ #
2161
+ # @return [String, nil]
2162
+ optional :external_id, String, nil?: true
2163
+
3301
2164
  # @!attribute internal_account_id
3302
2165
  # The ID of the Internal Account for the expected payment.
3303
2166
  #
@@ -3366,7 +2229,7 @@ module ModernTreasury
3366
2229
  # @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
3367
2230
  optional :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
3368
2231
 
3369
- # @!method initialize(id: nil, amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil)
2232
+ # @!method initialize(id: nil, amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil)
3370
2233
  # Some parameter documentations has been truncated, see
3371
2234
  # {ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID}
3372
2235
  # for more details.
@@ -3389,6 +2252,8 @@ module ModernTreasury
3389
2252
  #
3390
2253
  # @param direction [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
3391
2254
  #
2255
+ # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
2256
+ #
3392
2257
  # @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
3393
2258
  #
3394
2259
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
@@ -3480,11 +2345,9 @@ module ModernTreasury
3480
2345
  # @!attribute ledger_entries
3481
2346
  # An array of ledger entry objects.
3482
2347
  #
3483
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerEntry>, nil]
2348
+ # @return [Array<ModernTreasury::Models::LedgerEntryCreateRequest>, nil]
3484
2349
  optional :ledger_entries,
3485
- -> {
3486
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerEntry]
3487
- }
2350
+ -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LedgerEntryCreateRequest] }
3488
2351
 
3489
2352
  # @!attribute ledgerable_id
3490
2353
  # If the ledger transaction can be reconciled to another object in Modern
@@ -3496,8 +2359,7 @@ module ModernTreasury
3496
2359
  # @!attribute ledgerable_type
3497
2360
  # If the ledger transaction can be reconciled to another object in Modern
3498
2361
  # Treasury, the type will be populated here, otherwise null. This can be one of
3499
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
3500
- # reversal.
2362
+ # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
3501
2363
  #
3502
2364
  # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerableType, nil]
3503
2365
  optional :ledgerable_type,
@@ -3532,7 +2394,7 @@ module ModernTreasury
3532
2394
  #
3533
2395
  # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
3534
2396
  #
3535
- # @param ledger_entries [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerEntry>] An array of ledger entry objects.
2397
+ # @param ledger_entries [Array<ModernTreasury::Models::LedgerEntryCreateRequest>] An array of ledger entry objects.
3536
2398
  #
3537
2399
  # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
3538
2400
  #
@@ -3542,106 +2404,9 @@ module ModernTreasury
3542
2404
  #
3543
2405
  # @param status [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::Status] To post a ledger transaction at creation, use `posted`.
3544
2406
 
3545
- class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
3546
- # @!attribute amount
3547
- # Value in specified currency's smallest unit. e.g. $10 would be represented
3548
- # as 1000. Can be any integer up to 36 digits.
3549
- #
3550
- # @return [Integer]
3551
- required :amount, Integer
3552
-
3553
- # @!attribute direction
3554
- # One of `credit`, `debit`. Describes the direction money is flowing in the
3555
- # transaction. A `credit` moves money from your account to someone else's. A
3556
- # `debit` pulls money from someone else's account to your own. Note that wire,
3557
- # rtp, and check payments will always be `credit`.
3558
- #
3559
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
3560
- required :direction, enum: -> { ModernTreasury::TransactionDirection }
3561
-
3562
- # @!attribute ledger_account_id
3563
- # The ledger account that this ledger entry is associated with.
3564
- #
3565
- # @return [String]
3566
- required :ledger_account_id, String
3567
-
3568
- # @!attribute available_balance_amount
3569
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
3570
- # account’s available balance. If any of these conditions would be false after the
3571
- # transaction is created, the entire call will fail with error code 422.
3572
- #
3573
- # @return [Hash{Symbol=>Integer}, nil]
3574
- optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
3575
-
3576
- # @!attribute lock_version
3577
- # Lock version of the ledger account. This can be passed when creating a ledger
3578
- # transaction to only succeed if no ledger transactions have posted since the
3579
- # given version. See our post about Designing the Ledgers API with Optimistic
3580
- # Locking for more details.
3581
- #
3582
- # @return [Integer, nil]
3583
- optional :lock_version, Integer, nil?: true
3584
-
3585
- # @!attribute metadata
3586
- # Additional data represented as key-value pairs. Both the key and value must be
3587
- # strings.
3588
- #
3589
- # @return [Hash{Symbol=>String}, nil]
3590
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
3591
-
3592
- # @!attribute pending_balance_amount
3593
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
3594
- # account’s pending balance. If any of these conditions would be false after the
3595
- # transaction is created, the entire call will fail with error code 422.
3596
- #
3597
- # @return [Hash{Symbol=>Integer}, nil]
3598
- optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
3599
-
3600
- # @!attribute posted_balance_amount
3601
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
3602
- # account’s posted balance. If any of these conditions would be false after the
3603
- # transaction is created, the entire call will fail with error code 422.
3604
- #
3605
- # @return [Hash{Symbol=>Integer}, nil]
3606
- optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
3607
-
3608
- # @!attribute show_resulting_ledger_account_balances
3609
- # If true, response will include the balance of the associated ledger account for
3610
- # the entry.
3611
- #
3612
- # @return [Boolean, nil]
3613
- optional :show_resulting_ledger_account_balances,
3614
- ModernTreasury::Internal::Type::Boolean,
3615
- nil?: true
3616
-
3617
- # @!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)
3618
- # Some parameter documentations has been truncated, see
3619
- # {ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerEntry}
3620
- # for more details.
3621
- #
3622
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
3623
- #
3624
- # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
3625
- #
3626
- # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
3627
- #
3628
- # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
3629
- #
3630
- # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
3631
- #
3632
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
3633
- #
3634
- # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
3635
- #
3636
- # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
3637
- #
3638
- # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
3639
- end
3640
-
3641
2407
  # If the ledger transaction can be reconciled to another object in Modern
3642
2408
  # Treasury, the type will be populated here, otherwise null. This can be one of
3643
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
3644
- # reversal.
2409
+ # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
3645
2410
  #
3646
2411
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID#ledgerable_type
3647
2412
  module LedgerableType
@@ -3649,7 +2414,6 @@ module ModernTreasury
3649
2414
 
3650
2415
  EXPECTED_PAYMENT = :expected_payment
3651
2416
  INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
3652
- PAPER_ITEM = :paper_item
3653
2417
  PAYMENT_ORDER = :payment_order
3654
2418
  RETURN = :return
3655
2419
  REVERSAL = :reversal
@@ -3674,7 +2438,7 @@ module ModernTreasury
3674
2438
  end
3675
2439
 
3676
2440
  # @!method self.variants
3677
- # @return [Array(ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID)]
2441
+ # @return [Array(ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID)]
3678
2442
  end
3679
2443
  end
3680
2444
  end