api.md

Shared Types

from modern_treasury.types import AccountsType, AsyncResponse, Currency, TransactionDirection

ModernTreasury

Types:

from modern_treasury.types import PingResponse

Methods:

• client.ping() -> PingResponse

Connections

Types:

from modern_treasury.types import Connection

Methods:

• client.connections.list(**params) -> SyncPage[Connection]

Counterparties

Types:

from modern_treasury.types import Counterparty, CounterpartyCollectAccountResponse

Methods:

• client.counterparties.create(**params) -> Counterparty
• client.counterparties.retrieve(id) -> Counterparty
• client.counterparties.update(id, **params) -> Counterparty
• client.counterparties.list(**params) -> SyncPage[Counterparty]
• client.counterparties.delete(id) -> None
• client.counterparties.collect_account(id, **params) -> CounterpartyCollectAccountResponse

Events

Types:

from modern_treasury.types import Event

Methods:

• client.events.retrieve(id) -> Event
• client.events.list(**params) -> SyncPage[Event]

ExpectedPayments

Types:

from modern_treasury.types import ExpectedPayment, ExpectedPaymentType

Methods:

• client.expected_payments.create(**params) -> ExpectedPayment
• client.expected_payments.retrieve(id) -> ExpectedPayment
• client.expected_payments.update(id, **params) -> ExpectedPayment
• client.expected_payments.list(**params) -> SyncPage[ExpectedPayment]
• client.expected_payments.delete(id) -> ExpectedPayment

ExternalAccounts

Types:

from modern_treasury.types import ExternalAccount, ExternalAccountType

Methods:

• client.external_accounts.create(**params) -> ExternalAccount
• client.external_accounts.retrieve(id) -> ExternalAccount
• client.external_accounts.update(id, **params) -> ExternalAccount
• client.external_accounts.list(**params) -> SyncPage[ExternalAccount]
• client.external_accounts.delete(id) -> None
• client.external_accounts.complete_verification(id, **params) -> ExternalAccount
• client.external_accounts.verify(id, **params) -> ExternalAccount

IncomingPaymentDetails

Types:

from modern_treasury.types import IncomingPaymentDetail

Methods:

• client.incoming_payment_details.retrieve(id) -> IncomingPaymentDetail
• client.incoming_payment_details.update(id, **params) -> IncomingPaymentDetail
• client.incoming_payment_details.list(**params) -> SyncPage[IncomingPaymentDetail]
• client.incoming_payment_details.create_async(**params) -> AsyncResponse

Invoices

Types:

from modern_treasury.types import Invoice

Methods:

• client.invoices.create(**params) -> Invoice
• client.invoices.retrieve(id) -> Invoice
• client.invoices.update(id, **params) -> Invoice
• client.invoices.list(**params) -> SyncPage[Invoice]
• client.invoices.add_payment_order(payment_order_id, *, id) -> None

LineItems

Types:

from modern_treasury.types.invoices import InvoiceLineItem

Methods:

• client.invoices.line_items.create(invoice_id, **params) -> InvoiceLineItem
• client.invoices.line_items.retrieve(id, *, invoice_id) -> InvoiceLineItem
• client.invoices.line_items.update(id, *, invoice_id, **params) -> InvoiceLineItem
• client.invoices.line_items.list(invoice_id, **params) -> SyncPage[InvoiceLineItem]
• client.invoices.line_items.delete(id, *, invoice_id) -> InvoiceLineItem

Documents

Types:

from modern_treasury.types import Document

Methods:

• client.documents.create(**params) -> Document
• client.documents.retrieve(id) -> Document
• client.documents.list(**params) -> SyncPage[Document]

AccountCollectionFlows

Types:

from modern_treasury.types import AccountCollectionFlow

Methods:

• client.account_collection_flows.create(**params) -> AccountCollectionFlow
• client.account_collection_flows.retrieve(id) -> AccountCollectionFlow
• client.account_collection_flows.update(id, **params) -> AccountCollectionFlow
• client.account_collection_flows.list(**params) -> SyncPage[AccountCollectionFlow]

