@tesouro/embedded-components-react 0.5.166 → 0.5.168

package/dist/fixtures/index.d.ts

@@ -28,6 +28,7 @@ type AddressOutput = {
      */
     state?: null | string;
 };
+type AllowedCountries = 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'IC' | 'CV' | 'KY' | 'CF' | 'EA' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'SS' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'BL' | 'BQ' | 'CW' | 'MF' | 'SX';
 /**
  * Output model representing a monetary amount in minor units alongside its ISO 4217 currency.
  */
@@ -42,129 +43,1338 @@ type AmountOutput = {
      */
     value: number | string;
 };
+type AttachmentResponse = {
+    /**
+     * Unique ID of the file with file_type=attachment from /v1/files.
+     */
+    id: string;
+    /**
+     * Indicates whether the file would be included in the email.
+     */
+    include_in_email?: boolean;
+    /**
+     * MIME type of the file (e.g., 'application/pdf').
+     */
+    mimetype: string;
+    /**
+     * Original filename of the attachment.
+     */
+    name: string;
+    /**
+     * File size in bytes.
+     */
+    size: number;
+    /**
+     * URL to access the attachment file.
+     */
+    url: string;
+};
+type BankAccountHolderType = 'INDIVIDUAL' | 'BUSINESS';
+type BankAccountSnapshot = {
+    account_holder_name?: string | null;
+    account_number?: string | null;
+    bank_name?: string | null;
+    routing_number?: string | null;
+};
+/**
+ * The status of a bank account.
+ */
+type BankAccountStatus = 'ACTIVE' | 'CLOSED';
+/**
+ * Output model for a bank account transfer account.
+ */
+type BankAccountTransferAccountOutput = {
+    /**
+     * Unique identifier for the account.
+     */
+    id: string;
+    /**
+     * Nickname for the account.
+     */
+    nickname?: null | string;
+};
+/**
+ * Type of payment network used for bank account transfers.
+ */
+type BankAccountTransferNetworkTypeDto = 'BOOK' | 'ACH' | 'RTP' | 'FED_NOW';
+/**
+ * Response model for a bank account transfer.
+ */
+type BankAccountTransferResponse = {
+    /**
+     * Unique identifier for the transfer.
+     */
+    id: string;
+    /**
+     * The amount transferred.
+     */
+    amount: AmountOutput;
+    /**
+     * The date of the transfer.
+     */
+    date: string;
+    /**
+     * The account the transfer is from.
+     */
+    fromAccount: BankAccountTransferAccountOutput;
+    /**
+     * The payment network the transfer was routed on.
+     */
+    network: BankAccountTransferNetworkTypeDto;
+    /**
+     * The caller-supplied reference from the money movement request that created this transfer,
+     * echoed back unchanged. Null when the request omitted one.
+     */
+    reference?: null | string;
+    /**
+     * The status of the transfer.
+     */
+    status: BankAccountTransferStatusDto;
+    /**
+     * The account the transfer is to.
+     */
+    toAccount: BankAccountTransferAccountOutput;
+    /**
+     * The type of transfer.
+     */
+    type: BankAccountTransferTypeDto;
+};
+/**
+ * Status of a bank account transfer operation.
+ */
+type BankAccountTransferStatusDto = 'PENDING' | 'COMPLETED' | 'FAILED';
+/**
+ * Type of bank account transfer operation.
+ */
+type BankAccountTransferTypeDto = 'INTERNAL_TO_EXTERNAL' | 'EXTERNAL_TO_INTERNAL' | 'INTERNAL_TO_INTERNAL';
+/**
+ * Response model for a bank account with balance information.
+ */
+type BankAccountWithBalanceResponse = {
+    /**
+     * Unique identifier for the bank account.
+     */
+    id: string;
+    /**
+     * Masked account number.
+     */
+    accountNumber: string;
+    /**
+     * Current balance of the bank account in minor units (e.g. cents for USD).
+     */
+    balance: AmountOutput;
+    /**
+     * Reference identifier associated with the bank account.
+     */
+    bankAccountReference?: null | string;
+    /**
+     * The UTC timestamp when the bank account was created.
+     */
+    createdDateTime: string;
+    /**
+     * Registered legal or DBA name on the bank account.
+     */
+    nameOnAccount: string;
+    /**
+     * Nickname for the bank account.
+     */
+    nickname?: null | string;
+    /**
+     * Bank routing number.
+     */
+    routingNumber: string;
+    /**
+     * The status of the bank account.
+     */
+    status: BankAccountStatus;
+};
+/**
+ * The card network (brand) an issued card runs on, such as Visa or Mastercard.
+ */
+type CardBrand = 'UNKNOWN' | 'VISA' | 'MASTERCARD' | 'DISCOVER' | 'AMERICAN_EXPRESS';
+type CounterpartType = 'individual' | 'organization';
+type CountryCode = 'AFG' | 'ALB' | 'DZA' | 'ASM' | 'ALA' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BES' | 'BMU' | 'BTN' | 'BOL' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COD' | 'COG' | 'CIV' | 'COK' | 'CRI' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'SWZ' | 'ETH' | 'FLK' | 'FRO' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRL' | 'IRN' | 'IRQ' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'KOR' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'FSM' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'MAC' | 'MKD' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'PRK' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWE' | 'SYR' | 'CHE' | 'TCA' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TUV' | 'UGA' | 'UKR' | 'UMI' | 'ARE' | 'GBR' | 'USA' | 'URY' | 'UZB' | 'VUT' | 'VAT' | 'VEN' | 'VIR' | 'VGB' | 'VNM' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE';
+type CreditCardResponse = {
+    id: string;
+    cardLimit?: null | number | string;
+    cardStatus: CreditCardStatus;
+    cardType: CreditCardType;
+    cardholderName: string;
+    createdAt: string;
+    currentBalance: AmountOutput;
+    description?: null | string;
+    lastFourDigits: string;
+    nickname?: null | string;
+    updatedAt: string;
+    userId: string;
+};
+type CreditCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
+type CreditCardType = 'DIGITAL' | 'PHYSICAL';
+type CreditNoteRenderingSettings = {
+    /**
+     * If set to `true`, the organization's bank account details will be displayed on the credit note PDF.
+     */
+    display_organization_bank_account?: boolean;
+};
+type CurrencyEnum = 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | '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' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW';
+type DebitCardCredentialsResponse = {
+    cvv: string;
+    expirationDate: string;
+    pan: string;
+};
+/**
+ * The detail view of a single debit card. Extends the fields returned by the list endpoint
+ * (DebitCardResponse).
+ */
+type DebitCardDetailResponse = {
+    id: string;
+    bankAccountId: string;
+    /**
+     * The billing address the issuer holds for this card.
+     */
+    billingAddress: AddressOutput;
+    cardBrand: CardBrand;
+    cardStatus: DebitCardStatus;
+    cardType: DebitCardType;
+    cardholderName: string;
+    createdAt: string;
+    description?: null | string;
+    expirationDate: string;
+    lastFourDigits: string;
+    /**
+     * The MCC groups allowed on this card.
+     */
+    mccGroups: Array<MccGroupResponse>;
+    nickname?: null | string;
+    reference: string;
+    updatedAt: string;
+    userId: string;
+    /**
+     * Velocity controls scoped to this card. Single-purchase, daily, and monthly limits appear here as
+     * controls with a `TRANSACTION`, `DAY`, and `MONTH` window respectively.
+     */
+    velocityControls: Array<VelocityControlResponse>;
+};
+type DebitCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
+type DebitCardType = 'DIGITAL' | 'PHYSICAL';
+type DeductionItem = {
+    /**
+     * The amount of the deduction in minor units(https://docs.monite.com/references/currencies#minor-units)
+     */
+    amount: number;
+    /**
+     * A note with additional information about this deduction
+     */
+    memo?: string | null;
+    /**
+     * Name or title of this deduction
+     */
+    name: string;
+};
+/**
+ * Who a disclosure binds, and therefore who can accept it. ENTITY binds the business itself: one
+ * authorized signer accepts on the company's behalf, and that acceptance covers every user of the
+ * organization. SIGNER is an authorized signer's own acknowledgement that they hold that authority,
+ * made by each signer for themselves. PERSON is an individual's own consent, which nobody can give
+ * on another person's behalf, so every user makes it for themselves, signer or not. Each is an
+ * independent version stream per bank organization, so a bank can have one version in force per
+ * scope at a time, and publishing into one stream leaves the others untouched.
+ */
+type DisclosureAcceptanceScope = 'ENTITY' | 'SIGNER' | 'PERSON';
+/**
+ * One acceptance scope's obligation, under the field names it had before the rename. Carries the
+ * same values as an entry of `disclosures`, and is removed with `capacities`.
+ */
+type DisclosureCapacityStateDto = {
+    accepted: boolean;
+    canAccept: boolean;
+    /**
+     * Who this disclosure binds. The former name of `acceptanceScope`.
+     */
+    capacity: DisclosureAcceptanceScope;
+    documents: Array<DisclosureDocumentDto>;
+    graceDeadlineTsUtc?: null | string;
+    standing: DisclosureStanding;
+    version: string;
+};
+/**
+ * One document the caller is being asked to accept.
+ */
+type DisclosureDocumentDto = {
+    /**
+     * Display name, as it should be shown to the user.
+     */
+    title: string;
+    /**
+     * Where the document is hosted. This service does not serve the file.
+     */
+    url: string;
+};
+/**
+ * One acceptance scope's obligation and where it leaves the caller.
+ */
+type DisclosureDto = {
+    /**
+     * Who this disclosure binds, and so who can accept it.
+     */
+    acceptanceScope: DisclosureAcceptanceScope;
+    /**
+     * Whether the obligation is met. On the ENTITY scope this is the organization's execution,
+     * so it can be true for a caller who did nothing themselves.
+     */
+    accepted: boolean;
+    /**
+     * Whether this caller can accept it. The ENTITY and SIGNER scopes are a designated
+     * authorized signer's to accept; false on every scope when the read was made on an invitee's
+     * behalf rather than by the person themselves.
+     */
+    canAccept: boolean;
+    /**
+     * The disclosure in force for this scope. Submit it back when accepting.
+     */
+    disclosureId: string;
+    /**
+     * The documents making up this disclosure, in the order to present them.
+     */
+    documents: Array<DisclosureDocumentDto>;
+    /**
+     * When an unmet ENTITY obligation stops being tolerated. Only that scope runs a grace
+     * period, so this is null on the others, and null once the obligation is met.
+     */
+    graceDeadlineTsUtc?: null | string;
+    /**
+     * Clear, owed with time left, or owed with the consequence applying now.
+     */
+    standing: DisclosureStanding;
+};
+type DisclosureRequirement = 'NOT_REQUIRED' | 'REQUIRED';
+/**
+ * Where a caller stands against one acceptance scope's obligation. Three states rather than a boolean
+ * because an unmet entity obligation runs a grace period before it restricts anything.
+ */
+type DisclosureStanding = 'CLEAR' | 'IN_GRACE' | 'EXPIRED';
+/**
+ * The disclosures in force for a caller, and whether they have accepted them.
+ */
+type DisclosuresResponseDto = {
+    /**
+     * Whether this caller has accepted the PERSON disclosure above. False for an invitee, and
+     * false again for an existing user once a new version is published.
+     *
+     * Deprecated. Duplicates the PERSON entry of `disclosures`. Read that instead; this is removed once every client has moved.
+     *
+     * @deprecated
+     */
+    accepted: boolean;
+    /**
+     * The same entries under their former name and shape.
+     *
+     * Deprecated. Read `disclosures` instead. Removed once every client has moved.
+     *
+     * @deprecated
+     */
+    capacities?: Array<DisclosureCapacityStateDto>;
+    /**
+     * Every acceptance scope the caller's bank has a disclosure in force for, whether or not it
+     * falls on this caller, so a client can show what governs the organization. Whether an entry
+     * is this caller's to act on is carried by its `standing` and `canAccept`.
+     */
+    disclosures?: Array<DisclosureDto>;
+    /**
+     * The PERSON disclosure's documents, in the order to present them. Only that scope's:
+     * `disclosures` carries the documents of every scope in force.
+     *
+     * Deprecated. Duplicates the PERSON entry of `disclosures`. Read that instead; this is removed once every client has moved.
+     *
+     * @deprecated
+     */
+    documents: Array<DisclosureDocumentDto>;
+    /**
+     * Whether this caller's organization requires disclosures at all.
+     */
+    requirement: DisclosureRequirement;
+    /**
+     * The PERSON disclosure in force, or null if the caller's bank has published none. This and
+     * the two fields below describe that one scope; `disclosures` carries every scope.
+     *
+     * Deprecated. Duplicates the PERSON entry of `disclosures`. Read that instead; this is removed once every client has moved.
+     *
+     * @deprecated
+     */
+    version: null | string;
+};
+type Discount = {
+    /**
+     * The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units
+     */
+    amount: number;
+    /**
+     * The field specifies whether to use product currency or %.
+     */
+    type: DiscountType;
+};
+type DiscountResponse = {
+    /**
+     * The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units
+     */
+    amount: number;
+    /**
+     * The field specifies whether to use product currency or %.
+     */
+    type: DiscountType;
+    /**
+     * The monetary amount of the discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). If the discount `type` is `amount`, this value is the same as the `amount` value. If `type` is `percentage`, the value is the calculated discount amount.
+     */
+    value?: number | null;
+};
+type DiscountType = 'amount' | 'percentage';
+/**
+ * Rendering settings that control how different parts of the PDF documents are displayed.
+ * Includes common settings for all document types such as quotes, invoices, and credit notes and document
+ * type-specific settings that are defined in their respective objects.
+ */
+type DocumentRenderingSettings = {
+    /**
+     * Credit note-specific rendering settings for PDF documents.
+     */
+    credit_note?: CreditNoteRenderingSettings;
+    /**
+     * If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`.
+     */
+    display_line_items?: boolean;
+    /**
+     * If set to `true`, the organization's bank account details will be displayed on the PDF documents. Defaults to `true`.
+     */
+    display_organization_bank_account?: boolean;
+    /**
+     * Invoice-specific rendering settings for PDF documents.
+     */
+    invoice?: InvoiceRenderingSettings;
+    /**
+     * Settings for rendering line items in PDF documents.
+     */
+    line_items?: LineItemsRenderingSettings;
+    /**
+     * Quote-specific rendering settings for PDF documents.
+     */
+    quote?: QuoteRenderingSettings;
+};
+/**
+ * Response representing an external bank account.
+ */
+type ExternalBankAccountResponse = {
+    /**
+     * Unique identifier for the external bank account.
+     */
+    id: string;
+    accountHolderType?: null | BankAccountHolderType;
+    /**
+     * Masked account number (last 4 digits visible).
+     */
+    accountNumber: string;
+    /**
+     * Status of the external bank account.
+     */
+    accountStatus: ExternalBankAccountStatusDto;
+    microDepositVerification?: null | MicroDepositVerificationResponse;
+    /**
+     * Name on the bank account.
+     */
+    nameOnAccount: string;
+    /**
+     * Nickname for the external bank account.
+     */
+    nickname: string;
+    /**
+     * Bank routing number (ABA number).
+     */
+    routingNumber: string;
+    /**
+     * Type of bank account (checking or savings).
+     */
+    type: ExternalBankAccountTypeDto;
+    /**
+     * Verification status of the external bank account.
+     */
+    verificationStatus: ExternalBankAccountVerificationStatusDto;
+};
+/**
+ * Status of an external bank account.
+ */
+type ExternalBankAccountStatusDto = 'ACTIVE' | 'INACTIVE';
+/**
+ * Type of external bank account.
+ */
+type ExternalBankAccountTypeDto = 'CHECKING' | 'SAVINGS';
+/**
+ * Verification status of an external bank account.
+ */
+type ExternalBankAccountVerificationStatusDto = 'UNVERIFIED' | 'VERIFICATION_SENT' | 'VERIFIED' | 'FAILED';
+type InlineTermDiscount = {
+    /**
+     * The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%.
+     */
+    discount: number;
+    end_date?: string | null;
+    /**
+     * The amount of days after the invoice issue date.
+     */
+    number_of_days?: number | null;
+};
+type InlineTermFinal = {
+    end_date?: string | null;
+    /**
+     * The amount of days after the invoice issue date.
+     */
+    number_of_days?: number | null;
+};
+type InvoiceRenderingSettings = {
+    /**
+     * If set to `true`, the organization's bank account details will be displayed on the invoice PDF.
+     */
+    display_organization_bank_account?: boolean;
+};
+type InvoiceResponsePayload = {
+    id: string;
+    /**
+     * Time at which the receivable was created. Timestamps follow the ISO 8601 standard.
+     */
+    created_at: string;
+    /**
+     * Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.
+     */
+    updated_at: string;
+    /**
+     * How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid.
+     */
+    amount_due: number;
+    /**
+     * How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units)
+     */
+    amount_paid: number;
+    /**
+     * How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts.
+     */
+    amount_to_pay?: number | null;
+    /**
+     * List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated.
+     */
+    attachments?: Array<AttachmentResponse> | null;
+    bank_account_id?: string | null;
+    bank_account_snapshot?: BankAccountSnapshot | null;
+    bank_account_type?: string | null;
+    /**
+     * The unique ID of a previous document related to the receivable if applicable.
+     */
+    based_on?: string | null;
+    /**
+     * The unique document ID of a previous document related to the receivable if applicable.
+     */
+    based_on_document_id?: string | null;
+    /**
+     * Field with a comment for pay/partially/uncollectible info on this Invoice
+     */
+    comment?: string | null;
+    /**
+     * The commercial terms of the receivable (e.g. The products must be delivered in X days).
+     */
+    commercial_condition_description?: string | null;
+    /**
+     * Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company.
+     */
+    counterpart_billing_address?: ReceivablesRepresentationOfCounterpartAddress | null;
+    /**
+     * Different types of companies for different countries, ex. GmbH, SAS, SNC, etc.
+     */
+    counterpart_business_type?: string | null;
+    /**
+     * Additional information about counterpart contacts.
+     */
+    counterpart_contact?: ReceivableCounterpartContact | null;
+    /**
+     * The external reference of the counterpart.
+     */
+    counterpart_external_reference?: string | null;
+    /**
+     * Unique ID of the counterpart.
+     */
+    counterpart_id: string;
+    /**
+     * A legal name of a counterpart it is an organization or first and last name if it is an individual
+     */
+    counterpart_name?: string | null;
+    /**
+     * Address where goods were shipped / where services were provided.
+     */
+    counterpart_shipping_address?: ReceivablesRepresentationOfCounterpartAddress | null;
+    /**
+     * The VAT/TAX ID of the counterpart.
+     */
+    counterpart_tax_id?: string | null;
+    /**
+     * The type of the counterpart.
+     */
+    counterpart_type: CounterpartType;
+    counterpart_vat_id?: ReceivableCounterpartVatIdResponse | null;
+    /**
+     * The currency used in the receivable.
+     */
+    currency: CurrencyEnum;
+    /**
+     * The amount of tax deducted in minor units
+     *
+     * @deprecated
+     */
+    deduction_amount?: number | null;
+    /**
+     * A note with additional information about a tax deduction
+     *
+     * @deprecated
+     */
+    deduction_memo?: string | null;
+    /**
+     * List of deductions applied to the receivable (maximum 10 deductions allowed)
+     */
+    deductions?: Array<DeductionItem> | null;
+    /**
+     * The discount for a receivable.
+     */
+    discount?: DiscountResponse | null;
+    /**
+     * Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    discounted_subtotal?: number | null;
+    /**
+     * The sequential code systematically assigned to invoices.
+     */
+    document_id?: string | null;
+    /**
+     * Settings for rendering documents in PDF format, including settings for line items and specific document types.
+     */
+    document_rendering?: DocumentRenderingSettings | null;
+    /**
+     * Optional field representing date until which invoice should be paid
+     */
+    due_date?: string | null;
+    entity: ReceivableEntityOrganization | ReceivableEntityIndividual;
+    entity_address: ReceivableEntityAddressSchema;
+    /**
+     * Deprecated. Always null; use `bank_account_snapshot` instead.
+     *
+     * @deprecated
+     */
+    entity_bank_account?: ReceivablesRepresentationOfEntityBankAccount | null;
+    /**
+     * The entity user who created this document.
+     */
+    entity_user_id?: string | null;
+    entity_vat_id?: ReceivableEntityVatIdResponse | null;
+    /**
+     * The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated.
+     */
+    file_language: LanguageCodeEnum;
+    /**
+     * The receivable's PDF URL in the counterpart's default language.
+     */
+    file_url?: string | null;
+    /**
+     * Optional text displayed below the line items table in the PDF.
+     */
+    footer?: string | null;
+    /**
+     * The date when the goods are shipped or the service is provided. Can be a current, past, or future date.
+     *
+     * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued.
+     *
+     * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.
+     */
+    fulfillment_date?: string | null;
+    /**
+     * Optional field for the issue of the entry.
+     */
+    issue_date?: string | null;
+    line_items: Array<ResponseItem>;
+    /**
+     * A note with additional information for a receivable.
+     */
+    memo?: string | null;
+    /**
+     * The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated.
+     */
+    original_file_language: LanguageCodeEnum;
+    /**
+     * The receivable's PDF URL in the entity's default language.
+     */
+    original_file_url?: string | null;
+    overdue_reminder_id?: string | null;
+    /**
+     * Date and time when the invoice was paid.
+     */
+    paid_at?: string | null;
+    /**
+     * Metadata for partner needs
+     */
+    partner_metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Link to the invoice's payment page. Either Monite's payment links or your custom payment links.
+     */
+    payment_page_url?: string | null;
+    payment_reminder_id?: string | null;
+    payment_terms?: PaymentTerms | null;
+    /**
+     * A project related to current receivable
+     */
+    project_id?: string | null;
+    /**
+     * Contain purchase order number.
+     */
+    purchase_order?: string | null;
+    /**
+     * Stores an unique ID of a recurrence if the receivable is in a recurring status
+     */
+    recurrence_id?: string | null;
+    /**
+     * Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc.
+     */
+    related_documents: RelatedDocuments;
+    /**
+     * The status of the receivable inside the receivable workflow.
+     */
+    status: ReceivablesStatusEnum;
+    /**
+     * The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    subtotal?: number | null;
+    /**
+     * The subtotal including tax but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    subtotal_after_tax?: number | null;
+    /**
+     * The list of tags for this receivable.
+     */
+    tags?: Array<TagReadSchema>;
+    /**
+     * Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not.
+     */
+    tax_exempt?: boolean | null;
+    /**
+     * The reason for the tax exemption, if applicable.
+     */
+    tax_exemption_rationale?: string | null;
+    /**
+     * Indicates whether the discount is applied to the tax-inclusive or tax-exclusive amount.
+     */
+    tax_inclusive_discount_mode?: VatModeEnum;
+    /**
+     * Defines whether the prices of products in receivable will already include tax or not.
+     */
+    tax_mode?: VatModeEnum;
+    /**
+     * Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_tax_amount.
+     */
+    total_amount?: number;
+    /**
+     * The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including tax and excluding all issued credit notes.
+     */
+    total_amount_with_credit_notes: number;
+    /**
+     * The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    total_deduction_amount?: number | null;
+    /**
+     * The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    total_tax_amount: number;
+    /**
+     * List of total tax amount for each tax rate, presented in receivable
+     */
+    total_tax_amounts?: Array<TotalTaxAmountItem> | null;
+    /**
+     * Total price of the receivable with tax withheld in minor units
+     */
+    total_withholding_tax?: number | null;
+    /**
+     * Trade name of the entity
+     */
+    trade_name?: string | null;
+    /**
+     * The type of the document uploaded.
+     */
+    type: 'invoice';
+    /**
+     * The amount of tax withheld in percent minor units
+     */
+    withholding_tax_rate?: number | null;
+};
+type LanguageCodeEnum = 'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'gd' | 'gl' | 'lg' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lu' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'gv' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'nr' | 'ng' | 'ne' | 'no' | 'nb' | 'nn' | 'ii' | 'oc' | 'oj' | 'om' | 'os' | 'pi' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'qu' | 'ro' | 'rm' | 'rn' | 'ru' | 'se' | 'sm' | 'sg' | 'sa' | 'sc' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'tl' | 'ty' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'ti' | 'to' | 'ts' | 'tn' | 'tr' | 'tk' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu';
+type LineItemColumnSettings = {
+    display?: boolean;
+    /**
+     * Line item table column header to override Monite's default. If not set, the Monite's default will be used.
+     */
+    label?: string | null;
+};
+/**
+ * Extended settings for numeric columns in line items.
+ */
+type LineItemNumericColumnSettings = {
+    display?: boolean;
+    /**
+     * Line item table column header to override Monite's default. If not set, the Monite's default will be used.
+     */
+    label?: string | null;
+    /**
+     * Number of decimal places to display for numeric values in this column.
+     */
+    precision?: number | null;
+};
+type LineItemProduct = {
+    /**
+     * Unique ID of the product.
+     */
+    id: string;
+    /**
+     * Unique identifier of the accounting tax rate object.
+     */
+    accounting_tax_rate_id?: string | null;
+    /**
+     * Description of the product.
+     */
+    description?: string | null;
+    /**
+     * A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog.
+     */
+    external_reference?: string | null;
+    /**
+     * Indicates whether the product is inline
+     */
+    is_inline?: boolean;
+    ledger_account_id?: string | null;
+    measure_unit?: LineItemProductMeasureUnit | null;
+    /**
+     * Name of the product.
+     */
+    name: string;
+    price: Price;
+    price_after_tax: Price;
+    /**
+     * The smallest amount allowed for this product.
+     */
+    smallest_amount?: number | null;
+    tax_rate: LineItemProductTaxRate;
+    /**
+     * Specifies whether this offering is a product or service. This may affect the applicable tax rates.
+     */
+    type?: ProductServiceTypeEnum;
+};
+type LineItemProductMeasureUnit = {
+    id?: string | null;
+    description?: string | null;
+    name: string;
+};
+type LineItemProductTaxRate = {
+    /**
+     * Unique identifier of the tax rate object.
+     */
+    id?: string | null;
+    /**
+     * Sub-taxes included in the VAT.
+     */
+    components?: Array<VatRateComponent> | null;
+    /**
+     * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+     */
+    country: AllowedCountries;
+    /**
+     * Indicates whether this tax rate is defined by user.
+     */
+    is_custom?: boolean;
+    /**
+     * Display name of the tax rate.
+     */
+    name?: string | null;
+    /**
+     * Percent minor units. Example: 12.5% is 1250.
+     */
+    value: number;
+};
+type LineItemsRenderingSettings = {
+    /**
+     * Settings for the discount column in the line items table.
+     */
+    discount?: LineItemColumnSettings;
+    /**
+     * Settings for the measure unit column in the line items table.
+     */
+    measure_unit?: LineItemColumnSettings;
+    /**
+     * Settings for the name column in the line items table.
+     */
+    name?: LineItemColumnSettings;
+    /**
+     * Settings for the price column in the line items table.
+     */
+    price?: LineItemNumericColumnSettings;
+    /**
+     * Settings for the price after tax column in the line items table.
+     */
+    price_after_tax?: LineItemNumericColumnSettings;
+    /**
+     * Settings for the quantity column in the line items table.
+     */
+    quantity?: LineItemColumnSettings;
+    /**
+     * Settings for the tax rate column in the line items table.
+     */
+    tax_rate?: LineItemNumericColumnSettings;
+    /**
+     * Settings for the total price column in the line items table.
+     */
+    total_price?: LineItemNumericColumnSettings;
+    /**
+     * Settings for the total price after tax column in the line items table.
+     */
+    total_price_after_tax?: LineItemNumericColumnSettings;
+    /**
+     * Settings for the VAT amount column in the line items table.
+     */
+    vat_amount?: LineItemNumericColumnSettings;
+};
+/**
+ * A caller-managed Merchant Category Code group applied as an authorization control at the debit
+ * card issuer. Exactly one of Guid? MccGroupResponse.OrganizationId (organization-scoped) or
+ * Guid? MccGroupResponse.CardId (card-scoped) is set.
+ */
+type MccGroupResponse = {
+    id: string;
+    active: boolean;
+    cardId?: null | string;
+    createdAt: string;
+    mccs: Array<string>;
+    name: string;
+    organizationId?: null | string;
+    updatedAt: string;
+};
+/**
+ * Whether submitted micro-deposit amounts matched the ones deposited.
+ */
+type MicroDepositVerificationOutcomeDto = 'AMOUNTS_MATCHED' | 'AMOUNTS_DID_NOT_MATCH';
+/**
+ * The outcome of a micro-deposit validation attempt and what is left of the bank's allowance.
+ */
+type MicroDepositVerificationResponse = {
+    /**
+     * The maximum number of validation attempts this account's bank allows.
+     */
+    attemptsAllowed: number | string;
+    /**
+     * Validation attempts left after this one.
+     */
+    attemptsRemaining: number | string;
+    /**
+     * Whether another set of amounts would be accepted for this account.
+     */
+    canAttemptAgain: boolean;
+    /**
+     * Whether the bank's policy makes FAILED final. Banks that fail on the first incorrect attempt
+     * always report false; canAttemptAgain reports whether the allowance is spent.
+     */
+    isTerminal: boolean;
+    /**
+     * Whether the submitted amounts matched the ones deposited.
+     */
+    outcome: MicroDepositVerificationOutcomeDto;
+};
+type OrganizationType = 'BANK' | 'EMBEDDED' | 'PLATFORM' | 'TRANSACTOR' | 'VERTICAL_SOFTWARE_PROVIDER';
+type PaymentTerms = {
+    id?: string | null;
+    /**
+     * Description of the payment term.
+     */
+    description?: string | null;
+    name?: string | null;
+    /**
+     * The first tier of the payment term. Represents the terms of the first early discount.
+     */
+    term_1?: InlineTermDiscount | null;
+    /**
+     * The second tier of the payment term. Defines the terms of the second early discount.
+     */
+    term_2?: InlineTermDiscount | null;
+    /**
+     * The final tier of the payment term. Defines the invoice due date.
+     */
+    term_final: InlineTermFinal;
+};
+type Price = {
+    /**
+     * The currency in which the price of the product is set.
+     */
+    currency: CurrencyEnum;
+    /**
+     * The actual price of the product.
+     */
+    value: number;
+};
+type ProductServiceTypeEnum = 'product' | 'service';
+type QuoteRenderingSettings = {
+    /**
+     * If set to `true`, the organization's bank account details will be displayed on the quote PDF.
+     */
+    display_organization_bank_account?: boolean;
+    /**
+     * If set to `true`, the signature field will be displayed on the quote PDF.
+     */
+    display_signature?: boolean;
+};
+type ReceivableCounterpartContact = {
+    /**
+     * The contact address of the counterpart
+     */
+    address?: ReceivablesRepresentationOfCounterpartAddress | null;
+    /**
+     * The contact email of the counterpart.
+     */
+    email?: string | null;
+    /**
+     * The first name of the counterpart contact.
+     */
+    first_name: string;
+    /**
+     * The last name of the counterpart contact.
+     */
+    last_name: string;
+    /**
+     * The contact phone number of the counterpart.
+     */
+    phone?: string | null;
+    /**
+     * The counterpart contact title (e.g. Dr., Mr., Mrs., Ms., etc).
+     */
+    title?: string | null;
+};
+type ReceivableCounterpartVatIdResponse = {
+    id: string;
+    counterpart_id: string;
+    country?: AllowedCountries | null;
+    type?: VatIdTypeEnum;
+    value: string;
+};
 /**
- * The status of a bank account.
+ * A schema represents address info of the entity
  */
