> ## 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 deuda cliente

> Devuelve la deuda del cliente, mes a mes: todos los períodos de deuda que Pruff tiene registrados para el cliente, acumulados de todas sus consultas; `lastUpdate` es la fecha de la última consulta. Es un endpoint de solo lectura: nunca gatilla una consulta nueva ni consume créditos de consulta. Los montos de cada período vienen en miles de pesos chilenos, como texto. Si el cliente nunca ha sido consultado, o la consulta no trajo deuda, responde `200` con `data` y `lastUpdate` en `null`. No exige que el RUT exista como empresa en Pruff.



## OpenAPI

````yaml openapi/clients.yaml GET /datahub/{identifier}/debt
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:
  /datahub/{identifier}/debt:
    get:
      tags:
        - Datahub
      summary: Obtener deuda cliente
      description: >-
        Devuelve la deuda del cliente, mes a mes: todos los períodos de deuda
        que Pruff tiene registrados para el cliente, acumulados de todas sus
        consultas; `lastUpdate` es la fecha de la última consulta. Es un
        endpoint de solo lectura: nunca gatilla una consulta nueva ni consume
        créditos de consulta. Los montos de cada período vienen en miles de
        pesos chilenos, como texto. Si el cliente nunca ha sido consultado, o la
        consulta no trajo deuda, responde `200` con `data` y `lastUpdate` en
        `null`. No exige que el RUT exista como empresa en Pruff.
      operationId: getDatahubDebt
      parameters:
        - name: identifier
          in: path
          required: true
          description: >-
            RUT del cliente, sin puntos, con guion y con la K del dígito
            verificador en mayúscula (por ejemplo `76111111-6`). También se
            acepta un NIT colombiano con el formato `XXXXXXXXX-Y`. Un
            identificador que no es un RUT ni un NIT válido responde `400`.
            Envía el RUT con su dígito verificador correcto.
          schema:
            type: string
            example: 76111111-6
            pattern: ^(\d{1,8}-[\dK]|\d{1,15}-\d)$
          example: 76111111-6
      responses:
        '200':
          description: Deuda del cliente, o respuesta vacía si no hay consulta registrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatahubDebtResponse'
              examples:
                conConsulta:
                  summary: Cliente con consulta registrada
                  value:
                    data:
                      identifier: 76111111-6
                      rows:
                        - key: Dir. Vigente
                          07-2026: '1500'
                          06-2026: '1200'
                        - key: Dir. Morosa
                          07-2026: '30'
                          06-2026: '0'
                    lastUpdate: '2026-08-15T14:00:00.000Z'
                sinConsulta:
                  summary: Cliente nunca consultado
                  value:
                    data: null
                    lastUpdate: null
        '400':
          description: El `identifier` no es un RUT o NIT válido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                message: invalid_union
                displayMessage: El RUT o Nit ingresado no es válido.
                data:
                  errors:
                    - path: identifier
                      message: El RUT o Nit ingresado no es válido.
                      code: invalid_union
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '504':
          $ref: '#/components/responses/Timeout'
components:
  schemas:
    DatahubDebtResponse:
      type: object
      required:
        - data
        - lastUpdate
      properties:
        data:
          type:
            - object
            - 'null'
          description: >-
            Todos los períodos de deuda que Pruff tiene registrados para el
            cliente, acumulados de todas sus consultas. `null` si el cliente
            nunca ha sido consultado o si la consulta no trajo filas de deuda.
          properties:
            identifier:
              type: string
              description: RUT consultado.
              example: 76111111-6
            rows:
              type: array
              description: Filas de deuda, una por tipo.
              items:
                $ref: '#/components/schemas/DatahubDebtRow'
          required:
            - identifier
            - rows
        lastUpdate:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Fecha y hora de la última consulta de deuda realizada para el
            cliente (no la de tu solicitud), en ISO 8601. `null` si nunca ha
            sido consultado.
    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.
    DatahubDebtRow:
      type: object
      required:
        - key
      description: >-
        Una fila por tipo de deuda. Solo vienen los tipos que tienen
        información. Además de `key`, la fila trae una propiedad por cada
        período informado, con la clave `MM-AAAA` (por ejemplo `07-2026`) y el
        monto como texto.
      properties:
        key:
          type: string
          description: >-
            Tipo de deuda. Valores posibles: `Dir. Vigente`, `Dir. Morosa`,
            `Dir. Vencida`, `Dir. Consumo`, `Dir. Acreedor`, `Dir. Hipotecaria`,
            `Dir. Inv. Financiera`, `Dir. Ope. C/Pacto`, `Dir. Comercial`, `MEX
            Vigente`, `MEX Vencida`, `Indir. Vigente`, `Indir. Vencida`,
            `Castigada Dir.`, `Castigada Inir.`, `Contingente`, `Leasing
            Vigente`, `Leasing Morosa`, `L.Crédito Disp.`.
          example: Dir. Vigente
      additionalProperties:
        type: string
        description: >-
          Monto del período indicado en la clave (`MM-AAAA`), en miles de pesos
          chilenos (CLP), escrito como texto.
        example: '1500'
    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.