AccountDetails

Types:

from modern_treasury.types import AccountDetail

Methods:

• client.account_details.create(account_id, *, accounts_type, **params) -> AccountDetail
• client.account_details.retrieve(id, *, accounts_type, account_id) -> AccountDetail
• client.account_details.list(account_id, *, accounts_type, **params) -> SyncPage[AccountDetail]
• client.account_details.delete(id, *, accounts_type, account_id) -> None

RoutingDetails

Types:

from modern_treasury.types import RoutingDetail

Methods:

• client.routing_details.create(account_id, *, accounts_type, **params) -> RoutingDetail
• client.routing_details.retrieve(id, *, accounts_type, account_id) -> RoutingDetail
• client.routing_details.list(account_id, *, accounts_type, **params) -> SyncPage[RoutingDetail]
• client.routing_details.delete(id, *, accounts_type, account_id) -> None

InternalAccounts

Types:

from modern_treasury.types import InternalAccount

Methods:

• client.internal_accounts.create(**params) -> InternalAccount
• client.internal_accounts.retrieve(id) -> InternalAccount
• client.internal_accounts.update(id, **params) -> InternalAccount
• client.internal_accounts.list(**params) -> SyncPage[InternalAccount]

BalanceReports

Types:

from modern_treasury.types.internal_accounts import BalanceReport

Methods:

• client.internal_accounts.balance_reports.create(internal_account_id, **params) -> BalanceReport
• client.internal_accounts.balance_reports.retrieve(id, *, internal_account_id) -> BalanceReport
• client.internal_accounts.balance_reports.list(internal_account_id, **params) -> SyncPage[BalanceReport]
• client.internal_accounts.balance_reports.delete(id, *, internal_account_id) -> None

Ledgers

Types:

from modern_treasury.types import Ledger

Methods:

• client.ledgers.create(**params) -> Ledger
• client.ledgers.retrieve(id) -> Ledger
• client.ledgers.update(id, **params) -> Ledger
• client.ledgers.list(**params) -> SyncPage[Ledger]
• client.ledgers.delete(id) -> Ledger

LedgerableEvents

Types:

from modern_treasury.types import LedgerableEvent

Methods:

• client.ledgerable_events.create(**params) -> LedgerableEvent
• client.ledgerable_events.retrieve(id) -> LedgerableEvent

LedgerAccountCategories

Types:

from modern_treasury.types import LedgerAccountCategory

Methods:

• client.ledger_account_categories.create(**params) -> LedgerAccountCategory
• client.ledger_account_categories.retrieve(id, **params) -> LedgerAccountCategory
• client.ledger_account_categories.update(id, **params) -> LedgerAccountCategory
• client.ledger_account_categories.list(**params) -> SyncPage[LedgerAccountCategory]
• client.ledger_account_categories.delete(id) -> LedgerAccountCategory
• client.ledger_account_categories.add_ledger_account(ledger_account_id, *, id) -> None
• client.ledger_account_categories.add_nested_category(sub_category_id, *, id) -> None
• client.ledger_account_categories.remove_ledger_account(ledger_account_id, *, id) -> None
• client.ledger_account_categories.remove_nested_category(sub_category_id, *, id) -> None

LedgerAccounts

Types:

from modern_treasury.types import LedgerAccount

Methods:

• client.ledger_accounts.create(**params) -> LedgerAccount
• client.ledger_accounts.retrieve(id, **params) -> LedgerAccount
• client.ledger_accounts.update(id, **params) -> LedgerAccount
• client.ledger_accounts.list(**params) -> SyncPage[LedgerAccount]
• client.ledger_accounts.delete(id) -> LedgerAccount

LedgerAccountBalanceMonitors

Types:

from modern_treasury.types import LedgerAccountBalanceMonitor

Methods:

• client.ledger_account_balance_monitors.create(**params) -> LedgerAccountBalanceMonitor
• client.ledger_account_balance_monitors.retrieve(id) -> LedgerAccountBalanceMonitor
• client.ledger_account_balance_monitors.update(id, **params) -> LedgerAccountBalanceMonitor
• client.ledger_account_balance_monitors.list(**params) -> SyncPage[LedgerAccountBalanceMonitor]
• client.ledger_account_balance_monitors.delete(id) -> LedgerAccountBalanceMonitor

