modern-treasury 3.3.0 → 4.4.2

package/src/resources/internal-accounts/internal-accounts.ts

@@ -89,6 +89,19 @@ export class InternalAccounts extends APIResource {
     return this._client.getAPIList('/api/internal_accounts', Page<InternalAccount>, { query, ...options });
   }
 
+  /**
+   * request closure of internal account
+   *
+   * @example
+   * ```ts
+   * const internalAccount =
+   *   await client.internalAccounts.requestClosure('id');
+   * ```
+   */
+  requestClosure(id: string, options?: RequestOptions): APIPromise<InternalAccount> {
+    return this._client.post(path`/api/internal_accounts/${id}/request_closure`, options);
+  }
+
   /**
    * update account_capability
    *
@@ -157,6 +170,12 @@ export interface InternalAccount {
    */
   connection: ConnectionsAPI.Connection;
 
+  /**
+   * If the internal account links to a contra ledger account in Modern Treasury, the
+   * id of the contra ledger account will be populated here.
+   */
+  contra_ledger_account_id: string | null;
+
   /**
    * The Counterparty associated to this account.
    */
@@ -169,6 +188,11 @@ export interface InternalAccount {
    */
   currency: Shared.Currency;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id: string | null;
+
   /**
    * If the internal account links to a ledger account in Modern Treasury, the id of
    * the ledger account will be populated here.
@@ -437,6 +461,11 @@ export interface InternalAccountCreateParams {
    */
   counterparty_id?: string;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * The LegalEntity associated to this account.
    */
@@ -564,11 +593,21 @@ export namespace InternalAccountCreateParams {
 }
 
 export interface InternalAccountUpdateParams {
+  /**
+   * The Contra Ledger Account associated to this account.
+   */
+  contra_ledger_account_id?: string;
+
   /**
    * The Counterparty associated to this account.
    */
   counterparty_id?: string;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * The Ledger Account associated to this account.
    */
@@ -602,6 +641,11 @@ export interface InternalAccountListParams extends PageParams {
    */
   currency?: Shared.Currency;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string;
+
   /**
    * Only return internal accounts associated with this legal entity.
    */

package/src/resources/invoices/invoices.ts

@@ -191,7 +191,7 @@ export interface Invoice {
   invoicer_name: string | null;
 
   /**
-   * The ledger account settlement object linked to the invoice.
+   * @deprecated The ledger account settlement object linked to the invoice.
    */
   ledger_account_settlement_id: string | null;
 
@@ -451,13 +451,6 @@ export interface InvoiceCreateParams {
    */
   fallback_payment_method?: string | null;
 
-  /**
-   * Whether to ingest the ledger_entries to populate the invoice line items. If this
-   * is false, then a line item must be provided. If this is true, line_items must be
-   * empty. Ignored if ledger_account_settlement_id is empty.
-   */
-  ingest_ledger_entries?: boolean | null;
-
   /**
    * An array of invoice line items. The API supports a maximum of 50 invoice line
    * items per invoice. If a greater number of invoice line items is required, please
@@ -470,11 +463,6 @@ export interface InvoiceCreateParams {
    */
   invoicer_address?: InvoiceCreateParams.InvoicerAddress | null;
 
-  /**
-   * The ID of the virtual account the invoice should be paid to.
-   */
-  ledger_account_settlement_id?: string | null;
-
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.
@@ -722,13 +710,6 @@ export interface InvoiceUpdateParams {
    */
   fallback_payment_method?: string | null;
 
-  /**
-   * Whether to ingest the ledger_entries to populate the invoice line items. If this
-   * is false, then a line item must be provided. If this is true, line_items must be
-   * empty. Ignored if ledger_account_settlement_id is empty.
-   */
-  ingest_ledger_entries?: boolean | null;
-
   /**
    * An array of invoice line items. The API supports a maximum of 50 invoice line
    * items per invoice. If a greater number of invoice line items is required, please
@@ -741,11 +722,6 @@ export interface InvoiceUpdateParams {
    */
   invoicer_address?: InvoiceUpdateParams.InvoicerAddress | null;
 
-  /**
-   * The ID of the virtual account the invoice should be paid to.
-   */
-  ledger_account_settlement_id?: string | null;
-
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.

package/src/resources/journal-entries.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class JournalEntries extends APIResource {
+  /**
+   * Retrieve a specific journal entry
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/journal_entries/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieve a list of journal entries
+   */
+  list(query: JournalEntryListParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/journal_entries', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface JournalEntryListParams {
+  /**
+   * The ID of the journal report
+   */
+  journal_report_id: string;
+
+  /**
+   * Page number for pagination
+   */
+  page?: number;
+
+  /**
+   * Number of items per page
+   */
+  per_page?: number;
+}
+
+export declare namespace JournalEntries {
+  export { type JournalEntryListParams as JournalEntryListParams };
+}

package/src/resources/journal-reports.ts

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class JournalReports extends APIResource {
+  /**
+   * Retrieve a specific journal report
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/journal_reports/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Update a journal report
+   */
+  update(
+    id: string,
+    body: JournalReportUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.patch(path`/api/journal_reports/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieve a list of journal reports
+   */
+  list(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/journal_reports', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface JournalReportUpdateParams {
+  metadata?: unknown;
+
+  status?: string;
+}
+
+export declare namespace JournalReports {
+  export { type JournalReportUpdateParams as JournalReportUpdateParams };
+}

package/src/resources/ledger-account-categories.ts

@@ -282,6 +282,11 @@ export interface LedgerAccountCategoryCreateParams {
    */
   description?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * The array of ledger account category ids that this ledger account category
    * should be a child of.
@@ -325,6 +330,11 @@ export interface LedgerAccountCategoryUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.
@@ -371,11 +381,7 @@ export interface LedgerAccountCategoryListParams extends PageParams {
    */
   metadata?: { [key: string]: string };
 
-  /**
-   * If you have specific names to retrieve in bulk, you can pass them as query
-   * parameters delimited with `name[]=`, for example `?name[]=123&name[]=abc`.
-   */
-  name?: Array<string>;
+  name?: string;
 
   /**
    * Query categories that are nested underneath a parent category

package/src/resources/ledger-accounts.ts

@@ -244,6 +244,11 @@ export interface LedgerAccountCreateParams {
    */
   description?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * The array of ledger account category ids that this ledger account should be a
    * child of.
@@ -310,6 +315,11 @@ export interface LedgerAccountUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * An optional user-defined 180 character unique identifier.
+   */
+  external_id?: string | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.

package/src/resources/ledger-entries.ts

@@ -84,6 +84,12 @@ export interface LedgerEntry {
 
   discarded_at: string | null;
 
+  /**
+   * The timestamp (ISO8601 format) at which the ledger transaction happened for
+   * reporting purposes.
+   */
+  effective_at: string;
+
   /**
    * The currency of the ledger account.
    */
@@ -258,7 +264,7 @@ export interface LedgerEntryListParams extends PageParams {
    * `posted`, or `archived`. For multiple statuses, use
    * `status[]=pending&status[]=posted`.
    */
-  status?: Array<'pending' | 'posted' | 'archived'>;
+  status?: 'pending' | 'posted' | 'archived';
 
   /**
    * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the

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

@@ -311,6 +311,12 @@ export interface LedgerTransactionUpdateParams {
    */
   effective_at?: 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.
    */

package/src/resources/ledger-transactions/versions.ts

@@ -167,6 +167,12 @@ export namespace LedgerTransactionVersion {
      */
     direction: Shared.TransactionDirection;
 
+    /**
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
+     */
+    effective_at: string;
+
     /**
      * The currency of the ledger account.
      */