modern_treasury 0.5.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +49 -0
- data/README.md +9 -9
- data/lib/modern_treasury/errors.rb +25 -11
- data/lib/modern_treasury/file_part.rb +10 -7
- data/lib/modern_treasury/internal/page.rb +3 -3
- data/lib/modern_treasury/internal/transport/base_client.rb +11 -7
- data/lib/modern_treasury/internal/transport/pooled_net_requester.rb +7 -10
- data/lib/modern_treasury/internal/type/base_page.rb +1 -1
- data/lib/modern_treasury/internal/type/file_input.rb +7 -4
- data/lib/modern_treasury/internal/util.rb +5 -5
- data/lib/modern_treasury/models/bulk_request_create_params.rb +155 -2
- data/lib/modern_treasury/models/counterparty.rb +5 -18
- data/lib/modern_treasury/models/counterparty_create_params.rb +7 -16
- data/lib/modern_treasury/models/incoming_payment_detail.rb +23 -1
- data/lib/modern_treasury/models/internal_account.rb +25 -1
- data/lib/modern_treasury/models/internal_account_list_params.rb +23 -1
- data/lib/modern_treasury/models/invoice_list_params.rb +17 -1
- data/lib/modern_treasury/models/line_item.rb +55 -1
- data/lib/modern_treasury/models/payment_order.rb +226 -1
- data/lib/modern_treasury/models/payment_order_create_async_params.rb +72 -1
- data/lib/modern_treasury/models/payment_order_create_params.rb +71 -1
- data/lib/modern_treasury/models/payment_order_list_params.rb +1 -0
- data/lib/modern_treasury/models/payment_order_update_params.rb +72 -1
- data/lib/modern_treasury/models/payment_orders/reversal.rb +24 -1
- data/lib/modern_treasury/models/payment_reference.rb +1 -0
- data/lib/modern_treasury/models/return_create_params.rb +21 -1
- data/lib/modern_treasury/models/return_object.rb +25 -1
- data/lib/modern_treasury/models/transaction.rb +1 -0
- data/lib/modern_treasury/resources/counterparties.rb +1 -1
- data/lib/modern_treasury/resources/internal_accounts.rb +3 -1
- data/lib/modern_treasury/resources/invoices.rb +5 -1
- data/lib/modern_treasury/resources/payment_orders.rb +21 -3
- data/lib/modern_treasury/resources/returns.rb +3 -1
- data/lib/modern_treasury/version.rb +1 -1
- data/rbi/modern_treasury/errors.rbi +29 -2
- data/rbi/modern_treasury/file_part.rbi +1 -1
- data/rbi/modern_treasury/internal/transport/base_client.rbi +4 -5
- data/rbi/modern_treasury/internal/type/base_page.rbi +1 -1
- data/rbi/modern_treasury/internal/util.rbi +1 -1
- data/rbi/modern_treasury/models/bulk_request_create_params.rbi +289 -0
- data/rbi/modern_treasury/models/counterparty.rbi +3 -49
- data/rbi/modern_treasury/models/counterparty_create_params.rbi +4 -62
- data/rbi/modern_treasury/models/incoming_payment_detail.rbi +54 -0
- data/rbi/modern_treasury/models/internal_account.rbi +52 -0
- data/rbi/modern_treasury/models/internal_account_list_params.rbi +66 -0
- data/rbi/modern_treasury/models/invoice_list_params.rbi +22 -0
- data/rbi/modern_treasury/models/line_item.rbi +69 -0
- data/rbi/modern_treasury/models/payment_order.rbi +374 -0
- data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +140 -0
- data/rbi/modern_treasury/models/payment_order_create_params.rbi +137 -0
- data/rbi/modern_treasury/models/payment_order_list_params.rbi +5 -0
- data/rbi/modern_treasury/models/payment_order_update_params.rbi +142 -0
- data/rbi/modern_treasury/models/payment_orders/reversal.rbi +54 -0
- data/rbi/modern_treasury/models/payment_reference.rbi +5 -0
- data/rbi/modern_treasury/models/return_create_params.rbi +64 -0
- data/rbi/modern_treasury/models/return_object.rbi +58 -0
- data/rbi/modern_treasury/models/transaction.rbi +5 -0
- data/rbi/modern_treasury/resources/counterparties.rbi +1 -2
- data/rbi/modern_treasury/resources/internal_accounts.rbi +3 -0
- data/rbi/modern_treasury/resources/invoices.rbi +6 -0
- data/rbi/modern_treasury/resources/payment_orders.rbi +33 -0
- data/rbi/modern_treasury/resources/returns.rbi +4 -0
- data/sig/modern_treasury/errors.rbs +7 -0
- data/sig/modern_treasury/file_part.rbs +1 -1
- data/sig/modern_treasury/models/bulk_request_create_params.rbs +98 -0
- data/sig/modern_treasury/models/counterparty.rbs +4 -18
- data/sig/modern_treasury/models/counterparty_create_params.rbs +5 -21
- data/sig/modern_treasury/models/incoming_payment_detail.rbs +18 -0
- data/sig/modern_treasury/models/internal_account.rbs +20 -0
- data/sig/modern_treasury/models/internal_account_list_params.rbs +25 -1
- data/sig/modern_treasury/models/invoice_list_params.rbs +14 -0
- data/sig/modern_treasury/models/line_item.rbs +22 -0
- data/sig/modern_treasury/models/payment_order.rbs +154 -0
- data/sig/modern_treasury/models/payment_order_create_async_params.rbs +48 -0
- data/sig/modern_treasury/models/payment_order_create_params.rbs +48 -0
- data/sig/modern_treasury/models/payment_order_list_params.rbs +2 -0
- data/sig/modern_treasury/models/payment_order_update_params.rbs +50 -0
- data/sig/modern_treasury/models/payment_orders/reversal.rbs +18 -0
- data/sig/modern_treasury/models/payment_reference.rbs +2 -0
- data/sig/modern_treasury/models/return_create_params.rbs +23 -1
- data/sig/modern_treasury/models/return_object.rbs +22 -0
- data/sig/modern_treasury/models/transaction.rbs +2 -0
- data/sig/modern_treasury/resources/counterparties.rbs +1 -1
- data/sig/modern_treasury/resources/internal_accounts.rbs +1 -0
- data/sig/modern_treasury/resources/invoices.rbs +2 -0
- data/sig/modern_treasury/resources/payment_orders.rbs +9 -0
- data/sig/modern_treasury/resources/returns.rbs +1 -0
- metadata +2 -2
|
@@ -9,6 +9,12 @@ module ModernTreasury
|
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
11
11
|
|
|
12
|
+
# @!attribute accounting
|
|
13
|
+
# @deprecated
|
|
14
|
+
#
|
|
15
|
+
# @return [ModernTreasury::Models::PaymentOrder::Accounting]
|
|
16
|
+
required :accounting, -> { ModernTreasury::PaymentOrder::Accounting }
|
|
17
|
+
|
|
12
18
|
# @!attribute accounting_category_id
|
|
13
19
|
# @deprecated
|
|
14
20
|
#
|
|
@@ -18,6 +24,15 @@ module ModernTreasury
|
|
|
18
24
|
# @return [String, nil]
|
|
19
25
|
required :accounting_category_id, String, nil?: true
|
|
20
26
|
|
|
27
|
+
# @!attribute accounting_ledger_class_id
|
|
28
|
+
# @deprecated
|
|
29
|
+
#
|
|
30
|
+
# The ID of one of your accounting ledger classes. Note that these will only be
|
|
31
|
+
# accessible if your accounting system has been connected.
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
required :accounting_ledger_class_id, String, nil?: true
|
|
35
|
+
|
|
21
36
|
# @!attribute amount
|
|
22
37
|
# Value in specified currency's smallest unit. e.g. $10 would be represented as
|
|
23
38
|
# 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
|
|
@@ -51,6 +66,13 @@ module ModernTreasury
|
|
|
51
66
|
# @return [Symbol, ModernTreasury::Models::Currency]
|
|
52
67
|
required :currency, enum: -> { ModernTreasury::Currency }
|
|
53
68
|
|
|
69
|
+
# @!attribute current_hold
|
|
70
|
+
# If the payment order's status is `held`, this will include the hold object's
|
|
71
|
+
# data.
|
|
72
|
+
#
|
|
73
|
+
# @return [ModernTreasury::Models::PaymentOrder::CurrentHold, nil]
|
|
74
|
+
required :current_hold, -> { ModernTreasury::PaymentOrder::CurrentHold }, nil?: true
|
|
75
|
+
|
|
54
76
|
# @!attribute current_return
|
|
55
77
|
# If the payment order's status is `returned`, this will include the return
|
|
56
78
|
# object's data.
|
|
@@ -200,6 +222,12 @@ module ModernTreasury
|
|
|
200
222
|
# @return [Symbol, ModernTreasury::Models::PaymentOrder::ReceivingAccountType]
|
|
201
223
|
required :receiving_account_type, enum: -> { ModernTreasury::PaymentOrder::ReceivingAccountType }
|
|
202
224
|
|
|
225
|
+
# @!attribute reconciliation_status
|
|
226
|
+
# One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
227
|
+
#
|
|
228
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrder::ReconciliationStatus]
|
|
229
|
+
required :reconciliation_status, enum: -> { ModernTreasury::PaymentOrder::ReconciliationStatus }
|
|
230
|
+
|
|
203
231
|
# @!attribute reference_numbers
|
|
204
232
|
#
|
|
205
233
|
# @return [Array<ModernTreasury::Models::PaymentOrder::ReferenceNumber>]
|
|
@@ -328,14 +356,18 @@ module ModernTreasury
|
|
|
328
356
|
# @return [String, nil]
|
|
329
357
|
required :vendor_failure_reason, String, nil?: true
|
|
330
358
|
|
|
331
|
-
# @!method initialize(id:, accounting_category_id:, amount:, charge_bearer:, counterparty_id:, created_at:, currency:, current_return:, description:, direction:, effective_date:, expires_at:, external_id:, foreign_exchange_contract:, foreign_exchange_indicator:, foreign_exchange_rate:, ledger_transaction_id:, live_mode:, metadata:, nsf_protected:, object:, originating_account_id:, originating_party_name:, priority:, process_after:, purpose:, receiving_account_id:, receiving_account_type:, reference_numbers:, remittance_information:, send_remittance_advice:, statement_descriptor:, status:, subtype:, transaction_ids:, type:, ultimate_originating_account:, ultimate_originating_account_id:, ultimate_originating_account_type:, ultimate_originating_party_identifier:, ultimate_originating_party_name:, ultimate_receiving_party_identifier:, ultimate_receiving_party_name:, updated_at:, vendor_attributes:, vendor_failure_reason:)
|
|
359
|
+
# @!method initialize(id:, accounting:, accounting_category_id:, accounting_ledger_class_id:, amount:, charge_bearer:, counterparty_id:, created_at:, currency:, current_hold:, current_return:, description:, direction:, effective_date:, expires_at:, external_id:, foreign_exchange_contract:, foreign_exchange_indicator:, foreign_exchange_rate:, ledger_transaction_id:, live_mode:, metadata:, nsf_protected:, object:, originating_account_id:, originating_party_name:, priority:, process_after:, purpose:, receiving_account_id:, receiving_account_type:, reconciliation_status:, reference_numbers:, remittance_information:, send_remittance_advice:, statement_descriptor:, status:, subtype:, transaction_ids:, type:, ultimate_originating_account:, ultimate_originating_account_id:, ultimate_originating_account_type:, ultimate_originating_party_identifier:, ultimate_originating_party_name:, ultimate_receiving_party_identifier:, ultimate_receiving_party_name:, updated_at:, vendor_attributes:, vendor_failure_reason:)
|
|
332
360
|
# Some parameter documentations has been truncated, see
|
|
333
361
|
# {ModernTreasury::Models::PaymentOrder} for more details.
|
|
334
362
|
#
|
|
335
363
|
# @param id [String]
|
|
336
364
|
#
|
|
365
|
+
# @param accounting [ModernTreasury::Models::PaymentOrder::Accounting]
|
|
366
|
+
#
|
|
337
367
|
# @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
338
368
|
#
|
|
369
|
+
# @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
|
|
370
|
+
#
|
|
339
371
|
# @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
|
|
340
372
|
#
|
|
341
373
|
# @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrder::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
|
|
@@ -346,6 +378,8 @@ module ModernTreasury
|
|
|
346
378
|
#
|
|
347
379
|
# @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
|
|
348
380
|
#
|
|
381
|
+
# @param current_hold [ModernTreasury::Models::PaymentOrder::CurrentHold, nil] If the payment order's status is `held`, this will include the hold object's dat
|
|
382
|
+
#
|
|
349
383
|
# @param current_return [ModernTreasury::Models::ReturnObject, nil] If the payment order's status is `returned`, this will include the return object
|
|
350
384
|
#
|
|
351
385
|
# @param description [String, nil] An optional description for internal use.
|
|
@@ -388,6 +422,8 @@ module ModernTreasury
|
|
|
388
422
|
#
|
|
389
423
|
# @param receiving_account_type [Symbol, ModernTreasury::Models::PaymentOrder::ReceivingAccountType]
|
|
390
424
|
#
|
|
425
|
+
# @param reconciliation_status [Symbol, ModernTreasury::Models::PaymentOrder::ReconciliationStatus] One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
426
|
+
#
|
|
391
427
|
# @param reference_numbers [Array<ModernTreasury::Models::PaymentOrder::ReferenceNumber>]
|
|
392
428
|
#
|
|
393
429
|
# @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
|
|
@@ -424,6 +460,38 @@ module ModernTreasury
|
|
|
424
460
|
#
|
|
425
461
|
# @param vendor_failure_reason [String, nil] This field will be populated if a vendor failure occurs. Logic shouldn't be buil
|
|
426
462
|
|
|
463
|
+
# @deprecated
|
|
464
|
+
#
|
|
465
|
+
# @see ModernTreasury::Models::PaymentOrder#accounting
|
|
466
|
+
class Accounting < ModernTreasury::Internal::Type::BaseModel
|
|
467
|
+
# @!attribute account_id
|
|
468
|
+
# @deprecated
|
|
469
|
+
#
|
|
470
|
+
# The ID of one of your accounting categories. Note that these will only be
|
|
471
|
+
# accessible if your accounting system has been connected.
|
|
472
|
+
#
|
|
473
|
+
# @return [String, nil]
|
|
474
|
+
optional :account_id, String, nil?: true
|
|
475
|
+
|
|
476
|
+
# @!attribute class_id
|
|
477
|
+
# @deprecated
|
|
478
|
+
#
|
|
479
|
+
# The ID of one of the class objects in your accounting system. Class objects
|
|
480
|
+
# track segments of your business independent of client or project. Note that
|
|
481
|
+
# these will only be accessible if your accounting system has been connected.
|
|
482
|
+
#
|
|
483
|
+
# @return [String, nil]
|
|
484
|
+
optional :class_id, String, nil?: true
|
|
485
|
+
|
|
486
|
+
# @!method initialize(account_id: nil, class_id: nil)
|
|
487
|
+
# Some parameter documentations has been truncated, see
|
|
488
|
+
# {ModernTreasury::Models::PaymentOrder::Accounting} for more details.
|
|
489
|
+
#
|
|
490
|
+
# @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
491
|
+
#
|
|
492
|
+
# @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
|
|
493
|
+
end
|
|
494
|
+
|
|
427
495
|
# The party that will pay the fees for the payment order. See
|
|
428
496
|
# https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
|
|
429
497
|
# differences between the options.
|
|
@@ -440,6 +508,147 @@ module ModernTreasury
|
|
|
440
508
|
# @return [Array<Symbol>]
|
|
441
509
|
end
|
|
442
510
|
|
|
511
|
+
# @see ModernTreasury::Models::PaymentOrder#current_hold
|
|
512
|
+
class CurrentHold < ModernTreasury::Internal::Type::BaseModel
|
|
513
|
+
# @!attribute id
|
|
514
|
+
#
|
|
515
|
+
# @return [String]
|
|
516
|
+
required :id, String
|
|
517
|
+
|
|
518
|
+
# @!attribute created_at
|
|
519
|
+
#
|
|
520
|
+
# @return [Time]
|
|
521
|
+
required :created_at, Time
|
|
522
|
+
|
|
523
|
+
# @!attribute object
|
|
524
|
+
# The type of object
|
|
525
|
+
#
|
|
526
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Object]
|
|
527
|
+
required :object, enum: -> { ModernTreasury::PaymentOrder::CurrentHold::Object }
|
|
528
|
+
|
|
529
|
+
# @!attribute status
|
|
530
|
+
# The status of the hold
|
|
531
|
+
#
|
|
532
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Status]
|
|
533
|
+
required :status, enum: -> { ModernTreasury::PaymentOrder::CurrentHold::Status }
|
|
534
|
+
|
|
535
|
+
# @!attribute target_id
|
|
536
|
+
# The ID of the target being held
|
|
537
|
+
#
|
|
538
|
+
# @return [String]
|
|
539
|
+
required :target_id, String
|
|
540
|
+
|
|
541
|
+
# @!attribute target_type
|
|
542
|
+
# The type of target being held
|
|
543
|
+
#
|
|
544
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::TargetType]
|
|
545
|
+
required :target_type, enum: -> { ModernTreasury::PaymentOrder::CurrentHold::TargetType }
|
|
546
|
+
|
|
547
|
+
# @!attribute updated_at
|
|
548
|
+
#
|
|
549
|
+
# @return [Time]
|
|
550
|
+
required :updated_at, Time
|
|
551
|
+
|
|
552
|
+
# @!attribute live_mode
|
|
553
|
+
# This field will be true if this object exists in the live environment or false
|
|
554
|
+
# if it exists in the test environment.
|
|
555
|
+
#
|
|
556
|
+
# @return [Boolean, nil]
|
|
557
|
+
optional :live_mode, ModernTreasury::Internal::Type::Boolean
|
|
558
|
+
|
|
559
|
+
# @!attribute metadata
|
|
560
|
+
# Additional metadata for the hold
|
|
561
|
+
#
|
|
562
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
563
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
|
|
564
|
+
|
|
565
|
+
# @!attribute reason
|
|
566
|
+
# The reason for the hold
|
|
567
|
+
#
|
|
568
|
+
# @return [String, nil]
|
|
569
|
+
optional :reason, String, nil?: true
|
|
570
|
+
|
|
571
|
+
# @!attribute resolution
|
|
572
|
+
# The resolution of the hold
|
|
573
|
+
#
|
|
574
|
+
# @return [String, nil]
|
|
575
|
+
optional :resolution, String, nil?: true
|
|
576
|
+
|
|
577
|
+
# @!attribute resolved_at
|
|
578
|
+
# When the hold was resolved
|
|
579
|
+
#
|
|
580
|
+
# @return [Time, nil]
|
|
581
|
+
optional :resolved_at, Time, nil?: true
|
|
582
|
+
|
|
583
|
+
# @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
|
|
584
|
+
# Some parameter documentations has been truncated, see
|
|
585
|
+
# {ModernTreasury::Models::PaymentOrder::CurrentHold} for more details.
|
|
586
|
+
#
|
|
587
|
+
# If the payment order's status is `held`, this will include the hold object's
|
|
588
|
+
# data.
|
|
589
|
+
#
|
|
590
|
+
# @param id [String]
|
|
591
|
+
#
|
|
592
|
+
# @param created_at [Time]
|
|
593
|
+
#
|
|
594
|
+
# @param object [Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Object] The type of object
|
|
595
|
+
#
|
|
596
|
+
# @param status [Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Status] The status of the hold
|
|
597
|
+
#
|
|
598
|
+
# @param target_id [String] The ID of the target being held
|
|
599
|
+
#
|
|
600
|
+
# @param target_type [Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::TargetType] The type of target being held
|
|
601
|
+
#
|
|
602
|
+
# @param updated_at [Time]
|
|
603
|
+
#
|
|
604
|
+
# @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
|
|
605
|
+
#
|
|
606
|
+
# @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
|
|
607
|
+
#
|
|
608
|
+
# @param reason [String, nil] The reason for the hold
|
|
609
|
+
#
|
|
610
|
+
# @param resolution [String, nil] The resolution of the hold
|
|
611
|
+
#
|
|
612
|
+
# @param resolved_at [Time, nil] When the hold was resolved
|
|
613
|
+
|
|
614
|
+
# The type of object
|
|
615
|
+
#
|
|
616
|
+
# @see ModernTreasury::Models::PaymentOrder::CurrentHold#object
|
|
617
|
+
module Object
|
|
618
|
+
extend ModernTreasury::Internal::Type::Enum
|
|
619
|
+
|
|
620
|
+
HOLD = :hold
|
|
621
|
+
|
|
622
|
+
# @!method self.values
|
|
623
|
+
# @return [Array<Symbol>]
|
|
624
|
+
end
|
|
625
|
+
|
|
626
|
+
# The status of the hold
|
|
627
|
+
#
|
|
628
|
+
# @see ModernTreasury::Models::PaymentOrder::CurrentHold#status
|
|
629
|
+
module Status
|
|
630
|
+
extend ModernTreasury::Internal::Type::Enum
|
|
631
|
+
|
|
632
|
+
ACTIVE = :active
|
|
633
|
+
RESOLVED = :resolved
|
|
634
|
+
|
|
635
|
+
# @!method self.values
|
|
636
|
+
# @return [Array<Symbol>]
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
# The type of target being held
|
|
640
|
+
#
|
|
641
|
+
# @see ModernTreasury::Models::PaymentOrder::CurrentHold#target_type
|
|
642
|
+
module TargetType
|
|
643
|
+
extend ModernTreasury::Internal::Type::Enum
|
|
644
|
+
|
|
645
|
+
PAYMENT_ORDER = :payment_order
|
|
646
|
+
|
|
647
|
+
# @!method self.values
|
|
648
|
+
# @return [Array<Symbol>]
|
|
649
|
+
end
|
|
650
|
+
end
|
|
651
|
+
|
|
443
652
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
|
444
653
|
# transaction. A `credit` moves money from your account to someone else's. A
|
|
445
654
|
# `debit` pulls money from someone else's account to your own. Note that wire,
|
|
@@ -497,6 +706,20 @@ module ModernTreasury
|
|
|
497
706
|
# @return [Array<Symbol>]
|
|
498
707
|
end
|
|
499
708
|
|
|
709
|
+
# One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
710
|
+
#
|
|
711
|
+
# @see ModernTreasury::Models::PaymentOrder#reconciliation_status
|
|
712
|
+
module ReconciliationStatus
|
|
713
|
+
extend ModernTreasury::Internal::Type::Enum
|
|
714
|
+
|
|
715
|
+
UNRECONCILED = :unreconciled
|
|
716
|
+
TENTATIVELY_RECONCILED = :tentatively_reconciled
|
|
717
|
+
RECONCILED = :reconciled
|
|
718
|
+
|
|
719
|
+
# @!method self.values
|
|
720
|
+
# @return [Array<Symbol>]
|
|
721
|
+
end
|
|
722
|
+
|
|
500
723
|
class ReferenceNumber < ModernTreasury::Internal::Type::BaseModel
|
|
501
724
|
# @!attribute id
|
|
502
725
|
#
|
|
@@ -619,6 +842,7 @@ module ModernTreasury
|
|
|
619
842
|
JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
|
|
620
843
|
JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
|
|
621
844
|
LOB_CHECK_ID = :lob_check_id
|
|
845
|
+
MT_FOF_TRANSFER_ID = :mt_fof_transfer_id
|
|
622
846
|
OTHER = :other
|
|
623
847
|
PARTIAL_SWIFT_MIR = :partial_swift_mir
|
|
624
848
|
PNC_CLEARING_REFERENCE = :pnc_clearing_reference
|
|
@@ -668,6 +892,7 @@ module ModernTreasury
|
|
|
668
892
|
COMPLETED = :completed
|
|
669
893
|
DENIED = :denied
|
|
670
894
|
FAILED = :failed
|
|
895
|
+
HELD = :held
|
|
671
896
|
NEEDS_APPROVAL = :needs_approval
|
|
672
897
|
PENDING = :pending
|
|
673
898
|
PROCESSING = :processing
|
|
@@ -37,6 +37,12 @@ module ModernTreasury
|
|
|
37
37
|
# @return [Symbol, ModernTreasury::Models::PaymentOrderType]
|
|
38
38
|
required :type, enum: -> { ModernTreasury::PaymentOrderType }
|
|
39
39
|
|
|
40
|
+
# @!attribute accounting
|
|
41
|
+
# @deprecated
|
|
42
|
+
#
|
|
43
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateAsyncParams::Accounting, nil]
|
|
44
|
+
optional :accounting, -> { ModernTreasury::PaymentOrderCreateAsyncParams::Accounting }
|
|
45
|
+
|
|
40
46
|
# @!attribute accounting_category_id
|
|
41
47
|
# @deprecated
|
|
42
48
|
#
|
|
@@ -46,6 +52,15 @@ module ModernTreasury
|
|
|
46
52
|
# @return [String, nil]
|
|
47
53
|
optional :accounting_category_id, String, nil?: true
|
|
48
54
|
|
|
55
|
+
# @!attribute accounting_ledger_class_id
|
|
56
|
+
# @deprecated
|
|
57
|
+
#
|
|
58
|
+
# The ID of one of your accounting ledger classes. Note that these will only be
|
|
59
|
+
# accessible if your accounting system has been connected.
|
|
60
|
+
#
|
|
61
|
+
# @return [String, nil]
|
|
62
|
+
optional :accounting_ledger_class_id, String, nil?: true
|
|
63
|
+
|
|
49
64
|
# @!attribute charge_bearer
|
|
50
65
|
# The party that will pay the fees for the payment order. See
|
|
51
66
|
# https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
|
|
@@ -197,6 +212,13 @@ module ModernTreasury
|
|
|
197
212
|
# @return [String, nil]
|
|
198
213
|
optional :receiving_account_id, String
|
|
199
214
|
|
|
215
|
+
# @!attribute reconciliation_status
|
|
216
|
+
# One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
217
|
+
#
|
|
218
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReconciliationStatus, nil]
|
|
219
|
+
optional :reconciliation_status,
|
|
220
|
+
enum: -> { ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus }
|
|
221
|
+
|
|
200
222
|
# @!attribute remittance_information
|
|
201
223
|
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
|
202
224
|
# payments the field will be passed through as the "Originator to Beneficiary
|
|
@@ -263,7 +285,7 @@ module ModernTreasury
|
|
|
263
285
|
# @return [String, nil]
|
|
264
286
|
optional :ultimate_receiving_party_name, String, nil?: true
|
|
265
287
|
|
|
266
|
-
# @!method initialize(amount:, direction:, originating_account_id:, type:, accounting_category_id: nil, charge_bearer: nil, currency: nil, description: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
|
|
288
|
+
# @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
|
|
267
289
|
# Some parameter documentations has been truncated, see
|
|
268
290
|
# {ModernTreasury::Models::PaymentOrderCreateAsyncParams} for more details.
|
|
269
291
|
#
|
|
@@ -275,8 +297,12 @@ module ModernTreasury
|
|
|
275
297
|
#
|
|
276
298
|
# @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
|
|
277
299
|
#
|
|
300
|
+
# @param accounting [ModernTreasury::Models::PaymentOrderCreateAsyncParams::Accounting]
|
|
301
|
+
#
|
|
278
302
|
# @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
279
303
|
#
|
|
304
|
+
# @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
|
|
305
|
+
#
|
|
280
306
|
# @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
|
|
281
307
|
#
|
|
282
308
|
# @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
|
|
@@ -315,6 +341,8 @@ module ModernTreasury
|
|
|
315
341
|
#
|
|
316
342
|
# @param receiving_account_id [String] Either `receiving_account` or `receiving_account_id` must be present. When using
|
|
317
343
|
#
|
|
344
|
+
# @param reconciliation_status [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReconciliationStatus] One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
345
|
+
#
|
|
318
346
|
# @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
|
|
319
347
|
#
|
|
320
348
|
# @param send_remittance_advice [Boolean, nil] Send an email to the counterparty when the payment order is sent to the bank. If
|
|
@@ -349,6 +377,37 @@ module ModernTreasury
|
|
|
349
377
|
# @return [Array<Symbol>]
|
|
350
378
|
end
|
|
351
379
|
|
|
380
|
+
# @deprecated
|
|
381
|
+
class Accounting < ModernTreasury::Internal::Type::BaseModel
|
|
382
|
+
# @!attribute account_id
|
|
383
|
+
# @deprecated
|
|
384
|
+
#
|
|
385
|
+
# The ID of one of your accounting categories. Note that these will only be
|
|
386
|
+
# accessible if your accounting system has been connected.
|
|
387
|
+
#
|
|
388
|
+
# @return [String, nil]
|
|
389
|
+
optional :account_id, String, nil?: true
|
|
390
|
+
|
|
391
|
+
# @!attribute class_id
|
|
392
|
+
# @deprecated
|
|
393
|
+
#
|
|
394
|
+
# The ID of one of the class objects in your accounting system. Class objects
|
|
395
|
+
# track segments of your business independent of client or project. Note that
|
|
396
|
+
# these will only be accessible if your accounting system has been connected.
|
|
397
|
+
#
|
|
398
|
+
# @return [String, nil]
|
|
399
|
+
optional :class_id, String, nil?: true
|
|
400
|
+
|
|
401
|
+
# @!method initialize(account_id: nil, class_id: nil)
|
|
402
|
+
# Some parameter documentations has been truncated, see
|
|
403
|
+
# {ModernTreasury::Models::PaymentOrderCreateAsyncParams::Accounting} for more
|
|
404
|
+
# details.
|
|
405
|
+
#
|
|
406
|
+
# @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
407
|
+
#
|
|
408
|
+
# @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
|
|
409
|
+
end
|
|
410
|
+
|
|
352
411
|
# The party that will pay the fees for the payment order. See
|
|
353
412
|
# https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
|
|
354
413
|
# differences between the options.
|
|
@@ -717,6 +776,18 @@ module ModernTreasury
|
|
|
717
776
|
end
|
|
718
777
|
end
|
|
719
778
|
end
|
|
779
|
+
|
|
780
|
+
# One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
781
|
+
module ReconciliationStatus
|
|
782
|
+
extend ModernTreasury::Internal::Type::Enum
|
|
783
|
+
|
|
784
|
+
UNRECONCILED = :unreconciled
|
|
785
|
+
TENTATIVELY_RECONCILED = :tentatively_reconciled
|
|
786
|
+
RECONCILED = :reconciled
|
|
787
|
+
|
|
788
|
+
# @!method self.values
|
|
789
|
+
# @return [Array<Symbol>]
|
|
790
|
+
end
|
|
720
791
|
end
|
|
721
792
|
end
|
|
722
793
|
end
|
|
@@ -37,6 +37,12 @@ module ModernTreasury
|
|
|
37
37
|
# @return [Symbol, ModernTreasury::Models::PaymentOrderType]
|
|
38
38
|
required :type, enum: -> { ModernTreasury::PaymentOrderType }
|
|
39
39
|
|
|
40
|
+
# @!attribute accounting
|
|
41
|
+
# @deprecated
|
|
42
|
+
#
|
|
43
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateParams::Accounting, nil]
|
|
44
|
+
optional :accounting, -> { ModernTreasury::PaymentOrderCreateParams::Accounting }
|
|
45
|
+
|
|
40
46
|
# @!attribute accounting_category_id
|
|
41
47
|
# @deprecated
|
|
42
48
|
#
|
|
@@ -46,6 +52,15 @@ module ModernTreasury
|
|
|
46
52
|
# @return [String, nil]
|
|
47
53
|
optional :accounting_category_id, String, nil?: true
|
|
48
54
|
|
|
55
|
+
# @!attribute accounting_ledger_class_id
|
|
56
|
+
# @deprecated
|
|
57
|
+
#
|
|
58
|
+
# The ID of one of your accounting ledger classes. Note that these will only be
|
|
59
|
+
# accessible if your accounting system has been connected.
|
|
60
|
+
#
|
|
61
|
+
# @return [String, nil]
|
|
62
|
+
optional :accounting_ledger_class_id, String, nil?: true
|
|
63
|
+
|
|
49
64
|
# @!attribute charge_bearer
|
|
50
65
|
# The party that will pay the fees for the payment order. See
|
|
51
66
|
# https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
|
|
@@ -203,6 +218,13 @@ module ModernTreasury
|
|
|
203
218
|
# @return [String, nil]
|
|
204
219
|
optional :receiving_account_id, String
|
|
205
220
|
|
|
221
|
+
# @!attribute reconciliation_status
|
|
222
|
+
# One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
223
|
+
#
|
|
224
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReconciliationStatus, nil]
|
|
225
|
+
optional :reconciliation_status,
|
|
226
|
+
enum: -> { ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus }
|
|
227
|
+
|
|
206
228
|
# @!attribute remittance_information
|
|
207
229
|
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
|
208
230
|
# payments the field will be passed through as the "Originator to Beneficiary
|
|
@@ -269,7 +291,7 @@ module ModernTreasury
|
|
|
269
291
|
# @return [String, nil]
|
|
270
292
|
optional :ultimate_receiving_party_name, String, nil?: true
|
|
271
293
|
|
|
272
|
-
# @!method initialize(amount:, direction:, originating_account_id:, type:, accounting_category_id: nil, charge_bearer: nil, currency: nil, description: nil, documents: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
|
|
294
|
+
# @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, documents: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
|
|
273
295
|
# Some parameter documentations has been truncated, see
|
|
274
296
|
# {ModernTreasury::Models::PaymentOrderCreateParams} for more details.
|
|
275
297
|
#
|
|
@@ -281,8 +303,12 @@ module ModernTreasury
|
|
|
281
303
|
#
|
|
282
304
|
# @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
|
|
283
305
|
#
|
|
306
|
+
# @param accounting [ModernTreasury::Models::PaymentOrderCreateParams::Accounting]
|
|
307
|
+
#
|
|
284
308
|
# @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
285
309
|
#
|
|
310
|
+
# @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
|
|
311
|
+
#
|
|
286
312
|
# @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
|
|
287
313
|
#
|
|
288
314
|
# @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
|
|
@@ -323,6 +349,8 @@ module ModernTreasury
|
|
|
323
349
|
#
|
|
324
350
|
# @param receiving_account_id [String] Either `receiving_account` or `receiving_account_id` must be present. When using
|
|
325
351
|
#
|
|
352
|
+
# @param reconciliation_status [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReconciliationStatus] One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
353
|
+
#
|
|
326
354
|
# @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
|
|
327
355
|
#
|
|
328
356
|
# @param send_remittance_advice [Boolean, nil] Send an email to the counterparty when the payment order is sent to the bank. If
|
|
@@ -357,6 +385,36 @@ module ModernTreasury
|
|
|
357
385
|
# @return [Array<Symbol>]
|
|
358
386
|
end
|
|
359
387
|
|
|
388
|
+
# @deprecated
|
|
389
|
+
class Accounting < ModernTreasury::Internal::Type::BaseModel
|
|
390
|
+
# @!attribute account_id
|
|
391
|
+
# @deprecated
|
|
392
|
+
#
|
|
393
|
+
# The ID of one of your accounting categories. Note that these will only be
|
|
394
|
+
# accessible if your accounting system has been connected.
|
|
395
|
+
#
|
|
396
|
+
# @return [String, nil]
|
|
397
|
+
optional :account_id, String, nil?: true
|
|
398
|
+
|
|
399
|
+
# @!attribute class_id
|
|
400
|
+
# @deprecated
|
|
401
|
+
#
|
|
402
|
+
# The ID of one of the class objects in your accounting system. Class objects
|
|
403
|
+
# track segments of your business independent of client or project. Note that
|
|
404
|
+
# these will only be accessible if your accounting system has been connected.
|
|
405
|
+
#
|
|
406
|
+
# @return [String, nil]
|
|
407
|
+
optional :class_id, String, nil?: true
|
|
408
|
+
|
|
409
|
+
# @!method initialize(account_id: nil, class_id: nil)
|
|
410
|
+
# Some parameter documentations has been truncated, see
|
|
411
|
+
# {ModernTreasury::Models::PaymentOrderCreateParams::Accounting} for more details.
|
|
412
|
+
#
|
|
413
|
+
# @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
|
|
414
|
+
#
|
|
415
|
+
# @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
|
|
416
|
+
end
|
|
417
|
+
|
|
360
418
|
# The party that will pay the fees for the payment order. See
|
|
361
419
|
# https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
|
|
362
420
|
# differences between the options.
|
|
@@ -777,6 +835,18 @@ module ModernTreasury
|
|
|
777
835
|
end
|
|
778
836
|
end
|
|
779
837
|
end
|
|
838
|
+
|
|
839
|
+
# One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
|
|
840
|
+
module ReconciliationStatus
|
|
841
|
+
extend ModernTreasury::Internal::Type::Enum
|
|
842
|
+
|
|
843
|
+
UNRECONCILED = :unreconciled
|
|
844
|
+
TENTATIVELY_RECONCILED = :tentatively_reconciled
|
|
845
|
+
RECONCILED = :reconciled
|
|
846
|
+
|
|
847
|
+
# @!method self.values
|
|
848
|
+
# @return [Array<Symbol>]
|
|
849
|
+
end
|
|
780
850
|
end
|
|
781
851
|
end
|
|
782
852
|
end
|