Ir al contenido

EcfHistorial de envíos de un comprobante

Historial de envíos de un comprobante

Ver como Markdown
GET
/api/v1/ecf/{id}/attempts
curl --request GET \
--url https://api.novafe.example/api/v1/ecf/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/attempts \
--header 'X-API-Key: <X-API-Key>'

Un renglón por cada resultado de un ciclo contra la DGII (aceptado, aceptado condicional, rechazado, en revisión o fallido), del más antiguo al más reciente. Conserva lo anterior a un reenvío, que el comprobante ya no muestra.

Autenticación: requiere una API key (header X-API-Key) con rol admin_tenant, emisor o consultor.

id
required
string format: uuid

OK

Array<object>

Un renglón del historial de envíos de un comprobante: cómo terminó un ciclo contra la DGII. Lo que emite GET /api/v1/ecf/{id}/attempts.

object
attempt
required

1, 2, 3… dentro del comprobante.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
outcome
required

En qué estado dejó el ciclo al comprobante: accepted, accepted_conditional, rejected, review o failed.

string
trackId
required

TrackId de la DGII de este ciclo; ausente si no llegó a haber uno.

null | string
statusCode
required

Código de estado de la DGII (1 aceptado, 2 rechazado, 4 aceptado condicional); ausente si no hubo veredicto.

null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
statusText
required

El estado textual de la DGII.

null | string
sequenceUsed
required

secuenciaUtilizada de la DGII: false = el e-NCF no se consumió; true o ausente = consumido.

null | boolean
messages
required

Observaciones o motivo de rechazo de la DGII; o el motivo del fallo si no hubo veredicto.

Array<object>
object
code
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
value
required
string
retryDecision
required

Qué se decidió con un rechazo: auto:&lt;código&gt; (la DGII falló de forma transitoria y NovaFE reenvía el mismo XML solo, p. ej. auto:4) o exhausted (era reintentable pero se agotó el ladder y el rechazo quedó firme). Ausente en el resto de resultados.

null | string
xmlSha256
required

SHA-256 (hex) del XML enviado en este ciclo.

string
recordedAt
required

Cuándo se registró el resultado.

string format: date-time

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string