> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tupana.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Resultado de una consulta de folios



## OpenAPI

````yaml api-reference/openapi-v2.json GET /folio-queries/{id}/
openapi: 3.0.0
info:
  title: Tupana API — v2
  description: >-
    API v2 de Tupana: facturación electrónica, cesiones, recaudación, consultas,
    boleta de honorarios y nómina. Los identificadores de recursos son public
    IDs opacos con prefijo (docu_, ment_, cred_, doce_, empl_…).
  version: 2.0.0
servers:
  - url: https://api.tupana.ai/v2
    description: Producción (v2)
security:
  - apiKeyAuth: []
paths:
  /folio-queries/{id}/:
    get:
      tags:
        - Folios
      summary: Resultado de una consulta de folios
      operationId: getFolioQuery_v2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Estado y resultado de la consulta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolioQuery'
        '403':
          description: La consulta es de otra entidad.
        '404':
          description: Consulta no encontrada.
      security:
        - apiKeyAuth: []
components:
  schemas:
    FolioQuery:
      type: object
      description: >-
        Consulta de folios al SII. Es un recurso para que puedas seguirla: antes
        esto era una acción que respondía 202 sin nada que consultar.
      properties:
        id:
          type: string
          example: foqu_3b7f1e9d5c2a8
        dte_type:
          type: integer
          example: 33
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
        result:
          type: object
          description: Lo que dijo el SII cuando la consulta terminó.
          properties:
            available:
              type: integer
              nullable: true
              description: >-
                Folios timbrados y sin emitir. `null` significa que no lo
                sabemos, no cero.
              example: 3
            max_per_request:
              type: integer
              nullable: true
              description: Máximo por solicitud vigente.
              example: 8
            last_timbraje:
              type: string
              nullable: true
            timbrajes:
              type: array
              description: Rangos timbrados históricamente.
              items:
                type: object
        error:
          type: string
          description: Motivo cuando la consulta no terminó bien.
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
        sii_environment:
          type: string
          enum:
            - production
            - certification
          description: >-
            Ambiente del SII en el que se hizo la operación. Un CAF de
            `certification` NO sirve para emitir.
        error_code:
          type: string
          description: >-
            Vocabulario cerrado del desenlace fallido; vacío si no hubo error.
            Ver la página de códigos de error.
          enum:
            - ''
            - certification_not_enabled
            - missing_certificate
            - no_folios_authorized
            - sii_unavailable
            - sii_unrecognized_page
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API Key para autenticación. Debe proporcionarse en el header
        Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo
        'Api-Key ' seguido de tu API key)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.