modern-treasury 2.6.0 → 2.7.2

package/resources/invoices/invoices.d.ts

@@ -2,649 +2,609 @@ import * as Core from 'modern-treasury/core';
 import { APIResource } from 'modern-treasury/resource';
 import * as Shared from 'modern-treasury/resources/shared';
 import * as PaymentOrders from 'modern-treasury/resources/payment-orders/index';
-import { LineItems } from './line-items.js';
-import * as API from './index.js';
+import { LineItems } from "./line-items.js";
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class Invoices extends APIResource {
-  lineItems: LineItems;
-  /**
-   * create invoice
-   */
-  create(params: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
-  /**
-   * get invoice
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
-  /**
-   * update invoice
-   */
-  update(id: string, body?: InvoiceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
-  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
-  /**
-   * list invoices
-   */
-  list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
-  /**
-   * Add a payment order to an invoice.
-   */
-  addPaymentOrder(id: string, paymentOrderId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    lineItems: LineItems;
+    /**
+     * create invoice
+     */
+    create(params: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    /**
+     * get invoice
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    /**
+     * update invoice
+     */
+    update(id: string, body?: InvoiceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    update(id: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    /**
+     * list invoices
+     */
+    list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
+    list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
+    /**
+     * Add a payment order to an invoice.
+     */
+    addPaymentOrder(id: string, paymentOrderId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+}
+export declare class InvoicesPage extends Page<Invoice> {
 }
-export declare class InvoicesPage extends Page<Invoice> {}
 type _InvoicesPage = InvoicesPage;
 export interface Invoice {
-  id: string;
-  /**
-   * The invoicer's contact details displayed at the top of the invoice.
-   */
-  contact_details: Array<Invoice.ContactDetail>;
-  /**
-   * The counterparty's billing address.
-   */
-  counterparty_billing_address: Invoice.CounterpartyBillingAddress | null;
-  /**
-   * The ID of the counterparty receiving the invoice.
-   */
-  counterparty_id: string;
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  counterparty_shipping_address: Invoice.CounterpartyShippingAddress | null;
-  created_at: string;
-  /**
-   * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
-   */
-  currency: Shared.Currency | null;
-  /**
-   * A free-form description of the invoice.
-   */
-  description: string;
-  /**
-   * A future date by when the invoice needs to be paid.
-   */
-  due_date: string;
-  /**
-   * The URL of the hosted web UI where the invoice can be viewed.
-   */
-  hosted_url: string;
-  /**
-   * The invoice issuer's business address.
-   */
-  invoicer_address: Invoice.InvoicerAddress | 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;
-  /**
-   * Emails in addition to the counterparty email to send invoice status
-   * notifications to. At least one email is required if notifications are enabled
-   * and the counterparty doesn't have an email.
-   */
-  notification_email_addresses: Array<string> | null;
-  /**
-   * If true, the invoice will send email notifications to the invoice recipients
-   * about invoice status changes.
-   */
-  notifications_enabled: boolean;
-  /**
-   * A unique record number assigned to each invoice that is issued.
-   */
-  number: string;
-  object: string;
-  /**
-   * The ID of the internal account the invoice should be paid to.
-   */
-  originating_account_id: string;
-  /**
-   * Date transactions are to be posted to the participants' account. Defaults to the
-   * current business day or the next business day if the current day is a bank
-   * holiday or weekend. Format: yyyy-mm-dd.
-   */
-  payment_effective_date: string | null;
-  /**
-   * When opening an invoice, whether to show the embedded payment UI , automatically
-   * debit the recipient, or rely on manual payment from the recipient.
-   */
-  payment_method: 'ui' | 'manual' | 'automatic' | null;
-  /**
-   * The payment orders created for paying the invoice through the invoice payment
-   * UI.
-   */
-  payment_orders: Array<PaymentOrders.PaymentOrder>;
-  /**
-   * One of `ach` or `eft`.
-   */
-  payment_type: 'eft' | 'ach' | null;
-  /**
-   * The URL where the invoice PDF can be downloaded.
-   */
-  pdf_url: string | null;
-  /**
-   * The receiving account ID. Can be an `internal_account`.
-   */
-  receiving_account_id: string | null;
-  /**
-   * The email of the recipient of the invoice. Leaving this value as null will
-   * fallback to using the counterparty's name.
-   */
-  recipient_email: string | null;
-  /**
-   * The name of the recipient of the invoice. Leaving this value as null will
-   * fallback to using the counterparty's name.
-   */
-  recipient_name: string | null;
-  /**
-   * The status of the invoice.
-   */
-  status: 'draft' | 'paid' | 'payment_pending' | 'unpaid' | 'voided';
-  /**
-   * Total amount due in specified currency's smallest unit, e.g., $10 USD would be
-   * represented as 1000.
-   */
-  total_amount: number;
-  /**
-   * IDs of transaction line items associated with an invoice.
-   */
-  transaction_line_item_ids: Array<string>;
-  updated_at: string;
-  /**
-   * The ID of the virtual account the invoice should be paid to.
-   */
-  virtual_account_id: string | null;
-}
-export declare namespace Invoice {
-  interface ContactDetail {
     id: string;
-    contact_identifier: string;
-    contact_identifier_type: 'email' | 'phone_number' | 'website';
+    /**
+     * The invoicer's contact details displayed at the top of the invoice.
+     */
+    contact_details: Array<Invoice.ContactDetail>;
+    /**
+     * The counterparty's billing address.
+     */
+    counterparty_billing_address: Invoice.CounterpartyBillingAddress | null;
+    /**
+     * The ID of the counterparty receiving the invoice.
+     */
+    counterparty_id: string;
+    /**
+     * The counterparty's shipping address where physical goods should be delivered.
+     */
+    counterparty_shipping_address: Invoice.CounterpartyShippingAddress | null;
     created_at: string;
-    discarded_at: string | null;
+    /**
+     * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+     */
+    currency: Shared.Currency | null;
+    /**
+     * A free-form description of the invoice.
+     */
+    description: string;
+    /**
+     * A future date by when the invoice needs to be paid.
+     */
+    due_date: string;
+    /**
+     * The URL of the hosted web UI where the invoice can be viewed.
+     */
+    hosted_url: string;
+    /**
+     * The invoice issuer's business address.
+     */
+    invoicer_address: Invoice.InvoicerAddress | 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;
+    /**
+     * Emails in addition to the counterparty email to send invoice status
+     * notifications to. At least one email is required if notifications are enabled
+     * and the counterparty doesn't have an email.
+     */
+    notification_email_addresses: Array<string> | null;
+    /**
+     * If true, the invoice will send email notifications to the invoice recipients
+     * about invoice status changes.
+     */
+    notifications_enabled: boolean;
+    /**
+     * A unique record number assigned to each invoice that is issued.
+     */
+    number: string;
     object: string;
-    updated_at: string;
-  }
-  /**
-   * The counterparty's billing address.
-   */
-  interface CounterpartyBillingAddress {
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The ID of the internal account the invoice should be paid to.
      */
-    country: string;
-    line1: string;
+    originating_account_id: string;
     /**
-     * Locality or City.
+     * Date transactions are to be posted to the participants' account. Defaults to the
+     * current business day or the next business day if the current day is a bank
+     * holiday or weekend. Format: yyyy-mm-dd.
      */
-    locality: string;
+    payment_effective_date: string | null;
     /**
-     * The postal code of the address.
+     * When opening an invoice, whether to show the embedded payment UI , automatically
+     * debit the recipient, or rely on manual payment from the recipient.
      */
-    postal_code: string;
+    payment_method: 'ui' | 'manual' | 'automatic' | null;
     /**
-     * Region or State.
+     * The payment orders created for paying the invoice through the invoice payment
+     * UI.
      */
-    region: string;
-    line2?: string;
-  }
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  interface CounterpartyShippingAddress {
+    payment_orders: Array<PaymentOrders.PaymentOrder>;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * One of `ach` or `eft`.
      */
-    country: string;
-    line1: string;
+    payment_type: 'eft' | 'ach' | null;
     /**
-     * Locality or City.
+     * The URL where the invoice PDF can be downloaded.
      */
-    locality: string;
+    pdf_url: string | null;
     /**
-     * The postal code of the address.
+     * The receiving account ID. Can be an `internal_account`.
      */
-    postal_code: string;
+    receiving_account_id: string | null;
     /**
-     * Region or State.
+     * The email of the recipient of the invoice. Leaving this value as null will
+     * fallback to using the counterparty's name.
      */
-    region: string;
-    line2?: string;
-  }
-  /**
-   * The invoice issuer's business address.
-   */
-  interface InvoicerAddress {
+    recipient_email: string | null;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The name of the recipient of the invoice. Leaving this value as null will
+     * fallback to using the counterparty's name.
      */
-    country: string;
-    line1: string;
+    recipient_name: string | null;
     /**
-     * Locality or City.
+     * The status of the invoice.
      */
-    locality: string;
+    status: 'draft' | 'paid' | 'payment_pending' | 'unpaid' | 'voided';
     /**
-     * The postal code of the address.
+     * Total amount due in specified currency's smallest unit, e.g., $10 USD would be
+     * represented as 1000.
      */
-    postal_code: string;
+    total_amount: number;
     /**
-     * Region or State.
+     * IDs of transaction line items associated with an invoice.
      */
-    region: string;
-    line2?: string;
-  }
+    transaction_line_item_ids: Array<string>;
+    updated_at: string;
+    /**
+     * The ID of the virtual account the invoice should be paid to.
+     */
+    virtual_account_id: string | null;
 }
-export interface InvoiceCreateParams {
-  /**
-   * The ID of the counterparty receiving the invoice.
-   */
-  counterparty_id: string;
-  /**
-   * A future date by when the invoice needs to be paid.
-   */
-  due_date: string;
-  /**
-   * The ID of the internal account the invoice should be paid to.
-   */
-  originating_account_id: string;
-  /**
-   * The invoicer's contact details displayed at the top of the invoice.
-   */
-  contact_details?: Array<InvoiceCreateParams.ContactDetail>;
-  /**
-   * The counterparty's billing address.
-   */
-  counterparty_billing_address?: InvoiceCreateParams.CounterpartyBillingAddress | null;
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  counterparty_shipping_address?: InvoiceCreateParams.CounterpartyShippingAddress | null;
-  /**
-   * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
-   */
-  currency?: Shared.Currency | null;
-  /**
-   * A free-form description of the invoice.
-   */
-  description?: string;
-  /**
-   * The invoice issuer's business address.
-   */
-  invoicer_address?: InvoiceCreateParams.InvoicerAddress | null;
-  /**
-   * Emails in addition to the counterparty email to send invoice status
-   * notifications to. At least one email is required if notifications are enabled
-   * and the counterparty doesn't have an email.
-   */
-  notification_email_addresses?: Array<string> | null;
-  /**
-   * If true, the invoice will send email notifications to the invoice recipients
-   * about invoice status changes.
-   */
-  notifications_enabled?: boolean;
-  /**
-   * Date transactions are to be posted to the participants' account. Defaults to the
-   * current business day or the next business day if the current day is a bank
-   * holiday or weekend. Format: yyyy-mm-dd.
-   */
-  payment_effective_date?: string;
-  /**
-   * The method by which the invoice can be paid. `ui` will show the embedded payment
-   * collection flow. `automatic` will automatically initiate payment based upon the
-   * account details of the receiving_account id.\nIf the invoice amount is positive,
-   * the automatically initiated payment order's direction will be debit. If the
-   * invoice amount is negative, the automatically initiated payment order's
-   * direction will be credit. One of `manual`, `ui`, or `automatic`.
-   */
-  payment_method?: 'ui' | 'manual' | 'automatic';
-  /**
-   * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
-   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
-   * `zengin`.
-   */
-  payment_type?:
-    | 'ach'
-    | 'au_becs'
-    | 'se_bankgirot'
-    | 'bacs'
-    | 'book'
-    | 'card'
-    | 'check'
-    | 'eft'
-    | 'cross_border'
-    | 'interac'
-    | 'masav'
-    | 'neft'
-    | 'nics'
-    | 'provxchange'
-    | 'rtp'
-    | 'sen'
-    | 'sic'
-    | 'sepa'
-    | 'signet'
-    | 'wire'
-    | 'zengin';
-  /**
-   * The receiving account ID. Can be an `external_account`.
-   */
-  receiving_account_id?: string;
-  /**
-   * The email of the recipient of the invoice. Leaving this value as null will
-   * fallback to using the counterparty's name.
-   */
-  recipient_email?: string | null;
-  /**
-   * The name of the recipient of the invoice. Leaving this value as null will
-   * fallback to using the counterparty's name.
-   */
-  recipient_name?: string | null;
-  /**
-   * The ID of the virtual account the invoice should be paid to.
-   */
-  virtual_account_id?: string | null;
+export declare namespace Invoice {
+    interface ContactDetail {
+        id: string;
+        contact_identifier: string;
+        contact_identifier_type: 'email' | 'phone_number' | 'website';
+        created_at: string;
+        discarded_at: string | 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;
+        object: string;
+        updated_at: string;
+    }
+    /**
+     * The counterparty's billing address.
+     */
+    interface CounterpartyBillingAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+    /**
+     * The counterparty's shipping address where physical goods should be delivered.
+     */
+    interface CounterpartyShippingAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+    /**
+     * The invoice issuer's business address.
+     */
+    interface InvoicerAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
 }
-export declare namespace InvoiceCreateParams {
-  interface ContactDetail {
-    id: string;
-    contact_identifier: string;
-    contact_identifier_type: 'email' | 'phone_number' | 'website';
-    created_at: string;
-    discarded_at: string | null;
+export interface InvoiceCreateParams {
     /**
-     * This field will be true if this object exists in the live environment or false
-     * if it exists in the test environment.
+     * The ID of the counterparty receiving the invoice.
      */
-    live_mode: boolean;
-    object: string;
-    updated_at: string;
-  }
-  /**
-   * The counterparty's billing address.
-   */
-  interface CounterpartyBillingAddress {
+    counterparty_id: string;
+    /**
+     * A future date by when the invoice needs to be paid.
+     */
+    due_date: string;
+    /**
+     * The ID of the internal account the invoice should be paid to.
+     */
+    originating_account_id: string;
+    /**
+     * The invoicer's contact details displayed at the top of the invoice.
+     */
+    contact_details?: Array<InvoiceCreateParams.ContactDetail>;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The counterparty's billing address.
      */
-    country: string;
-    line1: string;
+    counterparty_billing_address?: InvoiceCreateParams.CounterpartyBillingAddress | null;
     /**
-     * Locality or City.
+     * The counterparty's shipping address where physical goods should be delivered.
      */
-    locality: string;
+    counterparty_shipping_address?: InvoiceCreateParams.CounterpartyShippingAddress | null;
     /**
-     * The postal code of the address.
+     * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
      */
-    postal_code: string;
+    currency?: Shared.Currency | null;
     /**
-     * Region or State.
+     * A free-form description of the invoice.
      */
-    region: string;
-    line2?: string;
-  }
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  interface CounterpartyShippingAddress {
+    description?: string;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The invoice issuer's business address.
      */
-    country: string;
-    line1: string;
+    invoicer_address?: InvoiceCreateParams.InvoicerAddress | null;
     /**
-     * Locality or City.
+     * Emails in addition to the counterparty email to send invoice status
+     * notifications to. At least one email is required if notifications are enabled
+     * and the counterparty doesn't have an email.
      */
-    locality: string;
+    notification_email_addresses?: Array<string> | null;
     /**
-     * The postal code of the address.
+     * If true, the invoice will send email notifications to the invoice recipients
+     * about invoice status changes.
      */
-    postal_code: string;
+    notifications_enabled?: boolean;
     /**
-     * Region or State.
+     * Date transactions are to be posted to the participants' account. Defaults to the
+     * current business day or the next business day if the current day is a bank
+     * holiday or weekend. Format: yyyy-mm-dd.
      */
-    region: string;
-    line2?: string;
-  }
-  /**
-   * The invoice issuer's business address.
-   */
-  interface InvoicerAddress {
+    payment_effective_date?: string;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The method by which the invoice can be paid. `ui` will show the embedded payment
+     * collection flow. `automatic` will automatically initiate payment based upon the
+     * account details of the receiving_account id.\nIf the invoice amount is positive,
+     * the automatically initiated payment order's direction will be debit. If the
+     * invoice amount is negative, the automatically initiated payment order's
+     * direction will be credit. One of `manual`, `ui`, or `automatic`.
      */
-    country: string;
-    line1: string;
+    payment_method?: 'ui' | 'manual' | 'automatic';
     /**
-     * Locality or City.
+     * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
+     * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
+     * `zengin`.
      */
-    locality: string;
+    payment_type?: 'ach' | 'au_becs' | 'se_bankgirot' | 'bacs' | 'book' | 'card' | 'check' | 'eft' | 'cross_border' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'sen' | 'sic' | 'sepa' | 'signet' | 'wire' | 'zengin';
     /**
-     * The postal code of the address.
+     * The receiving account ID. Can be an `external_account`.
      */
-    postal_code: string;
+    receiving_account_id?: string;
     /**
-     * Region or State.
+     * The email of the recipient of the invoice. Leaving this value as null will
+     * fallback to using the counterparty's name.
      */
-    region: string;
-    line2?: string;
-  }
+    recipient_email?: string | null;
+    /**
+     * The name of the recipient of the invoice. Leaving this value as null will
+     * fallback to using the counterparty's name.
+     */
+    recipient_name?: string | null;
+    /**
+     * The ID of the virtual account the invoice should be paid to.
+     */
+    virtual_account_id?: string | null;
 }
-export interface InvoiceUpdateParams {
-  /**
-   * The invoicer's contact details displayed at the top of the invoice.
-   */
-  contact_details?: Array<InvoiceUpdateParams.ContactDetail>;
-  /**
-   * The counterparty's billing address.
-   */
-  counterparty_billing_address?: InvoiceUpdateParams.CounterpartyBillingAddress | null;
-  /**
-   * The ID of the counterparty receiving the invoice.
-   */
-  counterparty_id?: string;
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  counterparty_shipping_address?: InvoiceUpdateParams.CounterpartyShippingAddress | null;
-  /**
-   * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
-   */
-  currency?: Shared.Currency | null;
-  /**
-   * A free-form description of the invoice.
-   */
-  description?: string;
-  /**
-   * A future date by when the invoice needs to be paid.
-   */
-  due_date?: string;
-  /**
-   * The invoice issuer's business address.
-   */
-  invoicer_address?: InvoiceUpdateParams.InvoicerAddress | null;
-  /**
-   * Emails in addition to the counterparty email to send invoice status
-   * notifications to. At least one email is required if notifications are enabled
-   * and the counterparty doesn't have an email.
-   */
-  notification_email_addresses?: Array<string> | null;
-  /**
-   * If true, the invoice will send email notifications to the invoice recipients
-   * about invoice status changes.
-   */
-  notifications_enabled?: boolean;
-  /**
-   * The ID of the internal account the invoice should be paid to.
-   */
-  originating_account_id?: string;
-  /**
-   * Date transactions are to be posted to the participants' account. Defaults to the
-   * current business day or the next business day if the current day is a bank
-   * holiday or weekend. Format: yyyy-mm-dd.
-   */
-  payment_effective_date?: string;
-  /**
-   * The method by which the invoice can be paid. `ui` will show the embedded payment
-   * collection flow. `automatic` will automatically initiate payment based upon the
-   * account details of the receiving_account id.\nIf the invoice amount is positive,
-   * the automatically initiated payment order's direction will be debit. If the
-   * invoice amount is negative, the automatically initiated payment order's
-   * direction will be credit. One of `manual`, `ui`, or `automatic`.
-   */
-  payment_method?: 'ui' | 'manual' | 'automatic';
-  /**
-   * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
-   * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
-   * `zengin`.
-   */
-  payment_type?:
-    | 'ach'
-    | 'au_becs'
-    | 'se_bankgirot'
-    | 'bacs'
-    | 'book'
-    | 'card'
-    | 'check'
-    | 'eft'
-    | 'cross_border'
-    | 'interac'
-    | 'masav'
-    | 'neft'
-    | 'nics'
-    | 'provxchange'
-    | 'rtp'
-    | 'sen'
-    | 'sic'
-    | 'sepa'
-    | 'signet'
-    | 'wire'
-    | 'zengin';
-  /**
-   * The receiving account ID. Can be an `external_account`.
-   */
-  receiving_account_id?: string;
-  /**
-   * The email of the recipient of the invoice. Leaving this value as null will
-   * fallback to using the counterparty's name.
-   */
-  recipient_email?: string | null;
-  /**
-   * The name of the recipient of the invoice. Leaving this value as null will
-   * fallback to using the counterparty's name.
-   */
-  recipient_name?: string | null;
-  /**
-   * Invoice status must be updated in a `PATCH` request that does not modify any
-   * other invoice attributes. Valid state transitions are `draft` to `unpaid`,
-   * `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
-   */
-  status?: string;
-  /**
-   * The ID of the virtual account the invoice should be paid to.
-   */
-  virtual_account_id?: string | null;
+export declare namespace InvoiceCreateParams {
+    interface ContactDetail {
+        id: string;
+        contact_identifier: string;
+        contact_identifier_type: 'email' | 'phone_number' | 'website';
+        created_at: string;
+        discarded_at: string | 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;
+        object: string;
+        updated_at: string;
+    }
+    /**
+     * The counterparty's billing address.
+     */
+    interface CounterpartyBillingAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+    /**
+     * The counterparty's shipping address where physical goods should be delivered.
+     */
+    interface CounterpartyShippingAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+    /**
+     * The invoice issuer's business address.
+     */
+    interface InvoicerAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
 }
-export declare namespace InvoiceUpdateParams {
-  interface ContactDetail {
-    id: string;
-    contact_identifier: string;
-    contact_identifier_type: 'email' | 'phone_number' | 'website';
-    created_at: string;
-    discarded_at: string | null;
+export interface InvoiceUpdateParams {
     /**
-     * This field will be true if this object exists in the live environment or false
-     * if it exists in the test environment.
+     * The invoicer's contact details displayed at the top of the invoice.
      */
-    live_mode: boolean;
-    object: string;
-    updated_at: string;
-  }
-  /**
-   * The counterparty's billing address.
-   */
-  interface CounterpartyBillingAddress {
+    contact_details?: Array<InvoiceUpdateParams.ContactDetail>;
+    /**
+     * The counterparty's billing address.
+     */
+    counterparty_billing_address?: InvoiceUpdateParams.CounterpartyBillingAddress | null;
+    /**
+     * The ID of the counterparty receiving the invoice.
+     */
+    counterparty_id?: string;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The counterparty's shipping address where physical goods should be delivered.
      */
-    country: string;
-    line1: string;
+    counterparty_shipping_address?: InvoiceUpdateParams.CounterpartyShippingAddress | null;
     /**
-     * Locality or City.
+     * Currency that the invoice is denominated in. Defaults to `USD` if not provided.
      */
-    locality: string;
+    currency?: Shared.Currency | null;
     /**
-     * The postal code of the address.
+     * A free-form description of the invoice.
      */
-    postal_code: string;
+    description?: string;
     /**
-     * Region or State.
+     * A future date by when the invoice needs to be paid.
      */
-    region: string;
-    line2?: string;
-  }
-  /**
-   * The counterparty's shipping address where physical goods should be delivered.
-   */
-  interface CounterpartyShippingAddress {
+    due_date?: string;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * The invoice issuer's business address.
      */
-    country: string;
-    line1: string;
+    invoicer_address?: InvoiceUpdateParams.InvoicerAddress | null;
     /**
-     * Locality or City.
+     * Emails in addition to the counterparty email to send invoice status
+     * notifications to. At least one email is required if notifications are enabled
+     * and the counterparty doesn't have an email.
      */
-    locality: string;
+    notification_email_addresses?: Array<string> | null;
     /**
-     * The postal code of the address.
+     * If true, the invoice will send email notifications to the invoice recipients
+     * about invoice status changes.
      */
-    postal_code: string;
+    notifications_enabled?: boolean;
     /**
-     * Region or State.
+     * The ID of the internal account the invoice should be paid to.
      */
-    region: string;
-    line2?: string;
-  }
-  /**
-   * The invoice issuer's business address.
-   */
-  interface InvoicerAddress {
+    originating_account_id?: string;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * Date transactions are to be posted to the participants' account. Defaults to the
+     * current business day or the next business day if the current day is a bank
+     * holiday or weekend. Format: yyyy-mm-dd.
      */
-    country: string;
-    line1: string;
+    payment_effective_date?: string;
     /**
-     * Locality or City.
+     * The method by which the invoice can be paid. `ui` will show the embedded payment
+     * collection flow. `automatic` will automatically initiate payment based upon the
+     * account details of the receiving_account id.\nIf the invoice amount is positive,
+     * the automatically initiated payment order's direction will be debit. If the
+     * invoice amount is negative, the automatically initiated payment order's
+     * direction will be credit. One of `manual`, `ui`, or `automatic`.
      */
-    locality: string;
+    payment_method?: 'ui' | 'manual' | 'automatic';
     /**
-     * The postal code of the address.
+     * One of `ach`, `bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
+     * `bacs`, `au_becs`, `interac`, `neft`, `nics`, `sic`, `signet`, `provexchange`,
+     * `zengin`.
      */
-    postal_code: string;
+    payment_type?: 'ach' | 'au_becs' | 'se_bankgirot' | 'bacs' | 'book' | 'card' | 'check' | 'eft' | 'cross_border' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'sen' | 'sic' | 'sepa' | 'signet' | 'wire' | 'zengin';
     /**
-     * Region or State.
+     * The receiving account ID. Can be an `external_account`.
      */
-    region: string;
-    line2?: string;
-  }
+    receiving_account_id?: string;
+    /**
+     * The email of the recipient of the invoice. Leaving this value as null will
+     * fallback to using the counterparty's name.
+     */
+    recipient_email?: string | null;
+    /**
+     * The name of the recipient of the invoice. Leaving this value as null will
+     * fallback to using the counterparty's name.
+     */
+    recipient_name?: string | null;
+    /**
+     * Invoice status must be updated in a `PATCH` request that does not modify any
+     * other invoice attributes. Valid state transitions are `draft` to `unpaid`,
+     * `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
+     */
+    status?: string;
+    /**
+     * The ID of the virtual account the invoice should be paid to.
+     */
+    virtual_account_id?: string | null;
+}
+export declare namespace InvoiceUpdateParams {
+    interface ContactDetail {
+        id: string;
+        contact_identifier: string;
+        contact_identifier_type: 'email' | 'phone_number' | 'website';
+        created_at: string;
+        discarded_at: string | 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;
+        object: string;
+        updated_at: string;
+    }
+    /**
+     * The counterparty's billing address.
+     */
+    interface CounterpartyBillingAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+    /**
+     * The counterparty's shipping address where physical goods should be delivered.
+     */
+    interface CounterpartyShippingAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+    /**
+     * The invoice issuer's business address.
+     */
+    interface InvoicerAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string;
+        line1: string;
+        /**
+         * Locality or City.
+         */
+        locality: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string;
+        /**
+         * Region or State.
+         */
+        region: string;
+        line2?: string;
+    }
+}
+export interface InvoiceListParams extends PageParams {
 }
-export interface InvoiceListParams extends PageParams {}
 export declare namespace Invoices {
-  export import Invoice = API.Invoice;
-  type InvoicesPage = _InvoicesPage;
-  export import InvoiceCreateParams = API.InvoiceCreateParams;
-  export import InvoiceUpdateParams = API.InvoiceUpdateParams;
-  export import InvoiceListParams = API.InvoiceListParams;
-  export import LineItems = API.LineItems;
-  export import InvoiceLineItem = API.InvoiceLineItem;
-  export import InvoiceLineItemsPage = API.InvoiceLineItemsPage;
-  export import LineItemCreateParams = API.LineItemCreateParams;
-  export import LineItemUpdateParams = API.LineItemUpdateParams;
-  export import LineItemListParams = API.LineItemListParams;
+    export import Invoice = API.Invoice;
+    type InvoicesPage = _InvoicesPage;
+    export import InvoiceCreateParams = API.InvoiceCreateParams;
+    export import InvoiceUpdateParams = API.InvoiceUpdateParams;
+    export import InvoiceListParams = API.InvoiceListParams;
+    export import LineItems = API.LineItems;
+    export import InvoiceLineItem = API.InvoiceLineItem;
+    export import InvoiceLineItemsPage = API.InvoiceLineItemsPage;
+    export import LineItemCreateParams = API.LineItemCreateParams;
+    export import LineItemUpdateParams = API.LineItemUpdateParams;
+    export import LineItemListParams = API.LineItemListParams;
 }
 export {};
-//# sourceMappingURL=invoices.d.ts.map
+//# sourceMappingURL=invoices.d.ts.map