-type BankAccountStatus = 'ACTIVE' | 'CLOSED';
+type ReceivableEntityAddressSchema = {
+    /**
+     * A city (a full name) where the entity is registered
+     */
+    city: string;
+    /**
+     * A country name (as ISO code) where the entity is registered
+     */
+    country?: AllowedCountries;
+    /**
+     * A street where the entity is registered
+     */
+    line1: string;
+    /**
+     * An alternative street used by the entity
+     */
+    line2?: string | null;
+    /**
+     * A postal code of the address where the entity is registered
+     */
+    postal_code: string;
+    /**
+     * A state in a country where the entity is registered
+     */
+    state?: string | null;
+};
 /**
- * Response model for a bank account with balance information.
+ * A Response schema for an entity of individual type
  */
-type BankAccountWithBalanceResponse = {
+type ReceivableEntityIndividual = {
     /**
-     * Unique identifier for the bank account.
+     * An email of the entity
      */
-    id: string;
+    email?: string | null;
     /**
-     * Masked account number.
+     * The first name of the entity issuing the receivable
      */
-    accountNumber: string;
+    first_name: string;
     /**
-     * Current balance of the bank account in minor units (e.g. cents for USD).
+     * The last name of the entity issuing the receivable
      */
-    balance: AmountOutput;
+    last_name: string;
     /**
-     * Reference identifier associated with the bank account.
+     * A link to the entity logo
      */
-    bankAccountReference?: null | string;
+    logo?: string | null;
     /**
-     * The UTC timestamp when the bank account was created.
+     * A phone number of the entity
      */
-    createdDateTime: string;
+    phone?: string | null;
     /**
-     * Registered legal or DBA name on the bank account.
+     * The registration authority of the entity
      */
-    nameOnAccount: string;
+    registration_authority?: string | null;
     /**
-     * Nickname for the bank account.
+     * The registration number of the entity
      */
-    nickname?: null | string;
+    registration_number?: string | null;
     /**
-     * Bank routing number.
+     * The Tax ID of the entity issuing the receivable
      */
-    routingNumber: string;
+    tax_id?: string | null;
     /**
-     * The status of the bank account.
+     * The entity type
      */
-    status: BankAccountStatus;
+    type: 'individual';
+    /**
+     * A website of the entity
+     */
+    website?: string | null;
 };
 /**
- * The card network (brand) an issued card runs on, such as Visa or Mastercard.
+ * A Response schema for an entity of organization type
  */
-type CardBrand = 'UNKNOWN' | 'VISA' | 'MASTERCARD' | 'DISCOVER' | 'AMERICAN_EXPRESS';
-type CountryCode = 'AFG' | 'ALB' | 'DZA' | 'ASM' | 'ALA' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BES' | 'BMU' | 'BTN' | 'BOL' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COD' | 'COG' | 'CIV' | 'COK' | 'CRI' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'SWZ' | 'ETH' | 'FLK' | 'FRO' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRL' | 'IRN' | 'IRQ' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'KOR' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'FSM' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'MAC' | 'MKD' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'PRK' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWE' | 'SYR' | 'CHE' | 'TCA' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TUV' | 'UGA' | 'UKR' | 'UMI' | 'ARE' | 'GBR' | 'USA' | 'URY' | 'UZB' | 'VUT' | 'VAT' | 'VEN' | 'VIR' | 'VGB' | 'VNM' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE';
-type CreditCardResponse = {
+type ReceivableEntityOrganization = {
+    /**
+     * An email of the entity
+     */
+    email?: string | null;
+    /**
+     * A link to the entity logo
+     */
+    logo?: string | null;
+    /**
+     * The name of the entity issuing the receivable, when it is an organization.
+     */
+    name: string;
+    /**
+     * A phone number of the entity
+     */
+    phone?: string | null;
+    /**
+     * The registration authority of the entity
+     */
+    registration_authority?: string | null;
+    /**
+     * The registration number of the entity
+     */
+    registration_number?: string | null;
+    /**
+     * The Tax ID of the entity issuing the receivable
+     */
+    tax_id?: string | null;
+    /**
+     * The entity type
+     */
+    type: 'organization';
+    /**
+     * The VAT ID of the entity issuing the receivable, when it is an organization.
+     */
+    vat_id?: string | null;
+    /**
+     * A website of the entity
+     */
+    website?: string | null;
+};
+type ReceivableEntityVatIdResponse = {
     id: string;
-    cardLimit?: null | number | string;
-    cardStatus: CreditCardStatus;
-    cardType: CreditCardType;
-    cardholderName: string;
-    createdAt: string;
-    currentBalance: AmountOutput;
-    description?: null | string;
-    lastFourDigits: string;
-    nickname?: null | string;
-    updatedAt: string;
-    userId: string;
+    country: AllowedCountries;
+    entity_id: string;
+    type?: VatIdTypeEnum;
+    value: string;
 };
-type CreditCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
-type CreditCardType = 'DIGITAL' | 'PHYSICAL';
-type DebitCardCredentialsResponse = {
-    cvv: string;
-    expirationDate: string;
-    pan: string;
+type ReceivablesRepresentationOfCounterpartAddress = {
+    /**
+     * Unique ID of the address in the system
+     */
+    id?: string | null;
+    /**
+     * City name.
+     */
+    city: string;
+    /**
+     * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+     */
+    country: AllowedCountries;
+    /**
+     * Street address.
+     */
+    line1: string;
+    /**
+     * Additional address information (if any).
+     */
+    line2?: string | null;
+    /**
+     * ZIP or postal code.
+     */
+    postal_code: string;
+    /**
+     * State, region, province, or county.
+     */
+    state?: string | null;
+};
+type ReceivablesRepresentationOfEntityBankAccount = {
+    /**
+     * Unique ID of the entity bank account.
+     */
+    id?: string | null;
+    /**
+     * Account holder's name
+     */
+    account_holder_name?: string | null;
+    /**
+     * Account number (required if IBAN is not provided)
+     */
+    account_number?: string | null;
+    /**
+     * The name of the entity's bank account.
+     */
+    bank_name?: string | null;
+    /**
+     * The BIC of the entity's bank account.
+     */
+    bic?: string | null;
+    /**
+     * The IBAN of the entity's bank account.
+     */
+    iban?: string | null;
+    /**
+     * Routing number (US)
+     */
+    routing_number?: string | null;
+    /**
+     * Sort code (GB)
+     */
+    sort_code?: string | null;
 };
 /**
- * The detail view of a single debit card. Extends the fields returned by the list endpoint
- * (DebitCardResponse).
+ * This Enum the results of combining two types of statuses from
+ * QuoteStateEnum, CreditNoteStateEnum and InvoiceStateEnum. You shouldn't use
+ * it in your scenarios if only for edge cases in workers, but ideally need to
+ * remove this shared Enum.
  */
-type DebitCardDetailResponse = {
+type ReceivablesStatusEnum = 'draft' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled' | 'deleted';
+type RelatedDocuments = {
+    credit_note_ids?: Array<string>;
+    proforma_invoice_id?: string | null;
+};
+type ResponseItem = {
+    /**
+     * Unique identifier of the line item within the receivable.
+     */
     id: string;
-    bankAccountId: string;
     /**
-     * The billing address the issuer holds for this card.
+     * The discount for a product.
      */
-    billingAddress: AddressOutput;
-    cardBrand: CardBrand;
-    cardStatus: DebitCardStatus;
-    cardType: DebitCardType;
-    cardholderName: string;
-    createdAt: string;
-    description?: null | string;
-    expirationDate: string;
-    lastFourDigits: string;
+    discount?: Discount | null;
+    product: LineItemProduct;
     /**
-     * The MCC groups allowed on this card.
+     * The quantity of each of the goods, materials, or services listed in the receivable.
      */
-    mccGroups: Array<MccGroupResponse>;
-    nickname?: null | string;
-    reference: string;
-    updatedAt: string;
-    userId: string;
+    quantity: number;
     /**
-     * Velocity controls scoped to this card. Single-purchase, daily, and monthly limits appear here as
-     * controls with a `TRANSACTION`, `DAY`, and `MONTH` window respectively.
+     * Tax applicability status of the line item. Possible values:
+     *
+     * * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified.
+     * * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations.
+     * * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates.
      */
-    velocityControls: Array<VelocityControlResponse>;
+    tax_status?: TaxStatusEnum;
+    /**
+     * Total of line_item after tax with applied line item discount in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    total_after_tax: number;
+    /**
+     * Total of line_item before tax in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    total_before_tax: number;
 };
-type DebitCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
-type DebitCardType = 'DIGITAL' | 'PHYSICAL';
-type DisclosureRequirement = 'NOT_REQUIRED' | 'REQUIRED';
+type TagCategory = 'document_type' | 'department' | 'project' | 'cost_center' | 'vendor_type' | 'payment_method' | 'approval_status';
 /**
- * A caller-managed Merchant Category Code group applied as an authorization control at the debit
- * card issuer. Exactly one of Guid? MccGroupResponse.OrganizationId (organization-scoped) or
- * Guid? MccGroupResponse.CardId (card-scoped) is set.
+ * Represents a user-defined tag that can be assigned to resources to filter them.
  */
-type MccGroupResponse = {
+type TagReadSchema = {
+    /**
+     * A unique ID of this tag.
+     */
     id: string;
-    active: boolean;
-    cardId?: null | string;
-    createdAt: string;
-    mccs: Array<string>;
+    /**
+     * Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
+     */
+    created_at: string;
+    /**
+     * Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
+     */
+    updated_at: string;
+    /**
+     * The tag category.
+     */
+    category?: TagCategory | null;
+    /**
+     * ID of the user who created the tag.
+     */
+    created_by_entity_user_id?: string | null;
+    /**
+     * The tag description.
+     */
+    description?: string | null;
+    /**
+     * The tag name.
+     */
     name: string;
-    organizationId?: null | string;
-    updatedAt: string;
 };
-type OrganizationType = 'BANK' | 'EMBEDDED' | 'PLATFORM' | 'TRANSACTOR' | 'VERTICAL_SOFTWARE_PROVIDER';
+type TaxStatusEnum = 'taxable' | 'exempt' | 'non_taxable';
+type TotalTaxAmountItem = {
+    id?: string | null;
+    /**
+     * The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    amount: number;
+    /**
+     * Sub-taxes included in the VAT.
+     */
+    components?: Array<TotalTaxAmountItemComponent> | null;
+    /**
+     * Display name of the tax rate.
+     */
+    name?: string | null;
+    /**
+     * The amount on which this VAT is calculated, in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    taxable_amount: number;
+    /**
+     * Percent minor units. Example: 12.5% is 1250.
+     */
+    value: number;
+};
+type TotalTaxAmountItemComponent = {
+    /**
+     * The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units).
+     */
+    amount: number;
+    name: string;
+    /**
+     * Percent minor units. Example: 12.5% is 1250.
+     */
+    value: number;
+};
+type VatIdTypeEnum = 'ae_trn' | 'au_abn' | 'au_arn' | 'bg_uic' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'es_cif' | 'eu_oss_vat' | 'eu_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'kr_brn' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'th_vat' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'za_vat' | 'unknown';
+type VatModeEnum = 'exclusive' | 'inclusive';
+type VatRateComponent = {
+    /**
+     * Display name of the Tax.
+     */
+    name: string;
+    /**
+     * Percent multiplied by a 100. Example: 12.125% is 1212.5. Will be rounded to 2 decimal places
+     */
+    value: number;
+};
 /**
  * A velocity control. Exactly one of Guid? VelocityControlResponse.OrganizationId (organization-scoped) or
  * Guid? VelocityControlResponse.CardId (card-scoped) is set.
@@ -195,6 +1405,22 @@ type VelocityControlResponse = {
  * `TRANSACTION` applies the limit per-transaction and therefore carries no usage limit.
  */
 type VelocityWindow = 'DAY' | 'LIFETIME' | 'MONTH' | 'TRANSACTION' | 'WEEK';
+/**
+ * The outcome of a widget user accepting disclosures.
+ */
+type WidgetDisclosureAcceptance = {
+    /**
+     * The requirement resolved for the user's organization while accepting, so the caller learns
+     * whether an acceptance was recorded without resolving the settings chain again. NOT_REQUIRED
+     * means nothing was written and nothing needed to be.
+     */
+    disclosureRequirement: DisclosureRequirement;
+    /**
+     * The user's status afterwards. ACTIVE for an invitee who was activated by the same operation,
+     * and for an already-active user re-accepting a newly published version.
+     */
+    status: WidgetUserStatus;
+};
 type WidgetInitResponse = {
     bankName?: null | string;
     /**
@@ -294,5 +1520,88 @@ declare const A_PENDING_DEBIT_CARD: DebitCardDetailResponse;
  * a fixture whose id did not match would render the em-dash and look like a bug.
  */
 declare const A_BANK_ACCOUNT: BankAccountWithBalanceResponse;
+/**
+ * An outside account that has finished micro-deposit verification, as
+ * `GET /external-bank-accounts` returns it.
+ *
+ * `accountNumber` is masked because the API masks it — the widget prints the
+ * field verbatim, so an unmasked value here would be the one fixture that
+ * misrepresents what an integrator sees.
+ *
+ * `VERIFIED` is the end of the connect chain rather than its start, which makes
+ * it the happy path: an account any earlier in the chain still owes the reader a
+ * verification step. A story walking that chain spreads this into the earlier
+ * statuses.
+ */
+declare const AN_EXTERNAL_BANK_ACCOUNT: ExternalBankAccountResponse;
+/**
+ * One completed book transfer out of {@link A_BANK_ACCOUNT}, as
+ * `GET /bank-accounts/{id}/transfers` returns it.
+ *
+ * Both ends are `{ id, nickname }` and nothing more, which is the whole reason
+ * the transfers list is a two-read screen: the id is resolved against the
+ * accounts read for a masked number, and the nickname the transfer carries is
+ * the fallback when it resolves against nothing. `toAccount` is deliberately an
+ * account no other fixture serves, so the fixture exercises that fallback as it
+ * stands; a story wanting both ends resolved re-points them by spreading.
+ */
+declare const A_BANK_ACCOUNT_TRANSFER: BankAccountTransferResponse;
+/**
+ * `GET /identity/v1/disclosures` for a caller who owes nothing, as every widget
+ * that reads it wants it by default.
+ *
+ * It agrees with {@link A_WIDGET_INIT}, which also says nothing is owed: init
+ * decides whether `WidgetProvider` replaces the widget with the acceptance
+ * gate, and this read decides what the widget itself does about disclosures, so
+ * a fixture disagreeing with init would put a story in a state the product
+ * cannot be in. `documents` is empty because nothing renders them while
+ * `requirement` is `NOT_REQUIRED`.
+ */
+declare const NO_DISCLOSURES_OWED: DisclosuresResponseDto;
+/**
+ * The same read for a caller who *does* owe an acceptance, with the documents
+ * they owe it on.
+ *
+ * A second fixture for one operation rather than a speculative extra, on the
+ * same grounds as {@link A_PENDING_CREDIT_CARD}: `AcceptDisclosuresWidget`
+ * exists only to be shown to this caller, and {@link NO_DISCLOSURES_OWED}
+ * cannot express them. It pairs with an init that owes an acceptance, which
+ * each story spreads for itself.
+ *
+ * The titles and their order are the backend's, and the widget renders exactly
+ * what it is given — there is no fixed four-slot mapping — so the four entries
+ * here are a plausible program rather than a required shape. `example.test` is
+ * reserved by RFC 6761 and resolves nowhere, which is what a public storybook
+ * wants from a link a reader might click.
+ */
+declare const A_DISCLOSURES_SET: DisclosuresResponseDto;
+/**
+ * What `POST /api/widget-gateway/disclosure-acceptance` answers with.
+ *
+ * `status: 'ACTIVE'` because the same call activates an invitee, which is the
+ * whole reason acceptance and activation are one transaction. Nothing renders
+ * this body — the widget reads the outcome from the widget-init refresh it
+ * kicks afterwards — so it is here to keep the write typed.
+ */
+declare const A_DISCLOSURE_ACCEPTANCE: WidgetDisclosureAcceptance;
+/**
+ * One outstanding invoice for {@link A_CUSTOMER_COUNTERPART}, as
+ * `GET /finops/v1/receivables?type=invoice` returns it.
+ *
+ * Two cross-references are load-bearing rather than cosmetic:
+ *
+ * - `bank_account_id` is {@link A_BANK_ACCOUNT}'s, which is what makes it a
+ *   *trusted* deposit target. `resolveInvoiceBankAccount` then labels it from
+ *   that account's own fetched record, so a widget that resolved the id and the
+ *   label from different sources shows the disagreement instead of hiding it.
+ * - `counterpart_id` is that counterpart's, so the invoice belongs to the
+ *   customer a picker selected. The endpoint filters on it server-side and a
+ *   mocked handler does not, so nothing enforces this but the fixture.
+ *
+ * `amount_due` rather than only `total_amount`: the picker shows what is still
+ * owed, and a fixture where the two agree cannot tell the two readings apart.
+ * `line_items` is empty because nothing in the deposit flow reads it.
+ */
+declare const AN_OUTSTANDING_INVOICE: InvoiceResponsePayload;
 
-export { A_BANK_ACCOUNT, A_CREDIT_CARD, A_DEBIT_CARD, A_DEBIT_CARD_CREDENTIALS, A_PENDING_CREDIT_CARD, A_PENDING_DEBIT_CARD, A_WIDGET_INIT };
+export { AN_EXTERNAL_BANK_ACCOUNT, AN_OUTSTANDING_INVOICE, A_BANK_ACCOUNT, A_BANK_ACCOUNT_TRANSFER, A_CREDIT_CARD, A_DEBIT_CARD, A_DEBIT_CARD_CREDENTIALS, A_DISCLOSURES_SET, A_DISCLOSURE_ACCEPTANCE, A_PENDING_CREDIT_CARD, A_PENDING_DEBIT_CARD, A_WIDGET_INIT, NO_DISCLOSURES_OWED };