DC-e

Consultar DC-e

Devolve status, protocolo, links de download do XML / DACE e o eco da requisição de emissão.

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

Requer os cabeçalhos de assinatura token, timestamp e sign, veja Autenticação.

Consulta o documento pelo id enviado na emissão. A seção de eco (remetente … observacoesMarketplace) vem do snapshot normalizado da requisição tirado na aceitação e continua disponível depois que a tarefa chega a um estado terminal. Os links de download têm o formato {base pública}/openapi/files/{kind}/{ref}?token=… (kind é xml ou dace); o token carrega a credencial, então não há cabeçalhos de assinatura, a validade vem da configuração do inquilino (padrão 7 dias) e os links são reassinados a cada consulta. Veja Download de arquivos.

Parâmetros

Parâmetros de caminho

empresaIdstringobrigatório
Identificador devolvido por Registrar empresa.
Exemplo: 1934811222334455
dceIdstringobrigatório
O id enviado na emissão.
Exemplo: DCe-000012333

Respostas

200

Documento encontrado. Os campos de fato do documento (numero, chaveAcesso, protocolo, links) vão sendo preenchidos conforme o status avança.

idstring
Id do documento no integrador.
ambientestring
Producao / Homologacao, conforme enviado na emissão.
Valores:ProducaoHomologacao
statusstring
Status do documento; veja a tabela de status abaixo.
Valores:PendenteAutorizadaNegadaCancelamentoPendenteCanceladaFalha
motivoStatusstring
Motivo do status: cStat - xMotivo em Negada, o motivo da falha em Falha, o motivo da última rejeição de cancelamento em Autorizada; caso contrário null.
dataCriacaostring
Momento da aceitação (ISO-8601, UTC).
dataUltimaAlteracaostring
Última alteração de status (ISO-8601, UTC).
numerointeger
Número do DC-e (nDC); presente a partir da numeração.
seriestring
Série do DC-e.
dataEmissaostring
Data/hora de emissão (ISO-8601).
chaveAcessostring
Chave de acesso de 44 dígitos; presente a partir da numeração. As posições 7-20 trazem sempre o CNPJ da empresa da plataforma.
dataAutorizacaostring
Momento da autorização pela SEFAZ (ISO-8601).
linkDacestring
Link do DACE em PDF, renderizado sob demanda pela chave (o link existe antes do arquivo; o primeiro download renderiza e arquiva; enquanto o serviço de renderização estiver indisponível o download devolve 503, tente de novo mais tarde). Após o cancelamento aponta para a versão re-renderizada com a marca d'água CANCELADA.
linkDownloadXmlstring
Link do XML dceProc (original legal).
protocoloobject
Protocolo de autorização.
emitidaEmContingenciaboolean
Sempre false na fase um.
remetenteobject
Eco do remetente enviado na emissão (mesma estrutura de Emitir DC-e).
destinatarioobject
Eco do destinatário (mesma estrutura da emissão). No ambiente de homologação o eco mantém o nome original, embora o XML e o DACE tragam o texto fixo.
itensarray
Eco das mercadorias declaradas.
transporteobject
Eco dos dados de transporte.
autorizacaoDownloadXmlarray
Eco dos documentos autorizados a baixar o XML.
informacoesAdicionaisstring
Eco das informações adicionais do marketplace.
informacoesAdicionaisFiscostring
Eco das informações adicionais para o fisco.
informacoesAdicionaisEmitentestring
Eco das informações complementares do emitente.
observacoesMarketplacearray
Eco das observações do marketplace.

Erros

Código	HTTP
DCe0001	404	`dceId` não encontrado ou não pertence à empresa. Verifique o id e o `empresaId`.
10003000	404	`empresaId` não encontrado.

Valores de `status`

`status`	Significado
`Pendente`	Aceito, na fila ou em envio (`numero` / `chaveAcesso` aparecem depois da numeração)
`Autorizada`	Autorizado pela SEFAZ (cStat 100); `linkDownloadXml` é o original legal dceProc, `linkDace` o DACE em PDF renderizado sob demanda pela chave, `protocolo` traz número e digest. Se o último cancelamento foi rejeitado pela SEFAZ, `motivoStatus` traz essa rejeição como `cStat - xMotivo` (mesmo valor de `dceMotivoStatus` no webhook `dce.cancel_rejected`); caso contrário é `null`
`Negada`	Rejeitado pela SEFAZ; `motivoStatus` é `cStat - xMotivo`
`CancelamentoPendente`	Cancelamento aceito, aguardando o veredito da SEFAZ
`Cancelada`	Cancelado (110111); `linkDace` aponta para a versão re-renderizada com a marca d'água `CANCELADA`
`CancelamentoNegado`	Somente no webhook: a SEFAZ rejeitou o cancelamento e o documento voltou a `Autorizada`; a consulta informa `Autorizada` com o motivo da rejeição em `motivoStatus`; um DELETE corrigido pode ser enviado de novo
`Falha`	Falha terminal da tarefa (parâmetros não interpretáveis, orçamento de retentativas esgotado, ...); `motivoStatus` explica; o mesmo `id` pode ser reenviado