Skip to main content
GET
/
documents
Listar documentos
curl --request GET \
  --url https://api.tupana.ai/v1/documents \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "folio": "<string>",
      "date_issued": "2023-12-25",
      "amount_with_iva": 123,
      "dte_type_code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Qué hace

  • Obtiene una lista paginada de documentos emitidos o recibidos por una entidad específica
  • Soporta búsqueda por folio, nombre del receptor y filtros avanzados
  • Permite paginar los resultados para manejar grandes volúmenes
  • Filtra documentos por estado, tipo, fecha y otros criterios

​
Ejemplos de uso

  • Listar todos los documentos de una entidad
  • Buscar un documento específico por folio
  • Filtrar documentos por fecha de emisión
  • Consultar documentos por tipo (factura, boleta, etc.)
  • Obtener documentos recibidos o emitidos por separado

Authorizations

​
Authorization
string
header
required

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)

Query Parameters

​
master_entity_id
integer
required

ID de la entidad emisora o receptora cuyos documentos quieres consultar.

​
document_type
enum<string>
default:issued

issued (por defecto) o received. issued devuelve documentos donde la entidad es el emisor. received devuelve documentos donde la entidad es el receptor (cuando usas received, el parámetro search buscará en el nombre y RUT del emisor, y issuer_tax_id permite filtrar por RUT del emisor específico).

Available options:
issued,
received
​
folio
integer

Folio exacto del documento. Si se envía, se ignoran otros filtros y se devuelve el documento específico.

​
search
string

Busca por nombre o RUT del receptor (cuando document_type=issued) o del emisor (cuando document_type=received).

​
dte_type__code__in
string[]

Lista de códigos DTE separados por coma (ej: 33,34).

​
issuer_tax_id
string

RUT del emisor cuando document_type=received.

​
page
integer
default:1

Página actual, parte de la paginación estándar. Por defecto: 1. La respuesta incluye count (total), next, previous (URLs de navegación) y results (arreglo de documentos con información de emisor, receptor, montos, estado, PDF y referencias).

​
page_size
integer
default:20

Tamaño de página (máx. 100). Por defecto: 20.

Required range: x <= 100

Response

Lista de documentos obtenida exitosamente

​
count
integer

Número total de documentos

​
next
string | null

URL de la siguiente página

​
previous
string | null

URL de la página anterior

​
results
object[]