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

# Obtener documentos

> Lista los documentos de tu empresa de forma paginada, ordenados por fecha de emisión descendente y, si dos documentos tienen la misma fecha, por `id` descendente. El orden es estable: al recorrer todas las páginas ninguno se repite ni se pierde. Todos los filtros son opcionales y se combinan entre sí.

Por defecto solo se listan documentos en `CLP`. Para ver documentos en otra moneda, envía `currency`.

El campo `type` de cada documento es el identificador del subproducto de factoring al que pertenece (por ejemplo `electronic-invoice`) y `subType` es el código del tipo de documento tributario (por ejemplo `33`), cuando aplica.



## OpenAPI

````yaml openapi/clients.yaml GET /documents
openapi: 3.1.0
info:
  title: API de clientes de Pruff
  version: '1'
  description: >-
    Endpoints que tus sistemas llaman para leer y operar los datos de tu empresa
    en Pruff. Todas las solicitudes van por HTTPS y se autentican con el header
    `x-api-key`. Las convenciones de formato, paginación y errores se describen
    en https://docs.pruff.com/api/introduccion.
servers:
  - url: https://api.pruff.com/api/clients
security:
  - ApiKeyAuth: []
tags:
  - name: Facturas
    description: Consulta de facturas electrónicas, facturas transables y cesiones.
  - name: Documentos
    description: Consulta y creación de documentos asociados a tus clientes.
  - name: Archivos
    description: Carga de archivos a operaciones y a los requerimientos de tus documentos.
  - name: Financiamiento
    description: >-
      Simula créditos, crea solicitudes de factoring y consulta las prórrogas de
      tu empresa.
  - name: Comité
    description: >-
      Consulta las aprobaciones de una solicitud en los comités de riesgo y de
      operaciones, y registra nuevas firmas.
  - name: Chat
    description: Exporta y envía mensajes del chat de una solicitud.
  - name: Reportes
    description: >-
      Reportes de operaciones, cartera, recaudaciones, cuentas pendientes y
      flujos de tu empresa.
  - name: Datahub
    description: >-
      Consulta de la información tributaria, financiera y de riesgo que Pruff
      tiene de tus clientes y deudores.
  - name: Mercado Público
    description: >-
      Licitaciones y órdenes de compra de Mercado Público (ChileCompra) cargadas
      en Pruff.
  - name: CRM
    description: >-
      Datos comerciales de tu CRM en Pruff: empresas con su ficha, pipeline,
      prospectos, gestiones y simulaciones.
  - name: SGR
    description: Operaciones SGR (garantías) de tu empresa.
  - name: Sincronizador
    description: >-
      Pide sincronizar a un cliente con el SII o la TGR para obtener su
      información más actualizada, y consulta el estado de esas
      sincronizaciones.
  - name: Usuarios
    description: >-
      Administra los usuarios de tu empresa en Pruff (crear, editar, eliminar,
      consultar su perfil y asignar subordinados) y consulta las cuentas
      (empresas conectadas) a las que cada usuario tiene acceso.
  - name: Contactos
    description: Crea contactos asociados a las empresas de tu cartera.
