DC-e
Consultar DC-e
Devolve status, protocolo, links de download do XML / DACE e o eco da requisição de emissão.
/openapi/v2/empresas/{empresaId}/dc-e/{dceId}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 de caminho
empresaId* | string | Identificador da empresa emitente |
dceId* | string | Identificador do documento |
* Campo obrigatório
numero, chaveAcesso, protocolo, links) vão sendo preenchidos conforme o status avança.id | string | Identificador da requisição |
ambiente | string | Ambiente |
status | string | Status do documento |
motivoStatus | string | Motivo do status |
dataCriacao | string | Momento da aceitação |
dataUltimaAlteracao | string | Última alteração |
numero | int | Número do documento |
serie | string | Série |
dataEmissao | string | Data de emissão |
chaveAcesso | string | Chave de acesso |
dataAutorizacao | string | Data de autorização |
linkDace | string | Link do DACE |
linkDownloadXml | string | Link do XML |
| object | Protocolo de autorização |
emitidaEmContingencia | bool | Emitida em contingência |
remetente | object | Remetente |
destinatario | object | Destinatário |
itens | array | Itens declarados |
transporte | object | Transporte |
autorizacaoDownloadXml | array | Autorizados a baixar o XML |
informacoesAdicionais | string | Observação do marketplace |
informacoesAdicionaisFisco | string | Observação ao fisco |
informacoesAdicionaisEmitente | string | Observação do emitente |
observacoesMarketplace | array | Observações do marketplace |
ambienteAmbiente de emissão
| Valores | Significado |
|---|---|
| Homologacao | Ambiente de teste da SEFAZ; o documento não tem validade |
| Producao | Ambiente oficial |
statusStatus do documento
O webhook tem ainda CancelamentoNegado: a SEFAZ rejeitou o cancelamento e o documento voltou a Autorizada; a consulta devolve Autorizada com o motivo em motivoStatus, e um cancelamento corrigido pode ser enviado de novo.
| Valores | Significado |
|---|---|
| Pendente | Aceito, na fila ou em envio; numero e chaveAcesso aparecem depois da numeração |
| Autorizada | Autorizado pela SEFAZ; linkDownloadXml, linkDace e protocolo disponíveis; se o último cancelamento foi rejeitado, motivoStatus traz o motivo |
| Negada | Rejeitado pela SEFAZ; motivoStatus é o código e a descrição da rejeição |
| CancelamentoPendente | Cancelamento aceito, aguardando o veredito da SEFAZ |
| Cancelada | Cancelado; linkDace aponta para a versão com a marca d'água CANCELADA |
| Falha | Falha terminal da tarefa (parâmetros não interpretáveis, retentativas esgotadas); motivoStatus explica; o mesmo id pode ser reenviado |
remetente.tipoPessoaTipo de pessoa
Também vale para destinatario.tipoPessoa.
| Valores | Significado |
|---|---|
| F | Pessoa física; cpfCnpj com 11 dígitos |
| J | Pessoa jurídica; cpfCnpj com 14 dígitos |
remetente.endereco.ufEstado do endereço
Também vale para destinatario.endereco.uf. Deve ser o estado do município em cidade, senão 10019011.
| Valores | Significado |
|---|---|
| AC | Acre |
| AL | Alagoas |
| AP | Amapá |
| AM | Amazonas |
| BA | Bahia |
| CE | Ceará |
| DF | Distrito Federal |
| ES | Espírito Santo |
| GO | Goiás |
| MA | Maranhão |
| MT | Mato Grosso |
| MS | Mato Grosso do Sul |
| MG | Minas Gerais |
| PA | Pará |
| PB | Paraíba |
| PR | Paraná |
| PE | Pernambuco |
| PI | Piauí |
| RJ | Rio de Janeiro |
| RN | Rio Grande do Norte |
| RS | Rio Grande do Sul |
| RO | Rondônia |
| RR | Roraima |
| SC | Santa Catarina |
| SP | São Paulo |
| SE | Sergipe |
| TO | Tocantins |
transporte.modalidadeModalidade de transporte
| Valores | Significado |
|---|---|
| PelosCorreios | Enviado pelos Correios |
| PorContaPropria | Levado por meios próprios do remetente |
| PorEmpresaTransportadora | Levado por uma transportadora; informe cnpjTransportadora |
| Código | HTTP | |
|---|---|---|
| 10019002 | 404 | dceId não encontrado ou não pertence à empresa. Verifique o id e o empresaId. |
| 10019003 | 404 | dceId não encontrado ou não pertence à empresa. Verifique o id e o empresaId. |
| 10003000 | 404 | empresaId não encontrado. |
