Intervenientes Privados
Prévia.
Esta é uma prévia gerada a partir do branch r63-purus . Não é a documentação definitiva. A documentação da release atual pode ser acessada em https://docs.portalunico.siscomex.gov.br/ .
Notificação push - Setor privado
A seguir são especificados os eventos de interesse dos intervenientes privados (exportadores/importadores), relacionados ao fluxo de negócio dos LPCO (Licenças, Permissões, Certificados e Outros).
Para ter acesso aos eventos, os interessados devem utilizar a API de notificação.
Situação do LPCO alterada pelo anuente
Notificação enviada para o interveniente privado quando o órgão anuente altera a situação de um LPCO.
Identificador do evento: talp-altsit-lpco-anu
Exemplo de conteúdo enviado na notificação:
[
{
"dataEvento":"31/12/2021 12:00:00.000000",
"numeroLPCO":"E2100000000",
"justificativa":"Alterar a situação",
"novaSituacao":{
"id":"PARA_ANALISE",
"descricao":"Para análise"
},
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001"
}
]
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| dataEvento | Momento da ocorrência do evento | Texto(26) 'DD/MM/AAAA hh:mm:ss.SSSSSS' | JSON |
| numeroLPCO | Número do pedido de LPCO | Texto(11) | JSON |
| justificativa | Justificativa para a alteração da situação do LPCO | Texto | JSON |
| novaSituacao | Nova situação LPCO | - | JSON |
| id | Identificador da nova situação | Texto | JSON |
| descricao | Descrição da nova situação | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
Inclusão de exigência no LPCO
Notificação enviada para o interveniente privado quando o órgão anuente inclui uma exigência para o LPCO.
Identificador do evento: talp-inclusao-exig
Exemplo de conteúdo enviado na notificação:
[
{
"numero":1,
"numeroLPCO":"E2100000000",
"exigencia":"Informar no pedido o número do certificado.",
"dataExigencia":"31/12/2021 12:00",
"situacao":{
"id":"PENDENTE",
"descricao":"Pendente"
},
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"EM_EXIGENCIA",
"descricao":"Em exigência"
}
}
]
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da exigência associada ao LPCO | Número | JSON |
| numeroLPCO | Número do pedido de LPCO | Texto(11) | JSON |
| exigencia | Descrição da exigência | Texto | JSON |
| dataExigencia | Data, hora e minuto do registro da exigência | Texto(16) 'DD/MM/AAAA hh:mm' | JSON |
| situacao | Situação da exigência | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Cancelamento de exigência do LPCO
Notificação enviada para o interveniente privado quando o órgão anuente cancela uma exigência criada para o LPCO.
Identificador do evento: talp-cancela-exig
Exemplo de conteúdo enviado na notificação:
[
{
"numero":1,
"numeroLPCO":"E2100000000",
"exigencia":"Informar no pedido o número do certificado.",
"dataExigencia":"31/12/2021 12:00",
"dataCancelamento":"31/12/2021 14:00",
"justificativa":"Não é mais necessária a informação.",
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"PARA_ANALISE",
"descricao":"Para análise"
}
}
]
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| numero | Número da exigência associada ao LPCO | Número | JSON |
| numeroLPCO | Número do pedido de LPCO | Texto(11) | JSON |
| exigencia | Descrição da exigência | Texto | JSON |
| dataExigencia | Data, hora e minuto do registro da exigência | Texto(16) 'DD/MM/AAAA hh:mm' | JSON |
| situacao | Situação do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Resultado de análise de prorrogação do LPCO
Notificação enviada para o interveniente privado quando o órgão anuente conclui a análise do pedido de prorrogação de um LPCO.
Identificador do evento: talp-analise-prorrog
Exemplo de conteúdo enviado na notificação:
[
{
"dataEvento":"31/12/2021 12:00",
"numeroLPCO":"E2100000000",
"justificativa":"Este pedido de LPCo não pode ser prorrogado.",
"resultado":"INDEFERIDO",
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"DEFERIDO",
"descricao":"Deferido"
}
}
]
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| dataEvento | Data, hora e minuto da ocorrência do evento | Texto(16) 'DD/MM/AAAA hh:mm' | JSON |
| numeroLPCO | Número do LPCO | Texto(11) | JSON |
| justificativa | Justificativa para o resultado do pedido de prorrogação | Texto | JSON |
| resultado | Resultado do pedido de prorrogação | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Resultado de análise de retificação do LPCO
Notificação enviada para o interveniente privado quando o órgão anuente conclui a análise do pedido de retificação de um LPCO.
Identificador do evento: talp-analise-retif
Exemplo de conteúdo enviado na notificação:
[
{
"dataEvento":"31/12/2021 12:00",
"numeroLPCO":"E2100000000",
"justificativa":"Este pedido de LPCO não pode ser alterado.",
"resultado":"INDEFERIDO",
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"DEFERIDO",
"descricao":"Deferido"
}
}
]
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| dataEvento | Data, hora e minuto da ocorrência do evento | Texto(16) 'DD/MM/AAAA hh:mm' | JSON |
| numeroLPCO | Número do LPCO | Texto(11) | JSON |
| justificativa | Justificativa para o resultado do pedido de retificação | Texto | JSON |
| resultado | Resultado do pedido de retificação | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Resultado de análise de compatibilização de produto do LPCO
Notificação enviada para o interveniente privado quando o órgão anuente conclui a análise do pedido de compatibilização de produtos de um LPCO.
Identificador do evento: talp-analise-compat
Exemplo de conteúdo enviado na notificação:
[
{
"dataEvento":"31/12/2021 12:00",
"numeroLPCO":"E2100000000",
"justificativa":"As novas versões do produto podem ser utilizadas.",
"resultado":"DEFERIDO",
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"DEFERIDO",
"descricao":"Deferido"
}
}
]
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| dataEvento | Data, hora e minuto da ocorrência do evento | Texto(16) 'DD/MM/AAAA hh:mm' | JSON |
| numeroLPCO | Número do LPCO | Texto(11) | JSON |
| justificativa | Justificativa para o resultado do pedido de compatibilização | Texto | JSON |
| resultado | Resultado do pedido de compatibilização | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | texto | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Inclusão de mensagem no LPCO feita pelo anuente
Mensagem enviada pelo anuente para o importador/exportdor que ficará registrada no histórico do LPCO.
Identificador do evento: talp-msg-lpco-anu
Exemplo de conteúdo enviado na notificação:
{
"dataEvento":"2021-12-31T12:00.000-0300",
"numeroLPCO":"E2100000000",
"mensagem":"Informações do pedido estão sendo conferidas.",
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"DEFERIDO",
"descricao":"Deferido"
}
}
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| dataEvento | Data/hora da ocorrência do evento | Texto(28) 'AAAA-MM-DDThh:mm:ss.SSS-0300' | JSON |
| numeroLPCO | Número do pedido de LPCO | Texto(11) | JSON |
| mensagem | Mensagem a ser enviada ao importador/exportador | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Retificação automática em caso de nova versão de produto
Notificação enviada para o interveniente privado quando o pedido LPCO foi retificado automaticamente devido a nova versão de produto utilizado.
Identificador do evento: talp-retif-automat
Exemplo de conteúdo enviado na notificação:
{
"dataEvento":"2021-12-31T12:00.000-0300",
"numeroLPCO":"E2100000000",
"mensagem":"Pedido LPCO foi retificado automaticamente para utilização de nova versão do produto 000001.",
"cpfCnpj": ["00000000000000"],
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"DEFERIDO",
"descricao":"Deferido"
}
}
Campos enviados:
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| dataEvento | Data/hora da ocorrência do evento | Texto(28) 'AAAA-MM-DDThh:mm:ss.SSS-0300' | JSON |
| numeroLPCO | Número do pedido de LPCO | Texto(11) | JSON |
| mensagem | Mensagem explicando o motivo da retificação | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Falha na tentativa de pagamento de taxa
Notificação enviada para o interveniente privado quando ocorre uma falha no pagamento de taxa do LPCO.
Identificador do evento: talp-falha-pagamento
Exemplo de conteúdo enviado na notificação
{
"data":"2021-12-31T12:00.000-0300",
"numeroLPCO":"E2100000000",
"mensagem": "A tentativa de pagamento falhou ...",
"cpfCnpj": ["00000000000000"]
"momentoTaxa":"REGISTRO_LPCO",
"codigoModelo":"E00001",
"situacaoLPCO":{
"id":"DEFERIDO",
"descricao":"Deferido"
}
}
Campos enviados
| Nome | Descrição | Tipo | Local |
|---|---|---|---|
| data | Data em que ocorreu o erro | Texto(28) 'AAAA-MM-DDThh:mm:ss.SSS-0300' | |
| numeroLPCO | Número do pedido de LPCO | Texto(11) | JSON |
| mensagem | Mensagem do erro ocorrido | Texto | JSON |
| cpfCnpj | CPF ou CNPJ do importador/exportador | Texto(14) | JSON |
| momentoTaxa | Momento para o qual a taxa está sendo cobrada | Texto | JSON |
| codigoModelo | Código do modelo do LPCO | Texto(6) | JSON |
| situacaoLPCO | Situação atual do LPCO | - | JSON |
| id | Identificador da situação | Texto | JSON |
| descricao | Descrição da situação | Texto | JSON |
Alteração ou ativação de TA e modelo LPCO de exportação
Notificação enviada para o interveniente privado quando houver ativação de novo tratamento administrativo que requer LPCO ou alteração de configuração de um TA vigente ou dos campos do formulário LPCO, nos casos de TA de exportação.
Identificador do evento: talp-alter-ta-modelo-exp
Exemplo de conteúdo enviado na notificação:
{
"tipo":"ATIVACAO_MODELO",
"codigoModelo":"E00001",
"orgao":"DECEX",
"inicioVigenciaModelo":"01/01/2025 00:00:00.000-0300"
}
Alteração ou ativação de TA e modelo LPCO de importação
Notificação enviada para o interveniente privado quando houver ativação de novo tratamento administrativo que requer LPCO ou alteração de configuração de um TA vigente ou dos campos do formulário LPCO, nos casos de TA de importação.
Identificador do evento: talp-alter-ta-modelo-imp
Exemplo de conteúdo enviado na notificação:
{
"tipo":"ATIVACAO_MODELO",
"codigoModelo":"I00001",
"orgao":"DECEX",
"inicioVigenciaModelo":"01/01/2025 00:00:00.000-0300"
}
Produto usado em LPCO está desatualizado do catálogo
Notificação enviada para o interveniente privado quando uma alteração de produto do seu catálogo deixar algum LPCO seu desatualizado na versão deste produto.
Identificador do evento: talp-produto-catp-desatual
Exemplo de conteúdo enviado na notificação:
{
"dataEvento":"01/12/2021 14:00",
"numeroLPCO":"E2100000000",
"cpfCnpjRaiz":"00000000000",
"codigoProduto":1,
"versaoProduto": "1"
}