LedgerAccountStatements

Types:

from modern_treasury.types import (
    LedgerAccountStatementCreateResponse,
    LedgerAccountStatementRetrieveResponse,
)

Methods:

• client.ledger_account_statements.create(**params) -> LedgerAccountStatementCreateResponse
• client.ledger_account_statements.retrieve(id) -> LedgerAccountStatementRetrieveResponse

LedgerEntries

Types:

from modern_treasury.types import LedgerEntry

Methods:

• client.ledger_entries.retrieve(id, **params) -> LedgerEntry
• client.ledger_entries.update(id, **params) -> LedgerEntry
• client.ledger_entries.list(**params) -> SyncPage[LedgerEntry]

LedgerEventHandlers

Types:

from modern_treasury.types import LedgerEventHandler, LedgerEventHandlerVariable

Methods:

• client.ledger_event_handlers.create(**params) -> LedgerEventHandler
• client.ledger_event_handlers.retrieve(id) -> LedgerEventHandler
• client.ledger_event_handlers.list(**params) -> SyncPage[LedgerEventHandler]
• client.ledger_event_handlers.delete(id) -> LedgerEventHandler

LedgerTransactions

Types:

from modern_treasury.types import LedgerTransaction

Methods:

• client.ledger_transactions.create(**params) -> LedgerTransaction
• client.ledger_transactions.retrieve(id) -> LedgerTransaction
• client.ledger_transactions.update(id, **params) -> LedgerTransaction
• client.ledger_transactions.list(**params) -> SyncPage[LedgerTransaction]
• client.ledger_transactions.create_reversal(id, **params) -> LedgerTransaction

Versions

Types:

from modern_treasury.types.ledger_transactions import LedgerTransactionVersion

Methods:

• client.ledger_transactions.versions.list(**params) -> SyncPage[LedgerTransactionVersion]

LineItems

Types:

from modern_treasury.types import LineItem

Methods:

• client.line_items.retrieve(id, *, itemizable_type, itemizable_id) -> LineItem
• client.line_items.update(id, *, itemizable_type, itemizable_id, **params) -> LineItem
• client.line_items.list(itemizable_id, *, itemizable_type, **params) -> SyncPage[LineItem]

PaymentFlows

Types:

from modern_treasury.types import PaymentFlow

Methods:

• client.payment_flows.create(**params) -> PaymentFlow
• client.payment_flows.retrieve(id) -> PaymentFlow
• client.payment_flows.update(id, **params) -> PaymentFlow
• client.payment_flows.list(**params) -> SyncPage[PaymentFlow]

PaymentOrders

Types:

from modern_treasury.types import PaymentOrder, PaymentOrderSubtype, PaymentOrderType

Methods:

• client.payment_orders.create(**params) -> PaymentOrder
• client.payment_orders.retrieve(id) -> PaymentOrder
• client.payment_orders.update(id, **params) -> PaymentOrder
• client.payment_orders.list(**params) -> SyncPage[PaymentOrder]
• client.payment_orders.create_async(**params) -> AsyncResponse

Reversals

Types:

from modern_treasury.types.payment_orders import Reversal

Methods:

• client.payment_orders.reversals.create(payment_order_id, **params) -> Reversal
• client.payment_orders.reversals.retrieve(reversal_id, *, payment_order_id) -> Reversal
• client.payment_orders.reversals.list(payment_order_id, **params) -> SyncPage[Reversal]

PaymentReferences

Types:

from modern_treasury.types import PaymentReference

Methods:

• client.payment_references.retrieve(id) -> PaymentReference
• client.payment_references.list(**params) -> SyncPage[PaymentReference]

Returns

Types:

from modern_treasury.types import ReturnObject

Methods:

• client.returns.create(**params) -> ReturnObject
• client.returns.retrieve(id) -> ReturnObject
• client.returns.list(**params) -> SyncPage[ReturnObject]

