modern-treasury 2.6.0 → 2.7.2

package/resources/ledger-transactions/ledger-transactions.d.ts

@@ -1,449 +1,395 @@
 import * as Core from 'modern-treasury/core';
 import { APIResource } from 'modern-treasury/resource';
 import * as LedgerEntries from 'modern-treasury/resources/ledger-entries';
-import { Versions } from './versions.js';
-import * as API from './index.js';
+import { Versions } from "./versions.js";
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class LedgerTransactions extends APIResource {
-  versions: Versions;
-  /**
-   * Create a ledger transaction.
-   */
-  create(
-    params: LedgerTransactionCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerTransaction>;
-  /**
-   * Get details on a single ledger transaction.
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
-  /**
-   * Update the details of a ledger transaction.
-   */
-  update(
-    id: string,
-    body?: LedgerTransactionUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerTransaction>;
-  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
-  /**
-   * Get a list of ledger transactions.
-   */
-  list(
-    query?: LedgerTransactionListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
-  /**
-   * Create a ledger transaction reversal.
-   */
-  createReversal(
-    id: string,
-    body?: LedgerTransactionCreateReversalParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<LedgerTransaction>;
-  createReversal(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+    versions: Versions;
+    /**
+     * Create a ledger transaction.
+     */
+    create(params: LedgerTransactionCreateParams, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+    /**
+     * Get details on a single ledger transaction.
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+    /**
+     * Update the details of a ledger transaction.
+     */
+    update(id: string, body?: LedgerTransactionUpdateParams, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+    update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+    /**
+     * Get a list of ledger transactions.
+     */
+    list(query?: LedgerTransactionListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
+    list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
+    /**
+     * Create a ledger transaction reversal.
+     */
+    createReversal(id: string, body?: LedgerTransactionCreateReversalParams, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+    createReversal(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
+}
+export declare class LedgerTransactionsPage extends Page<LedgerTransaction> {
 }
-export declare class LedgerTransactionsPage extends Page<LedgerTransaction> {}
 type _LedgerTransactionsPage = LedgerTransactionsPage;
 export interface LedgerTransaction {
-  id: string;
-  created_at: string;
-  /**
-   * An optional description for internal use.
-   */
-  description: string | null;
-  /**
-   * The timestamp (ISO8601 format) at which the ledger transaction happened for
-   * reporting purposes.
-   */
-  effective_at: string;
-  /**
-   * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-   * purposes.
-   */
-  effective_date: string;
-  /**
-   * A unique string to represent the ledger transaction. Only one pending or posted
-   * ledger transaction may have this ID in the ledger.
-   */
-  external_id: string | null;
-  /**
-   * An array of ledger entry objects.
-   */
-  ledger_entries: Array<LedgerEntries.LedgerEntry>;
-  /**
-   * The ID of the ledger this ledger transaction belongs to.
-   */
-  ledger_id: string;
-  /**
-   * If the ledger transaction can be reconciled to another object in Modern
-   * Treasury, the id will be populated here, otherwise null.
-   */
-  ledgerable_id: string | null;
-  /**
-   * If the ledger transaction can be reconciled to another object in Modern
-   * Treasury, the type will be populated here, otherwise null. This can be one of
-   * payment_order, incoming_payment_detail, expected_payment, return, or reversal.
-   */
-  ledgerable_type:
-    | 'counterparty'
-    | 'expected_payment'
-    | 'incoming_payment_detail'
-    | 'internal_account'
-    | 'line_item'
-    | 'paper_item'
-    | 'payment_order'
-    | 'payment_order_attempt'
-    | 'return'
-    | 'reversal'
-    | null;
-  /**
-   * This field will be true if this object exists in the live environment or false
-   * if it exists in the test environment.
-   */
-  live_mode: boolean;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata: Record<string, string>;
-  object: string;
-  /**
-   * The time on which the ledger transaction posted. This is null if the ledger
-   * transaction is pending.
-   */
-  posted_at: string | null;
-  /**
-   * The ID of the original ledger transaction that this ledger transaction reverses.
-   */
-  reverses_ledger_transaction_id: string | null;
-  /**
-   * To post a ledger transaction at creation, use `posted`.
-   */
-  status: 'archived' | 'pending' | 'posted';
-  updated_at: string;
-}
-export interface LedgerTransactionCreateParams {
-  /**
-   * An array of ledger entry objects.
-   */
-  ledger_entries: Array<LedgerTransactionCreateParams.LedgerEntry>;
-  /**
-   * An optional description for internal use.
-   */
-  description?: string | null;
-  /**
-   * The timestamp (ISO8601 format) at which the ledger transaction happened for
-   * reporting purposes.
-   */
-  effective_at?: string;
-  /**
-   * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-   * purposes.
-   */
-  effective_date?: string;
-  /**
-   * A unique string to represent the ledger transaction. Only one pending or posted
-   * ledger transaction may have this ID in the ledger.
-   */
-  external_id?: string;
-  /**
-   * If the ledger transaction can be reconciled to another object in Modern
-   * Treasury, the id will be populated here, otherwise null.
-   */
-  ledgerable_id?: string;
-  /**
-   * If the ledger transaction can be reconciled to another object in Modern
-   * Treasury, the type will be populated here, otherwise null. This can be one of
-   * payment_order, incoming_payment_detail, expected_payment, return, or reversal.
-   */
-  ledgerable_type?:
-    | 'counterparty'
-    | 'expected_payment'
-    | 'incoming_payment_detail'
-    | 'internal_account'
-    | 'line_item'
-    | 'paper_item'
-    | 'payment_order'
-    | 'payment_order_attempt'
-    | 'return'
-    | 'reversal';
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * To post a ledger transaction at creation, use `posted`.
-   */
-  status?: 'archived' | 'pending' | 'posted';
-}
-export declare namespace LedgerTransactionCreateParams {
-  interface LedgerEntry {
+    id: string;
+    created_at: string;
+    /**
+     * An optional description for internal use.
+     */
+    description: string | null;
+    /**
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
+     */
+    effective_at: string;
+    /**
+     * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
+     * purposes.
+     */
+    effective_date: string;
+    /**
+     * A unique string to represent the ledger transaction. Only one pending or posted
+     * ledger transaction may have this ID in the ledger.
+     */
+    external_id: string | null;
     /**
-     * Value in specified currency's smallest unit. e.g. $10 would be represented
-     * as 1000. Can be any integer up to 36 digits.
+     * An array of ledger entry objects.
      */
-    amount: number;
+    ledger_entries: Array<LedgerEntries.LedgerEntry>;
     /**
-     * One of `credit`, `debit`. Describes the direction money is flowing in the
-     * transaction. A `credit` moves money from your account to someone else's. A
-     * `debit` pulls money from someone else's account to your own. Note that wire,
-     * rtp, and check payments will always be `credit`.
+     * The ID of the ledger this ledger transaction belongs to.
      */
-    direction: 'credit' | 'debit';
+    ledger_id: string;
     /**
-     * The ledger account that this ledger entry is associated with.
+     * If the ledger transaction can be reconciled to another object in Modern
+     * Treasury, the id will be populated here, otherwise null.
      */
-    ledger_account_id: string;
+    ledgerable_id: string | null;
     /**
-     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-     * account’s available balance. If any of these conditions would be false after the
-     * transaction is created, the entire call will fail with error code 422.
+     * If the ledger transaction can be reconciled to another object in Modern
+     * Treasury, the type will be populated here, otherwise null. This can be one of
+     * payment_order, incoming_payment_detail, expected_payment, return, or reversal.
      */
-    available_balance_amount?: Record<string, number> | null;
+    ledgerable_type: 'counterparty' | 'expected_payment' | 'incoming_payment_detail' | 'internal_account' | 'line_item' | 'paper_item' | 'payment_order' | 'payment_order_attempt' | 'return' | 'reversal' | null;
     /**
-     * Lock version of the ledger account. This can be passed when creating a ledger
-     * transaction to only succeed if no ledger transactions have posted since the
-     * given version. See our post about Designing the Ledgers API with Optimistic
-     * Locking for more details.
+     * This field will be true if this object exists in the live environment or false
+     * if it exists in the test environment.
      */
-    lock_version?: number | null;
+    live_mode: boolean;
     /**
      * Additional data represented as key-value pairs. Both the key and value must be
      * strings.
      */
-    metadata?: Record<string, string>;
+    metadata: Record<string, string>;
+    object: string;
     /**
-     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-     * account’s pending balance. If any of these conditions would be false after the
-     * transaction is created, the entire call will fail with error code 422.
+     * The time on which the ledger transaction posted. This is null if the ledger
+     * transaction is pending.
      */
-    pending_balance_amount?: Record<string, number> | null;
+    posted_at: string | null;
     /**
-     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-     * account’s posted balance. If any of these conditions would be false after the
-     * transaction is created, the entire call will fail with error code 422.
+     * The ID of the original ledger transaction that this ledger transaction reverses.
      */
-    posted_balance_amount?: Record<string, number> | null;
+    reverses_ledger_transaction_id: string | null;
     /**
-     * If true, response will include the balance of the associated ledger account for
-     * the entry.
+     * To post a ledger transaction at creation, use `posted`.
      */
-    show_resulting_ledger_account_balances?: boolean | null;
-  }
-}
-export interface LedgerTransactionUpdateParams {
-  /**
-   * An optional description for internal use.
-   */
-  description?: string | null;
-  /**
-   * The timestamp (ISO8601 format) at which the ledger transaction happened for
-   * reporting purposes.
-   */
-  effective_at?: string;
-  /**
-   * An array of ledger entry objects.
-   */
-  ledger_entries?: Array<LedgerTransactionUpdateParams.LedgerEntry>;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * To post a ledger transaction at creation, use `posted`.
-   */
-  status?: 'archived' | 'pending' | 'posted';
+    status: 'archived' | 'pending' | 'posted';
+    updated_at: string;
 }
-export declare namespace LedgerTransactionUpdateParams {
-  interface LedgerEntry {
+export interface LedgerTransactionCreateParams {
+    /**
+     * An array of ledger entry objects.
+     */
+    ledger_entries: Array<LedgerTransactionCreateParams.LedgerEntry>;
     /**
-     * Value in specified currency's smallest unit. e.g. $10 would be represented
-     * as 1000. Can be any integer up to 36 digits.
+     * An optional description for internal use.
      */
-    amount: number;
+    description?: string | null;
     /**
-     * One of `credit`, `debit`. Describes the direction money is flowing in the
-     * transaction. A `credit` moves money from your account to someone else's. A
-     * `debit` pulls money from someone else's account to your own. Note that wire,
-     * rtp, and check payments will always be `credit`.
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
      */
-    direction: 'credit' | 'debit';
+    effective_at?: string;
     /**
-     * The ledger account that this ledger entry is associated with.
+     * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
+     * purposes.
      */
-    ledger_account_id: string;
+    effective_date?: string;
     /**
-     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-     * account’s available balance. If any of these conditions would be false after the
-     * transaction is created, the entire call will fail with error code 422.
+     * A unique string to represent the ledger transaction. Only one pending or posted
+     * ledger transaction may have this ID in the ledger.
      */
-    available_balance_amount?: Record<string, number> | null;
+    external_id?: string;
     /**
-     * Lock version of the ledger account. This can be passed when creating a ledger
-     * transaction to only succeed if no ledger transactions have posted since the
-     * given version. See our post about Designing the Ledgers API with Optimistic
-     * Locking for more details.
+     * If the ledger transaction can be reconciled to another object in Modern
+     * Treasury, the id will be populated here, otherwise null.
      */
-    lock_version?: number | null;
+    ledgerable_id?: string;
+    /**
+     * If the ledger transaction can be reconciled to another object in Modern
+     * Treasury, the type will be populated here, otherwise null. This can be one of
+     * payment_order, incoming_payment_detail, expected_payment, return, or reversal.
+     */
+    ledgerable_type?: 'counterparty' | 'expected_payment' | 'incoming_payment_detail' | 'internal_account' | 'line_item' | 'paper_item' | 'payment_order' | 'payment_order_attempt' | 'return' | 'reversal';
     /**
      * Additional data represented as key-value pairs. Both the key and value must be
      * strings.
      */
     metadata?: Record<string, string>;
     /**
-     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-     * account’s pending balance. If any of these conditions would be false after the
-     * transaction is created, the entire call will fail with error code 422.
+     * To post a ledger transaction at creation, use `posted`.
+     */
+    status?: 'archived' | 'pending' | 'posted';
+}
+export declare namespace LedgerTransactionCreateParams {
+    interface LedgerEntry {
+        /**
+         * Value in specified currency's smallest unit. e.g. $10 would be represented
+         * as 1000. Can be any integer up to 36 digits.
+         */
+        amount: number;
+        /**
+         * One of `credit`, `debit`. Describes the direction money is flowing in the
+         * transaction. A `credit` moves money from your account to someone else's. A
+         * `debit` pulls money from someone else's account to your own. Note that wire,
+         * rtp, and check payments will always be `credit`.
+         */
+        direction: 'credit' | 'debit';
+        /**
+         * The ledger account that this ledger entry is associated with.
+         */
+        ledger_account_id: string;
+        /**
+         * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+         * account’s available balance. If any of these conditions would be false after the
+         * transaction is created, the entire call will fail with error code 422.
+         */
+        available_balance_amount?: Record<string, number> | null;
+        /**
+         * Lock version of the ledger account. This can be passed when creating a ledger
+         * transaction to only succeed if no ledger transactions have posted since the
+         * given version. See our post about Designing the Ledgers API with Optimistic
+         * Locking for more details.
+         */
+        lock_version?: number | null;
+        /**
+         * Additional data represented as key-value pairs. Both the key and value must be
+         * strings.
+         */
+        metadata?: Record<string, string>;
+        /**
+         * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+         * account’s pending balance. If any of these conditions would be false after the
+         * transaction is created, the entire call will fail with error code 422.
+         */
+        pending_balance_amount?: Record<string, number> | null;
+        /**
+         * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+         * account’s posted balance. If any of these conditions would be false after the
+         * transaction is created, the entire call will fail with error code 422.
+         */
+        posted_balance_amount?: Record<string, number> | null;
+        /**
+         * If true, response will include the balance of the associated ledger account for
+         * the entry.
+         */
+        show_resulting_ledger_account_balances?: boolean | null;
+    }
+}
+export interface LedgerTransactionUpdateParams {
+    /**
+     * An optional description for internal use.
      */
-    pending_balance_amount?: Record<string, number> | null;
+    description?: string | null;
     /**
-     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-     * account’s posted balance. If any of these conditions would be false after the
-     * transaction is created, the entire call will fail with error code 422.
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
      */
-    posted_balance_amount?: Record<string, number> | null;
+    effective_at?: string;
     /**
-     * If true, response will include the balance of the associated ledger account for
-     * the entry.
+     * An array of ledger entry objects.
      */
-    show_resulting_ledger_account_balances?: boolean | null;
-  }
+    ledger_entries?: Array<LedgerTransactionUpdateParams.LedgerEntry>;
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * To post a ledger transaction at creation, use `posted`.
+     */
+    status?: 'archived' | 'pending' | 'posted';
+}
+export declare namespace LedgerTransactionUpdateParams {
+    interface LedgerEntry {
+        /**
+         * Value in specified currency's smallest unit. e.g. $10 would be represented
+         * as 1000. Can be any integer up to 36 digits.
+         */
+        amount: number;
+        /**
+         * One of `credit`, `debit`. Describes the direction money is flowing in the
+         * transaction. A `credit` moves money from your account to someone else's. A
+         * `debit` pulls money from someone else's account to your own. Note that wire,
+         * rtp, and check payments will always be `credit`.
+         */
+        direction: 'credit' | 'debit';
+        /**
+         * The ledger account that this ledger entry is associated with.
+         */
+        ledger_account_id: string;
+        /**
+         * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+         * account’s available balance. If any of these conditions would be false after the
+         * transaction is created, the entire call will fail with error code 422.
+         */
+        available_balance_amount?: Record<string, number> | null;
+        /**
+         * Lock version of the ledger account. This can be passed when creating a ledger
+         * transaction to only succeed if no ledger transactions have posted since the
+         * given version. See our post about Designing the Ledgers API with Optimistic
+         * Locking for more details.
+         */
+        lock_version?: number | null;
+        /**
+         * Additional data represented as key-value pairs. Both the key and value must be
+         * strings.
+         */
+        metadata?: Record<string, string>;
+        /**
+         * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+         * account’s pending balance. If any of these conditions would be false after the
+         * transaction is created, the entire call will fail with error code 422.
+         */
+        pending_balance_amount?: Record<string, number> | null;
+        /**
+         * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+         * account’s posted balance. If any of these conditions would be false after the
+         * transaction is created, the entire call will fail with error code 422.
+         */
+        posted_balance_amount?: Record<string, number> | null;
+        /**
+         * If true, response will include the balance of the associated ledger account for
+         * the entry.
+         */
+        show_resulting_ledger_account_balances?: boolean | null;
+    }
 }
 export interface LedgerTransactionListParams extends PageParams {
-  /**
-   * If you have specific IDs to retrieve in bulk, you can pass them as query
-   * parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
-   */
-  id?: Array<string>;
-  /**
-   * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by
-   * effective at. For example, for all transactions after Jan 1 2000, use
-   * effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z.
-   */
-  effective_at?: Record<string, string>;
-  /**
-   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by
-   * effective date. For example, for all dates after Jan 1 2000, use
-   * effective_date%5Bgt%5D=2000-01-01.
-   */
-  effective_date?: Record<string, string>;
-  external_id?: string;
-  ledger_account_category_id?: string;
-  ledger_account_id?: string;
-  ledger_account_payout_id?: string;
-  ledger_id?: string;
-  ledgerable_id?: string;
-  ledgerable_type?:
-    | 'counterparty'
-    | 'expected_payment'
-    | 'incoming_payment_detail'
-    | 'internal_account'
-    | 'line_item'
-    | 'paper_item'
-    | 'payment_order'
-    | 'payment_order_attempt'
-    | 'return'
-    | 'reversal';
-  /**
-   * For example, if you want to query for records with metadata key `Type` and value
-   * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-   * parameters.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
-   * to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
-   * by only one field at a time is supported.
-   */
-  order_by?: LedgerTransactionListParams.OrderBy;
-  /**
-   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-   * posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-   * posted_at%5Bgt%5D=2000-01-01T12:00:00Z.
-   */
-  posted_at?: Record<string, string>;
-  reverses_ledger_transaction_id?: string;
-  status?: 'pending' | 'posted' | 'archived';
-  /**
-   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-   * posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-   * updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
-   */
-  updated_at?: Record<string, string>;
+    /**
+     * If you have specific IDs to retrieve in bulk, you can pass them as query
+     * parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
+     */
+    id?: Array<string>;
+    /**
+     * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by
+     * effective at. For example, for all transactions after Jan 1 2000, use
+     * effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z.
+     */
+    effective_at?: Record<string, string>;
+    /**
+     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by
+     * effective date. For example, for all dates after Jan 1 2000, use
+     * effective_date%5Bgt%5D=2000-01-01.
+     */
+    effective_date?: Record<string, string>;
+    external_id?: string;
+    ledger_account_category_id?: string;
+    ledger_account_id?: string;
+    ledger_account_payout_id?: string;
+    ledger_id?: string;
+    ledgerable_id?: string;
+    ledgerable_type?: 'counterparty' | 'expected_payment' | 'incoming_payment_detail' | 'internal_account' | 'line_item' | 'paper_item' | 'payment_order' | 'payment_order_attempt' | 'return' | 'reversal';
+    /**
+     * For example, if you want to query for records with metadata key `Type` and value
+     * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+     * parameters.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
+     * to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+     * by only one field at a time is supported.
+     */
+    order_by?: LedgerTransactionListParams.OrderBy;
+    /**
+     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+     * posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+     * posted_at%5Bgt%5D=2000-01-01T12:00:00Z.
+     */
+    posted_at?: Record<string, string>;
+    reverses_ledger_transaction_id?: string;
+    status?: 'pending' | 'posted' | 'archived';
+    /**
+     * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+     * posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+     * updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
+     */
+    updated_at?: Record<string, string>;
 }
 export declare namespace LedgerTransactionListParams {
-  /**
-   * Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
-   * to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
-   * by only one field at a time is supported.
-   */
-  interface OrderBy {
-    created_at?: 'asc' | 'desc';
-    effective_at?: 'asc' | 'desc';
-  }
+    /**
+     * Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
+     * to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+     * by only one field at a time is supported.
+     */
+    interface OrderBy {
+        created_at?: 'asc' | 'desc';
+        effective_at?: 'asc' | 'desc';
+    }
 }
 export interface LedgerTransactionCreateReversalParams {
-  /**
-   * An optional free-form description for the reversal ledger transaction. Maximum
-   * of 1000 characters allowed.
-   */
-  description?: string;
-  /**
-   * The timestamp (ISO8601 format) at which the reversal ledger transaction happened
-   * for reporting purposes. It defaults to the `effective_at` of the original ledger
-   * transaction if not provided.
-   */
-  effective_at?: string | null;
-  /**
-   * Must be unique within the ledger.
-   */
-  external_id?: string;
-  /**
-   * Specify this if you'd like to link the reversal ledger transaction to a Payment
-   * object like Return or Reversal.
-   */
-  ledgerable_id?: string;
-  /**
-   * Specify this if you'd like to link the reversal ledger transaction to a Payment
-   * object like Return or Reversal.
-   */
-  ledgerable_type?:
-    | 'counterparty'
-    | 'expected_payment'
-    | 'incoming_payment_detail'
-    | 'internal_account'
-    | 'line_item'
-    | 'paper_item'
-    | 'payment_order'
-    | 'payment_order_attempt'
-    | 'return'
-    | 'reversal';
-  /**
-   * Additional data to be added to the reversal ledger transaction as key-value
-   * pairs. Both the key and value must be strings.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * Status of the reversal ledger transaction. It defaults to `posted` if not
-   * provided.
-   */
-  status?: 'archived' | 'pending' | 'posted';
+    /**
+     * An optional free-form description for the reversal ledger transaction. Maximum
+     * of 1000 characters allowed.
+     */
+    description?: string;
+    /**
+     * The timestamp (ISO8601 format) at which the reversal ledger transaction happened
+     * for reporting purposes. It defaults to the `effective_at` of the original ledger
+     * transaction if not provided.
+     */
+    effective_at?: string | null;
+    /**
+     * Must be unique within the ledger.
+     */
+    external_id?: string;
+    /**
+     * Specify this if you'd like to link the reversal ledger transaction to a Payment
+     * object like Return or Reversal.
+     */
+    ledgerable_id?: string;
+    /**
+     * Specify this if you'd like to link the reversal ledger transaction to a Payment
+     * object like Return or Reversal.
+     */
+    ledgerable_type?: 'counterparty' | 'expected_payment' | 'incoming_payment_detail' | 'internal_account' | 'line_item' | 'paper_item' | 'payment_order' | 'payment_order_attempt' | 'return' | 'reversal';
+    /**
+     * Additional data to be added to the reversal ledger transaction as key-value
+     * pairs. Both the key and value must be strings.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * Status of the reversal ledger transaction. It defaults to `posted` if not
+     * provided.
+     */
+    status?: 'archived' | 'pending' | 'posted';
 }
 export declare namespace LedgerTransactions {
-  export import LedgerTransaction = API.LedgerTransaction;
-  type LedgerTransactionsPage = _LedgerTransactionsPage;
-  export import LedgerTransactionCreateParams = API.LedgerTransactionCreateParams;
-  export import LedgerTransactionUpdateParams = API.LedgerTransactionUpdateParams;
-  export import LedgerTransactionListParams = API.LedgerTransactionListParams;
-  export import LedgerTransactionCreateReversalParams = API.LedgerTransactionCreateReversalParams;
-  export import Versions = API.Versions;
-  export import LedgerTransactionVersion = API.LedgerTransactionVersion;
-  export import LedgerTransactionVersionsPage = API.LedgerTransactionVersionsPage;
-  export import VersionListParams = API.VersionListParams;
+    export import LedgerTransaction = API.LedgerTransaction;
+    type LedgerTransactionsPage = _LedgerTransactionsPage;
+    export import LedgerTransactionCreateParams = API.LedgerTransactionCreateParams;
+    export import LedgerTransactionUpdateParams = API.LedgerTransactionUpdateParams;
+    export import LedgerTransactionListParams = API.LedgerTransactionListParams;
+    export import LedgerTransactionCreateReversalParams = API.LedgerTransactionCreateReversalParams;
+    export import Versions = API.Versions;
+    export import LedgerTransactionVersion = API.LedgerTransactionVersion;
+    export import LedgerTransactionVersionsPage = API.LedgerTransactionVersionsPage;
+    export import VersionListParams = API.VersionListParams;
 }
 export {};
-//# sourceMappingURL=ledger-transactions.d.ts.map
+//# sourceMappingURL=ledger-transactions.d.ts.map