DC-e
Consultar DC-e
Devuelve estado, protocolo, enlaces de descarga del XML / DACE y el eco de la solicitud de emisión.
/openapi/v2/empresas/{empresaId}/dc-e/{dceId}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 de ruta
empresaId* | string | Identificador de la empresa emisora |
dceId* | string | Identificador del documento |
* Campo obligatorio
numero, chaveAcesso, protocolo, enlaces) se van rellenando conforme avanza el estado.id | string | Identificador de la solicitud |
ambiente | string | Ambiente |
status | string | Estado del documento |
motivoStatus | string | Motivo del estado |
dataCriacao | string | Momento de la aceptación |
dataUltimaAlteracao | string | Última modificación |
numero | int | Número del documento |
serie | string | Serie |
dataEmissao | string | Fecha de emisión |
chaveAcesso | string | Clave de acceso |
dataAutorizacao | string | Fecha de autorización |
linkDace | string | Enlace del DACE |
linkDownloadXml | string | Enlace del XML |
| object | Protocolo de autorización |
emitidaEmContingencia | bool | Emitida en contingencia |
remetente | object | Remitente |
destinatario | object | Destinatario |
itens | array | Ítems declarados |
transporte | object | Transporte |
autorizacaoDownloadXml | array | Autorizados a descargar el XML |
informacoesAdicionais | string | Observación del marketplace |
informacoesAdicionaisFisco | string | Observación al fisco |
informacoesAdicionaisEmitente | string | Observación del emisor |
observacoesMarketplace | array | Observaciones del marketplace |
ambienteAmbiente de emisión
| Valores | Significado |
|---|---|
| Homologacao | Ambiente de prueba de la SEFAZ; el documento no tiene validez |
| Producao | Ambiente oficial |
statusEstado del documento
El webhook tiene además CancelamentoNegado: la SEFAZ rechazó la cancelación y el documento volvió a Autorizada; la consulta devuelve Autorizada con el motivo en motivoStatus, y puede enviarse de nuevo una cancelación corregida.
| Valores | Significado |
|---|---|
| Pendente | Aceptado, en cola o en envío; numero y chaveAcesso aparecen tras la numeración |
| Autorizada | Autorizado por la SEFAZ; linkDownloadXml, linkDace y protocolo disponibles; si la última cancelación fue rechazada, motivoStatus trae el motivo |
| Negada | Rechazado por la SEFAZ; motivoStatus es el código y la descripción del rechazo |
| CancelamentoPendente | Cancelación aceptada, esperando el veredicto de la SEFAZ |
| Cancelada | Cancelado; linkDace apunta a la versión con la marca de agua CANCELADA |
| Falha | Fallo terminal de la tarea (parámetros no interpretables, reintentos agotados); motivoStatus lo explica; el mismo id puede reenviarse |
| Código | HTTP | |
|---|---|---|
| 10019002 | 404 | dceId no encontrado o no pertenece a la empresa. Verifique el id y el empresaId. |
| 10019003 | 404 | dceId no encontrado o no pertenece a la empresa. Verifique el id y el empresaId. |
| 10003000 | 404 | empresaId no encontrado. |
