Trifaco API
Documentos

Consultar saldo ajustable por línea

GET/v1/documents/{id}/credit-balance

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.

Authorization

ClientApiKey
X-API-Key<token>

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

In: header

Path Parameters

id*string

Identificador opaco. No autoriza acceso por sí mismo.

Formatuuid
Length1 <= length <= 36

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/credit-balance"
{  "original_document_id": "00000000-0000-4000-8000-000000000020",  "debit_note_ids": [    "00000000-0000-4000-8000-000000000021"  ],  "mixed": true,  "lines": [    {      "original_line_id": "1",      "tax_code": "01",      "tax_rate": "19",      "adjusted_unit_price": "12000",      "original": {        "quantity": "1",        "base_amount": "10000",        "tax_amount": "1900"      },      "increments": {        "base_amount": "2000",        "tax_amount": "380"      },      "adjusted": {        "quantity": "1",        "base_amount": "12000",        "tax_amount": "2280"      },      "consumed": {        "quantity": "0",        "base_amount": "0",        "tax_amount": "0"      },      "reserved": {        "quantity": "0",        "base_amount": "0",        "tax_amount": "0"      },      "remaining": {        "quantity": "1",        "base_amount": "12000",        "tax_amount": "2280"      },      "available_original": {        "base_amount": "10000",        "tax_amount": "1900"      },      "available_increments": {        "base_amount": "2000",        "tax_amount": "380"      }    }  ]}

Prevalidar nota crédito y saldo contextual POST

**Estado:** parcial. **Ambientes:** simulation, qualification. **Permisos:** `documents:write`. **Alcance:** Comprueba estructura, cálculo y contexto del saldo de la factura original sin reservar ni emitir. Los errores semánticos devuelven 200 con valid=false; entrada mal formada devuelve 400 y referencias inaccesibles 404. La emisión de notas solo está disponible en qualification. Conserva exactamente el comprador y hereda las reglas de la factura original; originales v1 siguen pudiendo ajustarse. No reserva, asigna número, firma ni transmite. 200 valid=false para errores fiscales/contextuales; referencias ajenas o de otro ambiente conservan 404. Un resultado válido no garantiza admisión futura. Errores contextuales usan CREDIT_CONTEXT_INVALID y detalle en message.

Buscar documentos propios GET

**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