Intervenientes Privados
Notificação push - Intervenientes Privados - Duimp
A seguir são especificados os eventos de interesse dos Intervenientes Privados, relacionados ao fluxo de negócio da Duimp (Declaração Única de Importação).
Para ter acesso aos eventos, os interessados devem utilizar a API de notificação.
Orientações para identificação de problemas:
Para saber se houve algum problema na tentativa de envio de algum evento é possível utilizar o serviço de recuperação de falhas no envio de notificação.
A Documentação deste serviço pode ser encontrada no seguinte endereço: Verificação de Falhas
Adicionalmente também está disponível um serviço que lista suas subscrições atuais, onde será possível verificar se a url informada no momento da subscrição do evento está correta.
A documentação para este serviço está disponível no endereço: Consultar subscrições
Eventos da Duimp de interesse os Intervenientes Privados
A seguir, todos eventos da Duimp possíveis de notificação aos Intervenientes Privados, com seus respectivos identificadores:
-
Resultado da solicitação de diagnóstico dimp-diag-import
- Notificação enviada para toda requisição de diagnóstico via API.
-
Resultado da solicitação de registro de uma Duimp dimp-registro-import
- Notificação enviada para toda requisição de registro via API.
-
Resultado da solicitação da Retificação de uma Duimp dimp-retifica-import
- Notificação enviada para toda requisição de retificação via API.
-
Mudança no andamento da situação dimp-situacao-import
- Notificação iniciada a partir do momento em que uma versão da Duimp for efetivada via API.
-
Notificação de andamento do ICMS dimp-icms-import
- Notificação iniciada a partir do momento em que uma versão da Duimp for efetivada via API.
Resultado da solicitação de diagnóstico
Exemplos de conteúdo enviado na notificação:
{
"code": "DIMP-INXXXX",
"message": "A solicitação de Diagnóstico da sua Duimp foi concluída.",
"identificacao": {
"numero": "20BR00000000198",
"versao": "0"
},
"niImportador":"00000000000191",
"situacaoDuimp": "SituacaoDuimp-Enum",
"evento": ["Solicitação de Diganóstico"],
"dataEvento":"2020-04-28T14:50:29-0300",
"diagnostico": {
"situacao": "SituacaoDiagnostico-Enum",
"dataGeracao": "2020-04-28T14:50:29-0300",
"resultado": [
{
"tipo": "SeveridadeDiagnostico-Enum",
"item": "0",
"mensagem": {
"codigo": "01",
"texto": "xxxxx"
},
"sistemaOrigem": "yyyyyyy"
}
]
}
}
Campos enviados:
evento (root)
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| event-type | Nome do evento que está sendo notificado | Texto | header | |
| code | Código da mensagem | body | ||
| message | Descrição da mensagem | Texto | body | |
| identificacao | Identificação da Duimp | Identificação | body | |
| niImportador | Número de identificação do Importador | Texto | body | |
| situacaoDuimp | Situação da Duimp | Enum | body | EM_ELABORACAO, ELABORADA_AGUARDANDO_VINCULACAO_CARGA, ELABORADA_AGUARDANDO_PCCE, ELABORADA_AGUARDANDO_DESVINCULACAO_CARGA, SOLICITACAO_RETIFICACAO_EM_ELABORACAO, SOLICITACAO_RETIFICACAO_AGUARDANDO_VINCULACAO_CARGA_NOVA, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_ANTIGA, SOLICITACAO_RETIFICACAO_AGUARDANDO_PAGAMENTO, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_NOVA, REGISTRADA_AGUARDANDO_CANAL, EM_CONFERENCIA_SELECIONADA, DESEMBARACADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, DESEMBARACADA_AGUARDANDO_ENTREGA_CARGA, DESEMBARACADA_CARGA_ENTREGUE, ENTREGA_ANTECIPADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, ENTREGA_ANTECIPADA_AGUARDANDO_ENTREGA_CARGA, ENTREGA_ANTECIPADA_CARGA_ENTREGUE, CANCELADA_PELA_ADUANA, CANCELADA_POR_APURACAO, ELABORADA_AGUARDANDO_PROCESSAMENTO_DRAWBACK, ELABORADA_AGUARDANDO_ROLLBACK_PROCESSAMENTO_DRAWBACK, SOLICITACAO_RETIFICACAO_AGUARDANDO_PROCESSAMENTO_DRAWBACK, SOLICITACAO_RETIFICACAO_AGUARDANDO_ROLLBACK_PROCESSAMENTO_DRAWBACK |
| evento | Descrição do evento da notificação | Texto | body | |
| dataEvento | Data do evento da notificação | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
| diagnostico | Diagnóstico gerado | Diagnóstico | body |
Identificação
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da declaração | texto(15) | body |
| versao | Versão da declaração | Numérico(4) | body |
Diagnóstico
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| situacao | Situação do diagnóstico | Enum | body | NAO_SOLICITADO, EM_PROCESSAMENTO, PROCESSADO_OK, PROCESSADO_ALERTA_NAO_IMPEDITIVO, PROCESSADO_ALERTA_NAO_IMPEDITIVO_AGUARDANDO_USUARIO, PROCESSADO_ERRO_NAO_IMPEDITIVO, PROCESSADO_ERRO_NAO_IMPEDITIVO_AGUARDANDO_USUARIO,PROCESSADO_ERRO_IMPEDITIVO, NAO_CONCLUIDO_FALHA_PROCESSAMENTO, EM_PROCESSAMENTO_AGUARDANDO_DWBK |
| dataGeracao | Data de geração do diagnóstico | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
| resultado | Resultado do diagnóstico | Lista Resultado | body |
Resultado
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| tipo | Severidade do item do diagnóstico | Enum | body | MENSAGEM_ALERTA, ERRO_NAO_IMPEDITIVO, ERRO_IMPEDITIVO, ERRO_IMPEDITIVO_EXCETO_PROCESSO_JUDICIAL, ERRO_IMPEDITIVO_EXCETO_PRELIMINAR, ERRO_IMPEDITIVO_EXCETO_PROCESSO_JUDICIAL_PRELIMINAR |
| item | Número do item da Duimp ou 00000 (para erro nos dados gerais) onde o erro ocorreu | Numérico | body | |
| mensagem | Mensagem de erro/alerta do item do diagnóstico | Mensagem | body | |
| sistemaOrigem | Origem do erro/alerta | Texto | body |
Mensagem
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| codigo | Código da mensagem | Texto | body |
| texto | Descrição da mensagem | Texto | body |
Resultado da solicitação de registro de uma Duimp
Exemplos de conteúdo enviado na notificação:
{
"registroIniciado":true,
"code": "DIMP-INXXXX",
"message": "A solicitação de registro de sua Duimp sem alertas e erros foi concluída.",
"identificacao": {
"numero": "20BR00000000198",
"versao": "0"
},
"niImportador":"00000000000191",
"situacaoDuimp": "SituacaoDuimp-Enum",
"evento": ["Solicitação de Registro"],
"dataEvento":"2020-04-28T14:50:29-0300",,
"diagnostico": {
"situacao": "SituacaoDiagnostico-Enum",
"dataGeracao": "2020-04-28T14:50:29-0300",,
}
}
Campos enviados:
evento (root)
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| event-type | Nome do evento que está sendo notificado | Texto | header | |
| registroIniciado | Indicador de início do processo de registro da Duimp | Boolean | body | |
| code | Código da mensagem | body | ||
| message | Descrição da mensagem | Texto | body | |
| identificacao | Identificação da Duimp | Identificação | body | |
| niImportador | Número de identificação do Importador | Texto | body | |
| situacaoDuimp | Situação da Duimp | Enum | body | EM_ELABORACAO, ELABORADA_AGUARDANDO_VINCULACAO_CARGA, ELABORADA_AGUARDANDO_PCCE, ELABORADA_AGUARDANDO_DESVINCULACAO_CARGA, SOLICITACAO_RETIFICACAO_EM_ELABORACAO, SOLICITACAO_RETIFICACAO_AGUARDANDO_VINCULACAO_CARGA_NOVA, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_ANTIGA, SOLICITACAO_RETIFICACAO_AGUARDANDO_PAGAMENTO, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_NOVA, REGISTRADA_AGUARDANDO_CANAL, EM_CONFERENCIA_SELECIONADA, DESEMBARACADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, DESEMBARACADA_AGUARDANDO_ENTREGA_CARGA, DESEMBARACADA_CARGA_ENTREGUE, ENTREGA_ANTECIPADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, ENTREGA_ANTECIPADA_AGUARDANDO_ENTREGA_CARGA, ENTREGA_ANTECIPADA_CARGA_ENTREGUE, CANCELADA_PELA_ADUANA, CANCELADA_POR_APURACAO |
| evento | Descrição do evento da notificação | Texto | body | |
| dataEvento | Data do evento da notificação | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
| diagnostico | Diagnóstico gerado | Diagnóstico | body |
Identificação
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da declaração | texto(15) | body |
| versao | Versão da declaração | Numérico(4) | body |
Diagnóstico
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| situacao | Situação do diagnóstico | Enum | body | NAO_SOLICITADO, EM_PROCESSAMENTO, PROCESSADO_OK, PROCESSADO_ALERTA_NAO_IMPEDITIVO, PROCESSADO_ALERTA_NAO_IMPEDITIVO_AGUARDANDO_USUARIO, PROCESSADO_ERRO_NAO_IMPEDITIVO, PROCESSADO_ERRO_NAO_IMPEDITIVO_AGUARDANDO_USUARIO,PROCESSADO_ERRO_IMPEDITIVO, NAO_CONCLUIDO_FALHA_PROCESSAMENTO |
| dataGeracao | Data de geração do diagnóstico | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
Resultado da solicitação da Retificação de uma Duimp
Exemplos de conteúdo enviado na notificação:
{
"registroIniciado":true,
"code": "DIMP-INXXXX",
"message": "A solicitação de registro de sua Duimp sem alertas e erros foi concluída.",
"identificacao": {
"numero": "20BR00000000198",
"versao": "0"
},
"niImportador":"00000000000191",
"situacaoDuimp": "SituacaoDuimp-Enum",
"evento": ["Solicitação de Registro"],
"dataEvento":"2020-04-28T14:50:29-0300",,
"diagnostico": {
"situacao": "SituacaoDiagnostico-Enum",
"dataGeracao": "2020-04-28T14:50:29-0300",,
}
}
Campos enviados:
evento (root)
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| event-type | Nome do evento que está sendo notificado | Texto | header | |
| registroIniciado | Indicador de início do processo de registro da Duimp | Boolean | body | |
| code | Código da mensagem | body | ||
| message | Descrição da mensagem | Texto | body | |
| identificacao | Identificação da Duimp | Identificação | body | |
| niImportador | Número de identificação do Importador | Texto | body | |
| situacaoDuimp | Situação da Duimp | Enum | body | EM_ELABORACAO, ELABORADA_AGUARDANDO_VINCULACAO_CARGA, ELABORADA_AGUARDANDO_PCCE, ELABORADA_AGUARDANDO_DESVINCULACAO_CARGA, SOLICITACAO_RETIFICACAO_EM_ELABORACAO, SOLICITACAO_RETIFICACAO_AGUARDANDO_VINCULACAO_CARGA_NOVA, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_ANTIGA, SOLICITACAO_RETIFICACAO_AGUARDANDO_PAGAMENTO, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_NOVA, REGISTRADA_AGUARDANDO_CANAL, EM_CONFERENCIA_SELECIONADA, DESEMBARACADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, DESEMBARACADA_AGUARDANDO_ENTREGA_CARGA, DESEMBARACADA_CARGA_ENTREGUE, ENTREGA_ANTECIPADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, ENTREGA_ANTECIPADA_AGUARDANDO_ENTREGA_CARGA, ENTREGA_ANTECIPADA_CARGA_ENTREGUE, CANCELADA_PELA_ADUANA, CANCELADA_POR_APURACAO |
| evento | Descrição do evento da notificação | Texto | body | |
| dataEvento | Data do evento da notificação | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
| diagnostico | Diagnóstico gerado | Diagnóstico | body |
Identificação
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da declaração | texto(15) | body |
| versao | Versão da declaração | Numérico(4) | body |
Diagnóstico
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| situacao | Situação do diagnóstico | Enum | body | NAO_SOLICITADO, EM_PROCESSAMENTO, PROCESSADO_OK, PROCESSADO_ALERTA_NAO_IMPEDITIVO, PROCESSADO_ALERTA_NAO_IMPEDITIVO_AGUARDANDO_USUARIO, PROCESSADO_ERRO_NAO_IMPEDITIVO, PROCESSADO_ERRO_NAO_IMPEDITIVO_AGUARDANDO_USUARIO,PROCESSADO_ERRO_IMPEDITIVO, NAO_CONCLUIDO_FALHA_PROCESSAMENTO |
| dataGeracao | Data de geração do diagnóstico | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
Mudança no andamento da situação
Exemplos de conteúdo enviado na notificação:
{
"code": "DIMP-INXXXX",
"message": "A sua Duimp se encontra em conferência.",
"identificacao": {
"numero": "20BR00000000198",
"versao": "1"
},
"niImportador":"00000000000191",
"situacaoDuimp": "SituacaoDuimp-Enum",
"evento": ["Solicitação de Registro"],
"dataEvento":"2020-04-28T14:50:29-0300",
"canal":"VERMELHO",
}
Campos enviados:
evento (root)
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| event-type | Nome do evento que está sendo notificado | Texto | header | |
| code | Código da mensagem | body | ||
| message | Descrição da mensagem | Texto | body | |
| identificacao | Identificação da Duimp | Identificação | body | |
| niImportador | Número de identificação do Importador | Texto | body | |
| situacaoDuimp | Situação da Duimp | Enum | body | EM_ELABORACAO, ELABORADA_AGUARDANDO_CRIACAO_ESTOQUE, ELABORADA_AGUARDANDO_EXCLUSAO_ESTOQUE, ELABORADA_AGUARDANDO_VINCULACAO_CARGA, ELABORADA_AGUARDANDO_PCCE, ELABORADA_AGUARDANDO_DESVINCULACAO_CARGA, ELABORADA_AGUARDANDO_PROCESSAMENTO_DRAWBACK, SOLICITACAO_RETIFICACAO_EM_ELABORACAO, SOLICITACAO_RETIFICACAO_AGUARDANDO_VINCULACAO_CARGA_NOVA, SOLICITACAO_RETIFICACAO_AGUARDANDO_PROCESSAMENTO_DRAWBACK, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_ANTIGA, SOLICITACAO_RETIFICACAO_AGUARDANDO_PAGAMENTO, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_NOVA, REGISTRADA_AGUARDANDO_CANAL, EM_CONFERENCIA_SELECIONADA, DESEMBARACADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, DESEMBARACADA_AGUARDANDO_ENTREGA_CARGA, DESEMBARACADA_CARGA_ENTREGUE, ENTREGA_ANTECIPADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, ENTREGA_ANTECIPADA_AGUARDANDO_ENTREGA_CARGA, ENTREGA_ANTECIPADA_CARGA_ENTREGUE, CANCELADA_PELA_ADUANA, CANCELADA_POR_APURACAO |
| evento | Descrição do evento da notificação | Texto | body | |
| dataEvento | Data do evento da notificação | Data | body | Formato ISO: AAAA-MM-DDTHH:mm:ssZ |
| Canal | Canal da Duimp | Enum | body | VERDE, AMARELO, VERMELHO, CINZA |
Identificação
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da declaração | texto(15) | body |
| versao | Versão da declaração | Numérico(4) | body |
Notificação de andamento do ICMS
Exemplos de conteúdo enviado na notificação:
{
"dataEvento" : "2021-04-29T12:28:07-0300",
"code" : "DIMP-IN8940",
"message" : "A sua Duimp teve o ICMS declarado.",
"identificacao" : {
"numero" : "21BR1234",
"versao" : "1"
},
"niImportador":"00000000000191",
"situacaoDuimp" : "DESEMBARACADA_AGUARDANDO_ENTREGA_CARGA",
"evento" : "Notificação de andamento do ICMS."
}
Campos enviados:
evento (root)
| Nome | Descrição | Tipo | Local | Detalhes |
|---|---|---|---|---|
| event-type | Nome do evento que está sendo notificado | Texto | header | |
| dataEvento | Data do evento da notificação | Data | body | |
| code | Código da mensagem | body | ||
| message | Descrição da mensagem | Texto | body | |
| identificacao | Identificação da Duimp | Identificação | body | |
| niImportador | Número de identificação do Importador | Texto | body | |
| situacaoDuimp | Situação da Duimp | Enum | body | EM_ELABORACAO, ELABORADA_AGUARDANDO_VINCULACAO_CARGA, ELABORADA_AGUARDANDO_PCCE, ELABORADA_AGUARDANDO_DESVINCULACAO_CARGA, SOLICITACAO_RETIFICACAO_EM_ELABORACAO, SOLICITACAO_RETIFICACAO_AGUARDANDO_VINCULACAO_CARGA_NOVA, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_ANTIGA, SOLICITACAO_RETIFICACAO_AGUARDANDO_PAGAMENTO, SOLICITACAO_RETIFICACAO_AGUARDANDO_DESVINCULACAO_CARGA_NOVA, REGISTRADA_AGUARDANDO_CANAL, EM_CONFERENCIA_SELECIONADA, DESEMBARACADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, DESEMBARACADA_AGUARDANDO_ENTREGA_CARGA, DESEMBARACADA_CARGA_ENTREGUE, ENTREGA_ANTECIPADA_AGUARDANDO_PENDENCIA_TRIBUTOS_ESTADUAIS, ENTREGA_ANTECIPADA_AGUARDANDO_ENTREGA_CARGA, ENTREGA_ANTECIPADA_CARGA_ENTREGUE, CANCELADA_PELA_ADUANA, CANCELADA_POR_APURACAO |
| evento | Descrição do evento da notificação | Texto | body |
Identificação
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da declaração | texto(15) | body |
| versao | Versão da declaração | Numérico(4) | body |