Trifaco API
Documentos

Buscar documentos propios

GET/v1/documents

Estado: implementada. Ambientes: simulation, qualification. Permisos: documents:read.

Alcance: Lista documentos propios con filtros y cursores ligados a la empresa, ambiente y consulta. La paginación excluye admisiones posteriores a la instantánea inicial.

Buscar documentos propios

Authorization

ClientApiKey
X-API-Key<token>

Secreto ligado a empresa, actor, permisos y ambiente. No admite cambiar empresa por body/header.

In: header

Query Parameters

cursor?string

Opaco y ligado a filtros/empresa/ambiente; caduca en 24 h. CURSOR_EXPIRED exige reiniciar listado.

Length1 <= length <= 2048
limit?integer
Range1 <= value <= 100
Default50
external_reference?string
Match^[A-Za-z0-9][A-Za-z0-9._:/-]{0,99}$
Length1 <= length <= 100
document_type?string

Value in

  • "invoice"
  • "credit_note"
  • "debit_note"
dian_status?string

Value in

  • "not_sent"
  • "pending"
  • "unknown"
  • "validated"
  • "rejected"
created_from?string
Formatdate-time
Length1 <= length <= 40
created_until?string
Formatdate-time
Length1 <= length <= 40
branch_code?string
Match^[A-Za-z0-9_.-]+$
Length1 <= length <= 30
fiscal_number?string
Length1 <= length <= 30

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents"
{  "items": [],  "next_cursor": "string",  "as_of": "2019-08-24T14:15:22Z"}

Consultar saldo ajustable por línea GET

**Estado:** parcial. **Ambientes:** simulation, qualification. **Permisos:** `documents:read`. **Alcance:** Devuelve un saldo informativo de cantidades, base e IVA del original y sus incrementos. Exige factura propia firmada, completada y validada; el uso efectivo con aceptación fiscal corresponde a qualification. Una admisión posterior puede encontrar un saldo diferente. Factura propia validada. Desglosa cantidad física, base/IVA original e incrementos, consumo, reservas y remanente. Bloqueo explícito ante ND pendiente o redondeo no representable.

Consultar estado actual del documento GET

**Estado:** implementada. **Ambientes:** simulation, qualification. **Permisos:** `documents:read`. **Alcance:** Devuelve el documento propio, su ETag y los estados separados de procesamiento y DIAN. Un resultado de simulation no representa aceptación fiscal real. Consultar estado actual del documento