flashpi 0.1.0

data/sig/flashpi/types.rbs

@@ -0,0 +1,2495 @@
+# Types of the Flashpi API, generated from its public OpenAPI document.
+#
+# GENERATED by scripts/openapi.rb from openapi/openapi.json. Do not edit by hand: run
+# `ruby scripts/openapi.rb sync` (or `generate`).
+module Flashpi
+  module Types
+    # Whether the account's buyer emails of one mode go out. Flashpi pauses them when the last 7
+    # days have at least 3 hard bounces and 3 % of the emails sent, or at least 2 complaints and
+    # 0.05 % (they protect the email provider's reputation that every customer shares). While
+    # paused, documents are still issued and authorized; their emails fail with
+    # `email_sending_paused` and resends answer 409 `email_sending_paused`. Only Flashpi's staff
+    # resume them.
+    type account_email_sending = {
+      environment: account_email_sending_environment,
+      status: account_email_sending_status,
+
+      # Format: date-time.
+      pausedAt: String?,
+
+      # Set while paused: `bounce_rate` (hard bounces), `complaint_rate` (complaints) or `staff`
+      # (Flashpi's staff paused them).
+      pauseReason: account_email_sending_pause_reason?,
+      window: account_email_sending_window
+    }
+
+    type account_email_sending_environment = "test" | "live"
+
+    # Set while paused: `bounce_rate` (hard bounces), `complaint_rate` (complaints) or `staff`
+    # (Flashpi's staff paused them).
+    type account_email_sending_pause_reason = "bounce_rate" | "complaint_rate" | "staff"
+
+    type account_email_sending_status = "active" | "paused"
+
+    # The buyer emails the account sent in the last 7 days in this mode (since Flashpi's staff last
+    # resumed them, when that is later).
+    type account_email_sending_window = {
+      # Where the counted period starts. Format: date-time.
+      since: String,
+
+      # Emails the email provider accepted.
+      sent: Integer | Float,
+
+      # Of those, hard bounces (`bounce_permanent`: the address or the domain does not exist).
+      hardBounces: Integer | Float,
+
+      # Of those, emails the recipient marked as spam.
+      complaints: Integer | Float
+    }
+
+    # An event about the account's email sending: `data` is the AccountEmailSending as the API
+    # returned it when the event happened (texts in English).
+    type account_event = {
+      # Format: uuid.
+      id: String,
+      type: account_event_type,
+
+      # Mode of the resource.
+      environment: account_event_environment,
+
+      # Format: date-time.
+      createdAt: String,
+      data: account_email_sending
+    }
+
+    # Mode of the resource.
+    type account_event_environment = "test" | "live"
+
+    type account_event_type = "account.email_paused" | "account.email_resumed"
+
+    # An issuer's .p12 signing certificate. Flashpi checks the upload asynchronously (`processing`,
+    # then `accepted` or `rejected`); the file and its password are never returned.
+    type certificate = {
+      # Format: uuid.
+      id: String,
+
+      # Format: uuid.
+      issuerId: String,
+
+      # Mode of the API key that uploaded it. A certificate of the issuer onboarding serves every
+      # mode (`allModes`): it shows the mode of the API key that reads it.
+      environment: certificate_environment,
+
+      # Whether it serves every mode (test and live): a certificate uploaded through the issuer
+      # onboarding (POST /v1/issuer-onboardings). False for one uploaded for one mode.
+      allModes: bool,
+      status: certificate_status,
+
+      # Whether it signs documents now: accepted, within its validity and not blocked.
+      usable: bool,
+
+      # Subject distinguished name.
+      subject: String?,
+
+      # Distinguished name of the certification authority that issued it.
+      issuedBy: String?,
+      serialNumber: String?,
+
+      # Format: date-time.
+      validFrom: String?,
+
+      # Format: date-time.
+      validUntil: String?,
+
+      # SHA-256 of the certificate, hex.
+      sha256Fingerprint: String?,
+
+      # The RUC found in the certificate, when its authority writes one.
+      ruc: String?,
+      revocation: certificate_revocation?,
+      rejection: certificate_rejection?,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # Mode of the API key that uploaded it. A certificate of the issuer onboarding serves every mode
+    # (`allModes`): it shows the mode of the API key that reads it.
+    type certificate_environment = "test" | "live"
+
+    # An event about a .p12 certificate: `data` is the Certificate as the API returned it when the
+    # event happened (texts in English).
+    type certificate_event = {
+      # Format: uuid.
+      id: String,
+      type: certificate_event_type,
+
+      # Mode of the resource.
+      environment: certificate_event_environment,
+
+      # Format: date-time.
+      createdAt: String,
+      data: certificate
+    }
+
+    # Mode of the resource.
+    type certificate_event_environment = "test" | "live"
+
+    type certificate_event_type = "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+
+    # A page of certificates, newest first.
+    type certificate_list = {
+      data: Array[certificate],
+      pagination: pagination
+    }
+
+    # Why the upload was rejected.
+    type certificate_rejection = {
+      code: String,
+      message: String
+    }
+
+    # Whether the certification authority revoked the certificate. `good`: verified not revoked.
+    # `pending`: could not be verified yet; it still signs until `blockAt` and is checked again
+    # hourly. `blocked`: still unverified after 7 days, or its chain is no longer trusted
+    # (`blockedReason`); it does not sign. `revoked`: never signs again.
+    type certificate_revocation = {
+      status: certificate_revocation_status,
+
+      # Format: date-time.
+      checkedAt: String,
+
+      # Format: date-time.
+      nextCheckAt: String?,
+
+      # Pending only: when it stops signing if still unverified. Format: date-time.
+      blockAt: String?,
+      blockedReason: certificate_revocation_blocked_reason?
+    }
+
+    type certificate_revocation_blocked_reason = "revocation_status_unverified"
+      | "untrusted_certificate_chain"
+
+    type certificate_revocation_status = "good" | "pending" | "blocked" | "revoked"
+
+    type certificate_status = "processing" | "accepted" | "rejected"
+
+    # The query of `certificatesList` (GET /v1/issuers/{issuerId}/certificates).
+    type certificates_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String
+    }
+
+    # The issuer to create, with the same fields as POST /v1/issuers (legalName, headOfficeAddress
+    # and taxProfile are required for a new issuer). For a renewal (`existingIssuer`) the body may
+    # be `{}`: the issuer is not changed (PATCH it if needed).
+    type complete_issuer_onboarding = {
+      # Required when the RUC did not come from the certificate (`rucNeedsConfirmation`): the
+      # proposed RUC or another one whose first 10 digits are the holder's cédula. Otherwise it may
+      # be left out, and must be the certificate's RUC when sent (422 `ruc_mismatch`).
+      ?ruc: String,
+
+      # Razón social.
+      ?legalName: String,
+
+      # Nombre comercial.
+      ?tradeName: String?,
+
+      # Dirección matriz.
+      ?headOfficeAddress: String,
+      ?taxProfile: issuer_tax_profile_input,
+      ?branding: issuer_branding_input,
+
+      # As in POST /v1/issuers. Default: `true`.
+      ?sendEmailByDefault: bool
+    }
+
+    # The issuer (created, with establishment 001 and emission point 001, or the existing one for a
+    # renewal) and its new certificate, `processing` until Flashpi onboards it.
+    type completed_issuer_onboarding = {
+      issuer: issuer,
+      certificate: certificate
+    }
+
+    # A credit note (nota de crédito) that reduces the amount of a document, for example for
+    # returned goods. Flashpi computes the credited amount.
+    type create_credit_note = {
+      # The issuer (taxpayer) that issues the document. Format: uuid.
+      issuerId: String,
+
+      # Establishment code (3 digits) registered on the issuer.
+      establishment: String,
+
+      # Emission point code (3 digits) registered on the establishment.
+      emissionPoint: String,
+
+      # Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later. Format: date.
+      ?issueDate: String,
+
+      # Sequential to use instead of the next one, for example when migrating from another system.
+      # It must not be used yet; later automatic sequentials continue after the highest one used.
+      # Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).
+      ?sequential: Integer,
+
+      # Additional information printed on the document (name → value, 1 to 300 characters each). A
+      # document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and
+      # Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.
+      ?additionalInfo: Hash[Symbol, String],
+
+      # Delivery options.
+      ?options: document_options,
+
+      # The buyer of the modified document. It cannot be a final consumer.
+      customer: document_party,
+
+      # The document the note modifies.
+      modifiedDocument: modified_document,
+
+      # Reason for the note.
+      reason: String,
+
+      # The lines of the document.
+      items: Array[document_item],
+
+      # The total you expect. Flashpi computes every total; when it differs from this value the
+      # request is refused with 422 total_mismatch, which shows both values.
+      ?expectedTotal: String
+    }
+
+    # A debit note (nota de débito) that increases the amount of a document, for example for
+    # interest or fees. Flashpi computes the taxes and the total.
+    type create_debit_note = {
+      # The issuer (taxpayer) that issues the document. Format: uuid.
+      issuerId: String,
+
+      # Establishment code (3 digits) registered on the issuer.
+      establishment: String,
+
+      # Emission point code (3 digits) registered on the establishment.
+      emissionPoint: String,
+
+      # Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later. Format: date.
+      ?issueDate: String,
+
+      # Sequential to use instead of the next one, for example when migrating from another system.
+      # It must not be used yet; later automatic sequentials continue after the highest one used.
+      # Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).
+      ?sequential: Integer,
+
+      # Additional information printed on the document (name → value, 1 to 300 characters each). A
+      # document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and
+      # Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.
+      ?additionalInfo: Hash[Symbol, String],
+
+      # Delivery options.
+      ?options: document_options,
+
+      # The buyer of the modified document. It cannot be a final consumer.
+      customer: document_party,
+
+      # The document the note modifies.
+      modifiedDocument: modified_document,
+
+      # The reasons and their amounts.
+      reasons: Array[debit_note_reason],
+
+      # How the debit is paid; the payments must add up to the total.
+      payments: Array[document_payment],
+
+      # The total you expect. Flashpi computes every total; when it differs from this value the
+      # request is refused with 422 total_mismatch, which shows both values.
+      ?expectedTotal: String
+    }
+
+    type create_emission_point = {
+      # Emission point code (punto de emisión), 3 digits. It cannot be changed later.
+      code: String
+    }
+
+    type create_establishment = {
+      # Establishment code (estab), 3 digits, as registered in the RUC. It cannot be changed later.
+      code: String,
+
+      # Address of the establishment (dirección del establecimiento).
+      address: String
+    }
+
+    # An invoice (factura). Send quantities, prices and tax rates; Flashpi computes the line
+    # subtotals, the taxes per rate, the tip and the total with the SRI rounding rules.
+    type create_invoice = {
+      # The issuer (taxpayer) that issues the document. Format: uuid.
+      issuerId: String,
+
+      # Establishment code (3 digits) registered on the issuer.
+      establishment: String,
+
+      # Emission point code (3 digits) registered on the establishment.
+      emissionPoint: String,
+
+      # Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later. Format: date.
+      ?issueDate: String,
+
+      # Sequential to use instead of the next one, for example when migrating from another system.
+      # It must not be used yet; later automatic sequentials continue after the highest one used.
+      # Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).
+      ?sequential: Integer,
+
+      # Additional information printed on the document (name → value, 1 to 300 characters each). A
+      # document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and
+      # Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.
+      ?additionalInfo: Hash[Symbol, String],
+
+      # Delivery options.
+      ?options: document_options,
+
+      # The buyer. `final_consumer` may omit `id` and `name`; the maximum amount of a final consumer
+      # invoice is not enforced yet.
+      customer: document_party,
+
+      # The lines of the document.
+      items: Array[document_item],
+
+      # How the invoice is paid; the payments must add up to the total.
+      payments: Array[document_payment],
+
+      # Tip (propina). Defaults to 0.
+      ?tip: String,
+
+      # Number of the waybill (guía de remisión) that carried the goods.
+      ?waybillNumber: String,
+
+      # The total you expect. Flashpi computes every total; when it differs from this value the
+      # request is refused with 422 total_mismatch, which shows both values.
+      ?expectedTotal: String
+    }
+
+    type create_issuer = {
+      # RUC: 13 digits ending in 001. Only the format is checked: newer RUCs fail the modulo-11
+      # check digit, so it is never verified. It cannot be changed later.
+      ruc: String,
+
+      # Legal name (razón social) as registered in the RUC.
+      legalName: String,
+
+      # Trade name (nombre comercial).
+      ?tradeName: String?,
+
+      # Head office address (dirección matriz).
+      headOfficeAddress: String,
+      taxProfile: issuer_tax_profile_input,
+      ?branding: issuer_branding_input,
+
+      # Default of a document request's `options.sendEmail`: true emails every authorized document
+      # (RIDE PDF and XML) to its buyer, false opts the issuer out. A request that sets
+      # `options.sendEmail` decides for itself. Default: `true`.
+      ?sendEmailByDefault: bool
+    }
+
+    # A purchase settlement (liquidación de compra): the buyer documents a purchase from a supplier
+    # without a RUC or who cannot issue invoices. Lines take VAT only.
+    type create_purchase_settlement = {
+      # The issuer (taxpayer) that issues the document. Format: uuid.
+      issuerId: String,
+
+      # Establishment code (3 digits) registered on the issuer.
+      establishment: String,
+
+      # Emission point code (3 digits) registered on the establishment.
+      emissionPoint: String,
+
+      # Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later. Format: date.
+      ?issueDate: String,
+
+      # Sequential to use instead of the next one, for example when migrating from another system.
+      # It must not be used yet; later automatic sequentials continue after the highest one used.
+      # Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).
+      ?sequential: Integer,
+
+      # Additional information printed on the document (name → value, 1 to 300 characters each). A
+      # document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and
+      # Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.
+      ?additionalInfo: Hash[Symbol, String],
+
+      # Delivery options.
+      ?options: document_options,
+
+      # The supplier. It cannot be a final consumer.
+      supplier: document_party,
+
+      # The lines of the document.
+      items: Array[document_item],
+
+      # How the purchase is paid; the payments must add up to the total and each one needs a `term`.
+      payments: Array[document_payment],
+
+      # The total you expect. Flashpi computes every total; when it differs from this value the
+      # request is refused with 422 total_mismatch, which shows both values.
+      ?expectedTotal: String
+    }
+
+    # A waybill (guía de remisión) that supports the transport of goods.
+    type create_waybill = {
+      # The issuer (taxpayer) that issues the document. Format: uuid.
+      issuerId: String,
+
+      # Establishment code (3 digits) registered on the issuer.
+      establishment: String,
+
+      # Emission point code (3 digits) registered on the establishment.
+      emissionPoint: String,
+
+      # Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later. Format: date.
+      ?issueDate: String,
+
+      # Sequential to use instead of the next one, for example when migrating from another system.
+      # It must not be used yet; later automatic sequentials continue after the highest one used.
+      # Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).
+      ?sequential: Integer,
+
+      # Additional information printed on the document (name → value, 1 to 300 characters each). A
+      # document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and
+      # Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.
+      ?additionalInfo: Hash[Symbol, String],
+
+      # Delivery options.
+      ?options: document_options,
+
+      # Where the transport starts.
+      departureAddress: String,
+
+      # The carrier.
+      carrier: waybill_carrier,
+
+      # License plate of the vehicle.
+      licensePlate: String,
+
+      # Start of the transport; not before the issue date. Format: date.
+      transportStartDate: String,
+
+      # End of the transport; not before its start. Format: date.
+      transportEndDate: String,
+
+      # The recipients and their goods.
+      recipients: Array[waybill_recipient]
+    }
+
+    type create_webhook_endpoint = {
+      # Where Flashpi POSTs the events: a public HTTPS URL without credentials or fragment. Changing
+      # it requires a new verification.
+      url: String,
+
+      # A label for your own reference.
+      ?description: String?,
+
+      # Event types the endpoint receives; `*` receives every type, including future ones.
+      enabledEvents: Array[create_webhook_endpoint_enabled_events_item],
+
+      # `full` (default): the event with a snapshot of its resource in `data`. `thin`: the event
+      # without `data`, only `id`, `type`, `environment` and `createdAt` (read the snapshot with GET
+      # /v1/events/{id}). Default: `"full"`.
+      ?payloadMode: create_webhook_endpoint_payload_mode
+    }
+
+    type create_webhook_endpoint_enabled_events_item = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+      | "*"
+
+    # `full` (default): the event with a snapshot of its resource in `data`. `thin`: the event
+    # without `data`, only `id`, `type`, `environment` and `createdAt` (read the snapshot with GET
+    # /v1/events/{id}). Default: `"full"`.
+    type create_webhook_endpoint_payload_mode = "full" | "thin"
+
+    # A withholding receipt (comprobante de retención). Flashpi computes every withheld amount and
+    # the total withheld.
+    type create_withholding = {
+      # The issuer (taxpayer) that issues the document. Format: uuid.
+      issuerId: String,
+
+      # Establishment code (3 digits) registered on the issuer.
+      establishment: String,
+
+      # Emission point code (3 digits) registered on the establishment.
+      emissionPoint: String,
+
+      # Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later. Format: date.
+      ?issueDate: String,
+
+      # Sequential to use instead of the next one, for example when migrating from another system.
+      # It must not be used yet; later automatic sequentials continue after the highest one used.
+      # Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).
+      ?sequential: Integer,
+
+      # Additional information printed on the document (name → value, 1 to 300 characters each). A
+      # document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and
+      # Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.
+      ?additionalInfo: Hash[Symbol, String],
+
+      # Delivery options.
+      ?options: document_options,
+
+      # The withheld supplier.
+      subject: withheld_subject,
+
+      # Fiscal period, YYYY-MM. Defaults to the month of the issue date.
+      ?fiscalPeriod: String,
+
+      # The supporting documents and their withholdings.
+      supportingDocuments: Array[supporting_document],
+
+      # The total withheld you expect; when it differs from the computed one the request is refused
+      # with 422 total_mismatch.
+      ?expectedTotal: String
+    }
+
+    # A reason for a debit note and its amount before taxes.
+    type debit_note_reason = {
+      # Reason.
+      description: String,
+
+      # Amount before taxes.
+      amount: String,
+
+      # The VAT of this amount (exactly one `vat`).
+      taxes: Array[document_tax]
+    }
+
+    # An SRI document of any type.
+    type document = {
+      # Format: uuid.
+      id: String,
+      type: document_type,
+
+      # Mode of the API key that issued it: `test` (SRI pruebas) or `live`.
+      environment: document_environment,
+
+      # Tax status: `processing` (being signed and sent), `pending_sri` (waiting for the SRI),
+      # `authorized`, `rejected`, `failed` or `voided`.
+      status: document_status,
+
+      # Format: uuid.
+      issuerId: String,
+      establishment: String,
+      emissionPoint: String,
+      sequential: Integer | Float,
+
+      # Establishment-emission point-sequential.
+      number: String,
+
+      # The 49-digit access key, also the authorization number.
+      accessKey: String,
+
+      # Format: date.
+      issueDate: String,
+
+      # Version of the SRI XML.
+      xmlVersion: String,
+      counterparty: document_counterparty?,
+
+      # Null for waybills.
+      totals: document_totals?,
+      authorization: document_authorization,
+      ride: document_ride,
+      email: document_email,
+
+      # Messages of the last SRI answer, mapped to Flashpi codes (the reasons of a rejection, or
+      # warnings of an authorization). Texts follow Accept-Language (English or Spanish).
+      sriMessages: Array[document_sri_message],
+
+      # Set when `status` is `failed`.
+      failure: document_failure?,
+
+      # Format: date-time.
+      voidedAt: String?,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # The SRI authorization.
+    type document_authorization = {
+      # Authorization number (the access key), once authorized.
+      number: String?,
+
+      # Format: date-time.
+      authorizedAt: String?
+    }
+
+    # The buyer, supplier, withheld subject or carrier.
+    type document_counterparty = {
+      id: String,
+      name: String
+    }
+
+    # Email delivery, separate from the tax status: sent only once the document is authorized, when
+    # it was requested and there is a recipient.
+    type document_email = {
+      # Whether the email was requested.
+      requested: bool,
+
+      # `not_requested` (opted out), `skipped` (no recipient), `queued` (sent once authorized), then
+      # `sent`, `delivered`, `bounced`, `complained` or `failed`.
+      status: document_email_status,
+      deliveries: Array[document_email_delivery],
+
+      # Warnings about the recipient's address, computed when the document is read: empty when
+      # nothing looks wrong.
+      warnings: Array[document_email_warning]
+    }
+
+    # One email to one recipient.
+    type document_email_delivery = {
+      # Format: uuid.
+      id: String,
+      recipient: String,
+      status: document_email_delivery_status,
+
+      # Format: date-time.
+      sentAt: String?,
+
+      # Format: date-time.
+      lastEventAt: String?,
+
+      # Why the email failed or bounced, as a code: for example `rejected`, `timeout`,
+      # `invalid_address`, `bounce_permanent`, `bounce_suppressed` (the address is on the
+      # suppression list of Flashpi's email provider after an earlier bounce or complaint),
+      # `complaint`, `account_email_limit_reached` (the account's emails of the day were used up;
+      # nothing was sent), `platform_email_limit_reached` (Flashpi's emails of the day across all
+      # accounts were used up; nothing was sent), `email_sending_paused` (the account's emails of
+      # the mode are paused; nothing was sent), `platform_email_sending_paused` (Flashpi paused the
+      # emails of its email provider for every account after too many bounces or complaints; nothing
+      # was sent), `test_recipient_not_allowed` (a test document whose recipient is not a verified
+      # member of the account's team; nothing was sent: download the RIDE and the XML to send them)
+      # or `invalid_domain` (the recipient's domain does not exist or receives no mail: no MX, A or
+      # AAAA record, or a null MX; nothing was sent).
+      error: String?
+    }
+
+    type document_email_delivery_status = "queued"
+      | "sent"
+      | "delivered"
+      | "bounced"
+      | "complained"
+      | "failed"
+
+    # `not_requested` (opted out), `skipped` (no recipient), `queued` (sent once authorized), then
+    # `sent`, `delivered`, `bounced`, `complained` or `failed`.
+    type document_email_status = "not_requested"
+      | "skipped"
+      | "queued"
+      | "sent"
+      | "delivered"
+      | "bounced"
+      | "complained"
+      | "failed"
+
+    # Something about the email that looks wrong. A warning never stops or changes the email.
+    type document_email_warning = {
+      # `recipient_domain_typo`: the recipient's domain looks like a typo of a common mail domain
+      # (for example gmial.com for gmail.com). The email is still sent to the address as given;
+      # nothing changes it.
+      code: document_email_warning_code,
+
+      # Follows Accept-Language (English or Spanish).
+      message: String,
+
+      # The address with the suggested domain.
+      suggestedRecipient: String
+    }
+
+    # `recipient_domain_typo`: the recipient's domain looks like a typo of a common mail domain (for
+    # example gmial.com for gmail.com). The email is still sent to the address as given; nothing
+    # changes it.
+    type document_email_warning_code = "recipient_domain_typo"
+
+    # Mode of the API key that issued it: `test` (SRI pruebas) or `live`.
+    type document_environment = "test" | "live"
+
+    # An event about a document (its tax outcome, RIDE or email): `data` is the Document as the API
+    # returned it when the event happened (texts in English).
+    type document_event = {
+      # Format: uuid.
+      id: String,
+      type: document_event_type,
+
+      # Mode of the resource.
+      environment: document_event_environment,
+
+      # Format: date-time.
+      createdAt: String,
+      data: document
+    }
+
+    # Mode of the resource.
+    type document_event_environment = "test" | "live"
+
+    type document_event_type = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+
+    # Why a `failed` document could not reach an SRI answer.
+    type document_failure = {
+      code: document_failure_code,
+      message: String
+    }
+
+    type document_failure_code = "certificate_required"
+      | "certificate_expired"
+      | "certificate_not_yet_valid"
+      | "certificate_blocked"
+      | "certificate_revoked"
+      | "certificate_unusable"
+      | "document_too_large"
+      | "document_invalid"
+      | "signing_failed"
+      | "sri_unavailable"
+      | "sri_authorization_timeout"
+      | "sri_request_refused"
+      | "sri_environment_mismatch"
+
+    # A line of an invoice, credit note or purchase settlement. Flashpi computes its subtotal
+    # (quantity × unit price − discount, rounded to 2 decimals) and its taxes.
+    type document_item = {
+      # Your product code. Required on invoices and purchase settlements.
+      ?code: String,
+
+      # A second code, for example the barcode.
+      ?auxiliaryCode: String,
+
+      # Description.
+      description: String,
+
+      # Unit of measure (invoices and purchase settlements).
+      ?unit: String,
+
+      # Quantity, up to 6 decimals.
+      quantity: String,
+
+      # Unit price without taxes, up to 6 decimals.
+      unitPrice: String,
+
+      # Discount amount of the line (not a percentage), up to 2 decimals. Defaults to 0.
+      ?discount: String,
+
+      # The taxes of the line.
+      taxes: Array[document_tax],
+
+      # Up to 3 extra details printed with the line (name → value, 1 to 300 characters).
+      ?additionalDetails: Hash[Symbol, String]
+    }
+
+    # A page of documents, newest first.
+    type document_list = {
+      data: Array[document],
+      pagination: pagination
+    }
+
+    # How Flashpi delivers the document once the SRI authorizes it.
+    type document_options = {
+      # Email the authorized document (PDF and XML) to the counterparty, when it has an email
+      # address. Defaults to the issuer's `sendEmailByDefault` (true unless the issuer opted out).
+      ?sendEmail: bool,
+
+      # Sync mode: wait for the SRI before answering. The response is 200 with the document once it
+      # is authorized, rejected or failed, or 202 with its current status (usually `pending_sri`)
+      # when the wait ends first; the document then continues asynchronously. Defaults to false (202
+      # at once).
+      ?waitForAuthorization: bool,
+
+      # Sync mode: the longest wait, in seconds, from 1 to 30. Defaults to 15. A longer wait is
+      # refused with `out_of_range`. Used only with `waitForAuthorization`.
+      ?waitTimeoutSeconds: Integer
+    }
+
+    # The buyer of an invoice, credit or debit note, or the supplier of a purchase settlement.
+    type document_party = {
+      # Identification type: `ruc` (13 digits ending in 001, format only), `cedula` (10 digits,
+      # check digit verified), `passport`, `final_consumer` (no identification; only invoices accept
+      # it) or `foreign_id` (issued by the tax authority of another country).
+      idType: document_party_id_type,
+
+      # Identification number. Required unless `idType` is `final_consumer`, whose number is always
+      # 9999999999999.
+      ?id: String,
+
+      # Legal name or full name. Required unless `idType` is `final_consumer` (printed as CONSUMIDOR
+      # FINAL).
+      ?name: String,
+
+      # Address. Credit and debit notes do not print it.
+      ?address: String,
+
+      # Where the authorized document is emailed (see `options.sendEmail`). Format: email.
+      ?email: String
+    }
+
+    # Identification type: `ruc` (13 digits ending in 001, format only), `cedula` (10 digits, check
+    # digit verified), `passport`, `final_consumer` (no identification; only invoices accept it) or
+    # `foreign_id` (issued by the tax authority of another country).
+    type document_party_id_type = "ruc" | "cedula" | "passport" | "final_consumer" | "foreign_id"
+
+    # A payment. The payments must add up to the document total.
+    type document_payment = {
+      # Payment method: `cash` (without the financial system), `debt_offset`, `debit_card`,
+      # `electronic_money`, `prepaid_card`, `credit_card`, `other_financial_system` (bank transfers,
+      # checks and other payments through the financial system) or `securities_endorsement`.
+      method: document_payment_method,
+
+      # Amount paid with this method.
+      amount: String,
+
+      # Payment term in `termUnit` units. Required on purchase settlements.
+      ?term: String,
+
+      # Unit of `term`: `days` or `months`.
+      ?termUnit: document_payment_term_unit
+    }
+
+    # Payment method: `cash` (without the financial system), `debt_offset`, `debit_card`,
+    # `electronic_money`, `prepaid_card`, `credit_card`, `other_financial_system` (bank transfers,
+    # checks and other payments through the financial system) or `securities_endorsement`.
+    type document_payment_method = "cash"
+      | "debt_offset"
+      | "debit_card"
+      | "electronic_money"
+      | "prepaid_card"
+      | "credit_card"
+      | "other_financial_system"
+      | "securities_endorsement"
+
+    # Unit of `term`: `days` or `months`.
+    type document_payment_term_unit = "days" | "months"
+
+    # The RIDE (printed PDF), generated once the document is authorized.
+    type document_ride = {
+      status: document_ride_status,
+      template: document_ride_template?,
+
+      # Format: date-time.
+      generatedAt: String?
+    }
+
+    type document_ride_status = "pending" | "generated" | "failed"
+
+    type document_ride_template = "modern" | "classic" | "minimal"
+
+    # A message of the SRI, mapped by Flashpi.
+    type document_sri_message = {
+      # Flashpi error code.
+      code: String,
+      message: String,
+      severity: document_sri_message_severity
+    }
+
+    type document_sri_message_severity = "error" | "warning"
+
+    # Tax status: `processing` (being signed and sent), `pending_sri` (waiting for the SRI),
+    # `authorized`, `rejected`, `failed` or `voided`.
+    type document_status = "processing"
+      | "pending_sri"
+      | "authorized"
+      | "rejected"
+      | "failed"
+      | "voided"
+
+    # A tax of a line. Every line needs exactly one `vat`; invoices and credit notes accept one ad
+    # valorem `ice` too. Flashpi computes the bases and amounts.
+    type document_tax = {
+      # `vat` (IVA) or `ice` (ICE).
+      type: document_tax_type,
+
+      # For `vat`, the rate: `0`, `5`, `8` (differentiated, tourism), `12`, `13`, `14`, `15`,
+      # `exempt` or `not_subject`; it must be in force on the issue date (for credit and debit
+      # notes, on the modified document issue date). For `ice`, the ad valorem percentage with up to
+      # 2 decimals (for example `75`).
+      rate: String,
+
+      # For `ice` only (required): the 4-digit ICE code of TABLA 18.
+      ?code: String
+    }
+
+    # A tax total, grouped per tax and rate.
+    type document_tax_total = {
+      type: document_tax_total_type,
+
+      # VAT: the rate (`15`, `0`, `exempt`, ...). ICE: the percentage.
+      rate: String,
+
+      # ICE: the TABLA 18 code.
+      ?code: String,
+
+      # Taxable base.
+      taxableBase: String,
+
+      # Tax amount.
+      amount: String
+    }
+
+    type document_tax_total_type = "vat" | "ice"
+
+    # `vat` (IVA) or `ice` (ICE).
+    type document_tax_type = "vat" | "ice"
+
+    # Totals computed by Flashpi. Invoices have every field but `withheld`; purchase settlements and
+    # credit notes have no `tip`; debit notes have no `discount` nor `tip`; withholding receipts
+    # only have `withheld`.
+    type document_totals = {
+      # Sum of the line subtotals.
+      ?subtotal: String,
+
+      # Sum of the line discounts.
+      ?discount: String,
+      ?taxes: Array[document_tax_total],
+
+      # Tip.
+      ?tip: String,
+
+      # Total (credited amount of a credit note, total of a debit note).
+      ?total: String,
+
+      # Total withheld.
+      ?withheld: String
+    }
+
+    type document_type = "invoice"
+      | "purchase_settlement"
+      | "credit_note"
+      | "debit_note"
+      | "waybill"
+      | "withholding"
+
+    # The query of `documentsList` (GET /v1/documents).
+    type documents_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String,
+
+      # Only documents of this issuer. Format: uuid.
+      ?issuerId: String,
+
+      # Only this document type.
+      ?type: documents_list_query_type,
+
+      # Only this tax status.
+      ?status: documents_list_query_status,
+
+      # Only documents issued on or after this date. Format: date.
+      ?issueDateFrom: String,
+
+      # Only documents issued on or before this date. Format: date.
+      ?issueDateTo: String,
+
+      # Only documents of this buyer, supplier, withheld subject or carrier.
+      ?counterpartyId: String,
+
+      # The document with this access key.
+      ?accessKey: String
+    }
+
+    type documents_list_query_status = "processing"
+      | "pending_sri"
+      | "authorized"
+      | "rejected"
+      | "failed"
+      | "voided"
+
+    type documents_list_query_type = "invoice"
+      | "purchase_settlement"
+      | "credit_note"
+      | "debit_note"
+      | "waybill"
+      | "withholding"
+
+    # An emission point of an establishment.
+    type emission_point = {
+      # Format: uuid.
+      id: String,
+
+      # Format: uuid.
+      issuerId: String,
+
+      # Format: uuid.
+      establishmentId: String,
+
+      # Emission point code (punto de emisión), 3 digits.
+      code: String,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # A page of emission points, by code.
+    type emission_point_list = {
+      data: Array[emission_point],
+      pagination: pagination
+    }
+
+    # The query of `emissionPointsList` (GET
+    # /v1/issuers/{issuerId}/establishments/{establishmentId}/emission-points).
+    type emission_points_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String
+    }
+
+    # Stable machine-readable error code, the same in every language. Branch on it, never on `type`,
+    # `title` or `detail`. New codes may be added: handle an unknown one by its HTTP status.
+    type error_code = "bad_request"
+      | "malformed_json"
+      | "invalid_correlation_id"
+      | "validation_failed"
+      | "authentication_required"
+      | "forbidden"
+      | "not_found"
+      | "method_not_allowed"
+      | "not_acceptable"
+      | "conflict"
+      | "payload_too_large"
+      | "unsupported_media_type"
+      | "rate_limited"
+      | "internal_error"
+      | "service_unavailable"
+      | "invalid_api_key"
+      | "key_scope_mismatch"
+      | "key_read_only"
+      | "ip_not_allowed"
+      | "invalid_idempotency_key"
+      | "idempotency_key_reused"
+      | "idempotency_key_in_progress"
+      | "issuer_already_exists"
+      | "establishment_already_exists"
+      | "emission_point_already_exists"
+      | "resource_in_use"
+      | "issuer_onboarding_not_ready"
+      | "issuer_onboarding_expired"
+      | "issuer_onboarding_completed"
+      | "issuer_onboarding_rejected"
+      | "total_mismatch"
+      | "sequential_already_used"
+      | "sequentials_exhausted"
+      | "document_schema_invalid"
+      | "document_too_large"
+      | "document_not_authorized"
+      | "ride_not_available"
+      | "email_recipient_missing"
+      | "email_already_queued"
+      | "email_resend_limit_reached"
+      | "account_email_limit_reached"
+      | "email_sending_paused"
+      | "test_recipient_not_allowed"
+      | "platform_email_limit_reached"
+      | "webhook_endpoint_disabled"
+      | "webhook_endpoint_already_verified"
+      | "webhook_endpoint_not_verified"
+      | "webhook_delivery_in_progress"
+      | "sandbox_not_enabled"
+      | "demo_issuer_quota_exceeded"
+      | "demo_issuer_unavailable"
+      | "account_suspended"
+
+    # An establishment of an issuer.
+    type establishment = {
+      # Format: uuid.
+      id: String,
+
+      # Format: uuid.
+      issuerId: String,
+
+      # Establishment code (estab), 3 digits.
+      code: String,
+
+      # Address of the establishment (dirección del establecimiento).
+      address: String,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # A page of establishments, by code.
+    type establishment_list = {
+      data: Array[establishment],
+      pagination: pagination
+    }
+
+    # The query of `establishmentsList` (GET /v1/issuers/{issuerId}/establishments).
+    type establishments_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String
+    }
+
+    # Something that happened to a resource. The webhook body is this same object (without `data`
+    # for thin endpoints), and `id` is its webhook-id header.
+    type event = document_event | certificate_event | account_event
+
+    # A page of events, newest first.
+    type event_list = {
+      data: Array[event],
+      pagination: pagination
+    }
+
+    # The body sent to `thin` endpoints: the event without its snapshot. Read it with GET
+    # /v1/events/{id}.
+    type event_thin = {
+      # Format: uuid.
+      id: String,
+      type: event_thin_type,
+      environment: event_thin_environment,
+
+      # Format: date-time.
+      createdAt: String
+    }
+
+    type event_thin_environment = "test" | "live"
+
+    type event_thin_type = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+
+    # The query of `eventsList` (GET /v1/events).
+    type events_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String,
+
+      # Only events of this type.
+      ?type: events_list_query_type,
+
+      # Only events of this issuer. Format: uuid.
+      ?issuerId: String,
+
+      # Only events of this document. Format: uuid.
+      ?documentId: String,
+
+      # Only events of this certificate. Format: uuid.
+      ?certificateId: String
+    }
+
+    type events_list_query_type = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+
+    type field_error = {
+      # Path of the invalid field.
+      field: String,
+
+      # Stable machine-readable reason. New codes may be added: treat an unknown one like
+      # `invalid_value`.
+      code: field_error_code,
+
+      # Localized message.
+      message: String
+    }
+
+    # Stable machine-readable reason. New codes may be added: treat an unknown one like
+    # `invalid_value`.
+    type field_error_code = "required"
+      | "unknown_field"
+      | "invalid_type"
+      | "invalid_format"
+      | "invalid_option"
+      | "too_short"
+      | "too_long"
+      | "out_of_range"
+      | "invalid_value"
+      | "unsupported_character"
+      | "not_found"
+      | "invalid_decimal"
+      | "invalid_identification"
+      | "invalid_check_digit"
+      | "final_consumer_not_allowed"
+      | "not_in_force"
+      | "too_many_additional_fields"
+      | "reserved_name"
+      | "amount_mismatch"
+      | "future_date"
+      | "date_too_early"
+      | "date_too_late"
+      | "discount_exceeds_amount"
+      | "duplicate"
+      | "vat_required"
+      | "unsupported_tax"
+      | "rate_mismatch"
+      | "incompatible_issuer_profile"
+      | "url_not_allowed"
+      | "demo_issuer_test_only"
+      | "demo_issuer_sequential_not_allowed"
+      | "ruc_mismatch"
+
+    # A taxpayer (RUC) that issues documents.
+    type issuer = {
+      # Format: uuid.
+      id: String,
+
+      # RUC: 13 digits ending in 001 (format only; the check digit is not verified).
+      ruc: String,
+
+      # Legal name (razón social) as registered in the RUC.
+      legalName: String,
+
+      # Trade name (nombre comercial).
+      tradeName: String?,
+
+      # Head office address (dirección matriz).
+      headOfficeAddress: String,
+      taxProfile: issuer_tax_profile,
+      branding: issuer_branding,
+
+      # Default of a document request's `options.sendEmail`: true emails every authorized document
+      # (RIDE PDF and XML) to its buyer, false opts the issuer out. A request that sets
+      # `options.sendEmail` decides for itself.
+      sendEmailByDefault: bool,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # RIDE branding of the issuer.
+    type issuer_branding = {
+      # Brand color of the RIDE PDF, #RRGGBB (returned in lowercase).
+      brandColor: String?
+    }
+
+    type issuer_branding_input = {
+      # Brand color of the RIDE PDF, #RRGGBB (returned in lowercase).
+      ?brandColor: String?
+    }
+
+    # A page of issuers, newest first.
+    type issuer_list = {
+      data: Array[issuer],
+      pagination: pagination
+    }
+
+    # An issuer onboarding from a .p12: Flashpi verifies the certificate (`verifying`), then it is
+    # `ready` with the certificate's facts, the RUC and, when the registry lookup is on, the SRI's
+    # profile, or `rejected`. Completing it creates the issuer (or renews an existing one) with the
+    # certificate, which serves test and live. It `expired` if not completed within 6 days, and it
+    # is deleted 30 days after it ends.
+    type issuer_onboarding = {
+      # Format: uuid.
+      id: String,
+      status: issuer_onboarding_status,
+
+      # When it expires unless completed. Format: date-time.
+      expiresAt: String,
+      rejection: issuer_onboarding_rejection?,
+      certificate: issuer_onboarding_certificate?,
+
+      # The RUC to complete with: the certificate's, or the holder's cédula followed by 001.
+      proposedRuc: String?,
+
+      # Whether the customer must confirm (or type) the RUC: it did not come from the certificate
+      # itself. Then complete must send `ruc`.
+      rucNeedsConfirmation: bool,
+      existingIssuer: issuer_onboarding_existing_issuer?,
+      sri: issuer_onboarding_sri?,
+      prefill: issuer_onboarding_prefill?,
+      completed: issuer_onboarding_completion?,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # Public facts of the verified certificate (no key material).
+    type issuer_onboarding_certificate = {
+      serialNumber: String,
+
+      # Format: date-time.
+      validFrom: String,
+
+      # Format: date-time.
+      validTo: String,
+      issuingCa: issuer_onboarding_issuing_ca?,
+      holder: issuer_onboarding_holder,
+      identification: issuer_onboarding_identification
+    }
+
+    # What completing it produced.
+    type issuer_onboarding_completion = {
+      # Format: uuid.
+      issuerId: String,
+
+      # Format: uuid.
+      certificateId: String
+    }
+
+    # The account's issuer that already has this RUC: completing renews its certificate instead of
+    # creating an issuer.
+    type issuer_onboarding_existing_issuer = {
+      # Format: uuid.
+      id: String,
+      legalName: String
+    }
+
+    # The certificate holder's names.
+    type issuer_onboarding_holder = {
+      # Common name (CN): the holder's name.
+      commonName: String?,
+
+      # Organization (O): usually the company of a legal representative.
+      organization: String?
+    }
+
+    # The identification the certificate carries: its RUC (`rucSource` certificate), or the holder's
+    # cédula, from which Flashpi proposes the RUC cédula + 001 (`rucSource` cedula).
+    type issuer_onboarding_identification = {
+      ruc: String?,
+      rucSource: issuer_onboarding_identification_ruc_source?,
+      cedula: String?
+    }
+
+    type issuer_onboarding_identification_ruc_source = "certificate" | "cedula"
+
+    # The Ecuadorian certification authority that issued the certificate.
+    type issuer_onboarding_issuing_ca = {
+      code: String?,
+      displayName: String?
+    }
+
+    # Values for the issuer's tax profile: the SRI's legal name first, else the certificate's
+    # organization (companies) or common name (persons); the trade name, the head office address and
+    # the tax profile from the SRI when it answered (`sri.status` `found`), otherwise null. They are
+    # the customer's to check and edit.
+    type issuer_onboarding_prefill = {
+      ruc: String?,
+      legalName: String?,
+      tradeName: String?,
+      headOfficeAddress: String?,
+      taxProfile: issuer_onboarding_prefill_tax_profile
+    }
+
+    # The tax profile to start from; null where nothing is known.
+    type issuer_onboarding_prefill_tax_profile = {
+      keepsAccounting: bool?,
+
+      # `general` means not in RIMPE (complete with `rimpeRegime: null`); null means unknown.
+      rimpeRegime: issuer_onboarding_prefill_tax_profile_rimpe_regime?,
+
+      # The SRI says special taxpayer: ask for the resolution number.
+      specialTaxpayer: bool?,
+
+      # The SRI says withholding agent: ask for the resolution number.
+      withholdingAgent: bool?
+    }
+
+    # `general` means not in RIMPE (complete with `rimpeRegime: null`); null means unknown.
+    type issuer_onboarding_prefill_tax_profile_rimpe_regime = "entrepreneur"
+      | "popular_business"
+      | "general"
+
+    # Why the certificate was rejected (the certificate rejection codes).
+    type issuer_onboarding_rejection = {
+      code: String,
+
+      # In the language of Accept-Language (Spanish or English).
+      message: String
+    }
+
+    # What the SRI's public RUC registry said about the RUC (best effort). `unavailable`: it did not
+    # answer. `disabled`: Flashpi did not ask it (the lookup is off). In both cases `profile` is
+    # null and the customer fills in the tax profile. Warnings never block.
+    type issuer_onboarding_sri = {
+      status: issuer_onboarding_sri_status,
+
+      # Format: date-time.
+      fetchedAt: String?,
+      profile: issuer_onboarding_sri_profile?,
+
+      # `inactive`: the RUC is not ACTIVO; `ghost` and `nonexistent_transactions`: the SRI flags the
+      # taxpayer; `head_office_closed`: its head office establishment is closed.
+      warnings: Array[issuer_onboarding_sri_warnings_item]
+    }
+
+    # The taxpayer's profile in the SRI's public RUC registry, normalized. The registry gives flags
+    # only for special taxpayer and withholding agent: the resolution numbers are the customer's to
+    # type.
+    type issuer_onboarding_sri_profile = {
+      # Razón social.
+      legalName: String?,
+
+      # Nombre comercial.
+      tradeName: String?,
+
+      # The RUC status as the SRI writes it.
+      taxpayerStatus: String?,
+      keepsAccounting: bool?,
+      specialTaxpayer: bool?,
+      withholdingAgent: bool?,
+
+      # `general`: not in RIMPE. `unknown`: the SRI answer could not be mapped; the customer
+      # chooses.
+      rimpeRegime: issuer_onboarding_sri_profile_rimpe_regime,
+
+      # The head office address.
+      headOfficeAddress: String?
+    }
+
+    # `general`: not in RIMPE. `unknown`: the SRI answer could not be mapped; the customer chooses.
+    type issuer_onboarding_sri_profile_rimpe_regime = "entrepreneur"
+      | "popular_business"
+      | "general"
+      | "unknown"
+
+    type issuer_onboarding_sri_status = "found" | "not_found" | "unavailable" | "disabled"
+
+    type issuer_onboarding_sri_warnings_item = "inactive"
+      | "ghost"
+      | "nonexistent_transactions"
+      | "head_office_closed"
+
+    type issuer_onboarding_status = "verifying" | "ready" | "rejected" | "completed" | "expired"
+
+    # Tax profile; Flashpi adds the mandatory tags and legends from it.
+    type issuer_tax_profile = {
+      # Whether the taxpayer is required to keep accounting (obligado a llevar contabilidad).
+      keepsAccounting: bool,
+
+      # Special taxpayer (contribuyente especial) resolution number: 3 to 13 letters or digits.
+      specialTaxpayerNumber: String?,
+
+      # Withholding agent (agente de retención) designation resolution number, digits only. Stored
+      # without leading zeros (at most 8 digits).
+      withholdingAgentResolution: String?,
+
+      # RIMPE regime: `entrepreneur` (CONTRIBUYENTE RÉGIMEN RIMPE) or `popular_business`
+      # (CONTRIBUYENTE NEGOCIO POPULAR - RÉGIMEN RIMPE). Null when not in RIMPE.
+      rimpeRegime: issuer_tax_profile_rimpe_regime?,
+
+      # Large taxpayer (gran contribuyente) designation resolution number.
+      largeTaxpayerResolution: String?
+    }
+
+    type issuer_tax_profile_input = {
+      # Whether the taxpayer is required to keep accounting (obligado a llevar contabilidad).
+      keepsAccounting: bool,
+
+      # Special taxpayer (contribuyente especial) resolution number: 3 to 13 letters or digits.
+      ?specialTaxpayerNumber: String?,
+
+      # Withholding agent (agente de retención) designation resolution number, digits only. Stored
+      # without leading zeros (at most 8 digits).
+      ?withholdingAgentResolution: String?,
+
+      # RIMPE regime: `entrepreneur` (CONTRIBUYENTE RÉGIMEN RIMPE) or `popular_business`
+      # (CONTRIBUYENTE NEGOCIO POPULAR - RÉGIMEN RIMPE). Null when not in RIMPE.
+      ?rimpeRegime: issuer_tax_profile_input_rimpe_regime?,
+
+      # Large taxpayer (gran contribuyente) designation resolution number.
+      ?largeTaxpayerResolution: String?
+    }
+
+    # RIMPE regime: `entrepreneur` (CONTRIBUYENTE RÉGIMEN RIMPE) or `popular_business`
+    # (CONTRIBUYENTE NEGOCIO POPULAR - RÉGIMEN RIMPE). Null when not in RIMPE.
+    type issuer_tax_profile_input_rimpe_regime = "entrepreneur" | "popular_business"
+
+    # Fields to change; null clears one.
+    type issuer_tax_profile_patch = {
+      # Whether the taxpayer is required to keep accounting (obligado a llevar contabilidad).
+      ?keepsAccounting: bool,
+
+      # Special taxpayer (contribuyente especial) resolution number: 3 to 13 letters or digits.
+      ?specialTaxpayerNumber: String?,
+
+      # Withholding agent (agente de retención) designation resolution number, digits only. Stored
+      # without leading zeros (at most 8 digits).
+      ?withholdingAgentResolution: String?,
+
+      # RIMPE regime: `entrepreneur` (CONTRIBUYENTE RÉGIMEN RIMPE) or `popular_business`
+      # (CONTRIBUYENTE NEGOCIO POPULAR - RÉGIMEN RIMPE). Null when not in RIMPE.
+      ?rimpeRegime: issuer_tax_profile_patch_rimpe_regime?,
+
+      # Large taxpayer (gran contribuyente) designation resolution number.
+      ?largeTaxpayerResolution: String?
+    }
+
+    # RIMPE regime: `entrepreneur` (CONTRIBUYENTE RÉGIMEN RIMPE) or `popular_business`
+    # (CONTRIBUYENTE NEGOCIO POPULAR - RÉGIMEN RIMPE). Null when not in RIMPE.
+    type issuer_tax_profile_patch_rimpe_regime = "entrepreneur" | "popular_business"
+
+    # RIMPE regime: `entrepreneur` (CONTRIBUYENTE RÉGIMEN RIMPE) or `popular_business`
+    # (CONTRIBUYENTE NEGOCIO POPULAR - RÉGIMEN RIMPE). Null when not in RIMPE.
+    type issuer_tax_profile_rimpe_regime = "entrepreneur" | "popular_business"
+
+    # The query of `issuersList` (GET /v1/issuers).
+    type issuers_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String
+    }
+
+    # The document a credit or debit note modifies.
+    type modified_document = {
+      # Type of the modified document. Defaults to `invoice`.
+      ?type: modified_document_type,
+
+      # Number of the modified document: establishment-emission point-sequential.
+      number: String,
+
+      # Issue date of the modified document (on or before the note). Its VAT rates are the ones in
+      # force on this date. Format: date.
+      issueDate: String
+    }
+
+    # Type of the modified document. Defaults to `invoice`.
+    type modified_document_type = "invoice"
+
+    # Position of a page in a list.
+    type pagination = {
+      # Cursor of the next page (send it as `cursor`), or null on the last page.
+      nextCursor: String?,
+
+      # Whether there are more items after this page.
+      hasMore: bool
+    }
+
+    # RFC 9457 problem details, in the language of Content-Language (`en`, or `es` with
+    # Accept-Language: es). Some codes add extension members, listed below; others may appear.
+    type problem_details = {
+      # URI of the problem type: the page that documents `code`, in the language of the response
+      # (`https://flashpi.com.ec/docs/en/errors/{code}` in English,
+      # `https://flashpi.com.ec/docs/errors/{code}` with Accept-Language: es). It changes with the
+      # language, so branch on `code`, never on `type`. Format: uri.
+      type: String,
+
+      # Localized summary of the type.
+      title: String,
+
+      # HTTP status code.
+      status: Integer | Float,
+
+      # Localized explanation of this occurrence.
+      detail: String,
+
+      # Path of the request.
+      instance: String,
+
+      # Stable machine-readable error code, the same in every language. Branch on it, never on
+      # `type`, `title` or `detail`. New codes may be added: handle an unknown one by its HTTP
+      # status.
+      code: error_code,
+
+      # Field-level errors (may be empty).
+      errors: Array[field_error],
+
+      # Request ID (UUIDv7); include it when contacting support.
+      requestId: String,
+
+      # `idempotency_key_reused`: the document the Idempotency-Key already created. Format: uuid.
+      ?documentId: String,
+
+      # The daily limit that was reached (`email_resend_limit_reached`,
+      # `account_email_limit_reached`, `demo_issuer_quota_exceeded`).
+      ?limit: Integer,
+
+      # When the daily limit resets: the next midnight in Ecuador (the three codes above and
+      # `platform_email_limit_reached`). Retry-After gives the same in seconds. Format: date-time.
+      ?resetsAt: String,
+
+      # `ride_not_available`: the status of the RIDE.
+      ?rideStatus: problem_details_ride_status,
+
+      # `document_not_authorized`: the status of the document.
+      ?documentStatus: problem_details_document_status,
+
+      # `email_sending_paused`: the mode whose email sending is paused.
+      ?environment: problem_details_environment,
+
+      # `total_mismatch`: the `expectedTotal` you sent.
+      ?expectedTotal: String,
+
+      # `total_mismatch`: the total Flashpi computed.
+      ?computedTotal: String
+    }
+
+    # `document_not_authorized`: the status of the document.
+    type problem_details_document_status = "processing"
+      | "pending_sri"
+      | "authorized"
+      | "rejected"
+      | "failed"
+      | "voided"
+
+    # `email_sending_paused`: the mode whose email sending is paused.
+    type problem_details_environment = "test" | "live"
+
+    # `ride_not_available`: the status of the RIDE.
+    type problem_details_ride_status = "pending" | "generated" | "failed"
+
+    type rotate_webhook_endpoint_secret = {
+      # Hours the previous secret keeps signing deliveries next to the new one (default 24, at most
+      # 168); 0 drops it at once.
+      ?previousSecretExpiresInHours: Integer
+    }
+
+    # No options yet: send an empty object or no body.
+    type send_document_email = {}
+
+    # Public status of Flashpi. Placeholder until the status monitors exist.
+    type status = {
+      # Overall status of Flashpi.
+      status: status_status
+    }
+
+    # Overall status of Flashpi.
+    type status_status = "operational"
+
+    # The supplier document whose taxes are withheld, usually an invoice.
+    type supporting_document = {
+      # Tax support code (Catálogo ATS tabla 5), for example `01`.
+      taxSupportCode: String,
+
+      # Document type code (Catálogo ATS tabla 4), for example `01` for an invoice.
+      documentTypeCode: String,
+
+      # Its number.
+      number: String,
+
+      # Its issue date, on or before the withholding. Format: date.
+      issueDate: String,
+
+      # Accounting record date. Format: date.
+      ?accountingDate: String,
+
+      # Its authorization number (10, 37 or 49 digits).
+      ?authorizationNumber: String,
+
+      # Whether the payment is `local` or `foreign`. Defaults to `local`.
+      ?paymentResidence: supporting_document_payment_residence,
+
+      # Foreign payment details; required for a `foreign` payment.
+      ?foreignPayment: withholding_foreign_payment,
+
+      # Its subtotal before taxes.
+      subtotal: String,
+
+      # Its total.
+      total: String,
+
+      # Its taxes.
+      taxes: Array[supporting_document_tax],
+
+      # What is withheld from it.
+      withholdings: Array[withholding],
+
+      # How it is paid; the payments must add up to its total.
+      payments: Array[withholding_payment]
+    }
+
+    # Whether the payment is `local` or `foreign`. Defaults to `local`.
+    type supporting_document_payment_residence = "local" | "foreign"
+
+    # A VAT of the supporting document.
+    type supporting_document_tax = {
+      # Tax type: `vat`.
+      type: supporting_document_tax_type,
+
+      # VAT rate in force on the supporting document issue date.
+      rate: supporting_document_tax_rate,
+
+      # Taxable base.
+      taxableBase: String,
+
+      # The supporting document's VAT amount. Defaults to base × rate, rounded.
+      ?amount: String
+    }
+
+    # VAT rate in force on the supporting document issue date.
+    type supporting_document_tax_rate = "0"
+      | "5"
+      | "8"
+      | "12"
+      | "13"
+      | "14"
+      | "15"
+      | "exempt"
+      | "not_subject"
+
+    # Tax type: `vat`.
+    type supporting_document_tax_type = "vat"
+
+    # Fields to change. The code cannot be changed.
+    type update_establishment = {
+      # Address of the establishment (dirección del establecimiento).
+      ?address: String
+    }
+
+    # Fields to change; null clears an optional field. The RUC cannot be changed.
+    type update_issuer = {
+      # Legal name (razón social) as registered in the RUC.
+      ?legalName: String,
+
+      # Trade name (nombre comercial).
+      ?tradeName: String?,
+
+      # Head office address (dirección matriz).
+      ?headOfficeAddress: String,
+      ?taxProfile: issuer_tax_profile_patch,
+      ?branding: issuer_branding_input,
+
+      # Default of a document request's `options.sendEmail`: true emails every authorized document
+      # (RIDE PDF and XML) to its buyer, false opts the issuer out. A request that sets
+      # `options.sendEmail` decides for itself.
+      ?sendEmailByDefault: bool
+    }
+
+    # Fields to change; null clears the description.
+    type update_webhook_endpoint = {
+      # Where Flashpi POSTs the events: a public HTTPS URL without credentials or fragment. Changing
+      # it requires a new verification.
+      ?url: String,
+
+      # A label for your own reference.
+      ?description: String?,
+
+      # Event types the endpoint receives; `*` receives every type, including future ones.
+      ?enabledEvents: Array[update_webhook_endpoint_enabled_events_item],
+
+      # `full` (default): the event with a snapshot of its resource in `data`. `thin`: the event
+      # without `data`, only `id`, `type`, `environment` and `createdAt` (read the snapshot with GET
+      # /v1/events/{id}).
+      ?payloadMode: update_webhook_endpoint_payload_mode,
+
+      # true disables the endpoint (pending deliveries end); false enables it again (a new
+      # verification is sent when it was never verified).
+      ?disabled: bool
+    }
+
+    type update_webhook_endpoint_enabled_events_item = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+      | "*"
+
+    # `full` (default): the event with a snapshot of its resource in `data`. `thin`: the event
+    # without `data`, only `id`, `type`, `environment` and `createdAt` (read the snapshot with GET
+    # /v1/events/{id}).
+    type update_webhook_endpoint_payload_mode = "full" | "thin"
+
+    # Who carries the goods.
+    type waybill_carrier = {
+      # Identification type of the carrier (not `final_consumer`).
+      idType: waybill_carrier_id_type,
+
+      # Identification number.
+      id: String,
+
+      # Legal name.
+      name: String
+    }
+
+    # Identification type of the carrier (not `final_consumer`).
+    type waybill_carrier_id_type = "ruc" | "cedula" | "passport" | "final_consumer" | "foreign_id"
+
+    # Goods carried for a recipient.
+    type waybill_item = {
+      # Your product code.
+      ?code: String,
+
+      # A second code.
+      ?auxiliaryCode: String,
+
+      # Description.
+      description: String,
+
+      # Quantity, up to 6 decimals.
+      quantity: String,
+
+      # Up to 3 extra details (name → value).
+      ?additionalDetails: Hash[Symbol, String]
+    }
+
+    # Who receives the goods, and what.
+    type waybill_recipient = {
+      # Identification number.
+      id: String,
+
+      # Legal name.
+      name: String,
+
+      # Delivery address.
+      address: String,
+
+      # Reason for the transfer.
+      transferReason: String,
+
+      # Single customs document (DAU), for imports and exports.
+      ?customsDocument: String,
+
+      # Destination establishment code of the recipient.
+      ?destinationEstablishment: String,
+
+      # Route.
+      ?route: String,
+
+      # The supporting document.
+      ?supportingDocument: waybill_supporting_document,
+
+      # The goods carried for this recipient.
+      items: Array[waybill_item]
+    }
+
+    # The document that supports the transfer, usually the sales invoice.
+    type waybill_supporting_document = {
+      # Type of the supporting document.
+      ?type: waybill_supporting_document_type,
+
+      # Its number.
+      ?number: String,
+
+      # Its authorization number (the 49-digit access key of electronic documents).
+      ?authorizationNumber: String,
+
+      # Its issue date. Format: date.
+      ?issueDate: String
+    }
+
+    # Type of the supporting document.
+    type waybill_supporting_document_type = "invoice"
+      | "purchase_settlement"
+      | "credit_note"
+      | "debit_note"
+      | "waybill"
+      | "withholding"
+
+    # One event sent to one endpoint, retried with backoff for 72 hours until it gets a 2xx.
+    type webhook_delivery = {
+      # Format: uuid.
+      id: String,
+
+      # Format: uuid.
+      webhookEndpointId: String,
+
+      # The event, also the webhook-id header. Format: uuid.
+      eventId: String,
+      eventType: webhook_delivery_event_type,
+      payloadMode: webhook_delivery_payload_mode,
+
+      # `pending` (an attempt is scheduled or running), `succeeded` or `failed`.
+      status: webhook_delivery_status,
+      attemptCount: Integer | Float,
+
+      # Format: date-time.
+      nextAttemptAt: String?,
+
+      # Format: date-time.
+      lastAttemptAt: String?,
+      lastResponseStatus: Integer?,
+
+      # Why it failed: `unexpected_status` (an answer other than 2xx, see the status), `timeout`,
+      # `connection_failed`, `dns_resolution_failed`, `tls_error`, `address_not_allowed`,
+      # `invalid_url`, or without an attempt `endpoint_disabled` and `endpoint_not_verified`.
+      lastError: String?,
+
+      # Format: date-time.
+      succeededAt: String?,
+
+      # No automatic attempt after this time. Format: date-time.
+      retryUntil: String,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    # One HTTP attempt of a delivery.
+    type webhook_delivery_attempt = {
+      # 1 for the first attempt.
+      number: Integer | Float,
+      trigger: webhook_delivery_attempt_trigger,
+
+      # Format: date-time.
+      startedAt: String,
+      durationMs: Integer | Float,
+      responseStatus: Integer?,
+
+      # Why it failed: `unexpected_status` (an answer other than 2xx, see the status), `timeout`,
+      # `connection_failed`, `dns_resolution_failed`, `tls_error`, `address_not_allowed`,
+      # `invalid_url`, or without an attempt `endpoint_disabled` and `endpoint_not_verified`.
+      error: String?,
+      succeeded: bool
+    }
+
+    type webhook_delivery_attempt_trigger = "automatic" | "replay"
+
+    # A delivery with its attempts.
+    type webhook_delivery_detail = {
+      # Format: uuid.
+      id: String,
+
+      # Format: uuid.
+      webhookEndpointId: String,
+
+      # The event, also the webhook-id header. Format: uuid.
+      eventId: String,
+      eventType: webhook_delivery_detail_event_type,
+      payloadMode: webhook_delivery_detail_payload_mode,
+
+      # `pending` (an attempt is scheduled or running), `succeeded` or `failed`.
+      status: webhook_delivery_detail_status,
+      attemptCount: Integer | Float,
+
+      # Format: date-time.
+      nextAttemptAt: String?,
+
+      # Format: date-time.
+      lastAttemptAt: String?,
+      lastResponseStatus: Integer?,
+
+      # Why it failed: `unexpected_status` (an answer other than 2xx, see the status), `timeout`,
+      # `connection_failed`, `dns_resolution_failed`, `tls_error`, `address_not_allowed`,
+      # `invalid_url`, or without an attempt `endpoint_disabled` and `endpoint_not_verified`.
+      lastError: String?,
+
+      # Format: date-time.
+      succeededAt: String?,
+
+      # No automatic attempt after this time. Format: date-time.
+      retryUntil: String,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String,
+
+      # Oldest first.
+      attempts: Array[webhook_delivery_attempt]
+    }
+
+    type webhook_delivery_detail_event_type = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+
+    type webhook_delivery_detail_payload_mode = "full" | "thin"
+
+    # `pending` (an attempt is scheduled or running), `succeeded` or `failed`.
+    type webhook_delivery_detail_status = "pending" | "succeeded" | "failed"
+
+    type webhook_delivery_event_type = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+
+    # A page of deliveries, newest first.
+    type webhook_delivery_list = {
+      data: Array[webhook_delivery],
+      pagination: pagination
+    }
+
+    type webhook_delivery_payload_mode = "full" | "thin"
+
+    # `pending` (an attempt is scheduled or running), `succeeded` or `failed`.
+    type webhook_delivery_status = "pending" | "succeeded" | "failed"
+
+    # A URL that receives Standard Webhooks, signed with a whsec_ secret (read it with GET
+    # .../secret). It receives the events of the mode of the API key that created it (test or live).
+    type webhook_endpoint = {
+      # Format: uuid.
+      id: String,
+
+      # Where Flashpi POSTs the events: a public HTTPS URL without credentials or fragment. Changing
+      # it requires a new verification.
+      url: String,
+
+      # A label for your own reference.
+      description: String?,
+
+      # Event types the endpoint receives; `*` receives every type, including future ones.
+      enabledEvents: Array[webhook_endpoint_enabled_events_item],
+
+      # `full` (default): the event with a snapshot of its resource in `data`. `thin`: the event
+      # without `data`, only `id`, `type`, `environment` and `createdAt` (read the snapshot with GET
+      # /v1/events/{id}).
+      payloadMode: webhook_endpoint_payload_mode,
+
+      # `pending_verification` (receives nothing until it echoes the challenge), `active` or
+      # `disabled`.
+      status: webhook_endpoint_status,
+
+      # Mode of the events it receives.
+      environment: webhook_endpoint_environment,
+      verification: webhook_endpoint_verification,
+
+      # After a rotation: until when deliveries are also signed with the previous secret. Format:
+      # date-time.
+      previousSecretExpiresAt: String?,
+
+      # Format: date-time.
+      disabledAt: String?,
+
+      # Format: date-time.
+      createdAt: String,
+
+      # Format: date-time.
+      updatedAt: String
+    }
+
+    type webhook_endpoint_enabled_events_item = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+      | "*"
+
+    # Mode of the events it receives.
+    type webhook_endpoint_environment = "test" | "live"
+
+    # A page of webhook endpoints, newest first.
+    type webhook_endpoint_list = {
+      data: Array[webhook_endpoint],
+      pagination: pagination
+    }
+
+    # `full` (default): the event with a snapshot of its resource in `data`. `thin`: the event
+    # without `data`, only `id`, `type`, `environment` and `createdAt` (read the snapshot with GET
+    # /v1/events/{id}).
+    type webhook_endpoint_payload_mode = "full" | "thin"
+
+    # The signing secret of an endpoint.
+    type webhook_endpoint_secret = {
+      # The current whsec_ secret (Standard Webhooks): base64 of the HMAC-SHA256 key after the
+      # prefix.
+      secret: String,
+
+      # After a rotation: until when the previous secret also signs. Format: date-time.
+      previousSecretExpiresAt: String?
+    }
+
+    # `pending_verification` (receives nothing until it echoes the challenge), `active` or
+    # `disabled`.
+    type webhook_endpoint_status = "pending_verification" | "active" | "disabled"
+
+    # The activation handshake: Flashpi POSTs a signed `webhook_endpoint.verification` body with a
+    # `challenge`, and the endpoint must answer 2xx echoing it.
+    type webhook_endpoint_verification = {
+      # Format: date-time.
+      verifiedAt: String?,
+
+      # Whether a handshake attempt is scheduled or running.
+      inProgress: bool,
+
+      # Attempts of the current handshake.
+      attempts: Integer | Float,
+
+      # Format: date-time.
+      lastAttemptAt: String?,
+
+      # Why the last attempt failed: `challenge_mismatch`, `unexpected_status`, `timeout`,
+      # `connection_failed`, `dns_resolution_failed`, `tls_error`, `address_not_allowed` or
+      # `invalid_url`.
+      lastError: String?,
+      lastResponseStatus: Integer?
+    }
+
+    # The activation handshake of an endpoint, sent when it is created, when its URL changes and on
+    # POST /v1/webhook-endpoints/{id}/verify; every attempt has a new id and challenge. It is signed
+    # like every webhook; answer 2xx with `{"challenge": "<data.challenge>"}` (or the challenge as
+    # plain text).
+    type webhook_endpoint_verification_event = {
+      # This attempt's id, also its webhook-id header: new on every attempt. Format: uuid.
+      id: String,
+      type: "webhook_endpoint.verification",
+      environment: webhook_endpoint_verification_event_environment,
+
+      # When this attempt was sent. Format: date-time.
+      createdAt: String,
+      data: webhook_endpoint_verification_event_data
+    }
+
+    type webhook_endpoint_verification_event_data = {
+      # Format: uuid.
+      webhookEndpointId: String,
+
+      # Random value to echo back, new on every attempt: echo the one of this request.
+      challenge: String
+    }
+
+    type webhook_endpoint_verification_event_environment = "test" | "live"
+
+    # The query of `webhookEndpointsDeliveriesList` (GET
+    # /v1/webhook-endpoints/{endpointId}/deliveries).
+    type webhook_endpoints_deliveries_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String,
+
+      # Only deliveries in this status.
+      ?status: webhook_endpoints_deliveries_list_query_status,
+
+      # Only deliveries of this event type.
+      ?eventType: webhook_endpoints_deliveries_list_query_event_type,
+
+      # Only the delivery of this event. Format: uuid.
+      ?eventId: String
+    }
+
+    type webhook_endpoints_deliveries_list_query_event_type = "invoice.authorized"
+      | "invoice.rejected"
+      | "purchase_settlement.authorized"
+      | "purchase_settlement.rejected"
+      | "credit_note.authorized"
+      | "credit_note.rejected"
+      | "debit_note.authorized"
+      | "debit_note.rejected"
+      | "waybill.authorized"
+      | "waybill.rejected"
+      | "withholding.authorized"
+      | "withholding.rejected"
+      | "certificate.verified"
+      | "certificate.pending"
+      | "certificate.blocked"
+      | "certificate.revoked"
+      | "certificate.reactivated"
+      | "document.ride.generated"
+      | "document.ride.failed"
+      | "document.email.sent"
+      | "document.email.delivered"
+      | "document.email.bounced"
+      | "document.email.complained"
+      | "document.email.failed"
+      | "account.email_paused"
+      | "account.email_resumed"
+
+    type webhook_endpoints_deliveries_list_query_status = "pending" | "succeeded" | "failed"
+
+    # The query of `webhookEndpointsList` (GET /v1/webhook-endpoints).
+    type webhook_endpoints_list_query = {
+      # Maximum number of items to return. Default: `20`.
+      ?limit: Integer,
+
+      # The `pagination.nextCursor` of the previous page. Omit it for the first page.
+      ?cursor: String
+    }
+
+    # The supplier whose taxes are withheld.
+    type withheld_subject = {
+      # Identification type (not `final_consumer`).
+      idType: withheld_subject_id_type,
+
+      # Identification number.
+      id: String,
+
+      # Legal name.
+      name: String,
+
+      # Whether the supplier is a related party.
+      relatedParty: bool,
+
+      # Required when `idType` is `foreign_id`: `individual` or `company`.
+      ?subjectType: withheld_subject_subject_type,
+
+      # Where the authorized receipt is emailed (see `options.sendEmail`). Format: email.
+      ?email: String
+    }
+
+    # Identification type (not `final_consumer`).
+    type withheld_subject_id_type = "ruc" | "cedula" | "passport" | "final_consumer" | "foreign_id"
+
+    # Required when `idType` is `foreign_id`: `individual` or `company`.
+    type withheld_subject_subject_type = "individual" | "company"
+
+    # A withholding. Flashpi computes the withheld amount: taxable base × percentage, rounded to 2
+    # decimals.
+    type withholding = {
+      # Tax withheld: `income_tax`, `vat` or `isd`.
+      tax: withholding_tax,
+
+      # Withholding code: TABLA 20 for `vat` (for example `1` = 30%, `2` = 70%, `3` = 100%) and
+      # `isd`, the Catálogo ATS for `income_tax` (for example `312`).
+      code: String,
+
+      # Taxable base of the withholding.
+      taxableBase: String,
+
+      # Percentage. Required for `income_tax`; for `vat` and `isd` Flashpi takes it from the code,
+      # and a different value is refused.
+      ?rate: String,
+
+      # Dividend details.
+      ?dividends: withholding_dividends,
+
+      # Banana box purchase.
+      ?bananaBoxes: withholding_banana_boxes
+    }
+
+    # Required for the banana box income tax codes (338, 340, 341, 342, 342A, 342B).
+    type withholding_banana_boxes = {
+      # Number of boxes.
+      count: Integer,
+
+      # Price per box.
+      pricePerBox: String
+    }
+
+    # Required when `taxSupportCode` is 10.
+    type withholding_dividends = {
+      # Dividend payment date. Format: date.
+      paymentDate: String,
+
+      # Corporate income tax attributable to the dividends.
+      corporateIncomeTax: String,
+
+      # Fiscal year of the distributed profits.
+      profitFiscalYear: String
+    }
+
+    # Required when the payment goes abroad (`paymentResidence` is `foreign`).
+    type withholding_foreign_payment = {
+      # Tax regime of the country of payment: `general`, `tax_haven` or `preferential` (preferential
+      # regime or lower-tax jurisdiction).
+      regime: withholding_foreign_payment_regime,
+
+      # Country of payment, as the SRI country code (3 or 4 digits).
+      country: String,
+
+      # Whether a double taxation treaty applies.
+      doubleTaxationTreatyApplies: bool,
+
+      # Whether the payment is subject to withholding under the law. Required when no double
+      # taxation treaty applies.
+      ?subjectToWithholdingUnderLaw: bool,
+
+      # Whether it is a payment to a preferential tax regime.
+      preferentialTaxRegime: bool
+    }
+
+    # Tax regime of the country of payment: `general`, `tax_haven` or `preferential` (preferential
+    # regime or lower-tax jurisdiction).
+    type withholding_foreign_payment_regime = "general" | "tax_haven" | "preferential"
+
+    # A payment of the supporting document.
+    type withholding_payment = {
+      # Payment method (same values as `DocumentPayment.method`).
+      method: withholding_payment_method,
+
+      # Amount.
+      amount: String
+    }
+
+    # Payment method (same values as `DocumentPayment.method`).
+    type withholding_payment_method = "cash"
+      | "debt_offset"
+      | "debit_card"
+      | "electronic_money"
+      | "prepaid_card"
+      | "credit_card"
+      | "other_financial_system"
+      | "securities_endorsement"
+
+    # Tax withheld: `income_tax`, `vat` or `isd`.
+    type withholding_tax = "income_tax" | "vat" | "isd"
+  end
+end