Saltar al contenido principal

Listar documentos

Además de consultar un documento puntual por su identificador (ver Consultar estado), el API expone un listado paginado con filtros — ideal para conciliar tu base de datos contra Ocote sin ir documento por documento.

GET /documents

Lista los documentos de venta (Factura, CCF, Nota de Crédito, Exportación) emitidos por la empresa.

Detalles técnicos

MétodoGET
URLhttps://ocote.io/api/connect/documents
AutenticaciónHeader Authorization: Bearer odt_...

Filtros (query params)

Todos opcionales; se combinan entre sí.

ParámetroDescripción
doc_typeFiltra por tipo: 01, 03, 05, 11.
successtrue / false.
invalidatedtrue / false.
date_from / date_toRango por fecha de emisión (YYYY-MM-DD).
customer_nameBúsqueda parcial por nombre del cliente.
control_numberBúsqueda parcial por correlativo.
external_refBúsqueda exacta.
pageNúmero de página (por defecto 1).
per_pageTamaño de página (por defecto 50, máximo 100).

Response

{
"results": [ /* ... documentos ... */ ],
"total": 128,
"page": 1,
"per_page": 50,
"total_pages": 3
}

Ejemplo

curl
curl -H "Authorization: Bearer odt_xxx" \
"https://ocote.io/api/connect/documents?doc_type=03&date_from=2026-06-01&date_to=2026-06-30&page=1"

Otros endpoints de la familia

EndpointPara qué
GET /documents/{id_or_ref}Detalle de una venta (por UUID o external_ref).
GET /documents/suexLista de Sujetos Excluidos.
GET /documents/suex/{id_or_ref}Detalle de un Sujeto Excluido.
GET /documents/summaryTotales agregados (conteos y montos por tipo de documento), con filtros date_from / date_to.

Ver también

  • Consultar estado — para un documento puntual por UUID o external_ref.
  • Reportes — libros contables en Excel (ZIP) por período.
  • Convenciones — fechas, paginación y semántica general.