modern-treasury 0.0.1

package/resources/expected-payments.ts

@@ -0,0 +1,1016 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class ExpectedPayments extends APIResource {
+  create(
+    body: ExpectedPaymentCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ExpectedPayment>> {
+    return this.post('/api/expected_payments', { body, ...options });
+  }
+
+  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>> {
+    return this.get(`/api/expected_payments/${id}`, options);
+  }
+
+  update(
+    id: string,
+    body: ExpectedPaymentUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ExpectedPayment>> {
+    return this.patch(`/api/expected_payments/${id}`, { body, ...options });
+  }
+
+  list(
+    query?: ExpectedPaymentListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ExpectedPaymentsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage>;
+  list(
+    query: ExpectedPaymentListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ExpectedPaymentsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/api/expected_payments', ExpectedPaymentsPage, { query, ...options });
+  }
+
+  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>> {
+    return this.delete(`/api/expected_payments/${id}`, options);
+  }
+}
+
+export class ExpectedPaymentsPage extends Page<ExpectedPayment> {}
+
+export interface ExpectedPayment {
+  /**
+   * The lowest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_lower_bound?: number;
+
+  /**
+   * The highest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_upper_bound?: number;
+
+  /**
+   * The ID of the counterparty you expect for this payment.
+   */
+  counterparty_id?: string | null;
+
+  created_at?: string;
+
+  /**
+   * Must conform to ISO 4217. Defaults to the currency of the internal account.
+   */
+  currency?:
+    | 'AED'
+    | 'AFN'
+    | 'ALL'
+    | 'AMD'
+    | 'ANG'
+    | 'AOA'
+    | 'ARS'
+    | 'AUD'
+    | 'AWG'
+    | 'AZN'
+    | 'BAM'
+    | 'BBD'
+    | 'BCH'
+    | 'BDT'
+    | 'BGN'
+    | 'BHD'
+    | 'BIF'
+    | 'BMD'
+    | 'BND'
+    | 'BOB'
+    | 'BRL'
+    | 'BSD'
+    | 'BTC'
+    | 'BTN'
+    | 'BWP'
+    | 'BYN'
+    | 'BYR'
+    | 'BZD'
+    | 'CAD'
+    | 'CDF'
+    | 'CHF'
+    | 'CLF'
+    | 'CLP'
+    | 'CNH'
+    | 'CNY'
+    | 'COP'
+    | 'CRC'
+    | 'CUC'
+    | 'CUP'
+    | 'CVE'
+    | 'CZK'
+    | 'DJF'
+    | 'DKK'
+    | 'DOP'
+    | 'DZD'
+    | 'EEK'
+    | 'EGP'
+    | 'ERN'
+    | 'ETB'
+    | 'EUR'
+    | 'FJD'
+    | 'FKP'
+    | 'GBP'
+    | 'GBX'
+    | 'GEL'
+    | 'GGP'
+    | 'GHS'
+    | 'GIP'
+    | 'GMD'
+    | 'GNF'
+    | 'GTQ'
+    | 'GYD'
+    | 'HKD'
+    | 'HNL'
+    | 'HRK'
+    | 'HTG'
+    | 'HUF'
+    | 'IDR'
+    | 'ILS'
+    | 'IMP'
+    | 'INR'
+    | 'IQD'
+    | 'IRR'
+    | 'ISK'
+    | 'JEP'
+    | 'JMD'
+    | 'JOD'
+    | 'JPY'
+    | 'KES'
+    | 'KGS'
+    | 'KHR'
+    | 'KMF'
+    | 'KPW'
+    | 'KRW'
+    | 'KWD'
+    | 'KYD'
+    | 'KZT'
+    | 'LAK'
+    | 'LBP'
+    | 'LKR'
+    | 'LRD'
+    | 'LSL'
+    | 'LTL'
+    | 'LVL'
+    | 'LYD'
+    | 'MAD'
+    | 'MDL'
+    | 'MGA'
+    | 'MKD'
+    | 'MMK'
+    | 'MNT'
+    | 'MOP'
+    | 'MRO'
+    | 'MRU'
+    | 'MTL'
+    | 'MUR'
+    | 'MVR'
+    | 'MWK'
+    | 'MXN'
+    | 'MYR'
+    | 'MZN'
+    | 'NAD'
+    | 'NGN'
+    | 'NIO'
+    | 'NOK'
+    | 'NPR'
+    | 'NZD'
+    | 'OMR'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * The earliest date the payment may come in. Format: yyyy-mm-dd
+   */
+  date_lower_bound?: string | null;
+
+  /**
+   * The latest date the payment may come in. Format: yyyy-mm-dd
+   */
+  date_upper_bound?: string | null;
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  /**
+   * One of credit or debit. When you are receiving money, use credit. When you are
+   * being charged, use debit.
+   */
+  direction?: 'credit' | 'debit';
+
+  id?: string;
+
+  /**
+   * The ID of the Internal Account for the expected payment.
+   */
+  internal_account_id?: string;
+
+  /**
+   * 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;
+
+  /**
+   * One of manual if this expected payment was manually reconciled in the dashboard,
+   * automatic if it was automatically reconciled by Modern Treasury, or null if it
+   * is unreconciled.
+   */
+  reconciliation_method?: 'automatic' | 'manual' | null;
+
+  /**
+   * For `ach`, this field will be passed through on an addenda record. For `wire`
+   * payments the field will be passed through as the "Originator to Beneficiary
+   * Information", also known as OBI or Fedwire tag 6000.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * The statement description you expect to see on the transaction. For ACH
+   * payments, this will be the full line item passed from the bank. For wire
+   * payments, this will be the OBI field on the wire. For check payments, this will
+   * be the memo field.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * One of unreconciled, reconciled, or archived.
+   */
+  status?: 'archived' | 'reconciled' | 'unreconciled';
+
+  /**
+   * The ID of the Transaction this expected payment object has been matched to.
+   */
+  transaction_id?: string | null;
+
+  /**
+   * The ID of the Transaction Line Item this expected payment has been matched to.
+   */
+  transaction_line_item_id?: string | null;
+
+  /**
+   * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+   * sepa, signet, wire.
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire'
+    | null;
+
+  updated_at?: string;
+}
+
+export interface ExpectedPaymentCreateParams {
+  /**
+   * The lowest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_lower_bound: number;
+
+  /**
+   * The highest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_upper_bound: number;
+
+  /**
+   * One of credit or debit. When you are receiving money, use credit. When you are
+   * being charged, use debit.
+   */
+  direction: 'credit' | 'debit';
+
+  /**
+   * The ID of the Internal Account for the expected payment.
+   */
+  internal_account_id: string;
+
+  /**
+   * The ID of the counterparty you expect for this payment.
+   */
+  counterparty_id?: string | null;
+
+  /**
+   * Must conform to ISO 4217. Defaults to the currency of the internal account.
+   */
+  currency?:
+    | 'AED'
+    | 'AFN'
+    | 'ALL'
+    | 'AMD'
+    | 'ANG'
+    | 'AOA'
+    | 'ARS'
+    | 'AUD'
+    | 'AWG'
+    | 'AZN'
+    | 'BAM'
+    | 'BBD'
+    | 'BCH'
+    | 'BDT'
+    | 'BGN'
+    | 'BHD'
+    | 'BIF'
+    | 'BMD'
+    | 'BND'
+    | 'BOB'
+    | 'BRL'
+    | 'BSD'
+    | 'BTC'
+    | 'BTN'
+    | 'BWP'
+    | 'BYN'
+    | 'BYR'
+    | 'BZD'
+    | 'CAD'
+    | 'CDF'
+    | 'CHF'
+    | 'CLF'
+    | 'CLP'
+    | 'CNH'
+    | 'CNY'
+    | 'COP'
+    | 'CRC'
+    | 'CUC'
+    | 'CUP'
+    | 'CVE'
+    | 'CZK'
+    | 'DJF'
+    | 'DKK'
+    | 'DOP'
+    | 'DZD'
+    | 'EEK'
+    | 'EGP'
+    | 'ERN'
+    | 'ETB'
+    | 'EUR'
+    | 'FJD'
+    | 'FKP'
+    | 'GBP'
+    | 'GBX'
+    | 'GEL'
+    | 'GGP'
+    | 'GHS'
+    | 'GIP'
+    | 'GMD'
+    | 'GNF'
+    | 'GTQ'
+    | 'GYD'
+    | 'HKD'
+    | 'HNL'
+    | 'HRK'
+    | 'HTG'
+    | 'HUF'
+    | 'IDR'
+    | 'ILS'
+    | 'IMP'
+    | 'INR'
+    | 'IQD'
+    | 'IRR'
+    | 'ISK'
+    | 'JEP'
+    | 'JMD'
+    | 'JOD'
+    | 'JPY'
+    | 'KES'
+    | 'KGS'
+    | 'KHR'
+    | 'KMF'
+    | 'KPW'
+    | 'KRW'
+    | 'KWD'
+    | 'KYD'
+    | 'KZT'
+    | 'LAK'
+    | 'LBP'
+    | 'LKR'
+    | 'LRD'
+    | 'LSL'
+    | 'LTL'
+    | 'LVL'
+    | 'LYD'
+    | 'MAD'
+    | 'MDL'
+    | 'MGA'
+    | 'MKD'
+    | 'MMK'
+    | 'MNT'
+    | 'MOP'
+    | 'MRO'
+    | 'MRU'
+    | 'MTL'
+    | 'MUR'
+    | 'MVR'
+    | 'MWK'
+    | 'MXN'
+    | 'MYR'
+    | 'MZN'
+    | 'NAD'
+    | 'NGN'
+    | 'NIO'
+    | 'NOK'
+    | 'NPR'
+    | 'NZD'
+    | 'OMR'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * The earliest date the payment may come in. Format: yyyy-mm-dd
+   */
+  date_lower_bound?: string | null;
+
+  /**
+   * The latest date the payment may come in. Format: yyyy-mm-dd
+   */
+  date_upper_bound?: string | null;
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  line_items?: Array<ExpectedPaymentCreateParams.LineItems>;
+
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * For `ach`, this field will be passed through on an addenda record. For `wire`
+   * payments the field will be passed through as the "Originator to Beneficiary
+   * Information", also known as OBI or Fedwire tag 6000.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * The statement description you expect to see on the transaction. For ACH
+   * payments, this will be the full line item passed from the bank. For wire
+   * payments, this will be the OBI field on the wire. For check payments, this will
+   * be the memo field.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+   * sepa, signet, wire.
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire'
+    | null;
+}
+
+export namespace ExpectedPaymentCreateParams {
+  export interface LineItems {
+    /**
+     * Value in specified currency's smallest unit. e.g. $10 would be represented
+     * as 1000.
+     */
+    amount: number;
+
+    /**
+     * The ID of one of your accounting categories. Note that these will only be
+     * accessible if your accounting system has been connected.
+     */
+    accounting_category_id?: string | null;
+
+    /**
+     * A free-form description of the line item.
+     */
+    description?: string | null;
+
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+  }
+}
+
+export interface ExpectedPaymentUpdateParams {
+  /**
+   * The lowest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_lower_bound: number;
+
+  /**
+   * The highest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
+   */
+  amount_upper_bound: number;
+
+  /**
+   * One of credit or debit. When you are receiving money, use credit. When you are
+   * being charged, use debit.
+   */
+  direction: 'credit' | 'debit';
+
+  /**
+   * The ID of the Internal Account for the expected payment.
+   */
+  internal_account_id: string;
+
+  /**
+   * The ID of the counterparty you expect for this payment.
+   */
+  counterparty_id?: string | null;
+
+  /**
+   * Must conform to ISO 4217. Defaults to the currency of the internal account.
+   */
+  currency?:
+    | 'AED'
+    | 'AFN'
+    | 'ALL'
+    | 'AMD'
+    | 'ANG'
+    | 'AOA'
+    | 'ARS'
+    | 'AUD'
+    | 'AWG'
+    | 'AZN'
+    | 'BAM'
+    | 'BBD'
+    | 'BCH'
+    | 'BDT'
+    | 'BGN'
+    | 'BHD'
+    | 'BIF'
+    | 'BMD'
+    | 'BND'
+    | 'BOB'
+    | 'BRL'
+    | 'BSD'
+    | 'BTC'
+    | 'BTN'
+    | 'BWP'
+    | 'BYN'
+    | 'BYR'
+    | 'BZD'
+    | 'CAD'
+    | 'CDF'
+    | 'CHF'
+    | 'CLF'
+    | 'CLP'
+    | 'CNH'
+    | 'CNY'
+    | 'COP'
+    | 'CRC'
+    | 'CUC'
+    | 'CUP'
+    | 'CVE'
+    | 'CZK'
+    | 'DJF'
+    | 'DKK'
+    | 'DOP'
+    | 'DZD'
+    | 'EEK'
+    | 'EGP'
+    | 'ERN'
+    | 'ETB'
+    | 'EUR'
+    | 'FJD'
+    | 'FKP'
+    | 'GBP'
+    | 'GBX'
+    | 'GEL'
+    | 'GGP'
+    | 'GHS'
+    | 'GIP'
+    | 'GMD'
+    | 'GNF'
+    | 'GTQ'
+    | 'GYD'
+    | 'HKD'
+    | 'HNL'
+    | 'HRK'
+    | 'HTG'
+    | 'HUF'
+    | 'IDR'
+    | 'ILS'
+    | 'IMP'
+    | 'INR'
+    | 'IQD'
+    | 'IRR'
+    | 'ISK'
+    | 'JEP'
+    | 'JMD'
+    | 'JOD'
+    | 'JPY'
+    | 'KES'
+    | 'KGS'
+    | 'KHR'
+    | 'KMF'
+    | 'KPW'
+    | 'KRW'
+    | 'KWD'
+    | 'KYD'
+    | 'KZT'
+    | 'LAK'
+    | 'LBP'
+    | 'LKR'
+    | 'LRD'
+    | 'LSL'
+    | 'LTL'
+    | 'LVL'
+    | 'LYD'
+    | 'MAD'
+    | 'MDL'
+    | 'MGA'
+    | 'MKD'
+    | 'MMK'
+    | 'MNT'
+    | 'MOP'
+    | 'MRO'
+    | 'MRU'
+    | 'MTL'
+    | 'MUR'
+    | 'MVR'
+    | 'MWK'
+    | 'MXN'
+    | 'MYR'
+    | 'MZN'
+    | 'NAD'
+    | 'NGN'
+    | 'NIO'
+    | 'NOK'
+    | 'NPR'
+    | 'NZD'
+    | 'OMR'
+    | 'PAB'
+    | 'PEN'
+    | 'PGK'
+    | 'PHP'
+    | 'PKR'
+    | 'PLN'
+    | 'PYG'
+    | 'QAR'
+    | 'RON'
+    | 'RSD'
+    | 'RUB'
+    | 'RWF'
+    | 'SAR'
+    | 'SBD'
+    | 'SCR'
+    | 'SDG'
+    | 'SEK'
+    | 'SGD'
+    | 'SHP'
+    | 'SKK'
+    | 'SLL'
+    | 'SOS'
+    | 'SRD'
+    | 'SSP'
+    | 'STD'
+    | 'SVC'
+    | 'SYP'
+    | 'SZL'
+    | 'THB'
+    | 'TJS'
+    | 'TMM'
+    | 'TMT'
+    | 'TND'
+    | 'TOP'
+    | 'TRY'
+    | 'TTD'
+    | 'TWD'
+    | 'TZS'
+    | 'UAH'
+    | 'UGX'
+    | 'USD'
+    | 'UYU'
+    | 'UZS'
+    | 'VEF'
+    | 'VES'
+    | 'VND'
+    | 'VUV'
+    | 'WST'
+    | 'XAF'
+    | 'XAG'
+    | 'XAU'
+    | 'XBA'
+    | 'XBB'
+    | 'XBC'
+    | 'XBD'
+    | 'XCD'
+    | 'XDR'
+    | 'XFU'
+    | 'XOF'
+    | 'XPD'
+    | 'XPF'
+    | 'XPT'
+    | 'XTS'
+    | 'YER'
+    | 'ZAR'
+    | 'ZMK'
+    | 'ZMW'
+    | 'ZWD'
+    | 'ZWL'
+    | 'ZWN'
+    | 'ZWR';
+
+  /**
+   * The earliest date the payment may come in. Format: yyyy-mm-dd
+   */
+  date_lower_bound?: string | null;
+
+  /**
+   * The latest date the payment may come in. Format: yyyy-mm-dd
+   */
+  date_upper_bound?: string | null;
+
+  /**
+   * An optional description for internal use.
+   */
+  description?: string | null;
+
+  /**
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
+   */
+  metadata?: Record<string, string>;
+
+  /**
+   * For `ach`, this field will be passed through on an addenda record. For `wire`
+   * payments the field will be passed through as the "Originator to Beneficiary
+   * Information", also known as OBI or Fedwire tag 6000.
+   */
+  remittance_information?: string | null;
+
+  /**
+   * The statement description you expect to see on the transaction. For ACH
+   * payments, this will be the full line item passed from the bank. For wire
+   * payments, this will be the OBI field on the wire. For check payments, this will
+   * be the memo field.
+   */
+  statement_descriptor?: string | null;
+
+  /**
+   * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+   * sepa, signet, wire.
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire'
+    | null;
+}
+
+export interface ExpectedPaymentListParams extends PageParams {
+  /**
+   * Specify counterparty_id to see expected_payments for a specific account.
+   */
+  counterparty_id?: string;
+
+  /**
+   * Used to return expected payments created after some datetime
+   */
+  created_at_lower_bound?: string;
+
+  /**
+   * Used to return expected payments created before some datetime
+   */
+  created_at_upper_bound?: string;
+
+  /**
+   * One of credit, debit
+   */
+  direction?: 'credit' | 'debit';
+
+  /**
+   * Specify internal_account_id to see expected_payments for a specific account.
+   */
+  internal_account_id?: string;
+
+  /**
+   * 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>;
+
+  /**
+   * One of unreconciled, reconciled, or archived.
+   */
+  status?: 'archived' | 'reconciled' | 'unreconciled';
+
+  /**
+   * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
+   * sepa, signet, wire
+   */
+  type?:
+    | 'ach'
+    | 'au_becs'
+    | 'bacs'
+    | 'book'
+    | 'card'
+    | 'check'
+    | 'eft'
+    | 'interac'
+    | 'provxchange'
+    | 'rtp'
+    | 'sen'
+    | 'sepa'
+    | 'signet'
+    | 'wire';
+}