Transactions

Types:

from modern_treasury.types import Transaction

Methods:

• client.transactions.create(**params) -> Transaction
• client.transactions.retrieve(id) -> Transaction
• client.transactions.update(id, **params) -> Transaction
• client.transactions.list(**params) -> SyncPage[Transaction]
• client.transactions.delete(id) -> None

LineItems

Types:

from modern_treasury.types.transactions import TransactionLineItem

Methods:

• client.transactions.line_items.create(**params) -> TransactionLineItem
• client.transactions.line_items.retrieve(id) -> TransactionLineItem
• client.transactions.line_items.list(**params) -> SyncPage[TransactionLineItem]
• client.transactions.line_items.delete(id) -> None

Validations

Types:

from modern_treasury.types import RoutingNumberLookupRequest

Methods:

• client.validations.validate_routing_number(**params) -> RoutingNumberLookupRequest

PaperItems

Types:

from modern_treasury.types import PaperItem

Methods:

• client.paper_items.retrieve(id) -> PaperItem
• client.paper_items.list(**params) -> SyncPage[PaperItem]

Webhooks

Methods:

• client.webhooks.get_signature(*args) -> str
• client.webhooks.validate_signature(*args) -> bool

VirtualAccounts

Types:

from modern_treasury.types import VirtualAccount

Methods:

• client.virtual_accounts.create(**params) -> VirtualAccount
• client.virtual_accounts.retrieve(id) -> VirtualAccount
• client.virtual_accounts.update(id, **params) -> VirtualAccount
• client.virtual_accounts.list(**params) -> SyncPage[VirtualAccount]
• client.virtual_accounts.delete(id) -> VirtualAccount

BulkRequests

Types:

from modern_treasury.types import BulkRequest

Methods:

• client.bulk_requests.create(**params) -> BulkRequest
• client.bulk_requests.retrieve(id) -> BulkRequest
• client.bulk_requests.list(**params) -> SyncPage[BulkRequest]

BulkResults

Types:

from modern_treasury.types import BulkResult

Methods:

• client.bulk_results.retrieve(id) -> BulkResult
• client.bulk_results.list(**params) -> SyncPage[BulkResult]

LedgerAccountSettlements

Types:

from modern_treasury.types import LedgerAccountSettlement

Methods:

• client.ledger_account_settlements.create(**params) -> LedgerAccountSettlement
• client.ledger_account_settlements.retrieve(id) -> LedgerAccountSettlement
• client.ledger_account_settlements.update(id, **params) -> LedgerAccountSettlement
• client.ledger_account_settlements.list(**params) -> SyncPage[LedgerAccountSettlement]

ForeignExchangeQuotes

Types:

from modern_treasury.types import ForeignExchangeQuote

Methods:

• client.foreign_exchange_quotes.create(**params) -> ForeignExchangeQuote
• client.foreign_exchange_quotes.retrieve(id) -> ForeignExchangeQuote
• client.foreign_exchange_quotes.list(**params) -> SyncPage[ForeignExchangeQuote]

ConnectionLegalEntities

Types:

from modern_treasury.types import ConnectionLegalEntity

Methods:

• client.connection_legal_entities.create(**params) -> ConnectionLegalEntity
• client.connection_legal_entities.retrieve(id) -> ConnectionLegalEntity
• client.connection_legal_entities.update(id, **params) -> ConnectionLegalEntity
• client.connection_legal_entities.list(**params) -> SyncPage[ConnectionLegalEntity]

LegalEntities

Types:

from modern_treasury.types import LegalEntity

Methods:

• client.legal_entities.create(**params) -> LegalEntity
• client.legal_entities.retrieve(id) -> LegalEntity
• client.legal_entities.update(id, **params) -> LegalEntity
• client.legal_entities.list(**params) -> SyncPage[LegalEntity]

LegalEntityAssociations

Types:

from modern_treasury.types import LegalEntityAssociation

Methods:

• client.legal_entity_associations.create(**params) -> LegalEntityAssociation