paths:
  /documents:
    get:
      tags:
        - Documentos
      summary: Obtener documentos
      description: >-
        Lista los documentos de tu empresa de forma paginada, ordenados por
        fecha de emisión descendente y, si dos documentos tienen la misma fecha,
        por `id` descendente. El orden es estable: al recorrer todas las páginas
        ninguno se repite ni se pierde. Todos los filtros son opcionales y se
        combinan entre sí.


        Por defecto solo se listan documentos en `CLP`. Para ver documentos en
        otra moneda, envía `currency`.


        El campo `type` de cada documento es el identificador del subproducto de
        factoring al que pertenece (por ejemplo `electronic-invoice`) y
        `subType` es el código del tipo de documento tributario (por ejemplo
        `33`), cuando aplica.
      operationId: getDocuments
      parameters:
        - name: page
          in: query
          required: false
          description: Número de página, desde 1.
          schema:
            type: integer
            minimum: 1
            default: 1
          example: 1
        - name: pageSize
          in: query
          required: false
          description: Cantidad de documentos por página. Máximo 250.
          schema:
            type: integer
            minimum: 1
            maximum: 250
            default: 10
          example: 50
        - name: startDate
          in: query
          required: false
          description: >-
            Fecha de emisión desde la cual quieres documentos (inclusive). Envía
            solo la fecha, en formato `YYYY-MM-DD` y sin hora, por ejemplo
            `2025-05-27`; se considera desde el inicio de ese día en UTC.
          schema:
            type: string
          example: '2025-05-27'
        - name: endDate
          in: query
          required: false
          description: >-
            Fecha de emisión hasta la cual quieres documentos (inclusive). Envía
            solo la fecha, en formato `YYYY-MM-DD` y sin hora, por ejemplo
            `2025-06-30`; se considera hasta el final de ese día en UTC.
          schema:
            type: string
          example: '2025-06-30'
        - name: businessIdentifier
          in: query
          required: false
          description: RUT del emisor del documento.
          schema:
            type: string
          example: 76000000-0
        - name: stakeholderIdentifier
          in: query
          required: false
          description: RUT del deudor (el receptor del documento).
          schema:
            type: string
          example: 77777777-7
        - name: clientIdentifier
          in: query
          required: false
          description: RUT del cliente dueño del documento.
          schema:
            type: string
          example: 76000000-0
        - name: folio
          in: query
          required: false
          description: Folio exacto del documento.
          schema:
            type: string
          example: '1333'
        - name: subProductId
          in: query
          required: false
          description: >-
            Identificador del subproducto de factoring al que pertenece el
            documento.
          schema:
            type: string
          example: electronic-invoice
        - name: currency
          in: query
          required: false
          description: >-
            Moneda del documento. Si no la envías, se listan solo los documentos
            en `CLP`.
          schema:
            type: string
            enum:
              - CLP
              - UF
              - USD
              - EUR
              - UTM
              - COP
              - ARS
              - PEN
              - BRL
              - MXN
            default: CLP
          example: CLP
      responses:
        '200':
          description: Página de documentos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentListResponse'
              example:
                data:
                  - id: c1d2e3f4-5678-4abc-8def-1234567890ab
                    folio: '1333'
                    type: electronic-invoice
                    subType: '33'
                    businessIdentifier: 76000000-0
                    businessName: Cliente Ejemplo SpA
                    stakeholderIdentifier: 77777777-7
                    stakeholderName: Pagador Ejemplo SpA
                    clientIdentifier: 76000000-0
                    clientName: Cliente Ejemplo SpA
                    amount: 4123123
                    currency: CLP
                    issuedDate: '2025-07-09T00:00:00.000Z'
                    receiptDate: '2025-07-10T00:00:00.000Z'
                    paidAt: null
                pagination:
                  total: 24
                  page: 1
                  pageSize: 10
                  totalPages: 3
        '400':
          description: >-
            Algún query param no cumple el formato esperado. `displayMessage`
            describe el primer error y `data.errors` los lista todos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                invalidDate:
                  summary: Fecha no válida
                  value:
                    message: custom
                    displayMessage: Fecha de inicio inválida
                    data:
                      errors:
                        - path: startDate
                          message: Fecha de inicio inválida
                          code: custom
                invalidCurrency:
                  summary: Moneda no soportada
                  value:
                    message: invalid_value
                    displayMessage: >-
                      Invalid option: expected one of
                      "CLP"|"UF"|"USD"|"EUR"|"UTM"|"COP"|"ARS"|"PEN"|"BRL"|"MXN"
                    data:
                      errors:
                        - path: currency
                          message: >-
                            Invalid option: expected one of
                            "CLP"|"UF"|"USD"|"EUR"|"UTM"|"COP"|"ARS"|"PEN"|"BRL"|"MXN"
                          code: invalid_value
                pageSizeTooBig:
                  summary: pageSize sobre el máximo
                  value:
                    message: too_big
                    displayMessage: pageSize must be less or equal to 250
                    data:
                      errors:
                        - path: pageSize
                          message: pageSize must be less or equal to 250
                          code: too_big
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '504':
          $ref: '#/components/responses/Timeout'
