DC-e

Consultar DC-e

Devuelve estado, protocolo, enlaces de descarga del XML / DACE y el eco de la solicitud de emisión.

GET/openapi/v2/empresas/{empresaId}/dc-e/{dceId}

Requiere las cabeceras de firma token, timestamp y sign, vea Autenticación.

Consulta el documento por el id enviado en la emisión. La sección de eco (remetente … observacoesMarketplace) proviene del snapshot normalizado de la solicitud tomado en la aceptación y sigue disponible después de que la tarea llega a un estado terminal. Los enlaces de descarga tienen el formato {base pública}/openapi/files/{kind}/{ref}?token=… (kind es xml o dace); el token lleva la credencial, así que no hacen falta cabeceras de firma, la validez viene de la configuración del inquilino (por defecto 7 días) y los enlaces se vuelven a firmar en cada consulta. Vea Descarga de archivos.

Parámetros

Parámetros de ruta

empresaIdstringobligatorio
Identificador devuelto por Registrar empresa.
Ejemplo: 1934811222334455
dceIdstringobligatorio
El id enviado en la emisión.
Ejemplo: DCe-000012333

Respuestas

200

Documento encontrado. Los campos de hecho del documento (numero, chaveAcesso, protocolo, enlaces) se van rellenando conforme avanza el estado.

idstring
Id del documento en el integrador.
ambientestring
Producao / Homologacao, según se envió en la emisión.
Valores:ProducaoHomologacao
statusstring
Estado del documento; vea la tabla de estados más abajo.
Valores:PendenteAutorizadaNegadaCancelamentoPendenteCanceladaFalha
motivoStatusstring
Motivo del estado: cStat - xMotivo en Negada, el motivo del fallo en Falha, el motivo del último rechazo de cancelación en Autorizada; en caso contrario null.
dataCriacaostring
Momento de la aceptación (ISO-8601, UTC).
dataUltimaAlteracaostring
Último cambio de estado (ISO-8601, UTC).
numerointeger
Número del DC-e (nDC); presente a partir de la numeración.
seriestring
Serie del DC-e.
dataEmissaostring
Fecha/hora de emisión (ISO-8601).
chaveAcessostring
Clave de acceso de 44 dígitos; presente a partir de la numeración. Las posiciones 7-20 siempre llevan el CNPJ de la empresa de la plataforma.
dataAutorizacaostring
Momento de la autorización por la SEFAZ (ISO-8601).
linkDacestring
Enlace del DACE en PDF, renderizado bajo demanda por la chave (el enlace existe antes que el archivo; la primera descarga lo renderiza y archiva; mientras el servicio de renderizado no esté disponible la descarga devuelve 503, reintente más tarde). Tras la cancelación apunta a la versión re-renderizada con la marca de agua CANCELADA.
linkDownloadXmlstring
Enlace del XML dceProc (original legal).
protocoloobject
Protocolo de autorización.
emitidaEmContingenciaboolean
Siempre false en la fase uno.
remetenteobject
Eco del remitente enviado en la emisión (misma estructura que Emitir DC-e).
destinatarioobject
Eco del destinatario (misma estructura que la emisión). En el entorno de certificación el eco conserva el nombre original aunque el XML y el DACE lleven el texto fijo.
itensarray
Eco de las mercancías declaradas.
transporteobject
Eco de los datos de transporte.
autorizacaoDownloadXmlarray
Eco de los documentos autorizados a descargar el XML.
informacoesAdicionaisstring
Eco de la información adicional del marketplace.
informacoesAdicionaisFiscostring
Eco de la información adicional para la autoridad fiscal.
informacoesAdicionaisEmitentestring
Eco de la información complementaria del emisor.
observacoesMarketplacearray
Eco de las observaciones del marketplace.

Errores

Código	HTTP
DCe0001	404	`dceId` no encontrado o no pertenece a la empresa. Verifique el id y el `empresaId`.
10003000	404	`empresaId` no encontrado.

Valores de `status`

`status`	Significado
`Pendente`	Aceptado, en cola o en envío (`numero` / `chaveAcesso` aparecen tras la numeración)
`Autorizada`	Autorizado por la SEFAZ (cStat 100); `linkDownloadXml` es el original legal dceProc, `linkDace` el DACE en PDF renderizado bajo demanda por la chave, `protocolo` lleva número y digest. Si la última cancelación fue rechazada por la SEFAZ, `motivoStatus` lleva ese rechazo como `cStat - xMotivo` (mismo valor que `dceMotivoStatus` en el webhook `dce.cancel_rejected`); en caso contrario es `null`
`Negada`	Rechazado por la SEFAZ; `motivoStatus` es `cStat - xMotivo`
`CancelamentoPendente`	Cancelación aceptada, esperando el veredicto de la SEFAZ
`Cancelada`	Cancelado (110111); `linkDace` apunta a la versión re-renderizada con la marca de agua `CANCELADA`
`CancelamentoNegado`	Solo en el webhook: la SEFAZ rechazó la cancelación y el documento volvió a `Autorizada`; la consulta informa `Autorizada` con el motivo del rechazo en `motivoStatus`; puede enviarse de nuevo un DELETE corregido
`Falha`	Fallo terminal de la tarea (parámetros no interpretables, presupuesto de reintentos agotado, ...); `motivoStatus` lo explica; el mismo `id` puede reenviarse