components:
  schemas:
    DocumentListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentListItem'
        pagination:
          $ref: '#/components/schemas/Pagination'
    ValidationError:
      type: object
      required:
        - message
        - displayMessage
        - data
      description: Error de validación del body, de los query params o de los path params.
      properties:
        message:
          type: string
          description: >-
            Código del primer error de validación (por ejemplo `custom`,
            `invalid_type`, `invalid_format`, `invalid_value`, `invalid_union`).
        displayMessage:
          type: string
          description: >-
            Mensaje del primer error de validación, pensado para mostrarlo a una
            persona. Normalmente en español; algunos mensajes de validación
            vienen en inglés.
        data:
          type: object
          required:
            - errors
          properties:
            errors:
              type: array
              description: Todos los errores de validación encontrados.
              items:
                type: object
                required:
                  - path
                  - message
                  - code
                properties:
                  path:
                    type: string
                    description: >-
                      Campo con el error. Para listas incluye la posición, por
                      ejemplo `types.0`. `(root)` si el error es del body
                      completo.
                  message:
                    type: string
                    description: Descripción del error en español.
                  code:
                    type: string
                    description: Código del tipo de error.
    DocumentListItem:
      type: object
      description: Documento asociado a tu empresa.
      required:
        - id
        - folio
        - type
        - subType
        - businessIdentifier
        - businessName
        - stakeholderIdentifier
        - stakeholderName
        - clientIdentifier
        - amount
        - currency
        - issuedDate
        - receiptDate
        - paidAt
      properties:
        id:
          type: string
          description: >-
            Identificador único del documento. Es un UUID, o el `cufe` si el
            documento se creó con uno.
          example: c1d2e3f4-5678-4abc-8def-1234567890ab
        folio:
          type: string
          description: Folio del documento.
          example: '1333'
        type:
          type: string
          description: >-
            Identificador del subproducto de factoring al que pertenece el
            documento.
          example: electronic-invoice
        subType:
          type:
            - string
            - 'null'
          description: >-
            Código del tipo de documento tributario (por ejemplo `33`, `34` o
            `46`). Es null si no aplica.
          example: '33'
        businessIdentifier:
          type: string
          description: RUT del emisor del documento.
          example: 76000000-0
        businessName:
          type: string
          description: Nombre del emisor.
          example: Cliente Ejemplo SpA
        stakeholderIdentifier:
          type: string
          description: RUT del deudor (el receptor del documento).
          example: 77777777-7
        stakeholderName:
          type: string
          description: Nombre del deudor.
          example: Pagador Ejemplo SpA
        clientIdentifier:
          type:
            - string
            - 'null'
          description: >-
            RUT del cliente dueño del documento. Es null si el documento no
            tiene cliente asociado.
          example: 76000000-0
        clientName:
          type: string
          description: >-
            Nombre del cliente. Se omite si el documento no tiene cliente
            asociado.
          example: Cliente Ejemplo SpA
        amount:
          type: integer
          description: >-
            Monto total del documento. En `PEN` está en céntimos (unidad menor,
            por ejemplo `123456` equivale a S/ 1.234,56); en las demás monedas,
            en la unidad principal de la moneda y sin decimales (por ejemplo,
            pesos para `CLP`).
          example: 4123123
        currency:
          type: string
          enum:
            - CLP
            - UF
            - USD
            - EUR
            - UTM
            - COP
            - ARS
            - PEN
            - BRL
            - MXN
          description: Moneda del documento.
          example: CLP
        issuedDate:
          type: string
          format: date-time
          description: Fecha de emisión del documento, en formato ISO 8601 (UTC).
          example: '2025-07-09T00:00:00.000Z'
        receiptDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Fecha de recepción del documento. Es null si no se informó.
          example: '2025-07-10T00:00:00.000Z'
        paidAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Fecha en que el documento se registró como pagado. Es null si no
            está pagado.
          example: null
    Pagination:
      type: object
      required:
        - total
        - page
        - pageSize
        - totalPages
      properties:
        total:
          type: integer
          description: Cantidad total de elementos que cumplen los filtros.
        page:
          type: integer
          description: Página devuelta, desde 1.
        pageSize:
          type: integer
          description: Cantidad de elementos por página.
        totalPages:
          type: integer
          description: Cantidad total de páginas.
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: >-
            Identifica el error. En algunos casos es un texto en inglés con
            valores variables. Para tu lógica, usa el código HTTP y, cuando
            exista, `data.code`.
        displayMessage:
          type: string
          description: >-
            Mensaje pensado para mostrarlo a una persona. Normalmente en
            español; algunos mensajes de validación vienen en inglés.
        data:
          description: Detalle adicional del error, cuando existe.
  responses:
    Unauthorized:
      description: >-
        Falta el header `x-api-key`, su valor no es válido o la cuenta de API de
        tu empresa no está habilitada.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
            properties:
              message:
                type: string
          example:
            message: 'Unauthorized: Invalid API Key'
    TooManyRequests:
      description: >-
        Tu empresa superó el límite de solicitudes. Todas las API keys de tu
        empresa comparten el mismo límite. Espera los segundos que indica el
        header `Retry-After` (o `data.retryAfterSeconds`) antes de reintentar.
      headers:
        Retry-After:
          description: Segundos que debes esperar antes de reintentar.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: >-
              Rate limit exceeded: 501 requests in the current 60s window, limit
              is 500. Retry in 12s.
            displayMessage: >-
              Superaste el límite de 500 solicitudes cada 60 segundos. Vuelve a
              intentarlo en 12 segundos.
            data:
              code: RATE_LIMIT_EXCEEDED
              scope: All API keys of your company share this budget.
              limit: 500
              used: 501
              windowSeconds: 60
              retryAfterSeconds: 12
              resetAt: '2026-11-04T15:00:12.000Z'
              hint: >-
                Wait until resetAt (or honor the Retry-After header) before
                retrying. Avoid repeating identical requests: reuse responses
                you already fetched, use filters and larger pageSize values
                instead of one request per item, and cap your client
                concurrency.
    InternalError:
      description: >-
        Error inesperado en Pruff. El texto de `message` puede variar (por
        ejemplo en mayúsculas); no dependas de él.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Internal server error
    Timeout:
      description: >-
        La solicitud superó el tiempo máximo de 55 segundos. La operación puede
        haberse completado igual: antes de reintentar una solicitud que crea o
        modifica datos, verifica su estado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: request_timeout
            displayMessage: La solicitud excedió el tiempo máximo permitido
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key que Pruff entrega a tu empresa.

````

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