NAV Navbar
Marca pucomex
shell

Introdução

Bem-vindo à API do Portal Único Siscomex (PUCOMEX). Consolidamos nessa página as informações técnicas da nova forma de integração entre o PUCOMEX e os sistemas próprios das empresas privadas e os diversos órgãos públicos intervenientes de Comércio Exterior.

No PUCOMEX, todos os serviços seguem o mesmo protocolo de acesso, baseado no padrão SSL/TLS e no uso de certificado digital. A API do Portal foi desenvolvida baseada na arquitetura REST. Serão utilizados os formatos XML e JSON, sendo que alguns serviços serão disponibilizados exclusivamente no formato XML, tendo sua estrutura especificada na sintaxe XSD (XML Schema Definition). Estes schemas serão disponibilizados para facilitar a validação e construção dos clientes consumidores dos serviços. Além disso, toda a nossa API usará o formato UTF-8.

Destacamos que o sistema foi implementado recentemente para as empresas privadas prepararem as adaptações necessárias em seus sistemas, podendo ainda ocorrer instabilidades pontuais. Caso haja dúvidas relacionadas ao Novo Processo de Exportações, envie-as ao Comex Responde (campo “Assunto Geral” opção “Sistemas e ferramentas de apoio” e campo “Assunto Específico” opção “Portal Único Siscomex”).

Para problemas relacionados à TI entre em contato com a Central Serpro de Atendimento (no campo de “Serviço” escolher a opção “PORTAL ÚNICO SISCOMEX - PUCOMEX”).

Esperamos que o PUCOMEX melhore os processos de negócios das empresas e dos intervenientes públicos, aumentando a competitividade, aumentando a qualidade e tempo de atendimento a sociedade e diminuindo os custos acessórios envolvidos.

Observação: Favor atentar que alguns serviços marcados com o texto: "Funcionalidade ainda não disponível nos ambientes de Validação das Empresas e Produção" ainda estão em processo de construção. Assim que os mesmos estiverem disponíveis em ambiente de validação e produção, os interessados serão informados e os textos excluídos das funcionalidades.

URLs de acesso

Abaixo estão descritas as URLs base da API por ambiente (usaremos a tag <url> para referenciá-las).

Ambiente de Validação das Empresas:

Ambiente de Produção:

Autenticação

A segurança do portal é baseada em SSL/TLS, sendo obrigatória a utilização de certificados digitais. Ao acionar o serviço de autenticação, será preciso realizar o processo de handshake SSL entre a aplicação cliente e o portal, apresentando um certificado digital válido e reconhecido pelo SERPRO. Após a validação do certificado, o portal consultará a base autorizativa a fim de identificar o perfil do usuário proprietário do certificado digital. O serviço suporta certificados A1 e A3, do padrão ICP-Brasil.

As plataformas de desenvolvimento atuais já implementam o fluxo de Handshake SSL/TLS. Em geral, basta configurar algumas variáveis de ambiente e a API se encarrega de executar o protocolo. Em resumo, o processo acontece da seguinte forma:

1. O cliente inicia o pedido de conexão com o serviço;

2. O serviço retorna o seu certificado assinado para que seja verificado pelo cliente;

3. O cliente verifica a sequência de cadeias de autoridades certificadoras presentes no certificado e compara com as cadeias presentes na TrustStore local. As cadeias de certificados podem ser encontradas no link “Baixar Cadeia”, no seguinte local: https://ccd.serpro.gov.br/serproacf Cadeia de Certificados emitida em 21/11/2011 com Algoritmos SHA2.

4. O cliente envia o seu certificado encapsulado em uma Keystore para que seja reconhecido pelo servidor;

5. O servidor valida o certificado do cliente;

6. O processo de handshake é finalizado e o cliente pode realizar a requisição ao serviço.

Fluxo de acionamento do serviço de autenticação:

alt text

Endpoint:

POST https://<url>/portal/api/autenticar

Atributos:

Nome Descrição Tipo do dado Tipo do Parâmetro
Role-Type Perfil para o qual se deseja efetuar a autenticação. string, obrigatório header

Lista de perfis disponíveis:

Nome Descrição
IMPEXP Declarante importador/exportador
DEPOSIT Depositário
OPERPORT Operador Portuário
TRANSPORT Transportador
AGEREMESS Remessa Expressa/Correio
AJUDESPAC Ajudante de Despachante
HABILITAD Habilitador
PUBLICO Público

Atributos do retorno:

Os seguintes atributos serão retornados no cabeçalho da resposta:

Nome Descrição Tipo
Set-Token JSON Web Token (JWT) contendo as informações do usuário. Conforme o padrão JWT, esse token poderá ser decodificado (Base64) a fim de se extrair as informações do usuário para que as mesmas sejam utilizadas na aplicação cliente. O token é assinado digitalmente pelo servidor e verificado a cada requisição, garantindo a sua inviolabilidade. string
X-CSRF-Token Token de prevenção contra ataques CSRF (Cross-Site Request Forgery). Ao contrário do JWT, esse token é criptografado e pode ser decodificado apenas no servidor. O token possui um tempo de vida de 60 minutos. A cada nova requisição, para qualquer endpoint do Portal, o token é gerado novamente pelo servidor e devolvido no header do response com o tempo de expiração renovado. Dessa forma, a cada nova requisição, dentro do prazo de 60 minutos, utilize o token renovado que foi recebido na requisição anterior, sem precisar chamar novamente o endpoint de autenticação. string
X-CSRF-Expiration Data de expiração do X-CSRF-Token, em milisegundos. Após essa data, o token não será mais aceito no servidor. string

Erros da Autenticação:

Código Mensagem Observações
PUCX-ER0101 O cabeçalho ‘Role-Type’ não está na requisição
PUCX-ER0102 O cabeçalho 'Role-Type’ é inválido. Verifique a tabela de domínio no manual de integração.
PLAT-ER2001 Não foi possível identificar um certificado digital válido. A autenticação SSL/TLS não foi efetuada com sucesso.
PLAT-ER2004 Não foi possível efetuar a consulta de representações do usuário. Instabilidade no Serviço Único (SUCE). Se possível aguarde alguns instantes e repita a operação. Se o problema persistir entre em contato com o administrador do sistema.
PLAT-ER2002 Ocorreu um erro na autenticação do usuário. Entre em contato com o administrador do sistema. Mensagem de retorno: Mensagem de erro retornada pelo Serviço Único (SUCE). Em caso de dúvida, entre em contato com o administrador do sistema.

Atributos da resposta quando o resultado for 4xx ou 5xx:

Exemplo da estrutura de resposta de erro no formato JSON

{
   "message":"O cabeçalho 'Role-Type' não está na requisição.",
   "code":"PUCX-ER0101",
   "tag":"[081454RXF]",
   "status":422,
   "severity":"ERROR"
}
Nome Descrição Tipo
message Mensagem de erro string
code Código que identifica o erro string
tag Tag do registro de log (para ser informado na abertura de chamado à central de suporte) string
status Código do status HTTP. Mesmo código retornado no HTTP Status Code da resposta. string

Atributos obrigatórios em todas as requisições após autenticação:

Nome Descrição Tipo Local
Authorization JSON Web Token (JWT) contendo as informações do usuário. Este token é recuperado no parâmetro Set-Token no response da autenticação string header
X-CSRF-Token Token de prevenção contra ataques CSRF (Cross-Site Request Forgery). Este token é recuperado no parâmetro X-CSRF-Token no response da autenticação string header

Status Codes

A API do Portal retornará sempre um HTTP status code para indicar sucesso ou falha de uma requisição.

Código Descrição
200 Operação realizada com sucesso
201 Criado
204 Sem conteúdo
400 Requisição mal formatada
401 Requisição requer autenticação
403 Requisição não autorizada
404 Registro não encontrado
422 Erro de negócio
500 Erro interno do servidor
503 Serviço indisponível

Carga

Entregar por Contêiner

Exemplo de entrada:

<entregasConteineres
    xmlns='http://www.pucomex.serpro.gov.br/cct'>
    <entregaConteiner>
        <identificacaoEntrega>611504718</identificacaoEntrega>
        <identificacaoPessoaJuridica>07396865000168</identificacaoPessoaJuridica>
        <local>
            <codigoRA>7911101</codigoRA>
        </local>
        <conteineres>
            <conteiner>
                <numeroConteiner>00I5TKzi4Z</numeroConteiner>
                <tara>1500.252</tara>
                <lacres>
                    <lacre>ABC123</lacre>
                </lacres>
                <pesoAferido>1600.000</pesoAferido>
            </conteiner>
        </conteineres>
        <recebedor>
            <cnpj>27657485000147</cnpj>
            <viaTransporte>04</viaTransporte>
            <transitoSimplificado>
                <codigoRADestino>7911101</codigoRADestino>
                <veiculoFerroviario>
                    <prefixoTrem>ABC1234</prefixoTrem>
                    <quantidadeVagoes>2</quantidadeVagoes>
                </veiculoFerroviario>
            </transitoSimplificado>
        </recebedor>
        <avariasIdentificadas>SEM AVARIAS</avariasIdentificadas>
        <divergenciasIdentificadas>SEM DIVERGENCIAS</divergenciasIdentificadas>
        <observacoesGerais>TESTE SOAP AUTOMATIZADO</observacoesGerais>
    </entregaConteiner>
</entregasConteineres>

Endpoint:

POST https://<url>/cct/api/ext/carga/entrega-conteiner

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
entregasConteineres Entregas por Contêineres Coleção de entregaConteiner, obrigatório body XSD para download

Entrega por Contêiner - entregaConteiner:

Nome Descrição Tipo Detalhes
identificacaoEntrega Identificação da entrega string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
identificacaoPessoaJuridica CNPJ do responsável pela entrega string(14), obrigatório
local Dados do local da entrega object local, obrigatório
conteineres Lista dos contêineres a serem entregues Coleção de conteiner, obrigatório
recebedor Dados do interveniente que está recebendo a carga object recebedor, obrigatório
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações adicionais string(250), opcional

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da unidade da Receita Federal onde a recepção está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Unidades da RFB. (*) Deve ser informado apenas quando o receptor não for um depositário.
codigoRA Código do recinto alfandegado onde a recepção está sendo efetuada numeric(7), obrigatório* Domínio: Tabela de recintos aduaneiros. (*) Deve ser informado apenas quando o receptor for um depositário.
coordenadas Dados das coordenadas geográficas do local da recepção object coordenadas, obrigatório (*) Deve ser informado apenas quando o receptor não for um depositário.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Recebedor - recebedor

Nome Descrição Tipo Detalhes
cnpj CNPJ do recebedor numeric(14), obrigatório Informado apenas quando o recebedor for nacional e pessoa jurídica.
cpf CPF do recebedor numeric(11), obrigatório Informado apenas quando o recebedor for nacional e pessoa física.
nomeEstrangeiro Nome do recebedor string(60), obrigatório Informado apenas quando o recebedor for estrangeiro.
viaTransporte Código da via de transporte numeric(02), opcional
baldeacaoOuTransbordo Indicador de baldeação ou transbordo string(1), opcional Domínio: S (Sim), N (Não). Quando este atributo for preenchido com ’S’ fica configurada a situação de trânsito especial. Deve ser informado como ’S’ apenas quando um depositário de uma recinto de zona primária (ou um operador portuário) estiver entregando a carga para um transportador de via aérea ou aquaviária. Não pode ser informado junto com o Trânsito Simplificado.
transitoSimplificado Conjunto de informações obrigatórias ao informar Trânsito Simplificado object transitoSimplificado, opcional Não pode ser informado junto com o Indicador de baldeação ou transbordo

Contêiner - conteiner:

Nome Descrição Tipo Detalhes
numeroConteiner Identificação string(11), obrigatório Não será permitida a inclusão de contêineres duplicados.
tara Tara em Kg numeric(9,3), obrigatório
lacres Lacres aplicados string(15), obrigatório Máximo 4 lacres diferentes entre si.
pesoBruto Peso bruto aferido numeric(9,3), obrigatório (*) informado e obrigatório apenas quando não foi informado um motivo para o não aferimento do peso.
motivoNaoPesagem Descrição do motivo de não realização da pesagem do contêiner string(250), obrigatório (*) informado e obrigatório apenas quando não foi informado o peso bruto aferido para o contêiner.

Transito Simplificado - transitoSimplificado

Nome Descrição Tipo Detalhes
codigoRADestino Código do Recinto Aduaneiro do local de destino do trânsito numeric(7), opcional Deve ser informado quando não for informada a Unidade da Receita Federal de destino
codigoURFDestino Código da Unidade da Receita Federal do local de destino do trânsito numeric(7), opcional Deve ser informado junto com o CNPJ Responsável do Destino quando não for informado o Recinto Aduaneiro
cnpjRespDestino CNPJ do responsável do local de destino do trânsito numeric(14), opcional Deve ser informado junto com o código da Unidade da Receita Federal no destino quando não for informado o Recinto Aduaneiro
veiculoRodoviario Definição do tipo de veículo object veiculoRodoviario Ao informar a tag veiculoRodoviario, a tag veiculoFerroviario não poderá ser informada.
veiculoFerroviario Definição do tipo de veículo object veiculoFerroviario Ao informar a tag veiculoFerroviario, a tag veiculoRodoviario não poderá ser informada.

Veículo Rodoviário - veiculoRodoviario

Nome Descrição Tipo Detalhes
cpfCondutor CPF do condutor numeric(11), opcional Informado quando o condutor for brasileiro
documentoCondutorEstrangeiro Documento de identificação do condutor estrangeiro string(15), opcional Informado quando o condutor for estrangeiro juntamente com o nome do condutor
nomeCondutorEstrangeiro Nome do condutor estrangeiro string(60), opcional Informado quando o condutor for estrangeiro juntamente com o documento do condutor
veiculos Informação de cada veiculo envolvido no trânsito Coleção de veiculo Máximo de 4 veículos diferentes entre si. Esta tag contém os dados do “cavalo” e seus reboques e será obedecida a seguinte ordem nas informações de veículo rodoviário quando informado : Truck/Cavalo, 1º Reboque, 2º Reboque e 3º Reboque;

Veículo - veiculo

Nome Descrição Tipo Detalhes
placa Identificação da placa do veículo do rodoviário string(15) , obrigatório
lacres Lacres aplicados ao veículo Coleção de string (15), opcional Máximo 4 lacres diferentes entre si.

Veículo Ferroviário - veiculoFerroviario

Nome Descrição Tipo Detalhes
prefixoTrem Identificação do trem string(15), obrigatório
quantidadeVagoes Número de vagões envolvidos no transporte numeric(3) , obrigatório de 1 até 999

Entregar Carga por DU-E/RUC

Exemplo: Entrega por DU-E com carga Solta, Granel e sem embalagem:

<entregasDocumentoCarga
    xmlns='http://www.pucomex.serpro.gov.br/cct'>
    <entregaDocumentoCarga>
        <identificacaoEntrega>ENT001</identificacaoEntrega>
        <identificacaoPessoaJuridica>15578569000106</identificacaoPessoaJuridica>
        <local>
            <codigoURF>0817600</codigoURF>
            <codigoRA>8911101</codigoRA>
        </local>
        <documentos>
            <documento>
                <numeroDUE>16BR0000076499</numeroDUE>
                <cargaSoltaVeiculo>
                    <carga>
                        <tipoEmbalagem>19</tipoEmbalagem>
                        <total>2000</total>
                        <quantidade>2000</quantidade>
                    </carga>
                    <carga>
                        <total>10</total>
                        <quantidade>2</quantidade>
                    </carga>
                </cargaSoltaVeiculo>
                <granel>
                    <carga>
                        <tipoGranel>10</tipoGranel>
                        <unidademedida>kg</unidademedida>
                        <total>1.000</total>
                        <quantidade>1.000</quantidade>
                    </carga>
                </granel>
            </documento>
        </documentos>
        <recebedor>
            <cnpj>02012862000160</cnpj>
            <viaTransporte>07</viaTransporte>
            <transitoSimplificado>
                <codigoURFDestino>0817800</codigoURFDestino>
                <cnpjRespDestino>44837524000107</cnpjRespDestino>
                <veiculoRodoviario>
                    <cpfCondutor>00475185123</cpfCondutor>
                    <veiculos>
                        <veiculo>
                            <placa>TRK0099</placa>
                            <lacres>
                                <lacre>TRK001</lacre>
                            </lacres>
                        </veiculo>
                    </veiculos>
                </veiculoRodoviario>
            </transitoSimplificado>
        </recebedor>
        <pesoAferido>10.000</pesoAferido>
    </entregaDocumentoCarga>
</entregasDocumentoCarga>

Endpoint:

POST https://<url>/cct/api/ext/carga/entrega-due-ruc

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
entregasDocumentoCarga Entrega por Documento de Carga Coleção de entregaDocumentoCarga body XSD para download

Entrega por Documento de Carga - entregaDocumentoCarga

Nome Descrição Tipo Detalhes
identificacaoEntrega Identificação da Entrega string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada entrega no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
identificacaoPessoaJuridica CNPJ do responsável pela Entrega numeric(14), obrigatório Formato: 99999999999999
local Dados do local da entrega object local, obrigatório
documentos documentos de carga envolvidos na entrega (DU-E / RUC) Coleção de documento, obrigatório
recebedor Dados do recebedor da carga object recebedor, obrigatório
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.

Local - local

Nome Descrição Tipo Detalhes
codigoURF Código da unidade da Receita Federal onde a entrega está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
codigoRA Código do recinto aduaneiro onde a entrega está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas do local da entrega object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Recebedor - recebedor

Nome Descrição Tipo Detalhes
cnpj CNPJ do recebedor numeric(14), obrigatório Informado apenas quando o recebedor for nacional e pessoa jurídica.
cpf CPF do recebedor numeric(11), obrigatório Informado apenas quando o recebedor for nacional e pessoa física.
nomeEstrangeiro Nome do recebedor string(60), obrigatório Informado apenas quando o recebedor for estrangeiro.
viaTransporte Código da via de transporte numeric(02), opcional
baldeacaoOuTransbordo Indicador de baldeação ou transbordo string(1), opcional Domínio: S (Sim), N (Não). Quando este atributo for preenchido com ’S’ fica configurada a situação de trânsito especial. Deve ser informado como ’S’ apenas quando um depositário de uma recinto de zona primária (ou um operador portuário) estiver entregando a carga para um transportador de via aérea ou aquaviária. Não pode ser informado junto com o Trânsito simplificado.
transitoSimplificado Conjunto de informações obrigatórias ao informar Trânsito Simplificado object transitoSimplificado, opcional Não pode ser informado junto com o Indicador de baldeação ou transbordo

Documento - documento

Nome Descrição Tipo Detalhe
numeroDUE Número da DU-E string(14), obrigatório Formato: AABRSSSSSSSSSD. Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado.
numeroRUC Numero da RUC ou RUC Master string(35), obrigatório Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado.
cargaSoltaVeiculo Dados informados para carga do tipo solta ou para veículos Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.
granel Dados informados para carga do tipo granel Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.

Carga (Solta / Veículo) - carga

Nome Descrição Tipo Detalhes
tipoEmbalagem Tipo de embalagem numeric(2), opcional Conforme a tabela Tipo de Embalagem. Obs: Este atributo não deve ser informado para veículos e outros tipos de carga que não possuem embalagem.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma operação de carga anteriormente. Caso o atributo quantidade não tenha sido informado, este atributo será obrigatório.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso o atributo total não tenha sido informado, este atributo será obrigatório. Além disso, ao menos um atributo carga deverá conter o atributo quantidade.

Carga (Granel) - carga

Nome Descrição Tipo Detalhes
tipoGranel Tipo de granel numeric(2), obrigatório Conforme a tabela Tipo de Granel.
unidademedida Unidade de medida estatística string(2), obrigatório Domínio: kg (quilo), m3 (metro cúbico).
total peso bruto total do granel informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma entrega anteriormente. Caso o atributo quantidade não tenha sido informado, este atributo será obrigatório.
quantidade peso bruto entregue numeric(7), obrigatório Caso o atributo total não tenha sido informado, este atributo será obrigatório. Além disso, ao menos um atributo carga deverá conter o atributo quantidade.

Recepcionar por Nota Fiscal Formulário

Exemplo de entrada:

<recepcoesNFF xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct RecepcaoNFF.xsd" 
    xmlns="http://www.pucomex.serpro.gov.br/cct" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">  

<recepcaoNFF>
    <identificacaoRecepcao>EXEMPLO</identificacaoRecepcao>
    <cnpjResp>00000000000000</cnpjResp>
    <local>
        <codigoURF>0717700</codigoURF>
        <codigoRA>7911101</codigoRA>
    </local>
    <referenciaLocalRecepcao>PontoReferencia</referenciaLocalRecepcao>>
    <notasFiscais>
        <notaFiscalFormulario>
            <numeroNF>30990001</numeroNF>
            <serieNF>100</serieNF>
            <modeloNF>01</modeloNF>
            <AAMM>1610</AAMM>
            <ufEmissor>BR-RJ</ufEmissor>
            <dataEmissao>15-10-2016</dataEmissao>
            <identificacaoEmissor>
                <cnpj>00000000000000</cnpj>
            </identificacaoEmissor>
            <destinatario>
                <identificacaoEstrangeiro>
                    <pais>AR</pais>
                    <nome>WALMART</nome>
                </identificacaoEstrangeiro>
            </destinatario>
            <itensNFF>
                <itemNFF>
                    <numeroItem>001</numeroItem>
                    <codigoProduto>24011010</codigoProduto>
                    <ncm>01022190</ncm>
                    <descricaoProduto>descricaoProduto</descricaoProduto>
                    <cfop>5504</cfop>
                    <valorTotal>100.00</valorTotal>
                    <quantidadeMedidaEstatistica>50</quantidadeMedidaEstatistica>
                </itemNFF>
            </itensNFF>
        </notaFiscalFormulario>
    </notasFiscais>
    <transportador>
        <nomeEstrageiro>Fulano</nomeEstrageiro>
        <nomeCondutorEstrangeiro>Beltrano</nomeCondutorEstrangeiro>
    </transportador>
    <pesoAferido>9777.901</pesoAferido>
    <localArmazenamento>LocalArmazenamento</localArmazenamento>
    <codigoIdentCarga>codigoIdentCarga</codigoIdentCarga>
    <avariasIdentificadas>avarias</avariasIdentificadas>
    <divergenciasIdentificadas>divergencias</divergenciasIdentificadas>
    <observacoesGerais>observacoes</observacoesGerais>
</recepcaoNFF>
</recepcoesNFF>

Endpoint:

POST https://<url>/cct/api/ext/carga/recepcao-nff

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
recepcoesNFF Recepções de Nota Fiscal Formulário Coleção de recepcaoNFF body XSD para download

Recepção de Nota Fiscal Formulário - recepcaoNFF:

Nome Descrição Tipo Detalhes
identificacaoRecepcao Identificação da recepção string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
cnpjResp CNPJ do responsável pela recepção string(14), obrigatório
local Dados do local da recepção object local, obrigatório
referenciaLocalRecepcao Informação de referência do local da recepção string(150), opcional
notasFiscais Notas Fiscais Formulário Coleção de notaFiscalFormulario, obrigatório
transportador Dados do Transportador object transportador, obrigatório
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.
localArmazenamento Local de armazenamento da carga string(150), opcional
codigoIdentCarga Código de identificação da carga string(150), opcional
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações adicionais string(250), opcional

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da Unidade da Receita Federal de Despacho numeric(7), obrigatório Domínio: Tabela de Unidades da RFB de Despacho
codigoRA Código do Recinto Alfandegado numeric(7), obrigatório* Domínio: Tabela de Recintos Alfandegados. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Nota Fiscal Formulário - notaFiscalFormulario:

Nome Descrição Tipo Detalhes
numeroNF Número da nota fiscal numeric(9), obrigatório Não será permitida a inclusão de notas fiscais duplicadas (Atributos idênticos para: numeroNF, serieNF, modeloNF, AAMM, ufEmissor, dataEmissao e identificacaoEmissor).
serieNF Número de série numeric(3), obrigatório Informar zero se não utilizada a série do documento fiscal.
modeloNF Modelo da nota fiscal numeric(3), obrigatório Domínio: 01 (modelo 01), 04 (produtor).
AAMM Ano e mês de emissão numeric(4), obrigatório
ufEmissor Sigla da Unidade da Federação emitente string(5), obrigatório Consulte a tabela de domínios “UF” (vide a seção 6.2 deste documento). Exemplo: BR-RJ, BR-AM, BR-PA, etc.
dataEmissao Data de emissão string(10), obrigatório Formato: AAAA-MM-DD.
identificacaoEmissor Dados do emissor object identificacaoEmissor, obrigatório
destinatario Dados do destinatário object destinatario, obrigatório
conteineres Dados dos contêineres Coleção de conteiner, opcional
itensNFF Lista de itens de nota fiscal Coleção de itemNFF, obrigatório

Transportador - transportador:

Nome Descrição Tipo Detalhes
cnpj CNPJ do transportador string(14), obrigatório* (*) Deve ser informado somente quando cpf e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
cpf CPF do transportador string(11), obrigatório* (*) Deve ser informado somente quando cnpj e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
nomeEstrangeiro Nome do transportador quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cnpj e cpf não forem informados. Neste caso, é obrigatório.
cpfCondutor CPF do condutor string(11), obrigatório* (*) Deve ser informado somente quando nomeCondutorEstrangeiro não for informado. Neste caso, é obrigatório.
nomeCondutorEstrangeiro Nome do condutor quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cpfCondutor não for informado. Neste caso, é obrigatório.

Emissor - identificacaoEmissor:

Nome Descrição Tipo Detalhes
cnpj CNPJ do emissor string(14), obrigatório* (*) Deve ser informado somente quando cpf não for informado. Neste caso, é obrigatório.
cpf CPF do emissor string(11), obrigatório* (*) Deve ser informado somente quando cnpj não for informado. Neste caso, é obrigatório.

Destinatário - destinatario:

Nome Descrição Tipo Detalhes
cnpj CNPJ do destinatário string(14), obrigatório* (*) Deve ser informado somente quando cpf e identificacaoEstrangeiro não forem informados. Neste caso, é obrigatório.
cpf CPF do destinatário string(11), obrigatório* (*) Deve ser informado somente quando cnpj e identificacaoEstrangeiro não forem informados. Neste caso, é obrigatório.
identificacaoEstrangeiro Dados do Destinatário Estrangeiro object [identificacaoEstrangeiro]
(#crnff-identificacaoEstrangeiro), obrigatório* (*) Deve ser informado somente quando e não forem informados. Neste caso, é obrigatório.

Contêiner - conteiner:

Nome Descrição Tipo Detalhes
numeroConteiner Identificação string(11), obrigatório Não será permitida a inclusão de contêineres duplicados.
tara Tara em Kg numeric(9,3), obrigatório
lacres Lacres aplicados string(15), obrigatório Máximo 4 lacres diferentes entre si.

Item da Nota Fiscal Formulário - itemNFF:

Nome Descrição Tipo Detalhes
numeroItem Número do item numeric(3), obrigatório Não será permitida a inclusão de itens duplicados.
codigoProduto Código do produto string(60), obrigatório
ncm Código NCM do produto numeric(8), obrigatório Domínio: Tabela de NCM
descricaoProduto Descrição do produto string(120), obrigatório
cfop Código Fiscal de Operações e Prestações numeric(4), obrigatório
valorTotal Valor total numeric(12,2), obrigatório
quantidadeMedidaEstatistica Quantidade na medida estatística definida para a NCM numeric(11,4), obrigatório

Destinatário Estrangeiro - identificacaoEstrangeiro:

Nome Descrição Tipo Detalhes
pais País do destinatário String(2), obrigatório Domínio: Tabela de Países - código ISO/ALFA2.
nome Nome do destinatário string(60), obrigatório

Recepcionar por Nota Fiscal Eletrônica (NF-e)

Exemplo de entrada:

<recepcoesNFE xsi:schemaLocation='http://www.pucomex.serpro.gov.br/cct RecepcaoNFE.xsd'
                xmlns='http://www.pucomex.serpro.gov.br/cct'
                xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <recepcaoNFE>
        <identificacaoRecepcao>REC001</identificacaoRecepcao>
        <cnpjResp>15573459000106</cnpjResp>
        <local>
            <codigoURF>0817600</codigoURF>
            <codigoRA>8911101</codigoRA>
        </local>
        <referenciaLocalRecepcao>referenciaLocalRecepcao</referenciaLocalRecepcao>
        <notasFiscais>
            <notaFiscalEletronica>
                <chaveAcesso>20161016175341723460934170526686662814689781</chaveAcesso>
            </notaFiscalEletronica>
        </notasFiscais>
        <transportador>
            <cnpj>00000000000272</cnpj>
            <cpfCondutor>10715312707</cpfCondutor>
        </transportador>
        <pesoAferido>100.000</pesoAferido>
        <localArmazenamento>localArmazenamento</localArmazenamento>
        <codigoIdentCarga>CARGA 0001 TESTE</codigoIdentCarga>
        <avariasIdentificadas>avarias Identificadas</avariasIdentificadas>
        <divergenciasIdentificadas>divergencias Identificadas</divergenciasIdentificadas>
        <observacoesGerais>observacoes Gerais</observacoesGerais>
    </recepcaoNFE>
</recepcoesNFE>

Endpoint:

POST https://<url>/cct/api/ext/carga/recepcao-nfe

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
recepcoesNFE Recepções de Nota Fiscal Eletrônica Coleção de recepcaoNFE body XSD para download

Recepção de Nota Fiscal Eletrônica - recepcaoNFE:

Nome Descrição Tipo Detalhes
identificacaoRecepcao Identificação da recepção string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
cnpjResp CNPJ do responsável pela recepção string(14), obrigatório
local Dados do local da recepção object local, obrigatório
referenciaLocalRecepcao Informação de referência do local da recepção string(150), opcional
notasFiscais Notas Fiscais Eletrônicas Coleção de notaFiscalEletronica, obrigatório
transportador Dados do Transportador object transportador, obrigatório
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.
localArmazenamento Local de armazenamento da carga string(150), opcional
codigoIdentCarga Código de identificação da carga string(150), opcional
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações adicionais string(250), opcional

Transportador - transportador:

Nome Descrição Tipo Detalhes
cnpj CNPJ do transportador string(14), obrigatório* (*) Deve ser informado somente quando cpf e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
cpf CPF do transportador string(11), obrigatório* (*) Deve ser informado somente quando cnpj e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
nomeEstrangeiro Nome do transportador quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cnpj e cpf não forem informados. Neste caso, é obrigatório.
cpfCondutor CPF do condutor string(11), obrigatório* (*) Deve ser informado somente quando nomeCondutorEstrangeiro não for informado. Neste caso, é obrigatório.
nomeCondutorEstrangeiro Nome do condutor quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cpfCondutor não for informado. Neste caso, é obrigatório.

Nota Fiscal Eletrônica - notaFiscalEletronica:

Nome Descrição Tipo Detalhes
chaveAcesso Chave de Acesso da Nota Fiscal Eletrônica string(44), obrigatório Não será permitida a inclusão de notas fiscais duplicadas (mesma chave de acesso).
conteineres Dados dos contêineres Coleção de conteiner, obrigatório

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da Unidade da Receita Federal de Despacho numeric(7), obrigatório Domínio: Tabela de Unidades da RFB de Despacho
codigoRA Código do Recinto Alfandegado numeric(7), obrigatório* Domínio: Tabela de Recintos Alfandegados. (*) Deve ser informado somente quando o atributo coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Contêiner - conteiner:

Nome Descrição Tipo Detalhes
numeroConteiner Identificação string(11), obrigatório Não será permitida a inclusão de contêineres duplicados.
tara Tara em Kg numeric(9,3), obrigatório
lacres Lacres aplicados string(15), obrigatório Máximo 4 lacres diferentes entre si.

Recepcionar por Contêiner

Exemplo de entrada:

<recepcoesConteineres
    xmlns='http://www.pucomex.serpro.gov.br/cct'>
    <recepcaoConteiner>
        <identificacaoRecepcao>613314937</identificacaoRecepcao>
        <cnpjResp>07396865000168</cnpjResp>
        <local>
            <codigoURF>0717700</codigoURF>
            <coordenadas>
                <latitude>-22.812222</latitude>
                <longitude>-43.248333</longitude>
            </coordenadas>
        </local>
        <referenciaLocalRecepcao>referencia local recepcao</referenciaLocalRecepcao>
        <entregador>
            <cnpj>07396865000168</cnpj>
        </entregador>
        <conteineres>
            <conteiner>
                <numeroConteiner>fBvrsrzHrA</numeroConteiner>
                <tara>1500.252</tara>
                <lacres>
                    <lacre>ABC123</lacre>
                </lacres>
                <pesoAferido>1500.252</pesoAferido>
            </conteiner>
        </conteineres>
        <localArmazenamento>loca do armazenamento</localArmazenamento>
        <codigoIdentCarga>45411454544</codigoIdentCarga>
        <avariasIdentificadas>SEM AVARIAS</avariasIdentificadas>
        <divergenciasIdentificadas>SEM DIVERGENCIAS</divergenciasIdentificadas>
        <observacoesGerais>SEM OBSERVAÇÕES</observacoesGerais>
        <transitoSimplificado>
            <veiculoRodoviario>
                <cpfCondutor>00475185123</cpfCondutor>
                <veiculos>
                    <veiculo>
                        <placa>TRK0099</placa>
                        <lacres>
                            <lacre>TRK001</lacre>
                        </lacres>
                    </veiculo>
                </veiculos>
            </veiculoRodoviario>
        </transitoSimplificado>
    </recepcaoConteiner>
</recepcoesConteineres>

Endpoint:

POST https://<url>/cct/api/ext/carga/recepcao-conteiner

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
recepcoesConteineres Recepções por Contêineres Coleção de recepcaoConteiner, obrigatório body XSD para download

Recepção por Contêiner - recepcaoConteiner:

Nome Descrição Tipo Detalhes
identificacaoRecepcao Identificação da recepção string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
cnpjResp CNPJ do responsável pela recepção string(14), obrigatório
local Dados do local da recepção object local, obrigatório
referenciaLocalRecepcao Referência do Local de recepção string(150), opcional
entregador Dados do interveniente que está entregando a carga object entregador, obrigatório
conteineres Lista dos contêineres a serem recepcionados Coleção de conteiner, obrigatório
localArmazenamento Local de armazenamento da carga string(150), opcional
codigoIdentCarga Código de identificação da carga string(150), opcional
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações adicionais string(250), opcional
transitoSimplificado Conjunto de informações dos veículos envolvidos no Trânsito Simplificado objectRodoviário ou objectFerroviário Será obedecida a seguinte ordem nas informações de veículo rodoviário quando informado : Truck/Cavalo, 1º Reboque, 2º Reboque e 3º Reboque;

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da unidade da Receita Federal onde a recepção está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Unidades da RFB. (*) Deve ser informado apenas quando o receptor não for um depositário.
codigoRA Código do recinto alfandegado onde a recepção está sendo efetuada numeric(7), obrigatório Domínio: Tabela de recintos aduaneiros. (*) Deve ser informado apenas quando o receptor for um depositário.
coordenadas Dados das coordenadas geográficas do local da recepção object coordenadas, obrigatório (*) Deve ser informado apenas quando o receptor não for um depositário.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Dados do Entregador - entregador:

Nome Descrição Tipo Detalhes
cnpj CNPJ do entregador numeric(14), obrigatório Informado apenas quando o entregador for nacional e pessoa jurídica.
cpf CPF do entregador numeric(11), obrigatório Informado apenas quando o entregador for nacional e pessoa física.
nomeEstrangeiro Nome do entregador string(60), obrigatório Informado apenas quando o entregador for estrangeiro.

Contêiner - conteiner:

Nome Descrição Tipo Detalhes
numeroConteiner Identificação string(11), obrigatório Não será permitida a inclusão de contêineres duplicados.
tara Tara em Kg numeric(9,3), obrigatório
lacres Lacres aplicados string(15), obrigatório Máximo 4 lacres diferentes entre si.
pesoBruto Peso bruto aferido numeric(9,3), obrigatório (*) informado e obrigatório apenas quando não foi informado um motivo para o não aferimento do peso.
motivoNaoPesagem Descrição do motivo de não realização da pesagem do contêiner string(250), obrigatório (*) informado e obrigatório apenas quando não foi informado o peso bruto aferido para o contêiner.

Recepcionar Carga por DU-E/RUC

Exemplo: Recepção por DU-E com carga Solta, Granel e sem embalagem:

<recepcoesDocumentoCarga xsi:schemaLocation='http://www.pucomex.serpro.gov.br/cct RecepcaoDocumentoCarga.xsd '
    xmlns='http://www.pucomex.serpro.gov.br/cct'
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <recepcaoDocumentoCarga>
        <identificacaoRecepcao>REP001</identificacaoRecepcao>
        <cnpjResp>07396865000168</cnpjResp>
        <local>
            <codigoURF>0717700</codigoURF>
            <codigoRA>7911101</codigoRA>
        </local>
        <referenciaLocalRecepcao>LOCAL DE RECEPÇÃO DO OPERADOR REMESSA</referenciaLocalRecepcao>
        <entregador>
            <cnpj>00000000000272</cnpj>
        </entregador>
        <documentos>
            <documento>
                <numeroDUE>16BR0000076499</numeroDUE>
                <cargaSoltaVeiculo>
                    <carga>
                        <tipoEmbalagem>19</tipoEmbalagem>
                        <total>2000</total>
                        <quantidade>2000</quantidade>
                    </carga>
                    <carga>
                        <total>10</total>
                        <quantidade>2</quantidade>
                    </carga>
                </cargaSoltaVeiculo>
                <granel>
                    <carga>
                        <tipoGranel>10</tipoGranel>
                        <unidademedida>kg</unidademedida>
                        <total>1.000</total>
                        <quantidade>1.000</quantidade>
                    </carga>
                </granel>
            </documento>
        </documentos>
        <pesoAferido>1000.000</pesoAferido>
        <localArmazenamento>LOCAL DO OPERADOR DE REMESSA</localArmazenamento>
        <codigoIdentCarga>CARGA OPERADOR REMESSA</codigoIdentCarga>
        <avariasIdentificadas>SEM AVARIAS</avariasIdentificadas>
        <divergenciasIdentificadas>SEM DIVERGENCIAS</divergenciasIdentificadas>
        <observacoesGerais>SEM OBSERVAÇÕES</observacoesGerais>
        <transitoSimplificado>
            <veiculoFerroviario>
                <prefixoTrem>ABC1234</prefixoTrem>
                <quantidadeVagoes>2</quantidadeVagoes>
            </veiculoFerroviario>
        </transitoSimplificado>
    </recepcaoDocumentoCarga>
</recepcoesDocumentoCarga>

Endpoint:

POST https://<url>/cct/api/ext/carga/recepcao-due-ruc

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
recepcoesDocumentoCarga Recepção por Documento de Carga Coleção de recepcaoDocumentoCarga body XSD para download

Recepção por Documento de Carga - recepcaoDocumentoCarga

Nome Descrição Tipo Detalhes
identificacaoRecepcao Identificação da Recepção string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
cnpjResp CNPJ do responsável pela recepção numeric(14), obrigatório Formato: 99999999999999.
local Dados do local da recepção object local, obrigatório
referenciaLocalRecepcao Referência do local de recepção string(150), opcional
entregador Dados do interveniente que está entregando a carga object entregador, opcional
documentos documentos de carga envolvidos na recepção (DU-E / RUC) Coleção de documento, obrigatório
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.
localArmazenamento Local de armazenamento da carga string(150), opcional
codigoIdentCarga Código de identificação da carga string(150), opcional
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações gerais string(250), opcional
transitoSimplificado Conjunto de informações dos veículos envolvidos no Trânsito Simplificado objectRodoviário ou objectFerroviário Será obedecida a seguinte ordem nas informações de veículo rodoviário quando informado : Truck/Cavalo, 1º Reboque, 2º Reboque e 3º Reboque;

Local - local

Nome Descrição Tipo Detalhes
codigoURF Código da unidade da Receita Federal onde a entrega está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
codigoRA Código do recinto aduaneiro onde a entrega está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas do local da entrega object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Dados do Entregador - entregador:

Nome Descrição Tipo Detalhes
cnpj CNPJ do entregador numeric(14), obrigatório Informado apenas quando o entregador for nacional e pessoa jurídica.
cpf CPF do entregador numeric(11), obrigatório Informado apenas quando o entregador for nacional e pessoa física.
nomeEstrangeiro Nome do entregador string(60), obrigatório Informado apenas quando o entregador for estrangeiro.

Documento - documento

Nome Descrição Tipo Detalhe
numeroDUE Número da DU-E string(14), obrigatório Formato: AABRSSSSSSSSSD. Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado.
numeroRUC Numero da RUC ou RUC Master string(35), obrigatório Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado.
cargaSoltaVeiculo Dados informados para carga do tipo solta ou para veículos Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.
granel Dados informados para carga do tipo granel Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.

Carga (Solta / Veículo) - carga

Nome Descrição Tipo Detalhes
tipoEmbalagem Tipo de embalagem numeric(2), opcional Conforme a tabela Tipo de Embalagem. Obs: Esta TAG não deve ser informada para veículos e outros tipos de carga que não possuem embalagem.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma operação de carga anteriormente. Caso a TAG quantidade não tenha sido informada, esta TAG será obrigatória.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso a TAG total não tenha sido informada, esta TAG será obrigatória. Além disso, ao menos uma TAG carga deverá conter a TAG quantidade.

Carga (Granel) - carga

Nome Descrição Tipo Detalhes
tipoGranel Tipo de granel numeric(2), obrigatório Conforme a tabela Tipo de Granel.
unidademedida Unidade de medida estatística string(2), obrigatório Domínio: kg = quilo e m3 = metro cúbico.
total peso bruto total do granel informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma entrega anteriormente. Caso a TAG quantidade não tenha sido informada, esta TAG será obrigatória.
quantidade peso bruto recepcionado numeric(7), obrigatório Caso a TAG total não tenha sido informada, esta TAG será obrigatória. Além disso, ao menos uma TAG carga deverá conter a TAG quantidade.

Manifestar

Exemplo 1: Manifestação de dados de Embarque com conhecimento e com carga do tipo Contêiner

<?xml version="1.0" encoding="UTF-8"?>
<ManifestacoesExportacao xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd">
   <manifestacao>
      <identificacaoManifestacao>231004740</identificacaoManifestacao>
      <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
      <indCargaEnviadaDespacho>S</indCargaEnviadaDespacho>
      <cargaJaEmbarcada>N</cargaJaEmbarcada>
      <cnpjTransportador>99999999999999</cnpjTransportador>
      <codigoRA>7921301</codigoRA>
      <veiculoAereo>
         <codigoTipoModal>04</codigoTipoModal>
         <prefixoAeronave>GLPRT</prefixoAeronave>
         <numeroVoo>52250</numeroVoo>
         <dataPartidaProcedencia>2016-09-16</dataPartidaProcedencia>
      </veiculoAereo>
      <conhecimentosCarga>
         <conhecimento>
            <numeroConhecimento>200920161220</numeroConhecimento>
            <dataEmissaoConhecimento>2016-09-16</dataEmissaoConhecimento>
            <frete>
               <codigoMoedaFrete>USD</codigoMoedaFrete>
               <formaPagamentoFrete>1</formaPagamentoFrete>
               <valorFrete>1150.50</valorFrete>
            </frete>
            <cargas>
               <dadosCarga>
                  <consignadoAOrdem>S</consignadoAOrdem>
                  <nomeConsignatario>Andre Lucio</nomeConsignatario>
                  <enderecoConsignatario>Rua A casa B</enderecoConsignatario>
                  <paisDestino>AR</paisDestino>
                  <conteiner>
                     <carga>
                        <numeroConteiner>Ow6P7yThXG</numeroConteiner>
                        <tara>1500.252</tara>
                        <lacres>
                           <lacre>ABC123</lacre>
                           <lacre>CDE456</lacre>
                           <lacre>EDR5676</lacre>
                        </lacres>
                        <pesoBruto>2663.231</pesoBruto>                        
                     </carga>
                  </conteiner>                  
               </dadosCarga>
            </cargas>
         </conhecimento>
      </conhecimentosCarga>
      <observacoes>Texto de observação</observacoes>
   </manifestacao>
</ManifestacoesExportacao>

Exemplo 2: Manifestação de dados de Embarque com conhecimento e com cargas dos tipos solta e granel

<?xml version="1.0" encoding="UTF-8"?>
<ManifestacoesExportacao xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd">
   <manifestacao>
      <identificacaoManifestacao>239543836</identificacaoManifestacao>
      <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
      <indCargaEnviadaDespacho>S</indCargaEnviadaDespacho>
      <cargaJaEmbarcada>S</cargaJaEmbarcada>
      <cnpjTransportador>99999999999999</cnpjTransportador>
      <codigoRA>7985999</codigoRA>
      <veiculoAereo>
         <codigoTipoModal>04</codigoTipoModal>
         <prefixoAeronave>GLPER</prefixoAeronave>
         <numeroVoo>52250</numeroVoo>
         <dataPartidaProcedencia>2016-09-16</dataPartidaProcedencia>
      </veiculoAereo>
      <conhecimentosCarga>
         <conhecimento>
            <numeroConhecimento>200920161220</numeroConhecimento>
            <dataEmissaoConhecimento>2016-09-16</dataEmissaoConhecimento>
            <frete>
               <codigoMoedaFrete>USD</codigoMoedaFrete>
               <formaPagamentoFrete>1</formaPagamentoFrete>
               <valorFrete>1150.50</valorFrete>
            </frete>
            <cargas>
               <dadosCarga>
                  <consignadoAOrdem>S</consignadoAOrdem>
                  <nomeConsignatario>João Silva</nomeConsignatario>
                  <enderecoConsignatario>Rua A casa B</enderecoConsignatario>
                  <paisDestino>AR</paisDestino>
                  <documentos>
                     <documento>
                        <numeroDUE>17BR0000173613</numeroDUE>
                        <cargaSoltaVeiculo>
                           <carga>
                              <tipoEmbalagem>60</tipoEmbalagem>
                              <total>20</total>
                              <quantidade>20</quantidade>
                              <pesoBruto>100.223</pesoBruto>
                           </carga>
                           <carga>
                              <total>20</total>
                              <quantidade>19</quantidade>
                              <pesoBruto>200.120</pesoBruto>
                           </carga>
                        </cargaSoltaVeiculo>
                        <granel>
                           <carga>
                              <tipoGranel>01</tipoGranel>
                              <unidademedida>kg</unidademedida>
                              <total>200.000</total>
                              <quantidade>100.000</quantidade>
                              <pesoBruto>2663.231</pesoBruto>
                           </carga>
                        </granel>
                     </documento>
                  </documentos>                  
               </dadosCarga>
            </cargas>
         </conhecimento>
      </conhecimentosCarga>
      <observacoes>Texto de observação</observacoes>
   </manifestacao>
</ManifestacoesExportacao>

Exemplo 3: Manifestação de dados de Embarque com conhecimento e com cargas dos tipos contêiner, granel e solta

<?xml version="1.0" encoding="UTF-8"?>
<ManifestacoesExportacao xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd">
   <manifestacao>
      <identificacaoManifestacao>239543836</identificacaoManifestacao>
      <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
      <indCargaEnviadaDespacho>S</indCargaEnviadaDespacho>
      <cargaJaEmbarcada>S</cargaJaEmbarcada>
      <cnpjTransportador>99999999999999</cnpjTransportador>
      <codigoRA>7985999</codigoRA>
      <veiculoAereo>
         <codigoTipoModal>04</codigoTipoModal>
         <prefixoAeronave>GLPER</prefixoAeronave>
         <numeroVoo>52250</numeroVoo>
         <dataPartidaProcedencia>2016-09-16</dataPartidaProcedencia>
      </veiculoAereo>
      <conhecimentosCarga>
         <conhecimento>
            <numeroConhecimento>200920161220</numeroConhecimento>
            <dataEmissaoConhecimento>2016-09-16</dataEmissaoConhecimento>
            <frete>
               <codigoMoedaFrete>USD</codigoMoedaFrete>
               <formaPagamentoFrete>1</formaPagamentoFrete>
               <valorFrete>1150.50</valorFrete>
            </frete>
            <cargas>
               <dadosCarga>
                  <consignadoAOrdem>S</consignadoAOrdem>
                  <nomeConsignatario>João Silva</nomeConsignatario>
                  <enderecoConsignatario>Rua A casa B</enderecoConsignatario>
                  <paisDestino>AR</paisDestino>
                  <documentos>
                     <documento>
                        <numeroDUE>17BR0000173613</numeroDUE>
                        <cargaSoltaVeiculo>
                           <carga>
                              <tipoEmbalagem>60</tipoEmbalagem>
                              <total>20</total>
                              <quantidade>20</quantidade>
                              <pesoBruto>1000.123</pesoBruto>
                           </carga>
                           <carga>
                              <total>20</total>
                              <quantidade>19</quantidade>
                              <pesoBruto>300.000</pesoBruto>
                           </carga>
                        </cargaSoltaVeiculo>
                        <granel>
                           <carga>
                              <tipoGranel>01</tipoGranel>
                              <unidademedida>kg</unidademedida>
                              <total>200.000</total>
                              <quantidade>100.000</quantidade>
                              <pesoBruto>200.000</pesoBruto>
                           </carga>
                        </granel>
                     </documento>
                  </documentos>
                  <conteiner>
                     <carga>
                        <numeroConteiner>Ow6P7yThXG</numeroConteiner>
                        <tara>1500.252</tara>
                        <lacres>
                           <lacre>ABC123</lacre>
                           <lacre>CDE456</lacre>
                           <lacre>EDR5676</lacre>
                        </lacres>
                        <pesoBruto>100.000</pesoBruto>
                     </carga>
                  </conteiner>                  
               </dadosCarga>
            </cargas>
         </conhecimento>
      </conhecimentosCarga>
      <observacoes>Texto de observação</observacoes>
   </manifestacao>
</ManifestacoesExportacao>

Exemplo 4: Manifestação de dados de Embarque sem conhecimento e com cargas dos tipos solta e granel

<?xml version="1.0" encoding="UTF-8"?>
<ManifestacoesExportacao xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd">
   <manifestacao>
      <identificacaoManifestacao>231035513</identificacaoManifestacao>
      <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
      <indCargaEnviadaDespacho>S</indCargaEnviadaDespacho>
      <cargaJaEmbarcada>S</cargaJaEmbarcada>
      <cnpjTransportador>99999999999999</cnpjTransportador>
      <codigoRA>7911101</codigoRA>
      <veiculoAereo>
         <codigoTipoModal>04</codigoTipoModal>
         <prefixoAeronave>GRPTK</prefixoAeronave>
         <numeroVoo>52250</numeroVoo>
         <dataPartidaProcedencia>2016-09-16</dataPartidaProcedencia>
      </veiculoAereo>
      <transporteProprio>
         <dadosCarga>
            <consignadoAOrdem>S</consignadoAOrdem>
            <nomeConsignatario>João Silva</nomeConsignatario>
            <enderecoConsignatario>Rua A casa B</enderecoConsignatario>
            <paisDestino>AR</paisDestino>
            <documentos>
               <documento>
                  <numeroDUE>17BR0000173613</numeroDUE>
                  <cargaSoltaVeiculo>
                     <carga>
                        <tipoEmbalagem>60</tipoEmbalagem>
                        <total>20</total>
                        <quantidade>20</quantidade>
                        <pesoBruto>100.000</pesoBruto>
                     </carga>
                     <carga>
                        <total>20</total>
                        <quantidade>19</quantidade>
                        <pesoBruto>200.000</pesoBruto>
                     </carga>
                  </cargaSoltaVeiculo>
                  <granel>
                     <carga>
                        <tipoGranel>01</tipoGranel>
                        <unidademedida>kg</unidademedida>
                        <total>200.000</total>
                        <quantidade>100.000</quantidade>
                        <pesoBruto>300.000</pesoBruto>
                     </carga>
                  </granel>
               </documento>
            </documentos>            
         </dadosCarga>
      </transporteProprio>
      <observacoes>Texto de observação</observacoes>
   </manifestacao>
</ManifestacoesExportacao>

Endpoint:

POST https://<url>/cct/api/ext/carga/manifestacao-dados-embarque

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
ManifestacoesExportacao Manifestação de Carga Coleção de manifestacao body XSD para download

Dados do Manifesto de Embarque - manifestacao

Nome Descrição Tipo Detalhes
identificacaoManifestacao Identificação da Manifestação string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada manifesto no momento da exibição de eventuais mensagens de erro. Este campo é uma chave dentro do arquivo XML, não admitindo duplicatas.
tipoDocumentoTransporte Tipo de Documento de Transporte numeric(2), obrigatório Domínio: Consultar a tabela de domínios Tipo de Documento.
indCargaEnviadaDespacho Indicador Carga Enviada para Despacho string(1) obrigatório Domínio: S (Sim), N(Não).
cargaJaEmbarcada Indicador Carga já Embarcada string(1) obrigatório Domínio: S (Sim), N(Não).
cnpjTransportador CNPJ do Transportador numeric(14) obrigatório (*) Informado e obrigatório apenas para transportador nacional do tipo pessoa jurídica.
cpfTransportador CPF do Transportador numeric(11) obrigatório (*) Informado e obrigatório apenas para transportador nacional do tipo pessoa física.
codigoRA Código do Recinto Aduaneiro numeric(7) obrigatório (*) Obrigatório quando não foi informada uma URF.
codigoURF Código da Unidade de Região Fiscal numeric(7), obrigatório (*) Obrigatório quando não foi informado um RA.
coordenadas Coordenadas Geográficas object coordenadas, obrigatório (*) Obrigatório apenas para o manifesto de embarque de carga ainda não embarcada, quando foi informado uma URF.
cnpjRespEstoqueCarga CNPJ do responsável pelo estoque da carga numeric(14) obrigatório (*) Obrigatório apenas para o manifesto de embarque de carga ainda não embarcada, quando foram informados URF + coordenadas e a carga não consta no estoque de um depositário.
veiculoAereo Dados do veículo aéreo object veiculoAereo, obrigatório Obs: Ao informar o atributo veiculoAereo, outroModal e veiculoAquaviario não poderão ser informados.
veiculoAquaviario Dados do veículo aquaviário object veiculoAquaviario, obrigatório Obs: Ao informar o atributo veiculoAquaviario, veiculoAereo e outroModal não poderão ser informados.
outroModal Dados para veículos de outros modais object outroModal, obrigatório Obs: Ao informar o atributo outroModal, veiculoAereo e veiculoAquaviario não poderão ser informados.
conhecimentosCarga Dados do conhecimento de carga Coleção de conhecimento, obrigatório (*) Informado e obrigatório apenas quando a manifestação dos dados de embarque for acobertada por conhecimento de carga.
transporteProprio Dados do transporte próprio Coleção de dadosCarga, obrigatório (*) Informado e obrigatório apenas quando a manifestação dos dados de embarque não for acobertada por conhecimento de carga.
observacoes Observações string(250), opcional

Dados do conhecimento de carga - conhecimento

Nome Descrição Tipo Detalhe
numeroConhecimento Número do conhecimento de carga string(5-20) obrigatório Em uma mesma manifestação de embarque não podem ser inseridos conhecimentos de carga com o mesmo número.
dataEmissaoConhecimento Data de emissão do conhecimento de carga string(10), obrigatório Formato: aaaa-mm-dd.
frete Dados do frete object frete, opcional
cargas Dados das cargas Manifestadas Coleção de dadoscarga, obrigatório

Dados do frete - frete

Nome Descrição Tipo Detalhe
codigoMoedaFrete Código da moeda do Frete string(3), obrigatório Domínio: Tabela Tipo de Moeda.
formaPagamentoFrete Forma de pagamento do Frete numeric(1), obrigatório Domínio: 1 (prepaid), 2 (collect).
valorFrete Valor do frete numeric(12,2), obrigatório

Dados das cargas - dadosCarga

Nome Descrição Tipo Detalhes
consignadoAOrdem Indicador de consignação à ordem string(1), obrigatório Domínio: Domínio: S (Sim), N(Não).
nomeConsignatario Nome do consignatário string(2-60), obrigatório (*) Informado e obrigatório apenas se indicador de consignação à ordem igual a Não.
enderecoConsignatario Endereço do consignatário string(2-120), obrigatório (*) Informado e obrigatório apenas se indicador de consignação à ordem igual a Não.
paisDestino Código do país de destino da carga string(2), obrigatório Domínio: Tabela de Países - código ISO/ALFA2.
documentos Dados das cargas do tipo solta e granel Coleção de documento, obrigatório (*) Obrigatório informar ao menos um dos atributos: conteiner ou documentos.
conteiner Dados do contêiner object conteiner, obrigatório (*) Obrigatório informar ao menos um dos atributos: conteiner ou documentos.

Documento - documento

Nome Descrição Tipo Detalhe
numeroDUE Número da DU-E string(14), obrigatório Formato: AABRSSSSSSSSSD. Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado.
numeroRUC Numero da RUC ou RUC Master string(35), obrigatório Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado.
cargaSoltaVeiculo Dados informados para carga do tipo solta ou para veículos Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.
granel Dados informados para carga do tipo granel Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.

Carga (Solta / Veículo) - carga

Nome Descrição Tipo Detalhes
tipoEmbalagem Tipo de embalagem numeric(2), opcional Conforme a tabela Tipo de Embalagem. Obs: Este atributo não deve ser informado para veículos e outros tipos de carga que não possuem embalagem.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma operação de carga anteriormente. Caso o atributo quantidade não tenha sido informado, este atributo será obrigatório.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso o atributo total não tenha sido informado, este atributo será obrigatório. Além disso, ao menos um atributo carga deverá conter o atributo quantidade.
pesoBruto Peso bruto numeric(9,3), obrigatório*

Carga (Granel) - carga

Nome Descrição Tipo Detalhes
tipoGranel Tipo de granel numeric(2), obrigatório Conforme a tabela Tipo de Granel.
unidademedida Unidade de medida estatística string(2), obrigatório Domínio: kg (quilo), m3 (metro cúbico).
total peso bruto total do granel informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma entrega anteriormente. Caso o atributo quantidade não tenha sido informado, este atributo será obrigatório.
quantidade peso bruto entregue numeric(7), obrigatório Caso o atributo total não tenha sido informado, este atributo será obrigatório. Além disso, ao menos um atributo carga deverá conter o atributo quantidade.
pesoBruto Peso bruto numeric(9,3), obrigatório*

Dados do contêiner - conteiner

Nome Descrição Tipo Detalhe
numeroConteiner Identificação do contêiner string(11), obrigatório
tara Tara do contêiner numeric(6,3), obrigatório Unidade de Medida: kg.
lacres Lacres aplicados ao contêiner Coleção de lacre,opcional Os lacres listados dentro do atributo lacres não podem ser repetidos.
pesoBruto Peso bruto numeric(9,3), obrigatório*

Lacre - lacre

Nome Descrição Tipo Detalhe
lacre Identificação do lacre string(1,15), obrigatório

Dados do veículo aéreo - veiculoAereo`

Nome Descrição Tipo Detalhe
codigoTipoModal Código do Tipo de Modal numerico(2) obrigatório Domínio: 04 (aéreo)
prefixoAeronave Prefixo da aeronave string(5-15), obrigatório
numeroVoo Número do voo string(5-9), obrigatório
dataPartidaProcedencia Data de partida da procedência string(10), obrigatório Formato: aaaa-mm-dd

Dados do veículo aquaviário - veiculoAquaviario`

Nome Descrição Tipo Detalhe
codigoTipoModal Código do Tipo de Modal numerico(2) obrigatório Domínio: 01 (marítimo), 02 (fluvial) e 03 (lacustre)
codigoIMO Código IMO da embarcação numeric(15), obrigatório
numeroEscala Número da Escala string(1,11), obrigatório
dataEncerramentoManifesto Data de encerramento do manifesto string(10), obrigatório Formato: aaaa-mm-dd

Dados do veículo do tipo “outros modais” - outroModal

Nome Descrição Tipo Detalhe
codigoTipoModal Código do Tipo de Modal numerico(2) obrigatório Domínio: 06 (ferroviário) e 07 (rodoviário)
identificacaoVeiculo Identificação do veículo string(15), obrigatório
numeroDocumentoTransporte Número do documento de transporte string(5,15), obrigatório
dataEmissaoDocumentoTransporte Data de emissão do documento de transporte string(10), obrigatório Formato: aaaa-mm-dd

Manifestar (Versão à ser implantada no dia 24/06/2018)

Exemplo 1: Manifestação de dados de Embarque com conhecimento e com carga do tipo Contêiner

<ManifestacoesExportacao xsi:schemaLocation='http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd '
    xmlns='http://www.pucomex.serpro.gov.br/cct'
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <manifestacao>
        <identificacaoManifestacao>MAN003</identificacaoManifestacao>
        <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
        <indCargaEnviadaDespacho>N</indCargaEnviadaDespacho>
        <cargaJaEmbarcada>S</cargaJaEmbarcada>
        <cnpjTransportador>99999999999999</cnpjTransportador>
        <codigoURF>0717700</codigoURF>
        <coordenadas>
            <latitude>-22.812222</latitude>
            <longitude>-43.248333</longitude>
        </coordenadas>
        <cnpjRespEstoqueCarga>99999999999999</cnpjRespEstoqueCarga>
        <veiculoAereo>
            <codigoTipoModal>04</codigoTipoModal>
            <prefixoAeronave>LMF1203</prefixoAeronave>
            <numeroVoo>70544</numeroVoo>
            <dataPartidaProcedencia>2016-12-18</dataPartidaProcedencia>
        </veiculoAereo>
        <conhecimentosCarga>
            <conhecimento>
                <numeroConhecimento>CE20161219114526</numeroConhecimento>
                <dataEmissaoConhecimento>2016-12-19</dataEmissaoConhecimento>
                <frete>
                    <codigoMoedaFrete>USD</codigoMoedaFrete>
                    <formaPagamentoFrete>1</formaPagamentoFrete>
                    <valorFrete>15632.87</valorFrete>
                </frete>
                <consignatario>
                    <consignadoAOrdem>N</consignadoAOrdem>
                    <nomeConsignatario>Nome do Consignatário</nomeConsignatario>
                    <enderecoConsignatario>Endereço do Consignatário</enderecoConsignatario>
                    <paisDestino>US</paisDestino>
                    <dadosCarga>
                        <conteiner>
                            <carga>
                                <numeroConteiner>MOLU1472580</numeroConteiner>
                                <tara>1243.852</tara>
                                <lacres>
                                    <lacre>KAC22233233</lacre>
                                </lacres>
                                <pesoBruto>2563.231</pesoBruto>
                            </carga>
                        </conteiner>
                    </dadosCarga>
                </consignatario>
            </conhecimento>
        </conhecimentosCarga>
        <observacoes>MANIFESTO COM CONTEINER E DOCUMENTO</observacoes>
    </manifestacao>
</ManifestacoesExportacao>

Exemplo 2: Manifestação de dados de Embarque com conhecimento e com cargas dos tipos solta e granel

<ManifestacoesExportacao xsi:schemaLocation='http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd '
    xmlns='http://www.pucomex.serpro.gov.br/cct'
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <manifestacao>
        <identificacaoManifestacao>MAN003</identificacaoManifestacao>
        <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
        <indCargaEnviadaDespacho>N</indCargaEnviadaDespacho>
        <cargaJaEmbarcada>S</cargaJaEmbarcada>
        <cnpjTransportador>99999999999999</cnpjTransportador>
        <codigoURF>0717700</codigoURF>
        <coordenadas>
            <latitude>-22.812222</latitude>
            <longitude>-43.248333</longitude>
        </coordenadas>
        <cnpjRespEstoqueCarga>99999999999999</cnpjRespEstoqueCarga>
        <veiculoAereo>
            <codigoTipoModal>04</codigoTipoModal>
            <prefixoAeronave>LMF1203</prefixoAeronave>
            <numeroVoo>70544</numeroVoo>
            <dataPartidaProcedencia>2016-12-18</dataPartidaProcedencia>
        </veiculoAereo>
        <conhecimentosCarga>
            <conhecimento>
                <numeroConhecimento>CE20161219114526</numeroConhecimento>
                <dataEmissaoConhecimento>2016-12-19</dataEmissaoConhecimento>
                <frete>
                    <codigoMoedaFrete>USD</codigoMoedaFrete>
                    <formaPagamentoFrete>1</formaPagamentoFrete>
                    <valorFrete>15632.87</valorFrete>
                </frete>
                <consignatario>
                    <consignadoAOrdem>N</consignadoAOrdem>
                    <nomeConsignatario>Nome do Consignatário</nomeConsignatario>
                    <enderecoConsignatario>Endereço do Consignatário</enderecoConsignatario>
                    <paisDestino>US</paisDestino>
                    <dadosCarga>
                        <documentos>
                            <documento>
                                <numeroDUE>16BR0000081778</numeroDUE>
                                <cargaSoltaVeiculo>
                                    <carga>
                                        <tipoEmbalagem>01</tipoEmbalagem>
                                        <total>1000</total>
                                        <quantidade>100</quantidade>
                                        <pesoBruto>2563.231</pesoBruto>
                                    </carga>
                                </cargaSoltaVeiculo>
                                <granel>
                                    <carga>
                                        <tipoGranel>01</tipoGranel>
                                        <unidademedida>kg</unidademedida>
                                        <total>100654.001</total>
                                        <quantidade>20330.001</quantidade>
                                        <pesoBruto>2563.231</pesoBruto>
                                    </carga>
                                </granel>
                            </documento>
                        </documentos>
                    </dadosCarga>
                </consignatario>
            </conhecimento>
        </conhecimentosCarga>
        <observacoes>MANIFESTO COM CARGA SOLTA E GRANEL</observacoes>
    </manifestacao>
</ManifestacoesExportacao>

Exemplo 3: Manifestação de dados de Embarque com conhecimento e com cargas dos tipos contêiner, granel e solta

<ManifestacoesExportacao xsi:schemaLocation='http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd '
    xmlns='http://www.pucomex.serpro.gov.br/cct'
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <manifestacao>
        <identificacaoManifestacao>MAN003</identificacaoManifestacao>
        <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
        <indCargaEnviadaDespacho>N</indCargaEnviadaDespacho>
        <cargaJaEmbarcada>S</cargaJaEmbarcada>
        <cnpjTransportador>99999999999999</cnpjTransportador>
        <codigoURF>0717700</codigoURF>
        <coordenadas>
            <latitude>-22.812222</latitude>
            <longitude>-43.248333</longitude>
        </coordenadas>
        <cnpjRespEstoqueCarga>99999999999999</cnpjRespEstoqueCarga>
        <veiculoAereo>
            <codigoTipoModal>04</codigoTipoModal>
            <prefixoAeronave>LMF1203</prefixoAeronave>
            <numeroVoo>70544</numeroVoo>
            <dataPartidaProcedencia>2016-12-18</dataPartidaProcedencia>
        </veiculoAereo>
        <conhecimentosCarga>
            <conhecimento>
                <numeroConhecimento>CE20161219114526</numeroConhecimento>
                <dataEmissaoConhecimento>2016-12-19</dataEmissaoConhecimento>
                <frete>
                    <codigoMoedaFrete>USD</codigoMoedaFrete>
                    <formaPagamentoFrete>1</formaPagamentoFrete>
                    <valorFrete>15632.87</valorFrete>
                </frete>
                <consignatario>
                    <consignadoAOrdem>N</consignadoAOrdem>
                    <nomeConsignatario>Nome do Consignatário</nomeConsignatario>
                    <enderecoConsignatario>Endereço do Consignatário</enderecoConsignatario>
                    <paisDestino>US</paisDestino>
                    <dadosCarga>
                        <documentos>
                            <documento>
                                <numeroDUE>16BR0000081778</numeroDUE>
                                <cargaSoltaVeiculo>
                                    <carga>
                                        <tipoEmbalagem>01</tipoEmbalagem>
                                        <total>1000</total>
                                        <quantidade>100</quantidade>
                                        <pesoBruto>2563.231</pesoBruto>
                                    </carga>
                                </cargaSoltaVeiculo>
                                <granel>
                                    <carga>
                                        <tipoGranel>01</tipoGranel>
                                        <unidademedida>kg</unidademedida>
                                        <total>100654.001</total>
                                        <quantidade>20330.001</quantidade>
                                        <pesoBruto>2563.231</pesoBruto>
                                    </carga>
                                </granel>
                            </documento>
                        </documentos>
                        <conteiner>
                            <carga>
                                <numeroConteiner>MOLU1472580</numeroConteiner>
                                <tara>1243.852</tara>
                                <lacres>
                                    <lacre>lacre</lacre>
                                    <lacre>lacre2</lacre>
                                </lacres>
                                <pesoBruto>2563.231</pesoBruto>
                            </carga>
                        </conteiner>
                    </dadosCarga>
                </consignatario>
            </conhecimento>
        </conhecimentosCarga>
        <observacoes>MANIFESTO COM CARGA SOLTA E GRANEL</observacoes>
    </manifestacao>
</ManifestacoesExportacao>

Exemplo 4: Manifestação de dados de Embarque sem conhecimento e com cargas dos tipos solta e granel

<ManifestacoesExportacao xsi:schemaLocation='http://www.pucomex.serpro.gov.br/cct ManifestacaoExportacao.xsd '
    xmlns='http://www.pucomex.serpro.gov.br/cct'
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <manifestacao>
        <identificacaoManifestacao>MAN003</identificacaoManifestacao>
        <tipoDocumentoTransporte>01</tipoDocumentoTransporte>
        <indCargaEnviadaDespacho>N</indCargaEnviadaDespacho>
        <cargaJaEmbarcada>S</cargaJaEmbarcada>
        <cnpjTransportador>99999999999999</cnpjTransportador>
        <codigoURF>0717700</codigoURF>
        <coordenadas>
            <latitude>-22.812222</latitude>
            <longitude>-43.248333</longitude>
        </coordenadas>
        <cnpjRespEstoqueCarga>99999999999999</cnpjRespEstoqueCarga>
        <veiculoAereo>
            <codigoTipoModal>04</codigoTipoModal>
            <prefixoAeronave>LMF1203</prefixoAeronave>
            <numeroVoo>70544</numeroVoo>
            <dataPartidaProcedencia>2016-12-18</dataPartidaProcedencia>
        </veiculoAereo>
        <transporteProprio>
            <consignatario>
                <consignadoAOrdem>N</consignadoAOrdem>
                <nomeConsignatario>Nome do Consignatário</nomeConsignatario>
                <enderecoConsignatario>Endereço do Consignatário</enderecoConsignatario>
                <paisDestino>US</paisDestino>
                <dadosCarga>
                    <documentos>
                        <documento>
                            <numeroDUE>16BR0000081778</numeroDUE>
                            <cargaSoltaVeiculo>
                                <carga>
                                    <tipoEmbalagem>01</tipoEmbalagem>
                                    <total>1000</total>
                                    <quantidade>100</quantidade>
                                    <pesoBruto>2563.231</pesoBruto>
                                </carga>
                            </cargaSoltaVeiculo>
                            <granel>
                                <carga>
                                    <tipoGranel>01</tipoGranel>
                                    <unidademedida>kg</unidademedida>
                                    <total>100654.001</total>
                                    <quantidade>20330.001</quantidade>
                                    <pesoBruto>2563.231</pesoBruto>
                                </carga>
                            </granel>
                        </documento>
                    </documentos>
                </dadosCarga>
            </consignatario>
        </transporteProprio>
        <observacoes>MANIFESTO COM CARGA SOLTA E GRANEL</observacoes>
    </manifestacao>
</ManifestacoesExportacao>

Endpoint:

POST https://<url>/cct/api/ext/carga/manifestacao-dados-embarque

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
ManifestacoesExportacao Manifestação de Carga Coleção de manifestacao body XSD para download

Dados do Manifesto de Embarque - manifestacao

Nome Descrição Tipo Detalhes
identificacaoManifestacao Identificação da Manifestação string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada manifesto no momento da exibição de eventuais mensagens de erro. Este campo é uma chave dentro do arquivo XML, não admitindo duplicatas.
tipoDocumentoTransporte Tipo de Documento de Transporte numeric(2), obrigatório Domínio: Consultar a tabela de domínios Tipo de Documento.
indCargaEnviadaDespacho Indicador Carga Enviada para Despacho string(1) obrigatório Domínio: S (Sim), N(Não).
cargaJaEmbarcada Indicador Carga já Embarcada string(1) obrigatório Domínio: S (Sim), N(Não).
cnpjTransportador CNPJ do Transportador numeric(14) obrigatório (*) Informado e obrigatório apenas para transportador nacional do tipo pessoa jurídica.
cpfTransportador CPF do Transportador numeric(11) obrigatório (*) Informado e obrigatório apenas para transportador nacional do tipo pessoa física.
codigoRA Código do Recinto Aduaneiro numeric(7) obrigatório (*) Obrigatório quando não foi informada uma URF.
codigoURF Código da Unidade de Região Fiscal numeric(7), obrigatório (*) Obrigatório quando não foi informado um RA.
coordenadas Coordenadas Geográficas object coordenadas, obrigatório (*) Obrigatório apenas para o manifesto de embarque de carga ainda não embarcada, quando foi informado uma URF.
cnpjRespEstoqueCarga CNPJ do responsável pelo estoque da carga numeric(14) obrigatório (*) Obrigatório apenas para o manifesto de embarque de carga ainda não embarcada, quando foram informados URF + coordenadas e a carga não consta no estoque de um depositário.
veiculoAereo Dados do veículo aéreo object veiculoAereo, obrigatório Obs: Ao informar o atributo veiculoAereo, outroModal e veiculoAquaviario não poderão ser informados.
veiculoAquaviario Dados do veículo aquaviário object veiculoAquaviario, obrigatório Obs: Ao informar o atributo veiculoAquaviario, veiculoAereo e outroModal não poderão ser informados.
outroModal Dados para veículos de outros modais object outroModal, obrigatório Obs: Ao informar o atributo outroModal, veiculoAereo e veiculoAquaviario não poderão ser informados.
conhecimentosCarga Dados do conhecimento de carga object conhecimento, obrigatório (*) Informado e obrigatório apenas quando a manifestação dos dados de embarque for acobertada por conhecimento de carga.
transporteProprio Dados do transporte próprio dados do consignatario, obrigatório (*) Informado e obrigatório apenas quando a manifestação dos dados de embarque não for acobertada por conhecimento de carga.
observacoes Observações string(250), opcional

Dados do conhecimento de carga - conhecimento

Nome Descrição Tipo Detalhe
numeroConhecimento Número do conhecimento de carga string(5-20) obrigatório Em uma mesma manifestação de embarque não podem ser inseridos conhecimentos de carga com o mesmo número.
dataEmissaoConhecimento Data de emissão do conhecimento de carga string(10), obrigatório Formato: aaaa-mm-dd.
frete Dados do frete object frete, opcional
Consignatário Informações do Consignatário object consignatario, obrigatório

Dados do frete - frete

Nome Descrição Tipo Detalhe
codigoMoedaFrete Código da moeda do Frete string(3), obrigatório Domínio: Tabela Tipo de Moeda.
formaPagamentoFrete Forma de pagamento do Frete numeric(1), obrigatório Domínio: 1 (prepaid), 2 (collect).
valorFrete Valor do frete numeric(12,2), obrigatório

Dados do Consignatário - consignatario

Nome Descrição Tipo Detalhes
consignadoAOrdem Indicador de consignação à ordem string(1), obrigatório Domínio: Domínio: S (Sim), N(Não).
nomeConsignatario Nome do consignatário string(2-60), obrigatório (*) Informado e obrigatório apenas se indicador de consignação à ordem igual a Não.
enderecoConsignatario Endereço do consignatário string(2-120), obrigatório (*) Informado e obrigatório apenas se indicador de consignação à ordem igual a Não.
paisDestino Código do país de destino da carga string(2), obrigatório Domínio: Tabela de Países - código ISO/ALFA2.
cargas Dados das cargas Manifestadas Coleção de dadoscarga, obrigatório

Dados das cargas - dadosCarga

Nome Descrição Tipo Detalhes
documentos Dados das cargas do tipo solta e granel Coleção de documento, obrigatório (*) Obrigatório informar ao menos um dos atributos: conteiner ou documentos.
conteiner Dados do contêiner object conteiner, obrigatório (*) Obrigatório informar ao menos um dos atributos: conteiner ou documentos.

Unitizar Carga

Exemplo: Unitização:

<?xml version="1.0" encoding="UTF-8"?>
<operacaoUnitizacao xmlns="http://www.pucomex.serpro.gov.br/cct">
   <identificacaoResponsavelUnitizacao>99999999999999</identificacaoResponsavelUnitizacao>
   <local>
      <codigoRA>9999999</codigoRA>
   </local>
   <unitizacoes>
      <unitizacao>
         <documentosUnitizacao>
            <documento>
               <numeroDUE>17BR0000999999</numeroDUE>
            </documento>
         </documentosUnitizacao>
         <conteineres>
            <conteiner>
               <numeroConteiner>MOLU123456</numeroConteiner>
               <tara>1500.252</tara>
               <lacres>
                  <lacre>ABC123</lacre>
                  <lacre>CDE456</lacre>
                  <lacre>EDR5676</lacre>
               </lacres>
            </conteiner>
         </conteineres>
      </unitizacao>
   </unitizacoes>
</operacaoUnitizacao>

Endpoint:

POST https://<url>/cct/api/ext/unitizacao/unitizar-carga

Content-Type:

application/xml

Unitização de Carga - operacaoUnitizacao

Nome Descrição Tipo Detalhes
identificacaoResponsavelUnitizacao CNPJ do responsável pela unitização numeric(14), obrigatório Formato: 99999999999999.
local Dados do local da unitização object local, obrigatório
unitizacoes Dados das cargas unitizadas Constituído por (#unitizacao), obrigatório

Local - local

Nome Descrição Tipo Detalhes
codigoURF Código da unidade da Receita Federal onde a unitização está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
coordenadas Dados das coordenadas geográficas do local da unitização object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.
cnpjRespEstoqueCarga CNPJ do responsável pela unitização numeric(14), obrigatório Formato: 99999999999999. (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.
codigoRA Código do recinto aduaneiro onde a unitização está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Obrigatório apenas quando os seguintes campos não forem informados: URF ,coordenadas e responsável pelo estoque. Neste caso, trata-se de unitização em recinto aduaneiro.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Dados das Cargas Unitizadas - unitizacao

Nome Descrição Tipo Detalhes
documentosUnitizacao Documentos de carga envolvidos na unitização Object documentosUnitizacao, obrigatório
conteineres Lista de contêineres envolvidos na unitização Objeto(#conteineres) obrigatório XXX

Documentos envolvidos na unitização - documentosUnitizacao

Nome Descrição Tipo Detalhe
documentos Lista de documentos envolvidos na unitização Coleção de documento, obrigatório
conteineres Lista dos contêineres envolvidos na unitização Coleção de conteiner, obrigatório

Documento - documento

Nome Descrição Tipo Detalhe
numeroDUE Número da DU-E string(14), obrigatório Formato: AABRSSSSSSSSSD. Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado. O número da DU-E não pode ser repetir na lista.
numeroRUC Numero da RUC ou RUC Master string(35), obrigatório Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado. O número da RUC não pode ser repetir na lista.
cargaSoltaVeiculo Dados informados para carga do tipo solta ou para veículos Coleção de carga Informado apenas se houve sobra de solta/veiculo ou granel fora do contêiner.
granel Dados informados para carga do tipo granel Coleção de carga Informado apenas se houve sobra de solta/veiculo ou granel fora do contêiner.

Carga (Solta / Veículo) - carga

Nome Descrição Tipo Detalhes
tipoEmbalagem Tipo de embalagem numeric(2), opcional Conforme a tabela Tipo de Embalagem. Obs: Esta TAG não deve ser informada para veículos e outros tipos de carga que não possuem embalagem.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma operação de carga anteriormente. Caso a TAG quantidade não tenha sido informada, esta TAG será obrigatória.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso a TAG total não tenha sido informada, esta TAG será obrigatória. Além disso, ao menos uma TAG carga deverá conter a TAG quantidade.

Carga (Granel) - carga

Nome Descrição Tipo Detalhes
tipoGranel Tipo de granel numeric(2), obrigatório Conforme a tabela Tipo de Granel.
unidademedida Unidade de medida estatística string(2), obrigatório Domínio: kg = quilo e m3 = metro cúbico.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma operação de carga anteriormente. Caso a TAG quantidade não tenha sido informada, esta TAG será obrigatória.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso a TAG total não tenha sido informada, esta TAG será obrigatória. Além disso, ao menos uma TAG carga deverá conter a TAG quantidade.

Contêiner - conteiner:

Nome Descrição Tipo Detalhes
numeroConteiner Identificação string(11), obrigatório Não será permitida a inclusão de contêineres duplicados.
tara Tara em Kg numeric(9,3), obrigatório
lacres Lacres aplicados string(15), obrigatório Máximo 4 lacres diferentes entre si.

Desunitizar Carga

Exemplo: Desunitização:

<?xml version="1.0" encoding="UTF-8"?>
<operacaoDesunitizacao xmlns="http://www.pucomex.serpro.gov.br/cct">
   <identificacaoResponsavelDesunitizacao>99999999999999</identificacaoResponsavelDesunitizacao>
   <local>
      <codigoRA>9999999</codigoRA>
   </local>
   <desunitizacoes>
      <desunitizacao>
         <numeroConteiner>oc1PnmBn0l</numeroConteiner>
         <documentos>
            <documento>
               <numeroDUE>17BR9999999999</numeroDUE>
               <cargaSoltaVeiculo>
                  <carga>
                     <tipoEmbalagem>60</tipoEmbalagem>
                     <quantidade>50</quantidade>
                  </carga>
               </cargaSoltaVeiculo>
            </documento>
         </documentos>
      </desunitizacao>
   </desunitizacoes>
</operacaoDesunitizacao>

Endpoint:

POST https://<url>/cct/api/ext/unitizacao/desunitizar-carga

Content-Type:

application/xml

Unitização de Carga - operacaoDesunitizacao

Nome Descrição Tipo Detalhes
identificacaoResponsavelDesunitizacao CNPJ do responsável pela Desunitização numeric(14), obrigatório Formato: 99999999999999.
local Dados do local da desunitização object local, obrigatório
desunitizacoes Dados das cargas unitizadas Constituído por (#desunitizacao), obrigatório

Local - local

Nome Descrição Tipo Detalhes
codigoURF Código da unidade da Receita Federal onde a desunitização está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
coordenadas Dados das coordenadas geográficas do local da desunitização object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.
cnpjRespEstoqueCarga CNPJ do responsável pela desunitização numeric(14), obrigatório Formato: 99999999999999. (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.
codigoRA Código do recinto aduaneiro onde a desunitização está sendo efetuada numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Obrigatório apenas quando os seguintes campos não forem informados: URF ,coordenadas e responsável pelo estoque. Neste caso, trata-se de desunitização em recinto aduaneiro.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Dados da Desunitização - desunitizacao

Nome Descrição Tipo Detalhes
numeroConteiner Número do contêiner que será desunitizado obrigatório
documentos documentos de carga envolvidos na desunitização Coleção de documento, obrigatório

Documento - documento

Nome Descrição Tipo Detalhe
numeroDUE Número da DU-E string(14), obrigatório Formato: AABRSSSSSSSSSD. Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado. O número da DU-E não pode ser repetir na lista.
numeroRUC Numero da RUC ou RUC Master string(35), obrigatório Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado. O número da RUC não pode ser repetir na lista.
cargaSoltaVeiculo Dados informados para carga do tipo solta ou para veículos Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.
granel Dados informados para carga do tipo granel Coleção de carga, obrigatório Ao menos um tipo de carga (solta/veiculo ou granel) deve ser informado.

Carga (Solta / Veículo) - carga

Nome Descrição Tipo Detalhes
tipoEmbalagem Tipo de embalagem numeric(2), opcional Conforme a tabela Tipo de Embalagem. Obs: Esta TAG não deve ser informada para veículos e outros tipos de carga que não possuem embalagem.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma operação de carga anteriormente. Caso a TAG quantidade não tenha sido informada, esta TAG será obrigatória.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso a TAG total não tenha sido informada, esta TAG será obrigatória. Além disso, ao menos uma TAG carga deverá conter a TAG quantidade.

Carga (Granel) - carga

Nome Descrição Tipo Detalhes
tipoGranel Tipo de granel numeric(2), obrigatório Conforme a tabela Tipo de Granel.
unidademedida Unidade de medida estatística string(2), obrigatório Domínio: kg = quilo e m3 = metro cúbico.
total quantidade total de volumes deste tipo de carga informado na DU-E numeric(7), obrigatório Obs: opcional apenas quando este tipo de carga já sofreu uma desunitização anteriormente. Caso a TAG quantidade não tenha sido informada, esta TAG será obrigatória.
quantidade quantidade de volumes entregues numeric(7), obrigatório Caso a TAG total não tenha sido informada, esta TAG será obrigatória. Além disso, ao menos uma TAG carga deverá conter a TAG quantidade.

Consolidar Carga

Exemplo: Consolidação de Carga:

<?xml version="1.0" encoding="UTF-8"?>
<operacoesConsolidacao xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct Consolidacao.xsd">
   <operacaoConsolidacao>
      <identificacaoConsolidacao>ABC9999999999999999</identificacaoConsolidacao>
      <numeroMRUC>7BR276574827551833214353477473070</numeroMRUC>
      <tipoDeCarga>2</tipoDeCarga>
      <cnpjConsolidador>99999999999999</cnpjConsolidador>
      <acondicionamento>
         <conteineres>
            <conteiner>
               <numeroConteiner>lMO79Wpir1</numeroConteiner>
               <tara>1500.525</tara>
               <lacres>
                  <lacre>BBC123</lacre>
                  <lacre>BDE456</lacre>
                  <lacre>BDR789</lacre>
               </lacres>
            </conteiner>
         </conteineres>
         <embalagens>
            <embalagem>
               <tipoEmbalagem>01</tipoEmbalagem>
               <quantidade>10</quantidade>
            </embalagem>
         </embalagens>
         <cargasSoltasVeiculos>
            <cargaSoltaVeiculo>
               <quantidade>10</quantidade>
            </cargaSoltaVeiculo>
         </cargasSoltasVeiculos>
         <graneis>
            <granel>
               <tipoGranel>01</tipoGranel>
               <unidademedida>kg</unidademedida>
               <quantidade>123.456</quantidade>
            </granel>
         </graneis>
      </acondicionamento>
      <documentosConsolidacao>
         <documento>
            <numeroDUE>17BR0000451540</numeroDUE>
            <conhecimento>
               <numeroConhecimento>2017071814</numeroConhecimento>
               <dataEmissaoConhecimento>2017-07-18</dataEmissaoConhecimento>
               <codigoMoedaSwift>USD</codigoMoedaSwift>
               <formaPagamentoFrete>1</formaPagamentoFrete>
               <valorFrete>123.45</valorFrete>
               <paisDestino>US</paisDestino>
               <consignadoAOrdem>N</consignadoAOrdem>
               <nomeConsignatario>Consignatario1</nomeConsignatario>
               <enderecoConsignatario>Endereco1</enderecoConsignatario>
            </conhecimento>
         </documento>
         <documento>
            <numeroDUE>17BR0000451567</numeroDUE>
            <conhecimento>
               <numeroConhecimento>2017071815</numeroConhecimento>
               <dataEmissaoConhecimento>2017-07-18</dataEmissaoConhecimento>
               <codigoMoedaSwift>USD</codigoMoedaSwift>
               <formaPagamentoFrete>1</formaPagamentoFrete>
               <valorFrete>123.45</valorFrete>
               <paisDestino>US</paisDestino>
               <consignadoAOrdem>N</consignadoAOrdem>
               <nomeConsignatario>Consignatario1</nomeConsignatario>
               <enderecoConsignatario>Endereco1</enderecoConsignatario>
            </conhecimento>
         </documento>
      </documentosConsolidacao>
   </operacaoConsolidacao>
</operacoesConsolidacao>

Endpoint:

POST https://<url>/cct/api/ext/carga/consolidar-carga

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
operacoesConsolidacao tag que contém todos os dados da consolidação Object operacaoConsolidacao body XSD para download

Consolidação de Carga - operacaoConsolidacao

Nome Descrição Tipo Detalhes
identificacaoConsolidacao Identificação da operação de consolidação string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada consolidação no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
numeroMRUC Numero da RUC Master que identificará esta consolidação string(35), opcional Mesmo formato de uma RUC.
tipoDeCarga Tipo da carga a ser consolidada numeric(1), obrigatório 2 = Solta ou Veículo
cnpjConsolidador CNPJ do responsável pela consolidação numeric(14), obrigatório Formato: 99999999999999.
acondicionamento Dados sobre o acondicionamento da carga object acondicionamento, opcional
documentosConsolidacao Lista de documentos envolvidos na consolidação Coleção de documento, obrigatório OBS: uma DU-E/RUC não pode repetir na lista de documentos. Devem ser incluídos ao menos dois documentos na lista.

Documento - acondicionamento

Nome Descrição Tipo Detalhe
conteineres Lista dos contêineres onde as cargas a serem consolidadas estão acondicionadas Coleção de conteiner, opcional
embalagens Lista das embalagens onde as cargas a serem consolidadas estão acondicionadas Coleção de embalagem, opcional Obs: Não pode haver duplicata de códigos de tipos de embalagem na lista.
cargasSoltasVeiculos Cargas soltas sem embalagem ou veículos envolvidas na consolidação Object cargaSoltaVeiculo, opcional
graneis Granéis envolvidos na consolidação Coleção de granel, opcional Obs: Não pode haver duplicata de códigos de tipos de granel na lista.

Contêiner - conteiner:

Nome Descrição Tipo Detalhes
numeroConteiner Identificação string(11), obrigatório Não será permitida a inclusão de contêineres duplicados.
tara Tara em Kg numeric(9,3), obrigatório
lacres Lacres aplicados string(15), obrigatório Máximo 4 lacres diferentes entre si.

Carga com Embalagem - embalagem

Nome Descrição Tipo Detalhes
tipoEmbalagem Tipo de embalagem numeric(2), obrigatório Conforme a tabela Tipo de Embalagem.
quantidade Quantidade de embalagens deste tipo numeric(7), obrigatório

Carga (Solta sem embalagem / Veículo) - cargaSoltaVeiculo`

Nome Descrição Tipo Detalhes
quantidade quantidade total de cargas soltas sem embalagem / veículos numeric(7), obrigatório

Carga (Granel) - granel

Nome Descrição Tipo Detalhes
tipoGranel Tipo de granel numeric(2), obrigatório Conforme a tabela Tipo de Granel.
unidademedida Unidade de medida estatística string(2), obrigatório Domínio: kg = quilo e m3 = metro cúbico.
total peso bruto total do granel informado na DU-E numeric(7), obrigatório
quantidade peso bruto numeric(7), obrigatório

Documento - documento

Nome Descrição Tipo Detalhe
numeroDUE Número da DU-E string(14), obrigatório Formato: AABRSSSSSSSSSD. Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado. O número da DU-E não pode ser repetir na lista.
numeroRUC Numero da RUC ou RUC Master string(35), obrigatório Obs: Ao informar o atributo numeroDUE, numeroRUC não poderá ser informado. O número da RUC não pode ser repetir na lista.
conhecimento Dados do conhecimento de carga Object conhecimento, obrigatório

Dados do conhecimento de carga - conhecimento

Nome Descrição Tipo Detalhe
numeroConhecimento Número do conhecimento de carga string(5-20) obrigatório
dataEmissaoConhecimento Data de emissão do conhecimento de carga string(10), obrigatório Formato: aaaa-mm-dd.
codigoMoedaSwift Código da moeda do Frete string(3), opcional Domínio: Tabela Tipo de Moeda.
formaPagamentoFrete Forma de pagamento do Frete numeric(1), opcional Domínio: 1 (prepaid), 2 (collect).
valorFrete Valor do frete numeric(12,2), obrigatório
paisDestino Código do país de destino da carga string(2), obrigatório Domínio: Tabela de Países - código ISO/ALFA2.
consignadoAOrdem Indicador de consignação à ordem string(1), obrigatório Domínio: Domínio: S (Sim), N(Não).
nomeConsignatario Nome do consignatário string(2-60), opcional (*) Informado e obrigatório apenas se indicador de consignação à ordem igual a Não.
enderecoConsignatario Endereço do consignatário string(2-120), opcional (*) Informado apenas se indicador de consignação à ordem igual a Não.

Consultar Contêineres

Exemplo de resposta para a consulta de contêineres

{
    "listaRetorno": [
        {
            "numeroConteiner": "SXYOU6BXDF",
            "pesoBruto": 1500.252,
            "tara": 1500.252,
            "lacres": [
                "ABC123",
                "CDE456",
                "EDR5676"
            ],
            "documentosCarga": [
                {
                    "documentos": [
                        {
                            "numeroDUE": "17BR0000453160",
                            "numeroRUC": "7BR00000000100000000000000000048055"
                        }
                    ]
                }
            ],
            "permiteMovimentacao": true
        }
    ],
    "listaMensagem": [
        {
            "codigo": "CCTR-ER0003",
            "mensagem": "Contêiner C222221317325 é inexistente."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/carga/conteiner?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local
nrConteiner Número de contêiner (até 50 ocorrências) String, obrigatório query string

Ex: https://<url>/cct/api/ext/carga/conteiner?nrConteiner=MOLU1021&nrConteiner=MOLU1055&...

Resposta (JSON Schema):

Nome Descrição Tipo
numeroConteiner Número do contêiner string
permiteMovimentacao O valor true indica que o contêiner pode ser movimentado boolean
pesoBruto Peso bruto informado numeric
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao contêiner coleção de strings
Documentos de carga
Documentos Lista de DUE’s e RUC’s vinculadas ao contêiner
numeroDUE Número da DU-E string
numeroRUC Número da RUC string

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Consultar DU-E, RUC e RUC Master

Exemplo de resposta para a consulta de uma DU-E, RUC ou RUC Master

{
    "listaRetorno": [
        {
            "numeroRUC": "6BR00000000100000000000000000003477",
            "numeroDUE": "16BR0000044309",
            "ocorreuDesembaracoOuAutorizacaoEmbarqueAntecipado": true,
            "existeImpedimentoEmbarque": false,
            "indicadorSeCargaRUCMaster": false,
            "numeroRUCMasterDaCarga": "6BR00000000100000000000000000003475",
            "conteineres": [
                "MARK016"
            ],
            "documentosDeTransporte": [
                {
                    "numeroDocumento": "8896325",
                    "tipoDocumento": "MIC-TIF",
                    "identificacaoVeiculo": "KGM2231"
                }
            ],
            "listaCargasSoltasVeiculos": [
                {
                    "tipoEmbalagem": 1,
                    "quantidade": 10
                }
            ],
            "listaGraneis": [
                {
                    "tipoGranel": 60,
                    "sgUnidadeMedida": "kg",
                    "quantidade": 10.001
                }
            ]
        }
    ],
    "listaMensagem": [
        {
            "codigo": "CCTR-ER0172",
            "mensagem": "DU-E 17BR0000181268 já está Averbada."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/carga/due-ruc?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local
nrDocumento Número da DU-E, da RUC ou RUC Master (até 50 ocorrências) String, obrigatório query string

Ex: https://<url>/cct/api/ext/carga/due-ruc?nrDocumento=16BR0000044198&nrDocumento=16BR0000044279&nrDocumento=6BR00000000100000000000000000003477&...

Resposta (JSON Schema):

Nome Descrição Tipo
numeroDUE Número da DU-E string
numeroRUC Número da RUC string
ocorreuDesembaracoOuAutorizacaoEmbarqueAntecipado O valor true indica que a DU-E/RUC está desembaraçada ou com autorização de embarque antecipado boolean
existeImpedimentoEmbarque O valor true indica que a DU-E/RUC está com um impedimento de embarque boolean
indicadorSeCargaRUCMaster O valor true indica que a RUC informada no parâmetro é uma RUC Master boolean
numeroRUCMasterDaCarga Número da RUC Master onde está consolidada a DU-E/RUC informada no parâmetro string
conteineres Lista com os números de contêineres vinculados diretamente a DU-E/RUC informada no parâmetro coleção de strings
Dados dos documentos de transporte
numeroDocumento Número do voo, número da escala ou do documento de transporte string
tipoDocumento Aéreo, aquaviário ou (MIC, TIF, DTAI, Outros e DAT) string
identificacaoVeiculo Prefixo da aeronave, código IMO ou identificação do veículo string
Dados Carga Solta ou Veículo
tipoEmbalagem Código do tipo de embalagem ou branco (carga sem emabalgem) numeric
quantidade Quantidade total de unidades da carga numeric
Granel
tipoGranel Código do tipo de granel numeric
sgUnidadeMedida sigla da unidade do granel (kg ou m3) string
quantidade Quantidade total de graneis no peso ou volume da carga numeric

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Tabela de dados dos documentos de transporte :

Tipo Documento Veículo
Aéreo Número do Voo Prefixo da Aeronave
Aquaviário Número da Escala Código IMO
MIC, TIF, DTAI, Outros e DAT Documento de Transporte Identificação do Veículo

Consultar RUC Master

Exemplo de resposta para a consulta de uma RUC Master

{
    "listaRetorno": [
        {
            "numeroMRUC": "7BR276574896791206600205675746307",
            "documentosCarga": [
                {
                    "nivel": "1",
                    "documentos": [
                        {
                            "numeroDUE": "17BR0000504490",
                            "numeroRUC": "7BR00000000100000000000000000053520"
                        },
                        {
                            "numeroDUE": "17BR0000504482",
                            "numeroRUC": "7BR00000000100000000000000000053519"
                        },
                        {
                            "numeroRUC": "7BR276574839586872869001557024101"
                        }
                    ]
                },
                {
                    "nivel": "2",
                    "documentos": [
                        {
                            "numeroDUE": "17BR0000504466",
                            "numeroRUC": "7BR00000000100000000000000000053517"
                        },
                        {
                            "numeroDUE": "17BR0000504474",
                            "numeroRUC": "7BR00000000100000000000000000053518"
                        }
                    ]
                }
            ],
            "permiteMovimentacao": true
        }
    ],
    "listaMensagem": [
        {
            "mensagem": "RUC Master 6BR27657485100000000000000000053420 está vinculada a DU-E averbada.",
            "codigoErro": "CCTR-ER0215"
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/carga/mruc?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local
nrDocumento Número da RUC Master (até 50 ocorrências) String, obrigatório query string

Ex: https://<url>/cct/api/ext/carga/mruc?nrDocumento=6BR000000001RUCTESTE&nrDocumento=6BR0739686518888&...

Resposta (JSON Schema):

Nome Descrição Tipo
numeroMRUC Número da RUC Master consultada string
permiteMovimentacao O valor true indica que a RUC Master pode ser movimentada boolean
Documentos de carga Caso o retorno seja RUC Master então será buscada a árvore da mesma e serão retornados os mesmos dados acimas até o último nível
nivel Nível dentro da árvore de consolidação das DU-Es e RUCs e RUC Masters vinculadas a RUC Master informada numeric
Documentos Lista de DUE’s e RUC’s e RUC Masters vinculadas a RUC Master dentro do nível indicado
numeroDUE Número da DU-E string
numeroRUC Número da RUC string

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Consultar Estoque Pós-ACD

Exemplo de resposta para a consulta de Estoque Pós-ACD

{
  "lista": [
    {
      "anoCarga": 2017,
      "sequenciaCarga": 2352,
      "codigoURF": 717700,
      "codigoRA": null,
      "latitude": "-22.812222",
      "longitude": "-43.248333",
      "idResponsavel": "27657485000147",
      "nomeResponsavel": "IHWIQBHIWMVHU KXIXW DVNW",
      "numeroDUE": null,
      "numeroRUC": "6BR27657485100000000000000000059755",
      "codigoPaisImportador": null,
      "nomePaisImportador": "Informação indisponível.",
      "codigoSituacaoEspecial": null,
      "nomeSituacaoEspecial": "",
      "existeConteiner": "N",
      "situacaoEspecial": ""
    },
    {
      "anoCarga": 2017,
      "sequenciaCarga": 2315,
      "codigoURF": 717700,
      "codigoRA": null,
      "latitude": "-22.812222",
      "longitude": "-43.248333",
      "idResponsavel": "27657485000147",
      "nomeResponsavel": "IHWIQBHIWMVHU KXIXW DVNW",
      "numeroDUE": "17BR0001034900",
      "numeroRUC": "7BR00000000100000000000000000059726",
      "codigoPaisImportador": 249,
      "nomePaisImportador": "ESTADOS UNIDOS",
      "codigoSituacaoEspecial": 2,
      "nomeSituacaoEspecial": "Embarque antecipado",
      "existeConteiner": "N",
      "situacaoEspecial": "Embarque antecipado"
    }
  ]
}

Endpoint:

GET https://<url>/cct/api/ext/deposito-carga/estoque-pos-acd

Content-Type:

application/json

Parâmetros de Entrada:

Obs: Os filtros abaixo seguem a separação apresentada na tela, e não podem ser combinados.

Nome Descrição Tipo Local
nrDocumento Número da DU-E, da RUC ou RUC Master String query string

Ex: https://<url>/cct/api/ext/deposito-carga/estoque-pos-acd?nrDocumento=7BR00000000100000000000000000058605

Nome Descrição Tipo Local
numeroConteiner Número de um Contênier string query string

Ex: https://<url>/cct/api/ext/deposito-carga/estoque-pos-acd?numeroConteiner=MOLU1032

Nome Descrição Tipo Local
dataEntradaInicial Data inicial do período de entrada no estoque string query string (formato = “ano-mês-dia” ex: 2017-11-30)
dataEntradaFinal Data final do período de entrada no estoque string query string (formato = “ano-mês-dia” ex: 2017-11-30)
codigoURF Unidade da RFB onde carga está estocada numeric query string
codigoRA Recinto Aduaneiro onde carga está estocada numeric query string
cpfOuCnpjResponsavel CPF ou CNPJ do responsável pela carga no estoque string query string
cpfOuCnpjConsolidador CPF ou CNPJ do responsável pela consolidação da carga no estocada string query string
cpfOuCnpjExportador CPF ou CNPJ do Exportador da DUE estocada string query string
codigoPaisImportador Código do país do importador (Tabela de país) numeric query string
codigoPaisDestino Código do país de destino da carga (Tabela de país) numeric query string

Ex: https://<url>/cct/api/ext/deposito-carga/estoque-pos-acd?dataEntradaInicial=2017-11-15&dataEntradaFinal=2017-11-30&codigoURF=0717700

(*) Para consultar por período, o usuário deve informar o período e ao menos mais um campo adicional. O período de consulta não pode ser superior a 15 dias.

Resposta (JSON Schema):

Nome Descrição Tipo
anoCarga Ano de registro da informação numeric
sequenciaCarga indentificação do registro da informação numeric
codigoURF Código da Unidade da RFB numeric
codigoRA Código do Recinto Aduaneiro numeric
latitude Latitude do local string
longitude Longitude do local string
idResponsavel CNPJ ou CPF do responsável pela carga string
nomeResponsavel Nome do responsável string
numeroDUE Número da DUE String
numeroRUC Número da RUC string
codigoPaisImportador Código do país do importador numeric
nomePaisImportador Nome do país do importador string
codigoSituacaoEspecial Código que indica a situação da carga numeric
nomeSituacaoEspecial Nome que descreve a sistuação especial da carga string
existeConteiner Indicador se carga vinculada a contêiner string (S = carga vinculada a contêiner ou N = carga não vinculada a contêiner)
situacaoEspecial Detalhe da situação especial da carga string (opções possíveis: embarque antecipado; em mãos; ficta ou meios próprios - domínio recuperado da DU-E, no módulo DA do PUCOMEX)

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Consultar Estoque Pré-ACD de NF-e

Exemplo de resposta para a consulta

{
  "estoqueNotasFiscais": [
    {
      "numero": "35190107689002000189551010000005001956156300",
      "urf": "0717700",
      "recinto": "7911101",
      "latitude": "-29.771832",
      "longitude": "-57.045485",
      "registro": "2019-01-05T13:16:53.686+0000",
      "responsavel": "01691041000568",
      "itens": [
        {
          "item": 1,
          "saldo": 1000
        }
      ]
    }
  ],
  "mensagens": [
    {
      "codigo": "CCTR-ER0003",
      "mensagem": "Nota Fiscal 45190107689002000189551010000005231956156305 é inexistente."
    }
  ]
}

Endpoint:

GET https://<url>/cct/api/deposito-carga/estoque-nota-fiscal/

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
danfes Lista de DANFEs separados por vírgula String, obrigatório param string

Ex: https://<url>/cct/api/ext/deposito-carga/estoque-nota-fiscal/35190107689002000189551010000005121956156301,45190107689002000189551010000005231956156305 ...

Resposta (JSON Schema):

Nome Descrição Tipo
estoqueNotasFiscais Lista de Estoque da NF-e Coleção de Estoque NFe
mensagens Lista de Mensagens de alerta ou Erro Coleção de mensagem

Estoque NFe:

Nome Descrição Tipo Detalhes
numero Número DANFE da NFe string
urf Código da unidade da Receita Federal onde está estocada a nota string Domínio: Tabela de Unidades da RFB
recinto Código do recinto aduaneiro onde está estocada a nota string Domínio: Tabela de Recintos Aduaneiros.
latitude Latitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
registro Data do registro em estoque string Formato: AAAA-MM-DDTHH:MI:SS
responsavel CPF ou CNPJ do responsável pelo estoque string
itens Lista de itens da NF-e Coleção de Itens de NF-e

Itens de NF-e:

Nome Descrição Tipo Detalhes
item Número do item da NFe numeric
saldo saldo do item da NFe no estoque numeric

Mensagem de alerta ou erro da consulta:

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Documento de Transporte

Recepcionar

Exemplo de entrada:

<?xml version="1.0" encoding="UTF-8"?>
<recepcoesDocumentoTransporte xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct RecepcaoDocumentoTransporte.xsd ">
  <recepcaoDocumentoTransporte>
    <identificacaoRecepcao>REC-DAT01</identificacaoRecepcao>
    <cnpjResp>99999999999999</cnpjResp>
    <local>
      <codigoURF>0717600</codigoURF>
      <codigoRA>7921301</codigoRA>
    </local>
    <documentosTransporte>
      <documentoTransporte>
        <identificacaoDocumentoTransporte>16BR0008093</identificacaoDocumentoTransporte>
        <tipoDocumentoTransporte>04</tipoDocumentoTransporte>
        <dataEmissaoDocumentoTransporte>2016-12-16</dataEmissaoDocumentoTransporte>
        <dadosVeiculoConferemRecepcao>S</dadosVeiculoConferemRecepcao>
        <dadosUnidadeTransporteConferemRecepcao>S</dadosUnidadeTransporteConferemRecepcao>
        <dadosConteinerConferemRecepcao>S</dadosConteinerConferemRecepcao>
        <pesoAferido>100.000</pesoAferido>                                       
      </documentoTransporte>
    </documentosTransporte>
    <transportador>
        <cnpj>99999999999999</cnpj>
        <cpfCondutor>99999999999</cpfCondutor>
    </transportador>    
    <localArmazenamento>local do armazenamento</localArmazenamento>
    <codigoIdentCarga>6564114553</codigoIdentCarga>
    <avariasIdentificadas>Descrição das avarias identificadas</avariasIdentificadas>
    <divergenciasIdentificadas>Descrição das avarias identificadas</divergenciasIdentificadas>
    <observacoesGerais>Observações Gerais</observacoesGerais>
  </recepcaoDocumentoTransporte>
</recepcoesDocumentoTransporte>

Endpoint:

POST https://<url>/cct/api/ext/documento-transporte/recepcao-dat

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
recepcoesDocumentoTransporte Recepções dos Documentos de Transporte Coleção de recepcaoDocumentoTransporte, obrigatório body XSD para download

Recepção por Documento de Transporte - recepcaoDocumentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoRecepcao Identificação da recepção string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
cnpjResp CNPJ do responsável pela recepção string(14), obrigatório
local Dados do local da recepção object local, obrigatório
referenciaLocalRecepcao Referência do Local de recepção string(150), opcional
documentosTransporte Dados dos documentos de transporte Coleção de documentoTransporte, obrigatório Esta lista deve conter até 1000
transportador Dados do Transportador object transportador, obrigatório
localArmazenamento Local de armazenamento da carga string(150), opcional
codigoIdentCarga Código de identificação da carga string(150), opcional
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações adicionais string(250), opcional

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da Unidade da Receita Federal numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
codigoRA Código do Recinto Aduaneiro numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Documento de Transporte - documentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoDocumentoTransporte Identificação do documento de transporte string(25), obrigatório
tipoDocumentoTransporte Tipo do documento de transporte numeric(2), obrigatório
dataEmissaoDocumentoTransporte Data de emissão do documento de transporte string(10), obrigatório Formato: AAAA-MM-DD
dadosVeiculoConferem Indicador de conferência dos dados do veículo com os dados recepcionados string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosUnidadeTransporteConferem Indicador de conferência dos dados da unidade de transporte com os dados recepcionados string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosConteinerConferem Indicador de conferência dos dados do contêiner com os dados recepcionados string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosEmbalagemConferem Indicador de conferência dos dados das embalagens com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.

Transportador - transportador:

Nome Descrição Tipo Detalhes
cnpj CNPJ do transportador string(14), obrigatório* (*) Deve ser informado somente quando cpf e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
cpf CPF do transportador string(11), obrigatório* (*) Deve ser informado somente quando cnpj e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
nomeEstrangeiro Nome do transportador quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cnpj e cpf não forem informados. Neste caso, é obrigatório.
cpfCondutor CPF do condutor string(11), obrigatório* (*) Deve ser informado somente quando nomeCondutorEstrangeiro não for informado. Neste caso, é obrigatório.
nomeCondutorEstrangeiro Nome do condutor quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cpfCondutor não for informado. Neste caso, é obrigatório.

Recepcionar (Versão à ser implantada no dia 24/06/2018)

Exemplo de entrada:

<?xml version="1.0" encoding="UTF-8"?>
<recepcoesDocumentoTransporte xmlns="http://www.pucomex.serpro.gov.br/cct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pucomex.serpro.gov.br/cct RecepcaoDocumentoTransporte.xsd ">
  <recepcaoDocumentoTransporte>
    <identificacaoRecepcao>REC-DAT01</identificacaoRecepcao>
    <cnpjResp>99999999999999</cnpjResp>
    <local>
      <codigoURF>0717600</codigoURF>
      <codigoRA>7921301</codigoRA>
    </local>
    <documentosTransporte>
      <documentoTransporte>
        <identificacaoDocumentoTransporte>16BR0008093</identificacaoDocumentoTransporte>
        <tipoDocumentoTransporte>04</tipoDocumentoTransporte>
        <dataEmissaoDocumentoTransporte>2016-12-16</dataEmissaoDocumentoTransporte>
        <dadosVeiculoConferemRecepcao>S</dadosVeiculoConferemRecepcao>
        <dadosUnidadeTransporteConferemRecepcao>S</dadosUnidadeTransporteConferemRecepcao>
        <dadosConteinerConferemRecepcao>S</dadosConteinerConferemRecepcao>
        <pesoAferido>100.000</pesoAferido>                                       
      </documentoTransporte>
    </documentosTransporte>
    <transportador>
        <cnpj>99999999999999</cnpj>
        <cpfCondutor>99999999999</cpfCondutor>
    </transportador>    
    <localArmazenamento>local do armazenamento</localArmazenamento>
    <codigoIdentCarga>6564114553</codigoIdentCarga>
    <avariasIdentificadas>Descrição das avarias identificadas</avariasIdentificadas>
    <divergenciasIdentificadas>Descrição das avarias identificadas</divergenciasIdentificadas>
    <observacoesGerais>Observações Gerais</observacoesGerais>
  </recepcaoDocumentoTransporte>
</recepcoesDocumentoTransporte>

Endpoint:

POST https://<url>/cct/api/ext/documento-transporte/recepcao-documento-transporte

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
recepcoesDocumentoTransporte Recepções dos Documentos de Transporte Coleção de recepcaoDocumentoTransporte, obrigatório body XSD para download

Recepção por Documento de Transporte - recepcaoDocumentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoRecepcao Identificação da recepção string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
cnpjResp CNPJ do responsável pela recepção string(14), obrigatório
local Dados do local da recepção object local, obrigatório
referenciaLocalRecepcao Referência do Local de recepção string(150), opcional
documentosTransporte Dados dos documentos de transporte Coleção de documentoTransporte, obrigatório Esta lista deve conter até 1000
transportador Dados do Transportador object transportador, obrigatório
localArmazenamento Local de armazenamento da carga string(150), opcional
codigoIdentCarga Código de identificação da carga string(150), opcional
avariasIdentificadas Avarias identificadas string(250), opcional
divergenciasIdentificadas Divergências identificadas string(250), opcional
observacoesGerais Observações adicionais string(250), opcional

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da Unidade da Receita Federal numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
codigoRA Código do Recinto Aduaneiro numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Documento de Transporte - documentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoDocumentoTransporte Identificação do documento de transporte string(25), obrigatório
tipoDocumentoTransporte Tipo do documento de transporte numeric(2), obrigatório
dataEmissaoDocumentoTransporte Data de emissão do documento de transporte string(10), obrigatório Formato: AAAA-MM-DD
dadosVeiculoConferem Indicador de conferência dos dados do veículo com os dados recepcionados string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosUnidadeTransporteConferem Indicador de conferência dos dados da unidade de transporte com os dados recepcionados string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosConteinerConferem Indicador de conferência dos dados do contêiner com os dados recepcionados string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosEmbalagemConferem Indicador de conferência dos dados das embalagens com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.

Transportador - transportador:

Nome Descrição Tipo Detalhes
cnpj CNPJ do transportador string(14), obrigatório* (*) Deve ser informado somente quando cpf e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
cpf CPF do transportador string(11), obrigatório* (*) Deve ser informado somente quando cnpj e nomeEstrangeiro não forem informados. Neste caso, é obrigatório.
nomeEstrangeiro Nome do transportador quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cnpj e cpf não forem informados. Neste caso, é obrigatório.
cpfCondutor CPF do condutor string(11), obrigatório* (*) Deve ser informado somente quando nomeCondutorEstrangeiro não for informado. Neste caso, é obrigatório.
nomeCondutorEstrangeiro Nome do condutor quando for estrangeiro string(60), obrigatório* (*) Deve ser informado somente quando cpfCondutor não for informado. Neste caso, é obrigatório.

Entregar

Exemplo de entrada:

<entregasDocumentoTransporte  xmlns="http://www.pucomex.serpro.gov.br/cct">
  <entregaDocumentoTransporte>
    <identificacaoEntrega>ENT001</identificacaoEntrega>
    <identificacaoPessoaJuridica>99999999999999</identificacaoPessoaJuridica>
    <local>
      <codigoURF>0717700</codigoURF>
      <codigoRA>7911101</codigoRA>
    </local>
    <documentosTransporte>
    <documentoTransporte>
        <identificacaoDocumentoTransporte>16BR0008093</identificacaoDocumentoTransporte>
        <tipoDocumentoTransporte>1</tipoDocumentoTransporte>
        <emissaoDocumentoTransporte>234569696</emissaoDocumentoTransporte>
        <dadosVeiculoConferem>NA</dadosVeiculoConferem>
        <dadosUnidadeTransporteConferem>S</dadosUnidadeTransporteConferem>
        <dadosConteinerConferem>S</dadosConteinerConferem>
        <dadosEmbalagemConferem>S</dadosEmbalagemConferem>
        <pesoAferido>100.000</pesoAferido>
        </documentoTransporte>
    </documentosTransporte>

  </entregaDocumentoTransporte>
</entregasDocumentoTransporte>

Endpoint:

POST https://<url>/cct/api/ext/documento-transporte/entrega-dat

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
entregasDocumentoTransporte Entregas por Documentos de Transporte Coleção de entregaDocumentoTransporte, obrigatório body XSD para download

Entrega por Documento de Transporte - entregaDocumentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoEntrega Identificação da entrega string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada entrega no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
identificacaoPessoaJuridica CNPJ do responsável pela entrega string(14), obrigatório
local Dados do local da entrega object local, obrigatório
documentosTransporte Dados dos documentos de transporte Coleção de documentoTransporte, obrigatório Esta lista pode conter até 200 documentos de transporte.

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da Unidade da Receita Federal numeric(7), obrigatório Domínio: Tabela de Unidades da RFB.
codigoRA Código do Recinto Aduaneiro numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Documento de Transporte - documentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoDocumentoTransporte Identificação do documento de transporte string(25), obrigatório
tipoDocumentoTransporte Tipo do documento de transporte numeric(2), obrigatório
dataEmissaoDocumentoTransporte Data de emissão do documento de transporte string(10), obrigatório Formato: AAAA-MM-DD
dadosVeiculoConferem Indicador de conferência dos dados do veículo com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosUnidadeTransporteConferem Indicador de conferência dos dados da unidade de transporte com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosConteinerConferem Indicador de conferência dos dados do contêiner com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosEmbalagemConferem Indicador de conferência dos dados das embalagens com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.

Entregar (Versão à ser implantada no dia 24/06/2018)

Exemplo de entrada:

<entregasDocumentoTransporte  xmlns="http://www.pucomex.serpro.gov.br/cct">
  <entregaDocumentoTransporte>
    <identificacaoEntrega>ENT001</identificacaoEntrega>
    <identificacaoPessoaJuridica>99999999999999</identificacaoPessoaJuridica>
    <local>
      <codigoURF>0717700</codigoURF>
      <codigoRA>7911101</codigoRA>
    </local>
    <documentosTransporte>
    <documentoTransporte>
        <identificacaoDocumentoTransporte>16BR0008093</identificacaoDocumentoTransporte>
        <tipoDocumentoTransporte>1</tipoDocumentoTransporte>
        <emissaoDocumentoTransporte>234569696</emissaoDocumentoTransporte>
        <dadosVeiculoConferem>NA</dadosVeiculoConferem>
        <dadosUnidadeTransporteConferem>S</dadosUnidadeTransporteConferem>
        <dadosConteinerConferem>S</dadosConteinerConferem>
        <dadosEmbalagemConferem>S</dadosEmbalagemConferem>
        <pesoAferido>100.000</pesoAferido>
        </documentoTransporte>
    </documentosTransporte>
    <transitoSimplificado>
        <codigoURFDestino>0717700</codigoURFDestino>
        <cnpjRespDestino>00000000000272</cnpjRespDestino>
    </transitoSimplificado>
  </entregaDocumentoTransporte>
</entregasDocumentoTransporte>

Endpoint:

POST https://<url>/cct/api/ext/documento-transporte/entrega-documento-transporte

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
entregasDocumentoTransporte Entregas por Documentos de Transporte Coleção de entregaDocumentoTransporte, obrigatório body XSD para download

Entrega por Documento de Transporte - entregaDocumentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoEntrega Identificação da entrega string(50), obrigatório Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada entrega no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.
identificacaoPessoaJuridica CNPJ do responsável pela entrega string(14), obrigatório
local Dados do local da entrega object local, obrigatório
documentosTransporte Dados dos documentos de transporte Coleção de documentoTransporte, obrigatório Esta lista pode conter até 200 documentos de transporte.
transitoSimplificado Conjunto de informações obrigatórias ao informar Trânsito Simplificado object transitoSimplificadoDocumentoTransporte, opcional

Local - local:

Nome Descrição Tipo Detalhes
codigoURF Código da Unidade da Receita Federal numeric(7), obrigatório Domínio: Tabela de Unidades da RFB.
codigoRA Código do Recinto Aduaneiro numeric(7), obrigatório Domínio: Tabela de Recintos Aduaneiros. (*) Deve ser informado somente quando coordenadas não for informado. Neste caso, é obrigatório.
coordenadas Dados das coordenadas geográficas object coordenadas(1), obrigatório* (*) Deve ser informado somente quando codigoRA não for informado. Neste caso, é obrigatório.

Coordenadas Geográficas - coordenadas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11), obrigatório Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Documento de Transporte - documentoTransporte:

Nome Descrição Tipo Detalhes
identificacaoDocumentoTransporte Identificação do documento de transporte string(25), obrigatório
tipoDocumentoTransporte Tipo do documento de transporte numeric(2), obrigatório
dataEmissaoDocumentoTransporte Data de emissão do documento de transporte string(10), obrigatório Formato: AAAA-MM-DD
dadosVeiculoConferem Indicador de conferência dos dados do veículo com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosUnidadeTransporteConferem Indicador de conferência dos dados da unidade de transporte com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosConteinerConferem Indicador de conferência dos dados do contêiner com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
dadosEmbalagemConferem Indicador de conferência dos dados das embalagens com os dados informados na entrega string(1), obrigatório Domínio: S = Sim, N = Não e NA = Não se aplica
pesoAferido Peso aferido na balança do recinto em Kg numeric(9,3), obrigatório* (*) Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.
motivoNaoPesagem Motivo da não realização da pesagem string(250), obrigatório* (*) Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.

Transito Simplificado - transitoSimplificadoDocumentoTransporte

Nome Descrição Tipo Detalhes
codigoRADestino Código do Recinto Aduaneiro do local de destino do trânsito numeric(7), opcional Deve ser informado quando não for informada a Unidade da Receita Federal de destino
codigoURFDestino Código da Unidade da Receita Federal do local de destino do trânsito numeric(7), opcional Deve ser informado junto com o CNPJ Responsável do Destino quando não for informado o Recinto Aduaneiro
cnpjRespDestino CNPJ do responsável do local de destino do trânsito numeric(14), opcional Deve ser informado junto com o código da Unidade da Receita Federal no destino quando não for informado o Recinto Aduaneiro

Consultar

Exemplo de resposta para a consulta de Documento de Transporte

{
    "documentosTransporte": [
        {
            "numeroDocumento": "17BR0027350",
            "tipoDocumento": "08",
            "viaTransporte": "07",
            "situacaoDocumento": "Manifestado",
            "cargas": [
                {
                    "conteiner": {
                        "numeroConteiner": "MARC02",
                        "tara": 1.001,
                        "lacres": [
                            "lacre02",
                            "lacre01"
                        ]
                    }
                },
                {
                    "numeroDue": "16BR0000080445",
                    "numeroRuc": "6BR00000000100000000000000000007620"
                }
            ],
            "veiculoRodoviario": {
                "veiculo": {
                    "nomeCondutor": "fulano",
                    "cpfCondutor": "05329594774",
                    "documentoCondutor": "321321321321",
                    "placa": "kpl5555",
                    "tara": 454.545,
                    "lacres": [
                        "lacre123213",
                        "LADSD"
                    ]
                },
                "reboques": [
                    {
                        "placa": "LJJ9929",
                        "tara": 213.123,
                        "lacres": [
                            "LACREQW443",
                            "LASDSAD234"
                        ]
                    }
                ]
            }
        }
    ],
    "listaMensagem": [
        {
            "codigo": "CCTR-ER0003",
            "mensagem": "Contêiner C222221317325 é inexistente."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/documento-transporte?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
tipo Número do tipo de documento de transporte numeric, obrigatório query numeric 1=MIF-DTA, 2=TIF-DTA, 3=DTAI, 4=OUTROS e 8=DAT
nrDocumento Número do documento de transporte (até 50 ocorrências) String, obrigatório query string -

Ex: https://<url>/cct/api/ext/documento-transporte?tipo=8&nrDocumento=17BR0040836&nrDocumento=17BR0040836&...

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numeroDocumento Número do documento de transporte string
tipoDocumento Código do tipo de documento de transporte string
viaTransporte Código da via de transporte string
situacaoDocumento Status do documento de transporte string caso tipo não seja DAT o status sempre será Manifestado
Lista de Cargas Lista de DUE’s e/ou RUC’s e contêineres vinculados ao documento de trasnporte
numeroDUE Número da DU-E string
numeroRUC Número da RUC string
Conteiner
numeroConteiner Número do contêiner string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao contêiner coleção de strings
Caso documento seja DAT do tipo completo
Se via de transporte for rodoviária
Para cada veículo
nomeCondutor Nome do condutor do DAT string
cpfCondutor CPF do condutor do DAT quando nacional string
documentoCondutor Documento do condutor do DAT quando estrangeiro string
placa Placa do veículo string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao veículo coleção de strings
Para cada reboque
placa Placa do veículo string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao veículo coleção de strings
Se via de transporte for ferroviária
prefixoTrem Prefixo do trem string
quantidadeVagoes Quantidade de vagões numeric
Caso documento NÃO seja DAT
identificacaoVeiculo Identificação Veículo string
dataEmissaoDocumentoTransporte Data de Emissão do documento de Transporte string

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Tipos de documentos de transporte :

Código Descrição
01 MIC/DTA - Manifesto Internacional de Carga / Declaração de Trânsito Aduaneiro
02 TIF/DTA - Carta de Porte Internacional / Declaração de Trânsito Aduaneiro
03 DTAI - Declaração de Trânsito Aduaneiro Internacional
04 Outros Documentos de Manifesto Internacional
08 DAT -Documento de Acompanhamento de Trânsito

Código da via de transporte :

Código Descrição
01 MARITIMA
02 FLUVIAL
03 LACUSTRE
04 AEREA
05 POSTAL
06 FERROVIARIA
07 RODOVIARIA
08 DUTO / REDE TRANSMISSAO
09 MEIOS PROPRIOS
10 VIA FICTA
11 COURRIER

Status do DAT :

Código Descrição
1 Manifestado
2 Trânsito Concedido
3 Trânsito Iniciado
4 Recebido em Trânsito
5 Trânsito Concluído
6 Cancelado

Consultar DAT

Exemplo de resposta para a consulta de DAT

{
    "documentosTransporte": [
        {
            "numeroDocumentoTransporte": "19BR0022213",
            "tipoDocumentoTransporte": "DAT",
            "viaTransporte": "RODOVIARIA",
            "situacaoAtual": "Trânsito Iniciado",
            "dataEmissao": "2019-01-15",
            "cpfCnpjTransportador": "27657485000147",
            "nomeTransportador": "IEYIQBEIWMVEU KXIXW DVNW",
            "tipoDAT": "COMPLETO",
            "localDestinoPrevisto": {
                "urf": {
                    "codigo": "0717600",
                    "descricao": "PORTO DO RIO"
                },
                "ra": {
                    "codigo": "7921301",
                    "descricao": "PORTO DO RIO DE JANEIRO - CODERJ - RIO DE JANEIRO/RJ - PORTO MARIT.ALFAND.-USO PUBLICO-CIA.DOCAS DO EST.DO RIO DE JANEIR"
                },
                "responsavel": {
                    "codigo": "42266890000128",
                    "descricao": "KXMPWMCQW NXKWU NX IQX NE RWMEQIX"
                },
                "coordenadas": {
                    "latitude": "-20.812222",
                    "longitude": "-40.248333"
                },
                "uf": {
                    "codigo": "RJ"
                },
                "municipio": {
                    "codigo": "6001",
                    "descricao": "RIO DE JANEIRO"
                }
            },
            "localEstoque": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "responsavel": {
                    "codigo": "07073311703",
                    "descricao": "TOZFXL WZ HROEZ WLH HZMGLH"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "veiculoRodoviario": {
                "cpjCnpjResponsavel": "01650261705",
                "nomeResponsavel": "HZMWIL WL MZHXRNVMGL ZIZFQL",
                "veiculo": {
                    "nomeCondutor": "nome cond estrangeiro",
                    "documentoCondutor": "doc123",
                    "placa": "FCXYK01",
                    "tara": 111.111,
                    "lacres": [
                        "1",
                        "2",
                        "3",
                        "4"
                    ]
                },
                "reboques": [
                    {
                        "placa": "6OMPKJJ",
                        "tara": 333.333,
                        "lacres": [
                            "444",
                            "333",
                            "111",
                            "222"
                        ]
                    }
                ]
            },
            "cargas": [
                {
                    "numeroDue": "19BR0003000493",
                    "numeroRuc": "9BR00000000100000000000000000016650",
                    "tipoCarga": {
                        "codigo": "Solta ou Veículo",
                        "descricao": "PALLETS"
                    },
                    "siglaUnidadeMedida": "un",
                    "quantidadeManifestada": 20
                },
                {
                    "numeroDue": "19BR0003000493",
                    "numeroRuc": "9BR00000000100000000000000000016650",
                    "tipoCarga": {
                        "codigo": "Granel",
                        "descricao": "SOJA EM GRÃO"
                    },
                    "siglaUnidadeMedida": "kg",
                    "quantidadeManifestada": 100
                }
            ]
        }
    ],
    "mensagens": [
        {
            "codigo": "CCTR-ER0003",
            "mensagem": "Documento de Transporte 19BR0022264 é inexistente."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/documento-transporte/dat?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
documentos Lista de DAT (número do documento) separados por “¦” String, obrigatório query string Cada documento de Transporte DAT é formado pelo número do DAT

Ex: https://<url>/cct/api/ext/documento-transporte/dat?documentos=19BR0022213|19BR0022264 ....

Resposta (JSON Schema):

Nome Descrição Tipo
documentosTransporte Lista de Documentos de Transporte Coleção de documentoTransporte
mensagens Lista de Mensagens de alerta ou Erro Coleção de mensagem

Documento de Transporte:

Nome Descrição Tipo Detalhes
numeroDocumentoTransporte Número do documento de transporte string
tipoDocumentoTransporte Tipo de documento de transporte string valor: DAT
viaTransporte Via de transporte string
situacaoAtual Situação do documento de transporte string
dataEmissao Data de Emissão do Documento de Transporte string No formato AAAA-MM-YY
cpfCnpjTransportador CPF ou CNPJ do Transportador string
nomeTransportador Nome do Transportador string
tipoDAT Tipo do DAT string valor: “COMPLETO” ou “SIMPLIFICADO”
localDestinoPrevisto Local de Destino Previsto do DAT object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
localEstoque Local onde está estocado o DAT object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
veiculoRodovario Informações sobre o veículo Rodoviário object veiculoRodoviario Se via de Transporte for "Rodoviária" e tipo de DAT for "COMPLETO"
veiculoFerroviario Informações sobre o veículo Ferroviário object veiculoFerroviario Se via de Transporte for "Ferroviária" e tipo de DAT for "COMPLETO"
cargas Lista de DUE’s e/ou RUC’s vinculados ao documento de transporte coleção de carga
conteineres Lista de Contêineres vinculados ao documento de transporte coleção de conteiner

Local:

Nome Descrição Tipo Detalhes
urf Unidade da Receita Federal object codigoDescricao Domínio: Tabela de Unidades da RFB
ra Recinto aduaneiro object codigoDescricao Domínio: Tabela de Recintos Aduaneiros.
responsavel CPF ou CNPJ do responsável object codigoDescricao
coordenadas Dados das coordenadas geográficas do local object coordenadas

Coordenadas Geográficas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Veículo Ferroviário:

Nome Descrição Tipo
prefixoTrem Prefixo do Trem string
quantidadeVagoes Quantidade de Vagões numeric

Veículo Rodoviário:

Nome Descrição Tipo
cpfCnpjResponsavel CPF ou CNPJ do responsável pelo veículo string
nomeResponsavel Nome do responsável pelo veículo string
veiculo informações sobre o veículo rodoviário object veiculo
reboques informações sobre os reboques coleção de reboque

Veículo:

Nome Descrição Tipo Detalhes
nomeCondutor Nome do condutor string
cpfCondutor CPF do condutor string Quando Nacional
documentoCondutor Documento do Condutor string Quando estrangeiro
placa Placa do veículo string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao veículo coleção de strings Máximo 4 lacres diferentes entre si.

Reboque:

Nome Descrição Tipo Detalhes
placa Placa do reboque string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao reboque coleção de strings Máximo 4 lacres diferentes entre si.

Carga:

Nome Descrição Tipo
numeroDue Número da DU-E string
numeroRuc Número da RUC string
tipoCarga Código e Descrição da Carga object codigoDescricao
siglaUnidadeMedida Sigla da Unidade de Medida string
quantidadeManifestada quantidade Manifestada numeric

Contêiner:

Nome Descrição Tipo
identificacao Número do contêiner string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao contêiner coleção de strings

Código e Descrição:

Nome Descrição Tipo
codigo Código da Carga string
descricao Descrição da Carga string

Mensagem de alerta ou erro da consulta:

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Via de transporte :

Código Descrição
01 MARITIMA
02 FLUVIAL
03 LACUSTRE
04 AEREA
05 POSTAL
06 FERROVIARIA
07 RODOVIARIA
08 DUTO / REDE TRANSMISSAO
09 MEIOS PROPRIOS
10 VIA FICTA
11 COURRIER

Situação do Documento de Transporte:

Código Descrição
1 Manifestado
2 Trânsito Autorizado
3 Trânsito Iniciado
4 Recebido em Trânsito
5 Trânsito Concluído
6 Cancelado
7 Em Análise Autorização
8 Em Análise Conclusão

Consultar MIC

Exemplo de resposta para a consulta de MIC

{
    "documentosTransporte": [
        {
            "numeroDocumentoTransporte": "BR000000001",
            "tipoDocumentoTransporte": "MIC_DTA",
            "viaTransporte": "RODOVIARIA",
            "situacaoAtual": "Manifestado",
            "dataEmissao": "2019-01-04",
            "cpfCnpjTransportador": "27657485000147",
            "nomeTransportador": "IEYIQBEIWMVEU KXIXW DVNW",
            "localOrigem": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "localDestinoPrevisto": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "localEstoque": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "veiculoRodoviario": {
                "cpjCnpjResponsavel": "27657485000147",
                "nomeResponsavel": "IEYIQBEIWMVEU KXIXW DVNW",
                "veiculo": {
                    "nomeCondutor": "ZOVCZMWIV KRMVRIL ILWIRTFVA",
                    "cpfCondutor": "02660763780",
                    "placa": "P12345",
                    "tara": 1
                },
                "reboques": [
                    {
                        "placa": "REB0002",
                        "tara": 2,
                        "lacres": [
                            "lacre3",
                            "lacre5",
                            "lacre4"
                        ]
                    },
                    {
                        "placa": "REB0001",
                        "tara": 1,
                        "lacres": [
                            "Lacre1",
                            "lacre2"
                        ]
                    }
                ]
            },
            "cargas": [
                {
                    "numeroDue": "19BR0002994126",
                    "numeroRuc": "9BR00000000100000000000000000015999",
                    "tipoCarga": {
                        "codigo": "Solta ou Veículo",
                        "descricao": "BARRICA DE FERRO"
                    },
                    "siglaUnidadeMedida": "un",
                    "quantidadeManifestada": 5000
                }
            ],
            "conteineres": [
                {
                    "identificacao": "CONT123",
                    "tara": 10,
                    "lacres": [
                        "lacre10",
                        "lacre8",
                        "lacre9"
                    ]
                }
            ]
        }
    ],
    "mensagens": [
        {
            "codigo": "CCTR-ER0003",
            "mensagem": "Documento de Transporte BR000000012 é inexistente."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/documento-transporte/mic?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
documentos Lista de MICs (número do documento, data de emissão) separados por “¦” String, obrigatório query string Cada documento de Transporte MIC é formado pelo número e pela data de emissão no formato (AAAAMMDD) separados por “,”

Ex: https://<url>/cct/api/ext/documento-transporte/mic?documentos=BR000000002,20190110|BR000000001,20190104 ....

Resposta (JSON Schema):

Nome Descrição Tipo
documentosTransporte Lista de Documentos de Transporte Coleção de documentoTransporte
mensagens Lista de Mensagens de alerta ou Erro Coleção de mensagem

Documento de Transporte:

Nome Descrição Tipo Detalhes
numeroDocumentoTransporte Número do documento de transporte string
tipoDocumentoTransporte Tipo de documento de transporte string valor: MIC_DTA
viaTransporte Via de transporte string valor: RODOVIARIA
situacaoAtual Situação do documento de transporte string
dataEmissao Data de Emissão do Documento de Transporte string No formato AAAA-MM-YY
cpfCnpjTransportador CPF ou CNPJ do Transportador string
nomeTransportador Nome do Transportador string
localOrigem Local de Partida do MIC object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
localDestinoPrevisto Local de Saída/Embarque do MIC object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
localEstoque Local onde está estocado o MIC object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
veiculoRodovario Informações sobre o veículo Rodoviário object veiculoRodoviario
cargas Lista de DUE’s e/ou RUC’s vinculados ao documento de transporte coleção de carga
conteineres Lista de Contêineres vinculados ao documento de transporte coleção de conteiner

Local:

Nome Descrição Tipo Detalhes
urf Unidade da Receita Federal object codigoDescricao Domínio: Tabela de Unidades da RFB
ra Recinto aduaneiro object codigoDescricao Domínio: Tabela de Recintos Aduaneiros.
responsavel CPF ou CNPJ do responsável object codigoDescricao
coordenadas Dados das coordenadas geográficas do local object coordenadas

Coordenadas Geográficas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Veículo Rodoviário:

Nome Descrição Tipo
cpfCnpjResponsavel CPF ou CNPJ do responsável pelo veículo string
nomeResponsavel Nome do responsável pelo veículo string
veiculo informações sobre o veículo rodoviário object veiculo
reboques informações sobre os reboques coleção de reboque

Veículo:

Nome Descrição Tipo Detalhes
nomeCondutor Nome do condutor string
cpfCondutor CPF do condutor string
placa Placa do veículo string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao veículo coleção de strings Máximo 4 lacres diferentes entre si.

Reboque:

Nome Descrição Tipo Detalhes
placa Placa do reboque string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao reboque coleção de strings Máximo 4 lacres diferentes entre si.

Carga:

Nome Descrição Tipo
numeroDue Número da DU-E string
numeroRuc Número da RUC string
tipoCarga Código e Descrição da Carga object codigoDescricao
siglaUnidadeMedida Sigla da Unidade de Medida string
quantidadeManifestada quantidade Manifestada numeric

Contêiner:

Nome Descrição Tipo
identificacao Número do contêiner string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao contêiner coleção de strings

Código e Descrição:

Nome Descrição Tipo
codigo Código da Carga string
descricao Descrição da Carga string

Mensagem de alerta ou erro da consulta:

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Situação do Documento de Transporte:

Código Descrição
1 Manifestado
2 Manifestado para Despacho
3 Aguardando análise Autorização
4 Aguardando análise Conclusão
5 Trânsito Autorizado
6 Trânsito Iniciado
7 Cancelado
8 Em análise Autorização
9 Em análise Conclusão
10 Concluído

Consultar DTAI

Exemplo de resposta para a consulta de DTAI

{
    "documentosTransporte": [
        {
            "numeroDocumentoTransporte": "VE123456",
            "tipoDocumentoTransporte": "DTAI",
            "viaTransporte": "RODOVIARIA",
            "situacaoAtual": "Manifestado",
            "dataEmissao": "2019-01-08",
            "cpfCnpjTransportador": "27657485000147",
            "nomeTransportador": "IEYIQBEIWMVEU KXIXW DVNW",
            "localDestinoPrevisto": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "localEstoque": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "veiculoRodoviario": {
                "veiculo": {
                    "placa": "VE123456"
                }
            },
            "cargas": [
                {
                    "numeroDue": "19BR0003000302",
                    "numeroRuc": "9BR00000000100000000000000000016631",
                    "tipoCarga": {
                        "codigo": "Solta ou Veículo",
                        "descricao": "Sem Embalagem"
                    },
                    "siglaUnidadeMedida": "un",
                    "quantidadeManifestada": 40000
                }
            ],
            "conteineres": [
                {
                    "identificacao": "CONT123",
                    "tara": 10,
                    "lacres": [
                        "lacre10",
                        "lacre8",
                        "lacre9"
                    ]
                }
            ]
        }
    ],
    "mensagens": [
        {
            "codigo": "CCTR-ER0003",
            "mensagem": "Documento de Transporte DTAI19NOV01 é inexistente."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/documento-transporte/dtai?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
documentos Lista de DTAIs (número do documento, data de emissão) separados por “¦” String, obrigatório query string Cada documento de Transporte DTAI é formado pelo número e pela data de emissão no formato (AAAAMMDD) separados por “,”

Ex: https://<url>/cct/api/ext/documento-transporte/dtai?documentos=DTAI19NOV01,20181120|VE123456,20190108 ....

Resposta (JSON Schema):

Nome Descrição Tipo
documentosTransporte Lista de Documentos de Transporte Coleção de documentoTransporte
mensagens Lista de Mensagens de alerta ou Erro Coleção de mensagem

Documento de Transporte:

Nome Descrição Tipo Detalhes
numeroDocumentoTransporte Número do documento de transporte string
tipoDocumentoTransporte Tipo de documento de transporte string valor: DTAI
viaTransporte Via de transporte string valor: RODOVIARIA
situacaoAtual Situação do documento de transporte string
dataEmissao Data de Emissão do Documento de Transporte string No formato AAAA-MM-YY
cpfCnpjTransportador CPF ou CNPJ do Transportador string
nomeTransportador Nome do Transportador string
localDestinoPrevisto Local de Saída/Embarque do DTAI object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
localEstoque Local onde está estocado o DTAI object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
veiculoRodovario Informações sobre o veículo Rodoviário object veiculoRodoviario
cargas Lista de DUE’s e/ou RUC’s vinculados ao documento de transporte coleção de carga
conteineres Lista de Contêineres vinculados ao documento de transporte coleção de conteiner

Local:

Nome Descrição Tipo Detalhes
urf Unidade da Receita Federal object codigoDescricao Domínio: Tabela de Unidades da RFB
ra Recinto aduaneiro object codigoDescricao Domínio: Tabela de Recintos Aduaneiros.
responsavel CPF ou CNPJ do responsável object codigoDescricao
coordenadas Dados das coordenadas geográficas do local object coordenadas

Coordenadas Geográficas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Veículo Rodoviário:

Nome Descrição Tipo
veiculo informações sobre o veículo Rodoviário object veiculo

Veículo:

Nome Descrição Tipo Detalhes
placa Placa do veículo string

Carga:

Nome Descrição Tipo
numeroDue Número da DU-E string
numeroRuc Número da RUC string
tipoCarga Código e Descrição da Carga object codigoDescricao
siglaUnidadeMedida Sigla da Unidade de Medida string
quantidadeManifestada quantidade Manifestada numeric

Contêiner:

Nome Descrição Tipo
identificacao Número do contêiner string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao contêiner coleção de strings

Código e Descrição:

Nome Descrição Tipo
codigo Código da Carga string
descricao Descrição da Carga string

Mensagem de alerta ou erro da consulta:

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Situação do Documento de Transporte:

Código Descrição
1 Manifestado
2 Manifestado para Despacho
3 Aguardando análise Autorização
4 Aguardando análise Conclusão
5 Trânsito Autorizado
6 Trânsito Iniciado
7 Cancelado
8 Em análise Autorização
9 Em análise Conclusão
10 Concluído

Consultar TIF

Exemplo de resposta para a consulta de TIF

{
    "documentosTransporte": [
        {
            "numeroDocumentoTransporte": "TR1901080001",
            "tipoDocumentoTransporte": "TIF_DTA",
            "viaTransporte": "FERROVIARIA",
            "situacaoAtual": "Manifestado",
            "dataEmissao": "2019-01-08",
            "cpfCnpjTransportador": "27657485000147",
            "nomeTransportador": "IEYIQBEIWMVEU KXIXW DVNW",
            "localDestinoPrevisto": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "localEstoque": {
                "urf": {
                    "codigo": "0717700",
                    "descricao": "AEROPORTO INTERNACIONAL DO RIO DE JANEIRO"
                },
                "ra": {
                    "codigo": "7911101",
                    "descricao": "AEROPORTO INTER DO RIO - INFRAERO *"
                },
                "responsavel": {
                    "codigo": "07396865000168",
                    "descricao": "GR CONFECCOES E AUTOMACAO INDUSTRIAL LTDA"
                },
                "coordenadas": {
                    "latitude": "-22.812222",
                    "longitude": "-43.248333"
                }
            },
            "veiculoFerroviario": {
                "prefixoTrem": "TR1901080001"
            },
            "cargas": [
                {
                    "numeroDue": "19BR0003000299",
                    "numeroRuc": "9BR00000000100000000000000000016630",
                    "tipoCarga": {
                        "codigo": "Solta ou Veículo",
                        "descricao": "AMARRADO/ATADO/FEIXE"
                    },
                    "siglaUnidadeMedida": "un",
                    "quantidadeManifestada": 1000
                }
            ],
            "conteineres": [
                {
                    "identificacao": "CONT123",
                    "tara": 10,
                    "lacres": [
                        "lacre10",
                        "lacre8",
                        "lacre9"
                    ]
                }
            ]

        }
    ],
    "mensagens": [
        {
            "codigo": "CCTR-ER0003",
            "mensagem": "Documento de Transporte TIF03DEZ01 é inexistente."
        }
    ]
}

Endpoint:

GET https://<url>/cct/api/ext/documento-transporte/tif?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
documentos Lista de TIFs (número do documento, data de emissão) separados por “¦” String, obrigatório query string Cada documento de Transporte TIF é formado pelo número e pela data de emissão no formato (AAAAMMDD) separados por “,”

Ex: https://<url>/cct/api/ext/documento-transporte/tif?documentos=TIF03DEZ01,20181203|TR1901080001,20190108 ....

Resposta (JSON Schema):

Nome Descrição Tipo
documentosTransporte Lista de Documentos de Transporte Coleção de documentoTransporte
mensagens Lista de Mensagens de alerta ou Erro Coleção de mensagem

Documento de Transporte:

Nome Descrição Tipo Detalhes
numeroDocumentoTransporte Número do documento de transporte string
tipoDocumentoTransporte Tipo de documento de transporte string valor: TIF_DTA
viaTransporte Via de transporte string valor: FERROVIARIA
situacaoAtual Situação do documento de transporte string
dataEmissao Data de Emissão do Documento de Transporte string No formato AAAA-MM-YY
cpfCnpjTransportador CPF ou CNPJ do Transportador string
nomeTransportador Nome do Transportador string
localDestinoPrevisto Local de Saída/Embarque do MIC object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
localEstoque Local onde está estocado o MIC object local (URF+CNPJ/CPF+coordenadas), se estiver em um recinto, traz o recinto também.
veiculoFerroviario Informações sobre o veículo Ferroviário object veiculoFerroviario
cargas Lista de DUE’s e/ou RUC’s vinculados ao documento de transporte coleção de carga
conteineres Lista de Contêineres vinculados ao documento de transporte coleção de conteiner

Local:

Nome Descrição Tipo Detalhes
urf Unidade da Receita Federal object codigoDescricao Domínio: Tabela de Unidades da RFB
ra Recinto aduaneiro object codigoDescricao Domínio: Tabela de Recintos Aduaneiros.
responsavel CPF ou CNPJ do responsável object codigoDescricao
coordenadas Dados das coordenadas geográficas do local object coordenadas

Coordenadas Geográficas:

Nome Descrição Tipo Detalhes
latitude Latitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitude Longitude do local string(11) Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.

Veículo Ferroviário:

Nome Descrição Tipo
prefixoTrem Prefixo do Trem string

Carga:

Nome Descrição Tipo
numeroDue Número da DU-E string
numeroRuc Número da RUC string
tipoCarga Código e Descrição da Carga object codigoDescricao
siglaUnidadeMedida Sigla da Unidade de Medida string
quantidadeManifestada quantidade Manifestada numeric

Contêiner:

Nome Descrição Tipo
identificacao Número do contêiner string
tara Valor da tara informada numeric
lacres Lista com os códigos dos lacres vinculados ao contêiner coleção de strings

Código e Descrição:

Nome Descrição Tipo
codigo Código da Carga string
descricao Descrição da Carga string

Mensagem de alerta ou erro da consulta:

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Situação do Documento de Transporte:

Código Descrição
1 Manifestado
2 Manifestado para Despacho
3 Aguardando análise Autorização
4 Aguardando análise Conclusão
5 Trânsito Autorizado
6 Trânsito Iniciado
7 Cancelado
8 Em análise Autorização
9 Em análise Conclusão
10 Concluído

DU-E

Declaração Única de Exportação

Registrar DUE com NFE

Exemplo de uma DU-E com uma Nota Fiscal Eletrônica (NFe)

<?xml version="1.0" encoding="UTF-8"?>
<Declaration xmlns:ds="urn:wco:datamodel:WCO:GoodsDeclaration_DS:1"
    xmlns="urn:wco:datamodel:WCO:GoodsDeclaration:1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="urn:wco:datamodel:WCO:GoodsDeclaration:1 GoodsDeclaration_1p0_DUE.xsd ">
    <DeclarationNFe>
        <!-- Dados do local de despacho -->
        <DeclarationOffice>
            <!-- Código da Unidade Local de Despacho  -->
            <ID listID="token">0717700</ID>
            <Warehouse>
                <!-- Recinto aduaneiro de Despacho  -->
                <ID>7911101</ID>
                <!-- Indicador de recinto alfandegado -->
                <!-- 281 - em recinto alfandegado -->
                <!-- 22  - fora de recinto alfandegado Não Domiciliar -->
                <!-- 19 - Fora de Recinto Alfandegado Domiciliar -->
                <TypeCode>281</TypeCode>
            </Warehouse>
        </DeclarationOffice>
        <!-- Forma de Exportação (CUS) -->
        <AdditionalInformation>
            <StatementCode>1001</StatementCode>
            <StatementTypeCode>CUS</StatementTypeCode>
        </AdditionalInformation>
        <!-- Via especial de Transporte (TRA) -->
        <AdditionalInformation>
            <StatementCode>4001</StatementCode>
            <StatementTypeCode>TRA</StatementTypeCode>
        </AdditionalInformation>
        <!-- Observações gerais (AAI) -->
        <AdditionalInformation>
            <StatementDescription languageID="">Observações gerais</StatementDescription>
            <StatementTypeCode>AAI</StatementTypeCode>
        </AdditionalInformation>        
        <!-- Moeda -->
        <CurrencyExchange>
            <CurrencyTypeCode>USD</CurrencyTypeCode>
        </CurrencyExchange>
        <!-- cpf/cnpj do declarente -->
        <Declarant>
            <ID schemeID="token">00000000000191</ID>
        </Declarant>
        <!-- Unidade Local de Embarque -->
        <ExitOffice>
            <ID>0717700</ID>
            <Warehouse>
                <!-- Recinto aduaneiro de embarque -->
                <ID>7911101</ID>
                <!-- Indicador de recinto alfandegado -->
                <!-- 281 - em recinto alfandegado -->
                <TypeCode>281</TypeCode>
            </Warehouse>
        </ExitOffice>
        <!-- Item DUE -->
        <GoodsShipment>
            <GovernmentAgencyGoodsItem>
                <!-- Valor no local de embarque -->
                <CustomsValueAmount languageID="">2000.0</CustomsValueAmount>
                <!-- Identificador do item de due -->
                <SequenceNumeric>0001</SequenceNumeric>
                <!-- País de destino -->
                <Destination>
                    <CountryCode>US</CountryCode>
                    <!-- Quantidade estatística no País de destino -->
                    <GoodsMeasure>
                        <TariffQuantity>1</TariffQuantity>
                    </GoodsMeasure>
                </Destination>
                <!-- Prioridade de carga -->
                <AdditionalInformation>
                    <StatementCode>5001</StatementCode>
                    <StatementDescription languageID="">p:StatementDescription</StatementDescription>
                    <StatementTypeCode>PRI</StatementTypeCode>
                </AdditionalInformation>
                <Commodity>
                    <!-- Descrição complementar -->
                    <Description>Descrição complementar</Description>
                    <!-- Valor da condição de venda -->
                    <ValueAmount schemeID="token">2000.1</ValueAmount>
                    <InvoiceLine>
                        <!-- Número do item de nota -->
                        <SequenceNumeric>1</SequenceNumeric>
                    </InvoiceLine>
                </Commodity>
                <!-- Peso Liquido Total do Item  -->
                <GoodsMeasure>
                    <NetNetWeightMeasure>49.1</NetNetWeightMeasure>
                </GoodsMeasure>
                <!-- Enquadramentos  -->
                <GovernmentProcedure>
                    <CurrentCode>80000</CurrentCode>
                </GovernmentProcedure>  
            </GovernmentAgencyGoodsItem>
            <Invoice>
                <!-- Chave de acesso da NFE  -->
                <ID schemeID="token">35180600000000002720550900011741681000000000</ID>
                <TypeCode>388</TypeCode>
            </Invoice>
            <TradeTerms>
                <!-- Condição de Venda -->
                 <ConditionCode>DDP</ConditionCode>
            </TradeTerms>
        </GoodsShipment>
    </DeclarationNFe>
</Declaration>

Endpoint:

POST https://<url>/due/api/ext/due

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download

Observações:

Neste exemplo, consta um XML para registro de uma DUE com apenas um item com nota fiscal eletrônica. Neste, constam informações que podem ser alteradas conforme a necessidade. A partir deste exemplo, podemos realizar diversas variações conforme demonstrado nos exemplos posteriores.

A grande diferença para uma DUE sem nota (de embarque antecipado), está na subtag principal “DeclarationNFe”. No Embarque Antecipado, a mesma deve ser substituída por “DeclarationNoNF”.

Registrar DUE com mais de 1 NFE

Exemplo do trecho a ser replicado para que uma DU-E contenha mais itens com suas respectivas Notas Fiscais Eletrônicas (NFe)

...  
<GoodsShipment>
    <GovernmentAgencyGoodsItem>
        ...
        <!-- Identificador do item de due -->
        <SequenceNumeric>0002</SequenceNumeric>
        ...
    </GovernmentAgencyGoodsItem>
    <Invoice>
        <!-- Chave de acesso da NFE  -->
        <ID schemeID="token">35180600000000002720550900011764551000000007</ID>
        <TypeCode>388</TypeCode>
    </Invoice>
    ...     
</GoodsShipment>
...

Endpoint:

POST https://<url>/due/api/ext/due

Content-Type:

application/xml

Parâmetros:

Os parâmetros são os mesmos do submenu Registrar DUE com NFE.

A diferença é que neste exemplo, teremos mais de um item de DUE, cada um relacionado a uma Nota fiscal eletrônica.

Neste caso, para cada item extra, deve ser duplicada a tag “GoodsShipment” incluindo todo seu conteúdo, incrementando o Identificador do item de DUE “SequenceNumeric” e preenchendo uma nova nota fiscal eletrônica no campo “Invoice.ID”.

Registrar DUE com NFE que possui mais de um item

Exemplo do trecho a ser replicado para que uma DU-E contenha mais itens relacionados a uma mesma Nota Fiscal Eletrônica (NFe)

...  
    <GovernmentAgencyGoodsItem>
        ...
        <!-- Identificador do item de due -->
        <SequenceNumeric>0002</SequenceNumeric>
        ...
        <Commodity>
            ...
            <InvoiceLine>
                <!-- Número do item de nota -->
                <SequenceNumeric>1</SequenceNumeric>
            </InvoiceLine>
        </Commodity>        
        ...
    </GovernmentAgencyGoodsItem>
    <Invoice>
        <!-- Chave de acesso da NFE  -->
        <ID schemeID="token">35180700000000002720550900011880191000000005</ID>
        <TypeCode>388</TypeCode>
    </Invoice>  
...

Endpoint:

POST https://<url>/due/api/ext/due

Content-Type:

application/xml

Parâmetros:

Os parâmetros são os mesmos do submenu Registrar DUE com NFE.

A diferença é que neste exemplo, teremos mais de um item de DUE, cada um relacionado a um item de uma mesma Nota fiscal eletrônica.

Neste caso, para cada item extra, deve ser duplicada a tag “GovernmentAgencyGoodsItem” incluindo todo seu conteúdo, incrementando o Identificador do item de DUE “GovernmentAgencyGoodsItem.SequenceNumeric”. Temos também que co-relacionar cada item de DUE com um item de nota (a DUE deve ficar com a mesma quantidade de itens que a Nota fiscal possui). O relacionamento do item da DUE com o item da nota fiscal é feito na tag “GovernmentAgencyGoodsItem.Commodity.InvoiceLine.SequenceNumeric”, onde é indicado o número de item da NFE.

No exemplo do trecho xml, estamos co-relacionando o item de DUE 1 com o item 2 da NFE. Obrigatoriamente teríamos que co-relacionar o item de DUE 2 com o item 1 da NFE.

No campo “Invoice.ID” constará a nota fiscal eletrônica que possui multiplos itens.

Registrar DUE com documento adicional(Importação ou Exportação) vinculado ao Item de DUE

Exemplo do trecho a ser replicado para vincular um documento adicional a um item de DU-E

...  
<GovernmentAgencyGoodsItem>
    ...
    <AdditionalDocument>
        <!-- Tipo do documento -->
        <!-- Todos os tipos disponíveis estão disponíveis no XSD -->
        <CategoryCode>DSI</CategoryCode>
        <!-- Número do documento -->
        <ID>546465454</ID>
        <!-- Quantidade -->
        <QuantityQuantity>100.00</QuantityQuantity>
    </AdditionalDocument>
    ...
</GovernmentAgencyGoodsItem>
...

Para maiores detalhes sobre a tag AdditionalDocument

AdditionalDocument

XSD para download

Endpoint:

POST https://<url>/due/api/ext/due

Content-Type:

application/xml

Parâmetros:

Os parâmetros são os mesmos do submenu Registrar DUE com NFE.

A diferença é que neste exemplo, teremos um documento adicional(Importação ou Exportação) vinculado ao Item de DUE.

Retificar DUE com NFE Antes do ACD

Exemplo do trecho necessário para realizar a retificação de uma DUE antes do ACD (Apresentação da carga para despacho)

    ...
    <DeclarationNFe>
        ...
        <GoodsShipment>
        ...
        </GoodsShipment>
        <!-- Número da RUC necessário para retificação da DUE -->
        <UCR>
            <TraderAssignedReferenceID>8BR00000000100000000000000000024234</TraderAssignedReferenceID>
        </UCR>        
    </DeclarationNFe>
    ...

Endpoint:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path

Observações:

Utilizaremos como base o XML de exemplo Registrar DUE com NFE.

No Endpoint, além da mudança do método POST para o método PUT, o número da DUE deve substituir o {id} no path.

Para realizar uma retificação de DUE antes do ACD, além de ser alterado o valor dos campos que precisam ser retificados, é necessária a presença da tag “DeclarationNFe.UCR.TraderAssignedReferenceID”, onde deve ser preechido o número da RUC.

Retificar DUE com NFE pós ACD

Exemplo do trecho necessário para realizar a retificação de uma DUE depois que ocorre o ACD (Apresentação da carga para despacho)

    ...
    <DeclarationNFe>
        <DeclarationOffice>
            ...
        </DeclarationOffice>    
        <!-- Motivo da retificação de DUE -->
        <AdditionalInformation>
            <StatementDescription languageID="">Motivo para retificacao de due pos ACD</StatementDescription>
            <StatementTypeCode>DEF</StatementTypeCode>
        </AdditionalInformation>
        ...    
        <GoodsShipment>
            ...
        </GoodsShipment>
        <!-- Número da RUC necessário para retificação da DUE -->
        <UCR>
            <TraderAssignedReferenceID>8BR00000000100000000000000000024234</TraderAssignedReferenceID>
        </UCR>        
    </DeclarationNFe>
    ...

Endpoint:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path

Observações:

Utilizaremos como base o XML de exemplo Registrar DUE com NFE.

No Endpoint, além da mudança do método POST para o método PUT, o número da DUE deve substituir o {id} no path.

Para realizar uma retificação de DUE depois que ocorre a apresentação da carga para despacho (ACD), além de ser alterado o valor dos campos que precisam ser retificados, deve ser preenchido o motivo da retificação, adicionando a tag “DeclarationNFe.AdditionalInformation”, com sua subtag “StatementTypeCode” contendo “DEF” em seu conteúdo, e a subtag “StatementDescription” contendo uma justificativa para a geração de uma solicitação de retificação.

Também é necessária a presença da tag “DeclarationNFe.UCR.TraderAssignedReferenceID”, onde deve ser preechido o número da RUC.

DUE com NFE possuindo notas referenciadas (Notas de Remessa)

Exemplo do trecho a ser considerado para cadastrar/retificar DUE com uma NFE que possui duas NFF referenciadas (do tipo REMESSA)

    ...
    <GoodsShipment>
        <GovernmentAgencyGoodsItem>
            ...
            <Commodity>
                ...                 
                <InvoiceLine>
                    <!-- Número do item de nota -->
                    <SequenceNumeric>1</SequenceNumeric>
                    <ReferencedInvoiceLine>
                        <SequenceNumeric>1</SequenceNumeric>
                        <InvoiceIdentificationID>FSP18070000000000019101222115327274</InvoiceIdentificationID>
                        <GoodsMeasure>
                            <TariffQuantity unitCode="">0.5</TariffQuantity>
                        </GoodsMeasure>
                    </ReferencedInvoiceLine>
                    <ReferencedInvoiceLine>
                        <SequenceNumeric>1</SequenceNumeric>
                        <InvoiceIdentificationID>FSP18070000000000019101222193051112</InvoiceIdentificationID>
                        <GoodsMeasure>
                            <TariffQuantity unitCode="">0.5</TariffQuantity>
                        </GoodsMeasure>
                    </ReferencedInvoiceLine>
                </InvoiceLine>  
            </Commodity>
            ...         
        </GovernmentAgencyGoodsItem>
        <Invoice>
            <!-- Chave de acesso da NFE  -->
            <ID>35180700000000002720550900012418781000000006</ID>
            <TypeCode>388</TypeCode>
            <!-- Chave da NFF ou NFE de remessa  -->
            <ReferencedInvoice>
                <ID>FSP18070000000000019101222115327274</ID>
                <TypeCode>REM</TypeCode>
                <Submitter>
                    <ID schemeID="token">00000000000191</ID>
                </Submitter>
            </ReferencedInvoice>
            <ReferencedInvoice>
                <ID>FSP18070000000000019101222193051112</ID>
                <TypeCode>REM</TypeCode>
                <Submitter>
                    <ID schemeID="token">00000000000191</ID>
                </Submitter>
            </ReferencedInvoice>
        </Invoice>      
        ...
    </GoodsShipment>
    ...


Endpoint - Registro de DUE:

POST https://<url>/due/api/ext/due

Endpoint - Retificação de DUE:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path (*) Obrigatório somente para retificação de DUE

Observações:

Para registrar/retificar uma DUE com uma Nota Fiscal que possui notas referenciadas (formulário ou eletrônica), elas devem ser informados em dois locais específicos no XML:

1) Na tag “Commodity.InvoiceLine”, deve ser adicionada a tag “ReferencedInvoiceLine” e todo seu conteúdo. Neste local, são informados os campos “SequenceNumeric” que representa o número do item da nota referenciada, “InvoiceIdentificationID” que deve conter o número da nota de remessa formulário ou eletrônica e “GoodsMeasure.TariffQuantity” onde é informado a quantidade consumida pela respectiva nota. A soma das quantidades de consumo de todas as notas não pode ser maior que a quantidade definida no país de destino.

2) Na tag “GoodsShipment.Invoice”, além de constar a chave de acesso da nota principal em “GoodsShipment.Invoice.ID”, deve ser adicionada a tag “ReferencedInvoice”, contendo a chave da nota referenciada em “ReferencedInvoice.ID”. Também deve ser informado o tipo da nota referenciada (REM para remessa).

Registrar DUE de Embarque Antecipado

Exemplo de uma DU-E de embarque antecipado (onde o registro ocorre sem Nota Fiscal Eletrônica e posteriormente deve ser adicionado uma NFE através da Retificação de DUE)

<?xml version="1.0" encoding="UTF-8"?>
<Declaration xmlns:ds="urn:wco:datamodel:WCO:GoodsDeclaration_DS:1" xmlns="urn:wco:datamodel:WCO:GoodsDeclaration:1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:wco:datamodel:WCO:GoodsDeclaration:1 GoodsDeclaration_1p0_DUE.xsd ">
    <DeclarationNoNF>
        <!-- Dados do local de despacho -->
        <DeclarationOffice>
            <!-- Código da Unidade Local de Despacho  -->
            <ID listID="token">0717700</ID>
            <Warehouse>
                <!-- Recinto aduaneiro de Despacho  -->
                <ID schemeID="token">7911101</ID>
                <!-- Indicador de recinto alfandegado -->
                <!-- 281 - em recinto alfandegado -->
                <!-- 22  - fora de recinto alfandegado Não Domiciliar -->
                <!-- 19 - Fora de Recinto Alfandegado Domiciliar -->
                <TypeCode>281</TypeCode>
            </Warehouse>
        </DeclarationOffice>
        <!-- Situação especial (AHZ) - Embarque antecipado = 2002 -->
        <AdditionalInformation>
            <StatementCode>2002</StatementCode>
            <StatementTypeCode>AHZ</StatementTypeCode>
        </AdditionalInformation>
        <!-- Forma de Exportação (CUS) -->
        <AdditionalInformation>
            <StatementCode>1001</StatementCode>
            <StatementTypeCode>CUS</StatementTypeCode>
        </AdditionalInformation>
        <!-- Via especial de Transporte (TRA) -->
        <AdditionalInformation>
            <StatementCode>4001</StatementCode>
            <StatementTypeCode>TRA</StatementTypeCode>
        </AdditionalInformation>
        <!-- Observações Gerais (AAI) -->
        <AdditionalInformation>
            <!--<StatementCode></StatementCode>-->
            <StatementDescription languageID="">observacoes emb antecipado</StatementDescription>
            <StatementTypeCode>AAI</StatementTypeCode>
        </AdditionalInformation>
        <!-- Moeda -->
        <CurrencyExchange>
            <CurrencyTypeCode>USD</CurrencyTypeCode>
        </CurrencyExchange>
        <!-- cpf/cnpj do declarente -->
        <Declarant>
            <ID schemeID="token">00000000000191</ID>
        </Declarant>
        <!-- Unidade Local de Embarque -->
        <ExitOffice>
            <ID>0717700</ID>
            <Warehouse>
                <!-- Recinto aduaneiro de embarque -->
                <ID>7911101</ID>
                <!-- Indicador de recinto alfandegado -->
                <!-- 281 - em recinto alfandegado -->
                <TypeCode>281</TypeCode>
            </Warehouse>
        </ExitOffice>
        <!-- Item DUE -->
        <GoodsShipment>
            <!-- Exportador -->
            <Exporter>
                <!-- Nome do Exportador -->
                <Name>Nome do exportador de teste</Name>
                <!-- CNPJ/CPF do Exportador -->
                <ID>00000000002720</ID>
                <Address>
                    <!-- Código do país -->
                    <CountryCode>AD</CountryCode>
                    <CountrySubDivisionCode>BR-AC</CountrySubDivisionCode>
                    <Line languageID="">Endereco do exportador de teste</Line>
                </Address>
            </Exporter>
            <GovernmentAgencyGoodsItem>
                <!-- Valor no local de embarque -->
                <CustomsValueAmount languageID="">2000.0</CustomsValueAmount>
                <!-- Identificador -->
                <SequenceNumeric>0001</SequenceNumeric>
                <!-- País de destino -->
                <Destination>
                    <CountryCode>US</CountryCode>
                    <GoodsMeasure>
                        <TariffQuantity unitCode="">1.0</TariffQuantity>
                    </GoodsMeasure>
                </Destination>
                <!-- Prioridade de carga -->
                <AdditionalInformation>
                    <StatementCode>5001</StatementCode>
                    <StatementDescription languageID="">p:StatementDescription</StatementDescription>
                    <StatementTypeCode>PRI</StatementTypeCode>
                </AdditionalInformation>
                <Commodity>
                    <!-- Descrição complementar -->
                    <Description languageID="">Descrição complementar</Description>
                    <!-- Valor da condição de venda -->
                    <ValueAmount schemeID="token">2000.1</ValueAmount>
                    <!-- Descrição da Mercadoria -->
                    <CommercialDescription languageID="">Descrição mercadoria</CommercialDescription>
                    <!-- ncm -->
                    <Classification>
                        <ID schemeID="token">02011001</ID>
                        <IdentificationTypeCode>HS</IdentificationTypeCode>
                    </Classification>
                    <!-- atributo da ncm -->
                    <ProductCharacteristics>
                        <!-- codigo do atributo -->
                        <TypeCode>ATT_1330</TypeCode>
                        <!-- descricao do atributo -->
                        <Description>1</Description>
                    </ProductCharacteristics>
                    <!-- qtdUnidadeEstatistica do item -->
                    <GoodsMeasure>
                        <TypeCode>AAF</TypeCode>
                        <TariffQuantity unitCode="">1.0</TariffQuantity>
                    </GoodsMeasure>
                    <!-- unidadeEstatistica do item -->
                    <GoodsMeasure>
                        <UnitDescription languageID="">KG</UnitDescription>
                        <TypeCode>ABW</TypeCode>
                        <TariffQuantity unitCode="">10</TariffQuantity>
                    </GoodsMeasure>
                </Commodity>
                <!-- Peso Liquido Total -->
                <GoodsMeasure>
                    <NetNetWeightMeasure unitCode="">49.0</NetNetWeightMeasure>
                </GoodsMeasure>
                <!-- Enquadramentos  -->
                <GovernmentProcedure>
                    <CurrentCode schemeID="token">80000</CurrentCode>
                </GovernmentProcedure>
            </GovernmentAgencyGoodsItem>
            <!-- Importador -->
            <Importer>
                <Name languageID="">Nome do Importador</Name>
                <!-- País de importador -->
                <Address>
                    <CountryCode>US</CountryCode>
                    <Line languageID="">Endereco no pais do importador</Line>
                </Address>
            </Importer>
            <!-- Nota fiscal, codigo 388, porém em DUE de emb antecipado, informar ACG=3004 -->
            <Invoice>
                <TypeCode>388</TypeCode>
                <AdditionalInformation>
                    <StatementCode>3004</StatementCode>
                    <StatementTypeCode>ACG</StatementTypeCode>
                </AdditionalInformation>
            </Invoice>
            <!-- Condição de Venda -->
            <TradeTerms>
                <ConditionCode>DDP</ConditionCode>
            </TradeTerms>
        </GoodsShipment>
    </DeclarationNoNF>
</Declaration>

Endpoint:

POST https://<url>/due/api/ext/due

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download

Observações:

Neste exemplo, existem mudanças significativas no corpo do XML em relação ao registro de DUE com NFE, iniciando pela necessidade da alteração da tag de “DeclarationNFe” para “DeclarationNoNF”.

Outras mudanças fundamentais neste XML em relação à DUE com NFE são:

1) A presença do motivo de dispensa de nota na tag “GoodsShipment.Invoice.AdditionalInformation.StatementCode” com conteúdo “3004” e “GoodsShipment.Invoice.AdditionalInformation.StatementTypeCode” com conteúdo “ACG”.

2) A definição da situação especial da DUE na tag “DeclarationNoNF.AdditionalInformation.StatementTypeCode” com conteúdo “AHZ” e “DeclarationNoNF.AdditionalInformation.StatementCode” com conteúdo “2002”.

3) Outras informações que numa DUE com NFE vêm do próprio SPED, como por exemplo a NCM, que deve ser informada no corpo do item. Exemplo: Tag “GovernmentAgencyGoodsItem.Commodity.Classification.ID” contendo a NCM da mercadoria. No nosso xml, utilizamos a NCM 02011001 que necessita de atributo a ser informado nas tags “GovernmentAgencyGoodsItem.Commodity.ProductCharacteristics.TypeCode” e “GovernmentAgencyGoodsItem.Commodity.ProductCharacteristics.Description”.

Registrar DUE de Embarque Antecipado com mais itens

Exemplo de uma DU-E de embarque antecipado com mais de um item (onde o registro ocorre sem Nota Fiscal Eletrônica e posteriormente deve ser adicionado uma NFE através da Retificação de DUE)

    ...
    <GovernmentAgencyGoodsItem>
        ...
        <!-- Identificador -->
        <SequenceNumeric>0002</SequenceNumeric>
        ...
    </GovernmentAgencyGoodsItem>
    ...

Endpoint:

POST https://<url>/due/api/ext/due

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download

Observações:

Neste exemplo, as tags são as mesmas do submenu Registrar DUE de Embarque Antecipado.

A diferença é que teremos mais de um item de DUE sem nota (inicialmente apenas, pois esta DUE deverá receber nota fiscal em retificação posterior).

Neste caso, para cada item extra, deve ser duplicada a tag “GovernmentAgencyGoodsItem” incluindo todo seu conteúdo, incrementando o Identificador do item de DUE “GovernmentAgencyGoodsItem.SequenceNumeric”.

DUE com Drawback Suspensão

Exemplo do trecho a ser considerado para Registrar/Retificar uma DU-E contendo Atos Concessórios de Drawback Suspensão

    ...
    <GoodsShipment>
        <GovernmentAgencyGoodsItem>
            <!-- Drawback Suspensão - Ato concessório comum terceiro (AC) - com NF de venda-->
            <AdditionalDocument>
                <!-- tipo do ato -->
                <CategoryCode>AC</CategoryCode>
                <!-- Identificador do ato -->
                <ID>20170000540</ID>
                <!-- ncm -->
                <DrawbackHsClassification>12011000</DrawbackHsClassification>
                <!-- CNPJ do beneficiário do Ato -->
                <!-- Sendo este diferente do CNPJ do declarante, deve ser informada NF de Venda -->
                <DrawbackRecipientId>01287588000330</DrawbackRecipientId>
                <!-- Valor sem cobertura cambial do ato -->
                <ValueWithoutExchangeCoverAmount>0.3</ValueWithoutExchangeCoverAmount>
                <!-- Valor com cobertura cambial do ato -->
                <ValueWithExchangeCoverAmount>0.2</ValueWithExchangeCoverAmount>
                <!-- Número do item correspondente do Ato -->
                <ItemID>1</ItemID>
                <!-- Quantidade do Ato-->
                <QuantityQuantity>0.9</QuantityQuantity>
                <!-- Notas fiscais de venda -->
                <Invoice>
                    <!-- Chave da NF de Venda-->
                    <ID>20100049999</ID>
                    <!-- Data de Emissão da NF de Venda-->
                    <IssueDateTime>2017-01-01</IssueDateTime>
                    <!-- Valor da NF de Venda-->
                    <CustomsValueAmount>0.1</CustomsValueAmount>
                    <!-- Quantidade da NF de Venda-->
                    <QuantityQuantity>0.3</QuantityQuantity>
                </Invoice>
                <Invoice>
                    <!-- Chave da NF de Venda-->
                    <ID>20100049998</ID>
                    <!-- Data de Emissão da NF de Venda-->
                    <IssueDateTime>2017-01-01</IssueDateTime>
                    <!-- Valor da NF de Venda-->
                    <CustomsValueAmount>0.4</CustomsValueAmount>
                    <!-- Quantidade da NF de Venda-->
                    <QuantityQuantity>0.6</QuantityQuantity>
                </Invoice>
            </AdditionalDocument>
            ...
            <!-- Enquadramentos - DBK Suspensao = 81101 -->
            <GovernmentProcedure>
                <CurrentCode>81101</CurrentCode>
            </GovernmentProcedure>              
        </GovernmentAgencyGoodsItem>
        ...
    </GoodsShipment>
    ...


Endpoint - Registro de DUE:

POST https://<url>/due/api/ext/due

Endpoint - Retificação de DUE:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path (*) Obrigatório somente para retificação de DUE

Observações:

Para registrar/retificar uma DUE contendo Drawback Suspensão, devemos adicionar a tag “AdditionalDocument” e todo seu conteúdo dentro da tag “GovernmentAgencyGoodsItem”.

Neste exemplo, consta um Ato do tipo Comum Terceiro (Para ato Comum Próprio, quando o CNPJ do ato é o mesmo do CNPJ do declarante da DUE, a tag “AdditionalDocument.Invoice” deve ser desconsiderada).

Outro ponto a ser considerado neste exemplo é o enquadramento de Drawback Suspensão que deve ser adicionado à tag “GovernmentProcedure.CurrentCode”.

DUE com Drawback Devolução

Exemplo do trecho a ser considerado para Registrar/Retificar uma DU-E contendo Atos Concessórios de Drawback Devolução

    ...
    <GoodsShipment>
        <GovernmentAgencyGoodsItem>
            <!-- Drawback Devolucao - Ato concessório intermediário (DBSI) - com DI -->
            <AdditionalDocument>
                <!-- tipo do ato -->
                <CategoryCode>DBSI</CategoryCode>
                <!-- Identificador do ato -->
                <ID>20090026853</ID>
                <!-- ncm -->
                <DrawbackHsClassification>12011000</DrawbackHsClassification>
                <!-- CNPJ do beneficiário do Ato -->
                <DrawbackRecipientId>00000000000191</DrawbackRecipientId>
                <!-- Valor com cobertura cambial do ato -->
                <ValueWithExchangeCoverAmount>2000</ValueWithExchangeCoverAmount>
                <!-- Número do item correspondente do Ato -->
                <ItemID>1</ItemID>
                <!-- Quantidade do Ato-->
                <QuantityQuantity>1</QuantityQuantity>
                <!-- Informações da Declaração de Importação -->
                <PreviousDocument>
                    <!-- Valor do documento de Importação -->
                    <AmountAmount>2000</AmountAmount>
                    <!-- Categoria do Documento (DI, DSI, DSIF, EDBV) -->
                    <CategoryCode>DI</CategoryCode>
                    <!-- Número do documento de Importação -->
                    <ID>1017838110</ID>
                    <!-- Quantidade -->
                    <QuantityQuantity>1.0</QuantityQuantity>
                    <!-- Adição -->
                    <ItemID>2</ItemID>
                </PreviousDocument>
            </AdditionalDocument>
            ...
            <!-- Enquadramentos - DBK Devolucao = 81195 -->
            <GovernmentProcedure>
                <CurrentCode>81195</CurrentCode>
            </GovernmentProcedure>              
        </GovernmentAgencyGoodsItem>
        ...
    </GoodsShipment>
    ...


Endpoint - Registro de DUE:

POST https://<url>/due/api/ext/due

Endpoint - Retificação de DUE:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path (*) Obrigatório somente para retificação de DUE

Observações:

Para registrar/retificar uma DUE contendo Drawback Devolução, devemos adicionar a tag “AdditionalDocument” e todo seu conteúdo dentro da tag “GovernmentAgencyGoodsItem”.

Neste exemplo, consta um Ato do tipo Intermediário com documento de importação (DI), onde suas informações constam dentro da tag “AdditionalDocument.PreviousDocument”.

Outro ponto a ser considerado neste exemplo é o enquadramento de Drawback Devolução que deve ser preenchido na tag “GovernmentProcedure.CurrentCode”.

DUE com Drawback Isenção - Vincular Ato Concessório após averbação

Exemplo de XML para vinculação de ato intermediário de drawback isenção

<?xml version="1.0" encoding="UTF-8"?>
<Declaration xmlns:ds="urn:wco:datamodel:WCO:GoodsDeclaration_DS:1" xmlns="urn:wco:datamodel:WCO:GoodsDeclaration:1" xmlns:xsi="htt//www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:wco:datamodel:WCO:GoodsDeclaration:1 GoodsDeclaration_1p0_DUE.xsd ">
    <DeclarationDrawbackIsencao>
        <!-- Item DUE -->
        <GoodsShipment>
            <GovernmentAgencyGoodsItem>
                <!-- Identificador do Item de DU-E-->
                <SequenceNumeric>1</SequenceNumeric>
                <!-- Drawback Isenção-->
                <!-- AC Comum:CategoryCode=DBI -->
                <!-- AC Intermediario:CategoryCode=DBII -->
                <AdditionalDocument>
                    <CategoryCode>DBII</CategoryCode>
                    <ID>20170000540</ID>
                    <ItemID>1</ItemID>
                    <!-- Quantidade do Ato-->
                    <QuantityQuantity>0.33</QuantityQuantity>
                    <!-- Valor do Ato-->
                    <ValueWithExchangeCoverAmount>1</ValueWithExchangeCoverAmount>
                    <!-- Ncm do Ato Concessório Drawback Isenção-->
                    <DrawbackHsClassification>12011000</DrawbackHsClassification>
                    <!-- CNPJ do beneficiário deo Ato-->
                    <DrawbackRecipientId>01287588000330</DrawbackRecipientId>
                    <!-- Lista de Notas Fiscais de Venda-->
                    <Invoice>
                        <!-- Chave da NF de Venda-->
                        <ID>20100049999</ID>
                        <!-- Tipo  NF-->
                        <TypeCode>388</TypeCode>
                        <!-- Data de Emissão da NF de Venda-->
                        <IssueDateTime>2017-01-01</IssueDateTime>
                        <!-- Valor da NF de Venda-->
                        <CustomsValueAmount>1</CustomsValueAmount>
                        <!-- Quantidade da NF de Venda-->
                        <QuantityQuantity>2</QuantityQuantity>
                    </Invoice>
                </AdditionalDocument>
                <!-- Enquadramentos: Drawback Isencao = 81105  -->
                <GovernmentProcedure>
                    <CurrentCode>80000</CurrentCode>
                </GovernmentProcedure>
                <GovernmentProcedure>
                    <CurrentCode>81105</CurrentCode>
                </GovernmentProcedure>
            </GovernmentAgencyGoodsItem>
        </GoodsShipment>
    </DeclarationDrawbackIsencao>
</Declaration>

Endpoint:

PUT https://<url>/due/api/ext/due/{numero}/ato-concessorio-isencao

Content-Type:

application/xml

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
numero Número da DU-E string(14), obrigatório path

Observações:

Para vincular atos de Drawback Isenção, a DUE precisa estar averbada. Apenas as informações do ato devem constar na estrutura XML de exemplo. Na tag “GovernmentAgencyGoodsItem.SequenceNumeric” deve ser informado o respectivo item da DUE que receberá a vinculação.

Atentar para o método http (PUT) e endpoint indicado, e informar no body somente os atos a serem vinculados aos respectivos itens de DUE (O número de due deve ser informado no path, substituindo o {numero} ).

Informar os enquadramentos originais do item e também o enquadramento de Drawback isenção na tag “GovernmentAgencyGoodsItem.GovernmentProcedure.CurrentCode”.

DUE com LPCO

Exemplo do trecho a ser considerado para adicionar 3 licenças (LPCO) necessárias para o Registro/Retificação de uma DU-E

    ...
    <GoodsShipment>
        <GovernmentAgencyGoodsItem>
            <!-- Licenças necessárias devido a NCM de exportação - (LPCO) -->
            <AdditionalDocument>
                <!-- categoria do documento adiconal (LPCO) -->
                <CategoryCode>LPCO</CategoryCode>
                <!-- Número do LPCO -->
                <ID>E1800000067</ID>
            </AdditionalDocument>
            <AdditionalDocument>
                <!-- categoria do documento adiconal (LPCO) -->
                <CategoryCode>LPCO</CategoryCode>
                <!-- Número do LPCO -->
                <ID>E1700000028</ID>
            </AdditionalDocument>   
            <AdditionalDocument>
                <!-- categoria do documento adiconal (LPCO) -->
                <CategoryCode>LPCO</CategoryCode>
                <!-- Número do LPCO -->
                <ID>E1700000026</ID>
            </AdditionalDocument>                                           
            ...         
        </GovernmentAgencyGoodsItem>
        ...
    </GoodsShipment>
    ...


Endpoint - Registro de DUE:

POST https://<url>/due/api/ext/due

Endpoint - Retificação de DUE:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path (*) Obrigatório somente para retificação de DUE

Observações:

Para registrar/retificar uma DUE que haja necessidade de informações de LPCO para Tratamento Administravo, devemos adicionar a tag “AdditionalDocument” contendo as subtags “CategoryCode = LPCO” e “ID = Número do LPCO”.

Neste exemplo, estamos demonstrando como registrar uma DUE com 3 licenças necessárias.

DUE com Depuração Estatística

Exemplo do trecho a ser considerado para cadastrar uma DUE cuja NCM de exportação exija justificativa para depuração estatística

    <!-- Moeda -->
    <CurrencyExchange>
        ...
    </CurrencyExchange>
    <!-- dados do declarente -->
    <Declarant>
        <!-- cpf/cnpj do declarente -->
        <ID schemeID="token">00000000002720</ID>
        <Contact>
            <!-- nome de contato do declarente -->
            <Name>Nome do contato</Name>
            <!-- email do declarente -->
            <Communication>
                <TypeCode>EM</TypeCode>
                <ID>E-mail do contato</ID>
            </Communication>
            <!-- telefone do declarente -->         
            <Communication>
                <TypeCode>TE</TypeCode>
                <ID>2135090000</ID>
            </Communication>
        </Contact>
    </Declarant>
    ...
    <GoodsShipment>
        <GovernmentAgencyGoodsItem>
            <!-- Justificativa de depuração estatística -->
            <AdditionalInformation>
                <StatementTypeCode>AVD</StatementTypeCode>
                <StatementDescription>Texto da justificativa</StatementDescription> 
            </AdditionalInformation>                                                
            ...         
        </GovernmentAgencyGoodsItem>
        ...
    </GoodsShipment>
    ...


Endpoint - Registro de DUE:

POST https://<url>/due/api/ext/due

Endpoint - Retificação de DUE:

PUT https://<url>/due/api/ext/due/{id}

Content-Type:

application/xml

Lista de enquadramentos:

Download em formato ODS Download em formato PDF

Parâmetros:

Nome Descrição Tipo Local Detalhes
Declaration Declaração Única de Exportação object Declaration, obrigatório body XSD para download
id Número da DU-E string(14), obrigatório path (*) Obrigatório somente para retificação de DUE

Observações:

Para registrar/retificar uma DUE que contenha NCM de exportação que necessite de justificativa de depuração estatística, deve ser informado os dados de contato do declarante (tag “Declarant.Contact)”. Também é necessário informar um texto de justificativa, na tag “GovernmentAgencyGoodsItem.AdditionalInformation.StatementDescription” e o código “AVD” na tag “GovernmentAgencyGoodsItem.AdditionalInformation.StatementTypeCode”.

Objetos

Declaration:

Nome Descrição Tipo Detalhes
DeclarationNFe Declaração Única de Exportação com nota fiscal eletrônica object DeclarationNFe, obrigatório* (*) Obrigatório caso o DeclarationNoNF não seja informado.
DeclarationNoNF Declaração Única de Exportação sem nota fiscal (Embarque Antecipado) object DeclarationNoNF, obrigatório* (*) Obrigatório caso o DeclarationNFe não seja informado.
DeclarationDrawbackIsencao Dados de Drawback Isenção contendo o ato a ser vinculado na Declaração Única de Exportação object DeclarationDrawbackIsencao, obrigatório* (*) Obrigatório ao utilizar o serviço de vinculação de ato concessório de Drawback Isenção.

Declaration.DeclarationNFe:

Nome Descrição Tipo Detalhes
DeclarationOffice Dados do local de despacho object DeclarationOffice, obrigatório
AdditionalInformation Dados de (CUS) Forma Exportação, (AHZ) Situação Especial, (TRA) Caso Especial de Transporte, (AAI) Observações Gerais , (ABC) Comprot , (DEF) Motivo retificação object AdditionalInformation, obrigatório
CurrencyExchange.currencyTypeCode Moeda de negociação - Lista de Moeda ISO 4217 string(3), obrigatório
Declarant CPF/CNPJ do Declarante da DU-E (Declarante é diferente de Exportador) object Declarant, obrigatório
ExitOffice Dados do local de embarque object ExitOffice, obrigatório
GoodsShipment Dados dos itens da DU-E agrupado por Nota Fiscal de Exportação object GoodsShipment, obrigatório
UCR.traderAssignedReferenceID Código RUC string(35), opcional (*) Este campo é obrigatório para realizar a retificação de DU-E.

DeclarationNFe(DeclarationNoNF).DeclarationOffice:

Nome Descrição Tipo Detalhes
id Código da Unidade da Receita Federal de Despacho numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
Warehouse Dados do Local do despacho sendo fora ou dentro de recinto alfandegado object Warehouse, obrigatório

DeclarationOffice.Warehouse:

Nome Descrição Tipo Detalhes
id Código do Recinto Alfandegado de Despacho ou , quando despacho fora de recinto, o CNPJ do responsável pelo local numeric(7) para Código do Recinto Alfandegado OU numeric(14) para despacho fora de Recinto, obrigatório Domínio: Tabela de Recintos Alfandegados ou CNPJ
typeCode Flag que identifica se o despacho será realizado dentro ou fora de recinto alfandegado numeric(3), obrigatório Domínio: 19 - Fora de Recinto Alfandegado - Domiciliar, 22 - Fora de Recinto Alfandegado - Não Domiciliar, 281 - Recinto alfandegado
latitudeMeasure Coordenada geográfica de latitude do local despacho. string (11), opcional* (*) Apenas necessário informar quando houver despacho fora de recinto alfandegado. Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
longitudeMeasure Coordenada geográfica de logitude do local despacho. string (11), opcional* (*) Apenas necessário informar quando houver despacho fora de recinto alfandegado. Formato: XX.XXXXXXX ou -XX.XXXXXXX. Coordenadas geográficas em graus decimais.
Address.line Endereço do local em que será realizado o despacho string (240), opcional* (*) Apenas necessário informar quando houver despacho fora de recinto alfandegado.

DeclarationNFe(DeclarationNoNF).AdditionalInformation:

Nome Descrição Tipo Detalhes
StatementTypeCode Código que indica qual dado será informado string (3), obrigatório* Domínio: (AAI) Observações Gerais , (ABC) Comprot , (DEF) Motivo retificação , (AHZ) Situação Especial , (CUS) Forma Exportação , (TRA) Caso Especial de Transporte
StatementCode Código que indica a informação do dado selecionado no statementType numeric(4), opcional* (*) Obrigatório utilizar este campo para informar Forma Exportação (CUS) (**obrigatório), Situação Especial (AHZ) (opcional) e Caso Especial de Transporte (TRA) (**opcional*). Para esses casos não utilizar o campo statementDescription. Domínio: 1001 - Forma Exportação/Por conta própria, 1002 - Forma Exportação/Por conta e ordem de terceiros, 1003 - Forma Exportação/Por operador de remessa postal ou expressa, 2001 - Situação Especial/Despacho a posteriori, 2002 - Situação Especial/Embarque antecipado, 2003 - Situação Especial/Sem saída da mercadoria do país, 4001 - Caso Especial Transporte/Meios próprios, 4002 - Caso Especial Transporte/Dutos, 4003 - Caso Especial Transporte/Linhas de transmissão, 4004 - Caso Especial Transporte/Em mãos, 4005 - Caso Especial Transporte/Por reboque
StatementDescription Descrição da informação adicional Para Observações Gerais (AAI) string(1000), para Motivo de retificação (DEF) string(600), para Comprot (ABC) numeric(17) opcional* (*) Obrigatório utilizar este campo para informar as Observações Gerais (AAI), Motivo de retificação (DEF) e Comprot (ABC). Quando este campo for utilizado, não utilizar o campo statementCode.

DeclarationNFe(DeclarationNoNF).Declarant:

Nome Descrição Tipo Detalhes
id CPF/CNPJ do Declarante da DU-E (Declarante é diferente de Exportador) Para CNPJ string(14), Para CPF string(11), obrigatório
Contact Informações de contato do declarante object Contact, opcional* (*) Obrigatório apenas quando há depuração estatística

Declarant.Contact:

Nome Descrição Tipo Detalhes
Name Nome de contato do declarante string(100), obrigatório
Communication Telefone/Email de contato do declarante object Communication, obrigatório

Contact.Communication:

Nome Descrição Tipo Detalhes
id Descrição da forma de comunicação Para telefone numeric(14,0), Para e-mail string(100), obrigatório
TypeCode Tipo da forma de comunicação string(2), obrigatório Domínio: (EM) Email , (TE) Telefone

DeclarationNFe(DeclarationNoNF).ExitOffice:

Nome Descrição Tipo Detalhes
id Código da Unidade da Receita Federal de Embarque numeric(7), obrigatório Domínio: Tabela de Unidades da RFB
Warehouse Dados do Local do embarque sendo fora ou dentro de recinto alfandegado object Warehouse, opcional* (*) Caso embarque fora de recinto alfandegado, não informar Warehouse. Se embarque for dentro de recinto alfandegado, obrigatório ifnromar Warehouse

ExitOffice.Warehouse:

Nome Descrição Tipo Detalhes
id Código do Recinto Alfandegado de Embarque ou , quando embarque fora de recinto, o CNPJ do responsável pelo local numeric(7), obrigatório Domínio: Tabela de Recintos Alfandegados.
typeCode Flag que indica que o embarque será realizado dentro de recinto alfandegado numeric(3), obrigatório Domínio: 19 - Fora de Recinto Alfandegado - Domiciliar, 22 - Fora de Recinto Alfandegado - Não Domiciliar, 281 - Recinto alfandegado.

DeclarationNFe.GoodsShipment:

Nome Descrição Tipo Detalhes
GovernmentAgencyGoodsItem Itens da DU-E relacionados ao itens da Nota Fiscal de Exportação object GovernmentAgencyGoodsItem, obrigatório*
Invoice Dados da Nota Fiscal object Invoice, obrigatório*
TradeTerms.conditionCode Condição de venda string(3), obrigatório Domínio: (C+F), (C+I), (CFR), (CIF), (CIP), (CPT), (DAP), (DAT), (DDP), (EXW), (FAS), (FCA), (FOB), (OCV)

GoodsShipment.Invoice:

Nome Descrição Tipo Detalhes
id Chave de acesso da Nota Fiscal de Exportação string(44), obrigatório
typeCode Código que define que é uma nota fiscal numeric (3), obrigatório Domínio: 388 - Nota Fiscal
Submitter.id CPF/CNPJ do emissor da Nota Fiscal Para CPF string(11), Para CNPJ string (14) , opcional Desnecessário quando utilizada uma NFE
ReferencedInvoice Nota Fiscal Referenciada de Remessa ou Complementar object ReferencedInvoice, opcional

Invoice.ReferencedInvoice:

Nome Descrição Tipo Detalhes
id Chave de acesso da Nota Fiscal Eletrônica ou da Nota Fiscal Formulário(*) string(44), obrigatório* (*) Número da nota fiscal referenciada ou complementar. Pode ser uma NFE ou NFF. Exemplo de NFF: FSP18070000000000019101222115327274, composto de ‘F’ + 'UF’ + ANO/MES + CNPJ + MODELO + SÉRIE + IDENTIFICADOR ÚNICO DA NFF. No XSD está definido como gerar a chave de acesso da Nota Fiscal Formulário.
typeCode Código que define se é uma Nota Fiscal de Remessa ou Complementar string(3), obrigatório Domínio: REM - Nota Fiscal de Remessa, COM - Nota Fiscal Complementar
Submitter.id CPF/CNPJ do emissor da Nota Fiscal Para CPF string(11), para CNPJ string(14), opcional

GoodsShipment.GovernmentAgencyGoodsItem:

Nome Descrição Tipo Detalhes
customsValueAmount Valor da mercadoria no local do embarque numeric(17,2), obrigatório
FinancedValueAmount Valor financiado do item. Preenchimento depende do tipo do enquadramento. numeric(17,2), opcional
SequenceNumeric Número do Item da DU-E numeric(9), obrigatório O primeiro item de DU-E inicia em 1. Apesar do campo ser numeric(9), o máximo de itens permitidos cadastrados por xml é 999.
Destination País de destino da mercadoria object Destination, obrigatório* (*) Podem ser indicado vários países. Obrigatório ser informado pelo menos um país.
AdditionalDocument Dados de Documentos adcionais à DUE, como Drawback Suspensão/Devolução, Licenças LPCO, entre outros. object AdditionalDocument, opcional* (*) Obrigatório em alguns casos, como: quando for informado enquadramento de Drawback Devolução ou Suspensão. Quando for informado uma NFE com NCM que exige LPCO. Dentre outros casos.
AdditionalInformation Dados de (PRI) Prioridade Carga, (AAZ) Exportação Temporária, (AVD) Justificativa depuração estatística qtd/peso/valor object AdditionalInformation, opcional* (*) Obrigatório quando o registro de DUE cair em depuração estatística, devendo ser informado o domínio (AVD) Justificativa depuração estatística qtd/peso/valor.
Commodity Informações da mercadoria object Commodity, obrigatório
GoodsMeasure. NetNetWeightMeasure Peso líquido total do item da DU-E em KG numeric(19,5), obrigatório
GovernmentProcedure. CurrentCode Enquadramento do item da DU-E numeric(5), obrigatório* (*) Podem ser informados até 4 enquadramentos, sendo pelo menos um obrigatório. Para cada enquadramento adicional, clonar a tag GovernmentProcedure, incluindo sua subtag currentCode.
ValuationAdjustment Informações de Comissão de Agente object ValuationAdjustment, opcional

GovernmentAgencyGoodsItem.Destination:

Nome Descrição Tipo Detalhes
countryCode Código do país qual a mercadoria foi enviada string(2), obrigatório Domínio: Lista de países ISO 3166-1 alfa-2. Exemplo: US (Estados Unidos), BR (Brasil), …
GoodsMeasure.tariffQuantity Quantidade da mercadoria, na unidade de medida estatística, enviada ao país numeric (19,5), obrigatório* (*) O somatório entre todos os GoodsMeasure.tariffQuantity de diferentes países deve ser igual a quantidade total na unidade de medida estatística do item da DU-E.

GovernmentAgencyGoodsItem.AdditionalDocument:

Nome Descrição Tipo Detalhes
CategoryCode Código da categoria do documento string(4), obrigatório Domínio - Drawback Suspensão/Devolução: AC = Drawback Suspensão Comum, DSG = Drawback Suspensão Genérico,DBSI = Drawback Suspensão Intermediário, DSIG = Drawback Suspensão Intermediário Genérico,DSEC = Drawback Suspensão Embarcação Comum, DSEG = Drawback Suspensão Embarcação Genérico, DSMC = Drawback Suspensão Fornecimento no Mercado Interno Comum, DSMG = Drawback Suspensão Fornecimento no Mercado Interno Genérico. Domínio - Transformação de exportação temporária em DU-E definitiva: DDE = DDE, DE = DE. Domínio - Indenização: DSE = DSE, RE = RE. Domínio - Indenização e transformação de exportação temporária em DU-E definitiva (informar também item da DU-E no tag ItemID): DUE = DU-E. Domínio - LPCO: LPCO = Licenças, Permissões, Certificados e Outros Documentos à Exportação, Domínio Reexportação e Substituição de Mercadoria Importada (Enquadramento tipo indenização): DSI = Declaração Simplificada de Importação, DSIF = Declaração Simplificada de Importação - Formulário, DI = Declaração de Importação, EDBV = e-DBV.
ID Código identificador numeric(11) para número do ato concessório, string(11) para Identificação do LPCO, string(20) para Número do documento de importação/exportação utilizados nos tipos de operações de reexportação/indenização. obrigatório*
DrawbackHsClassification NCM do item do ato concessório string(8) , opcional*
DrawbackRecipientId CNPJ do beneficiário do ato concessório string(14) , opcional
ValueWithoutExchangeCoverAmount Valor sem cobertura cambial numeric(17,2), opcional
ValueWithExchangeCoverAmount Valor com cobertura cambial numeric(17,2), opcional
ItemID Número do item do ato concessório ou Número do item do documento de admissão (Este item pode ser uma adição (quando for DI) ou um bem (quando for DSI)). numeric(6) para item do ato concessório, string(20) para Número do item do documento de admissão. opcional
QuantityQuantity Quantidade exportada para Drawback, Quantidade utilizada para Documento de Importação numeric(16,5) para quantidade exportada do ato concessório, numeric(19,5) para Quantidade utilizada, opcional
AdditionalInformation Número do comprot de um Documento de Importação object AdditionalInformation, opcional
PreviousDocument Informações de um Documento de Importação - para drawback devolução object PreviousDocument, opcional
Invoice Informações de uma nota fiscal de venda object Invoice, opcional

GovernmentAgencyGoodsItem.AdditionalDocument.AdditionalInformation:

Nome Descrição Tipo Detalhes
StatementDescription Número do Comprot numeric(17,0) , obrigatório
StatementTypeCode Tipo de informação adicional string(3), obrigatório Domínio: ABC = Comprot.

GovernmentAgencyGoodsItem.AdditionalDocument.PreviousDocument:

Nome Descrição Tipo Detalhes
AmountAmount Valor utilizado numeric(17,2) , opcional* (*) Não informando este campo, é cadastrado valor ZERO.
CategoryCode Código da categoria do documento. string(4), obrigatório Domínio(Drawback Devolução): DSI = Declaração Simplificada de Importação, DSIF = Declaração Simplificada de Importação - Formulário, DI = Declaração de Importação, EDBV = e-DBV.
ID Numero da declaracao de importacao string(20) , obrigatório
QuantityQuantity Quantidade utilizada numeric(19,5) , opcional* (*) Não informando este campo, é cadastrado valor ZERO.
ItemID Número do item do documento de admissão. Este item pode ser uma adição (quando for DI) ou um bem (quando for DSI). string(20) , obrigatório

GovernmentAgencyGoodsItem.AdditionalDocument.Invoice:

Nome Descrição Tipo Detalhes
ID Numero do documento fiscal string(44) , obrigatório
IssueDateTime Data de emissão da Nota Fiscal Date, obrigatório yyyy-mm-dd Ex: 1900-01-31
TypeCode Tipo de Fatura numeric(3), opcional Domínio: 388 = Nota Fiscal
CustomsValueAmount Valor da nota fiscal numeric(15,2), obrigatório
QuantityQuantity Quantidade utilizada da nota fiscal numeric(16,5), obrigatório

GovernmentAgencyGoodsItem.AdditionalInformation:

Nome Descrição Tipo Detalhes
StatementTypeCode Tipo de informação adicional string(3), obrigatório Domínio: (AAZ) Exportação Temporária , (PRI) Prioridade Carga, (AVD) Justificativa depuração estatística qtd/peso/valor
StatementCode Código da informação adicional numeric(4), opcional* (*)Obrigatório Para (PRI) Prioridade Carga. Domínio: 5001 - Prioridade Carga/Carga viva, 5002 - Prioridade Carga/Carga perecível, 5003 - Prioridade Carga/Carga perigosa, 5006 - Prioridade Carga/Partes/peças de aeronave.
StatementDescription Descrição Para (AAZ) Exportação Temporária numeric(17,0), Para (AVD) Justificativa depuração estatística string(2000) , opcional* (*)Obrigatório Para (AAZ) Exportação Temporária representando o Número do Dossie ou proceso da exportação temporária. (*)Obrigatório Para (AVD) Justificativa depuração estatística representando o Texto livre para justificativa de depuração estatística.
LimitDateTime Prazo da exportação temporária numeric(4,0), opcional (*)Obrigatorio apenas para (AAZ) Exportação Temporária

GovernmentAgencyGoodsItem.Commodity:

Nome Descrição Tipo Detalhes
Description Descrição complementar da mercadoria string(600), opcional
ValueAmount Valor da mercadoria na condição de venda numeric(17,2), obrigatório Valor na moeda na condição de venda, deverá ser informada de acordo com as condições de venda.
InvoiceBRLvalueAmount Valor total da mercadoria numeric(17,2), opcional
GoodsMeasure Quantidade na unidade comercializada para ABW ou Quantidade na unidade estátistica para AAF object GoodsMeasure, opcional Pode conter no máximo duas incidências
InvoiceLine Item da Nota Fiscal object InvoiceLine, obrigatório
ProductCharacteristics Atributos da NCM object ProductCharacteristics, opcional (*)Necessário quando uma NCM possui cadastro de atributos.
ProductCriteriaConformance Informações de certificado Mercosul (CCPTC/CCROM) object ProductCriteriaConformance, opcional

Commodity.GoodsMeasure:

Nome Descrição Tipo Detalhes
TypeCode Código da categoria do ajuste string(3), obrigatório Domínio: AAF = Unidade de medida estatística, ABW = Unidade comercial
TariffQuantity Quantidade na unidade comercializada para ABW ou Quantidade na unidade estátistica para AAF. para ambos numeric(19,5) , obrigatório

GovernmentAgencyGoodsItem.ValuationAdjustment:

Nome Descrição Tipo Detalhes
AdditionCode Código da categoria do ajuste numeric(3), obrigatório Domínio: 149 = Comissão do agente.
PercentageNumeric Porcentagem numérica numeric(5,2), obrigatório Valor em Percentual de comissão do agente.

Commodity.InvoiceLine:

Nome Descrição Tipo Detalhes
sequenceNumeric Número do item da Nota Fiscal de Exportação numeric(3), obrigatório Relaciona o item da DUE com o item da nota fiscal de exportação. Os números do item de nota iniciam em 1.
ReferencedInvoiceLine Item da Nota Fiscal de Remessa ou Complementar object ReferencedInvoiceLine, opcional

InvoiceLine.ReferencedInvoiceLine:

Nome Descrição Tipo Detalhes
sequenceNumeric Número do item da Nota Fiscal de Remessa ou Complementar numeric(3), obrigatório
invoiceIdentificationID Chave de Acesso da Nota Fiscal de Remessa ou Complementar string(44), obrigatório
GoodsMeasure.tariffQuantity Quantidade na unidade de medida estatística a ser consumida da Nota Fisca de Remessa numeric(19,5), opcional* (*) Caso Nota Fiscal de Remessa é obrigatório informar GoodsMeasure.tariffQuantity. Caso Nota Fiscal Complementar este campo não deve ser informado.

Commodity.ProductCharacteristics:

Nome Descrição Tipo Detalhes
TypeCode Código do atributo da NCM string(19), obrigatório Domínio: Verificar lista de atributos vinculados a cada NCM publicado no portal.siscomex.gov.br. Este campo representa o Número sequencial da vinculação do atributo por produto.
Description Conteúdo a ser informado para o atributo da NCM string(512), obrigatório

Commodity.ProductCriteriaConformance:

Nome Descrição Tipo Detalhes
QuantityQuantity Quantitade na unidade de medida estística numeric(19,5) , obrigatório
TypeCode Tipo do certificado numeric(1),obrigatório Domínio: 1 - Mercadoria amparada por CCPTC, 2 - Mercadoria amparada por CCROM.
Description Código do certificado string(24), obrigatório

Declaration.DeclarationDrawbackIsencao:

Nome Descrição Tipo Detalhes
GoodsShipment Dados dos Bens Exportados object GoodsShipment ,obrigatório

Declaration.DeclarationDrawbackIsencao.GoodsShipment:

Nome Descrição Tipo Detalhes
GovernmentAgencyGoodsItem Informações do Item de DUE (que receberá vinculação de ato de Drawback Isenção) object GovernmentAgencyGoodsItem ,obrigatório

Declaration.DeclarationDrawbackIsencao.GoodsShipment.GovernmentAgencyGoodsItem:

Nome Descrição Tipo Detalhes
SequenceNumeric Número do Item da DU-E cujo ato de Drawback Isenção será vinculado numeric(3), obrigatório
AdditionalDocument Ato concessório - Drawback Isenção object AdditionalDocument ,obrigatório
GovernmentProcedure Enquadramentos object GovernmentProcedure,obrigatório (*) Obrigatório informar o(s) enquadramento(s) original(ais) do item e o enquadramento necessário para vincular atos de Drawback Isenção. OBS: Pode ser informado no máximo (4) enquadramentos. Para cada enquadramento adicional, clonar a tag GovernmentProcedure, incluindo sua subtag currentCode.

Declaration.DeclarationDrawbackIsencao.GoodsShipment. GovernmentAgencyGoodsItem.AdditionalDocument:

Nome Descrição Tipo Detalhes
CategoryCode Tipo do Ato concessório string ,obrigatório Domínio: DBI - Drawback Isenção Comum, DBII - Drawback Isenção Intermediário
ID Código do Ato Concessório numeric(11) ,obrigatório
DrawbackHsClassification NCM do Ato Concessório string ,obrigatório
DrawbackRecipientId CNPJ do Beneficiário do ato concessório string(14) ,obrigatório
ValueWithExchangeCoverAmount Valor com cobertura cambial decimal ,obrigatório
ItemID Número do item do ato concessório numeric(3) ,obrigatório
QuantityQuantity Quantidade exportada decimal ,obrigatório
Invoice Notas Fiscais de Venda Invoice object Invoice,obrigatório (*) Obrigatório informar para Atos Drawback Isenção Intermediário (DBII) ou Drawback Isenção Comum (DBI) Terceiro (cujo CNPJ Beneficiário do Ato Concessório é diferente do CNPJ do declarante da DUE)

Declaration.DeclarationDrawbackIsencao.GoodsShipment. GovernmentAgencyGoodsItem.AdditionalDocument.Invoice:

Nome Descrição Tipo Detalhes
ID Chave de acesso da Nota Fiscal string ,obrigatório
IssueDateTime Data de emissão da Nota Fiscal string ,obrigatório Formato yyyy-MM-dd.
TypeCode Código que define que é uma nota fiscal numeric (3), opcional Domínio: 388 - Nota Fiscal.
CustomsValueAmount Valor da Nota Fiscal decimal ,obrigatório
QuantityQuantity Quantidade da Nota Fiscal decimal ,obrigatório

Declaration.DeclarationDrawbackIsencao.GoodsShipment. GovernmentAgencyGoodsItem.GovernmentProcedure:

Nome Descrição Tipo Detalhes
CurrentCode Código do Enquadramento do item da DU-E numeric(5), obrigatório*

Declaration.DeclarationNoNF:

Nome Descrição Tipo Detalhes
DeclarationOffice Dados do local de despacho object DeclarationOffice, obrigatório
AdditionalInformation Dados de (CUS) Forma Exportação, (AHZ) Situação Especial, (TRA) Caso Especial de Transporte, (AAI) Observações Gerais , (ABC) Comprot , (DEF) Motivo retificação object AdditionalInformation, obrigatório
CurrencyExchange.currencyTypeCode Moeda de negociação - Lista de Moeda ISO 4217 string(3), obrigatório
Declarant CPF/CNPJ do Declarante da DU-E (Declarante é diferente de Exportador) object Declarant, obrigatório
ExitOffice Dados do local de embarque object ExitOffice, obrigatório
GoodsShipment Dados dos itens da DU-E. Como ainda não há nota Nota Fiscal de Exportação atrelada, diversas informações como NCM e nome do produto devem ser informadas object GoodsShipment, obrigatório
UCR.traderAssignedReferenceID Código RUC string(35), opcional (*) Este campo é obrigatório para realizar a retificação de DU-E. Porém hoje não é possível retificar uma DUE de embarque antecipado até que ela receba Nota Fiscal Eletrônica (através de uma retificação com object DeclarationNFe)

DeclarationNoNF.GoodsShipment:

Nome Descrição Tipo Detalhes
Exporter Dados do Exportador object Exporter, obrigatório
GovernmentAgencyGoodsItem Itens da DU-E sem nota object GovernmentAgencyGoodsItem, obrigatório*
Importer Dados do Importador object Importer, obrigatório
Invoice Detalhamento da dispensa de nota fiscal object Invoice, obrigatório
TradeTerms.conditionCode Condição de venda string(3), obrigatório Domínio: (C+F), (C+I), (CFR), (CIF), (CIP), (CPT), (DAP), (DAT), (DDP), (EXW), (FAS), (FCA), (FOB), (OCV)

DeclarationNoNF.GoodsShipment.Exporter:

Nome Descrição Tipo Detalhes
Name Nome do Exportador string(60), obrigatório* (*) Avaliar real necessidade deste campo
ID CPF ou CNPJ do Exportador string(11) para CPF, string (14) para CNPJ, obrigatório*
Address Informações de endereço do exportador object Address, obrigatório* (*) Avaliar real necessidade deste campo

DeclarationNoNF.GoodsShipment.Exporter.Address:

Nome Descrição Tipo Detalhes
CountryCode Código do país do Exportador string(2), obrigatório Domínio: Lista de países ISO 3166-1 alfa-2. Exemplo: US (Estados Unidos), BR (Brasil), …
CountrySubDivisionCode Estado do país do exportador string(5), obrigatório* (*) Avaliar a necessidade deste campo. Domínio: BR-AC, BR-AL, BR-AM, BR-AP, BR-BA, BR-CE, BR-DF, BR-ES, BR-GO, BR-MA, BR-MG, BR-MS, BR-MT, BR-PA, BR-PB, BR-PE, BR-PI, BR-PR, BR-RJ, BR-RN, BR-RO, BR-RR, BR-RS, BR-SC, BR-SE, BR-SP, BR-TO
Line Endereço do exportador string, obrigatório* (*) Avaliar real necessidade deste campo

DeclarationNoNF.GoodsShipment.GovernmentAgencyGoodsItem:

Nome Descrição Tipo Detalhes
customsValueAmount Valor na moeda no local de embarque numeric(17,2), obrigatório
FinancedValueAmount Valor financiado do item. Preenchimento depende do tipo do enquadramento. numeric(17,2), opcional
SequenceNumeric Número do Item da DU-E numeric(9), obrigatório O primeiro item de DU-E inicia em 1. Apesar do campo ser numeric(9), o máximo de itens permitidos cadastrados por xml é 999.
Destination País de destino da mercadoria object Destination, obrigatório* (*) Podem ser indicado vários países. Obrigatório ser informado pelo menos um país.
AdditionalDocument Dados de Documentos adcionais à DUE, como Drawback Suspensão/Devolução, Licenças LPCO, entre outros. object AdditionalDocument, opcional* (*) Obrigatório em alguns casos, como: Quando for informado uma NFE com NCM que exige LPCO. Dentre outros casos.
AdditionalInformation Dados de (PRI) Prioridade Carga, (AAZ) Exportação Temporária, (AVD) Justificativa depuração estatística qtd/peso/valor object AdditionalInformation, opcional* (*) Obrigatório quando o registro de DUE cair em depuração estatística, devendo ser informado o domínio (AVD) Justificativa depuração estatística qtd/peso/valor.
Commodity Informações da mercadoria object Commodity, obrigatório
GoodsMeasure. NetNetWeightMeasure Peso líquido total do item da DU-E em KG numeric(19,5), obrigatório
GovernmentProcedure. CurrentCode Enquadramento do item da DU-E numeric(5), obrigatório* (*) Podem ser informados até 4 enquadramentos, sendo pelo menos um obrigatório. Para cada enquadramento adicional, clonar a tag GovernmentProcedure, incluindo sua subtag currentCode.
ValuationAdjustment Informações de Comissão de Agente object ValuationAdjustment, opcional

DeclarationNoNF.GoodsShipment. GovernmentAgencyGoodsItem.AdditionalDocument:

Nome Descrição Tipo Detalhes
CategoryCode Código da categoria do documento string(4), obrigatório Domínio - LPCO: LPCO = Licenças, Permissões, Certificados e Outros Documentos à Exportação, Domínio - Reexportação e Substituição de Mercadoria Importada (Enquadramento tipo indenização): DSI = Declaração Simplificada de Importação, DSIF = Declaração Simplificada de Importação - Formulário, DI = Declaração de Importação, EDBV = e-DBV.
ID Código identificador string(11) para Identificação do LPCO, string(20) para Número do documento de importação/exportação utilizados nos tipos de operações de reexportação/indenização. obrigatório
ItemID Número do item do documento de admissão (Este item pode ser uma adição (quando for DI) ou um bem (quando for DSI)). string(20) para Número do item do documento de admissão. opcional
QuantityQuantity Quantidade utilizada numeric(19,5), opcional
AdditionalInformation Número do comprot de um Documento de Importação object AdditionalInformation, opcional

DeclarationNoNF.GoodsShipment. GovernmentAgencyGoodsItem.Commodity:

Nome Descrição Tipo Detalhes
Description Descrição complementar da mercadoria string(600), opcional
ValueAmount Valor da mercadoria na condição de venda numeric(17,2), obrigatório Valor na moeda na condição de venda, deverá ser informada de acordo com as condições de venda.
CommercialDescription Descrição comercial da mercadoria string(600), obrigatório
Classification NCM da mercadoria object Classification, Obrigatório
GoodsMeasure Quantidade na unidade comercializada para ABW ou Quantidade na unidade estátistica para AAF object GoodsMeasure, obrigatório Deve conter duas tags GoodsMeasure. Uma para o domínio (ABW) e outra para o domínio (AAF).
ProductCharacteristics Atributos da NCM object ProductCharacteristics, opcional (*)Necessário quando uma NCM possui cadastro de atributos.
ProductCriteriaConformance Informações de certificado Mercosul (CCPTC/CCROM) object ProductCriteriaConformance, opcional

DeclarationNoNF.GoodsShipment. GovernmentAgencyGoodsItem.Commodity.Classification:

Nome Descrição Tipo Detalhes
ID Código NCM do item de DUE string(8), obrigatório
IdentificationTypeCode Identifica NCM, único domínio (HS) string(2), obrigatório Domínio: HS

DeclarationNoNF.GoodsShipment. GovernmentAgencyGoodsItem.Commodity.GoodsMeasure:

Nome Descrição Tipo Detalhes
UnitDescription Unidade Comercializada string(20), opcional* (*)Obrigatório quando TypeCode = ABW. Exemplo de unidades informadas no campo: UN, KG…
TypeCode Código da categoria string(3), obrigatório Domínio: AAF = Unidade de medida estatística, ABW = Unidade comercial
TariffQuantity Quantidade na unidade comercializada para ABW ou Quantidade na unidade estátistica para AAF. para ambos numeric(19,5) , obrigatório

DeclarationNoNF.GoodsShipment.Importer:

Nome Descrição Tipo Detalhes
Name Nome do Importador string(60), obrigatório
Address Informações de endereço do exportador object Address, obrigatório

DeclarationNoNF.GoodsShipment.Importer.Address:

Nome Descrição Tipo Detalhes
CountryCode Código do país do Importador string(2), obrigatório Domínio: Lista de países ISO 3166-1 alfa-2. Exemplo: US (Estados Unidos), BR (Brasil), …
Line Endereço do importador string(380), obrigatório

DeclarationNoNF.GoodsShipment.Invoice:

Nome Descrição Tipo Detalhes
TypeCode Código que define que este item receberá uma nota fiscal posteriormente numeric(3), opcional Domínio: 388 - Nota Fiscal
AdditionalInformation Informações que identificam o motivo da dispensa de nota object AdditionalInformation, obrigatório

DeclarationNoNF.GoodsShipment.Invoice. AdditionalInformation:

Nome Descrição Tipo Detalhes
StatementCode Código que caracteriza a DUE como Embarque Antecipado para que seja dispensada de nota fiscal inicialmente numeric(4), obrigatório Domínio: 3004 = Embarque antecipado
StatementTypeCode Definição do campo como ACG - Motivo Dispensa NF string(3), obrigatório Domínio: ACG = Motivo Dispensa NF

Pesquisar DU-E por parâmetros

Model Schema

[
  {
    "title": "string",
    "rel": "string",
    "href": "string",
    "method": "string",
    "type": "string"
  }
]

Model

Link {
        title(string, optional),
        rel(string, optional),
        href(string, optional),
        method(string, optional) = ["GET" or "HEAD" or "POST" or "PUT" or "DELETE" or "OPTIONS" or "TRACE" or "PATCH"],
        type(string, optional)
}

Exemplo de Resposta

[{
    title: 'Link para DUE:18BR9900010840',
    rel: '18BR9900010840',
    href: 'https://hom.pucomex.serpro.gov.br/due/api/ext/due/numero-da-due/18BR9900010840',
    method: 'GET',
    type: 'application/json'
},
{
    title: 'Link para DUE:18BR9900011065',
    rel: '18BR9900011065',
    href: 'https://hom.pucomex.serpro.gov.br/due/api/ext/due/numero-da-due/18BR9900011065',
    method: 'GET',
    type: 'application/json'
}]

Endpoint:

GET https://<url>/due/api/ext/due

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
nota-fiscal Nota Fiscal String, obrigatório query param Ex.: 35181100000000002720550900016376281000000009. https://hom.pucomex.serpro.gov.br/due/api/ext/due?nota-fiscal=35181100000000002720550900016376281000000009

Content-Type:

application/json

Observações:

O Model Schema, o Model e um exemplo de resposta podem ser visualizados ao lado.

Status Codes

Código Descrição
200 Operação realizada com sucesso
204 Sem conteúdo

Obter dados resumidos

Exemplo de resposta para uma DU-E com dados resumidos

{
   "numeroDUE": "18BR0000021635",
   "numeroRUC": "8BR00000000100000000000000000023298",
   "situacaoDUE": 83,
   "dataSituacaoDUE": "2018-07-13 09:28:27.0",
   "indicadorBloqueio": 2,
   "controleAdministrativo": 2,
   "uaEmbarque": "717700",
   "uaDespacho": "717700",
   "responsavelUADespacho": null,
   "codigoRecintoAduaneiroDespacho": "7911101",
   "codigoRecintoAduaneiroEmbarque": "7911101",
   "latitudeDespacho": null,
   "longitudeDespacho": null,   
   "declarante":    {
      "numero": "00000000000191",
      "tipo": "PJ"
   },
   "exportadores": [   {
      "numero": "00000000000191",
      "tipo": "PJ"
   }],
   "situacaoCarga": [4]
}

Endpoint:

GET https://<url>/due/api/ext/due/consultarDadosResumidosDUE

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
numero Número da DU-E ou da RUC String, obrigatório query string -

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numeroDUE Número da DU-E string
numeroRUC Número da RUC string
situacaoDUE Código da situação da DU-E numeric
dataSituacaoDUE Data da situação da DU-E string
indicadorBloqueio Código da indicação de bloqueio numeric
controleAdministrativo Controle administrativo numeric
uaEmbarque Unidade de embarque string
uaDespacho Unidade de despacho string
responsavelUADespacho Nome do responsável pela unidade de despacho string
codigoRecintoAduaneiroDespacho Código do recinto aduaneiro de despacho string
codigoRecintoAduaneiroEmbarque Código do recinto aduaneiro de embarque string
latitudeDespacho Latitude do local de despacho string
longitudeDespacho Longitude do local de despacho string
niDeclarante Número do documento de identificação do declarante string
tipoDeclarante Tipo de declarante string
niExportador Número do documento de identificação do exportador string
tipoExportador Tipo de exportador string
situacaoCarga Código da situação da carga numeric

Tabela de situação da DU-E - situacaoDUE:

Código Descrição
1 Em elaboração
10 Registrada
11 Declaração Apresentada para Despacho
15 ACD em processamento
20 Liberada sem conferência Aduaneira canal verde
21 Selecionada para conferência canal laranja ou vermelho
24 Embarque antecipado pendente de LPCO
25 Embarque antecipado autorizado
26 Embarque antecipado pendente de autorização
30 Em análise fiscal
35 Concluída análise fiscal
36 Desembaraço aguardando resolução de pendência administrativa
40 Desembaraçada
70 Averbada
80 Cancelada pelo Exportador
81 Cancelada por Expiração de Prazo
82 Cancelada pela Aduana
83 Cancelada pela Aduana a pedido do exportador
86 Interrompida

Tabela de indicação de bloqueio - indicadorBloqueio:

Código Descrição
1 Bloqueado
2 Desbloqueado

Tabela de situação da carga - situacaoCarga:

Código Descrição
1 Estocada
2 Em Trânsito
3 Carga Completamente Exportada
4 Não se aplica

Tabela de controle administrativo - controleAdministrativo:

Código Descrição
1 Deferido
2 Dispensado
3 Pendente
4 Em processamento
5 Impedido

Obter dados completos

Model Schema

{
  "bloqueio": false,
  "canal": "string",
  "chaveDeAcesso": "string",
  "dataDeRegistro": "2019-01-29T16:56:58.504Z",
  "declarante": {
    "nome": "string",
    "nacionalidade": {
      "codigo": 0,
      "nome": "string",
      "nomeResumido": "string"
    },
    "numeroDoDocumento": "string",
    "tipoDoDocumento": "string",
    "estrangeiro": false
  },
  "embarqueEmRecintoAlfandegado": false,
  "despachoEmRecintoAlfandegado": false,
  "enderecoDoEstabelecimentoDoLocalDeDespacho": "string",
  "enderecoDoEstabelecimentoDoLocalDeEmbarque": "string",
  "estabelecimentoDoLocalDeDespacho": {
    "nomeFantasia": "string",
    "representante": {
      "cpf": {
        "links": [
          {
            "title": "string",
            "rel": "string",
            "href": "string",
            "method": "string",
            "type": "string"
          }
        ],
        "numero": "string"
      }
    },
    "razaoSocial": "string",
    "cnae": {
      "codigo": "string",
      "descricao": "string"
    },
    "codigoDaNaturezaJuridica": "string",
    "endereco": {
      "logradouro": {
        "nome": "string",
        "numero": "string"
      },
      "bairro": "string",
      "municipio": "string",
      "cep": "string",
      "uf": "string"
    },
    "numero": "string"
  },
  "eventosDoHistorico": [
    {
      "evento": "string",
      "responsavel": "string",
      "informacoesAdicionais": "string",
      "motivo": "string",
      "detalhes": "string",
      "dataEHoraDoEvento": "2019-01-29T16:56:58.504Z"
    }
  ],
  "exigenciasFiscais": [
    {
      "orgao": "string",
      "numeroOrdem": 0,
      "textoDaExigencia": "string",
      "textoDaJustificativa": "string",
      "dataDaExigencia": "2019-01-29T16:56:58.504Z",
      "dataDeLiberacao": "2019-01-29T16:56:58.504Z",
      "auditorDoRegistro": "string",
      "auditorDaLiberacao": "string",
      "situacao": "string"
    }
  ],
  "formaDeExportacao": "string",
  "impedidoDeEmbarque": false,
  "informacoesComplementares": "string",
  "itens": [
    {
      "ncm": {
        "unidadeEstatistica": "string",
        "codigo": "string",
        "descricao": "string",
        "atributos": [
          {
            "codigo": "string",
            "conteudo": "string"
          }
        ]
      },
      "quantidadeNaUnidadeEstatistica": 0,
      "numero": 0,
      "pesoLiquidoTotal": 0,
      "valorDaMercadoriaNaCondicaoDeVenda": 0,
      "valorDaMercadoriaNoLocalDeEmbarque": 0,
      "valorDaMercadoriaNoLocalDeEmbarqueEmReais": 0,
      "valorTotalItem": 0,
      "dataDeConversao": "2019-01-29T16:56:58.504Z",
      "itemDaNotaFiscalDeExportacao": {
        "numeroDoItem": 0,
        "notaFiscal": {
          "chaveDeAcesso": "string",
          "modelo": "string",
          "serie": 0,
          "numeroDoDocumento": 0,
          "ufDoEmissor": "string",
          "identificacaoDoEmitente": {
            "numero": "string",
            "nome": "string",
            "cnpj": false,
            "cpf": false
          },
          "finalidade": "string",
          "quantidadeDeItens": 0,
          "notaFicalEletronica": false
        },
        "cfop": 0,
        "codigoDoProduto": "string",
        "descricao": "string",
        "quantidadeEstatistica": 0,
        "unidadeComercial": "string",
        "valorTotalBruto": 0,
        "valorTotalCalculado": 0,
        "ncm": {
          "unidadeEstatistica": "string",
          "codigo": "string",
          "descricao": "string",
          "atributos": [
            {
              "codigo": "string",
              "conteudo": "string"
            }
          ]
        },
        "apresentadaParaDespacho": false,
        "quantidadeConsumida": 0
      },
      "itensDeNotaComplementar": [
        {
          "numeroDoItem": 0,
          "notaFiscal": {
            "chaveDeAcesso": "string",
            "modelo": "string",
            "serie": 0,
            "numeroDoDocumento": 0,
            "ufDoEmissor": "string",
            "identificacaoDoEmitente": {
              "numero": "string",
              "nome": "string",
              "cnpj": false,
              "cpf": false
            },
            "finalidade": "string",
            "quantidadeDeItens": 0,
            "notaFicalEletronica": false
          },
          "cfop": 0,
          "codigoDoProduto": "string",
          "descricao": "string",
          "quantidadeEstatistica": 0,
          "unidadeComercial": "string",
          "valorTotalBruto": 0,
          "valorTotalCalculado": 0,
          "ncm": {
            "unidadeEstatistica": "string",
            "codigo": "string",
            "descricao": "string",
            "atributos": [
              {
                "codigo": "string",
                "conteudo": "string"
              }
            ]
          },
          "apresentadaParaDespacho": false,
          "quantidadeConsumida": 0
        }
      ],
      "itensDaNotaDeRemessa": [
        {
          "numeroDoItem": 0,
          "notaFiscal": {
            "chaveDeAcesso": "string",
            "modelo": "string",
            "serie": 0,
            "numeroDoDocumento": 0,
            "ufDoEmissor": "string",
            "identificacaoDoEmitente": {
              "numero": "string",
              "nome": "string",
              "cnpj": false,
              "cpf": false
            },
            "finalidade": "string",
            "quantidadeDeItens": 0,
            "notaFicalEletronica": false
          },
          "cfop": 0,
          "codigoDoProduto": "string",
          "descricao": "string",
          "quantidadeEstatistica": 0,
          "unidadeComercial": "string",
          "valorTotalBruto": 0,
          "valorTotalCalculado": 0,
          "ncm": {
            "unidadeEstatistica": "string",
            "codigo": "string",
            "descricao": "string",
            "atributos": [
              {
                "codigo": "string",
                "conteudo": "string"
              }
            ]
          },
          "apresentadaParaDespacho": false,
          "quantidadeConsumida": 0
        }
      ],
      "motivoDoTratamentoPrioritario": "string",
      "descricaoDaMercadoria": "string",
      "exportador": {
        "nome": "string",
        "nacionalidade": {
          "codigo": 0,
          "nome": "string",
          "nomeResumido": "string"
        },
        "numeroDoDocumento": "string",
        "tipoDoDocumento": "string",
        "estrangeiro": false
      },
      "unidadeComercializada": "string",
      "percentualDeComissaoDoAgente": 0,
      "atributos": [
        {
          "codigo": "string",
          "conteudo": "string"
        }
      ],
      "tratamentosAdministrativos": [
        {
          "codigo": "string",
          "descricao": "string",
          "dataDeRegistro": "2019-01-29T16:56:58.500Z"
        }
      ],
      "valorFinanciado": 0,
      "documentosImportacao": [
        {
          "dataRegistro": "2019-01-29T16:56:58.504Z",
          "numeroProcesso": 0,
          "numeroDI": "string",
          "numeroDSI": "string",
          "numeroDSIFormulario": "string",
          "numeroEDBV": "string",
          "complemento": "string",
          "quantidadeUtilizada": 0
        }
      ],
      "descricaoMercadoria": "string",
      "codigoCondicaoVenda": {
        "codigo": "string",
        "descricao": "string",
        "descricaoCrt": "string"
      },
      "nomeImportador": "string",
      "enderecoImportador": "string",
      "listaDeEnquadramentos": [
        {
          "codigo": 0,
          "descricao": "string"
        }
      ],
      "listaPaisDestino": [
        {
          "codigo": 0,
          "nome": "string",
          "nomeResumido": "string"
        }
      ],
      "valorTotalCalculadoItem": 0,
      "descricaoComplementar": "string",
      "quantidadeNaUnidadeComercializada": 0
    }
  ],
  "latitudeDoLocalDeEmbarque": "string",
  "longitudeDoLocalDeEmbarque": "string",
  "latitudeDoLocalDeDespacho": "string",
  "longitudeDoLocalDeDespacho": "string",
  "moeda": {
    "codigo": "string",
    "descricao": "string"
  },
  "numero": "string",
  "paisImportador": {
    "codigo": 0,
    "nome": "string",
    "nomeResumido": "string"
  },
  "recintoAduaneiroDeDespacho": {
    "codigo": "string",
    "descricao": "string",
    "latitude": "string",
    "longitude": "string"
  },
  "recintoAduaneiroDeEmbarque": {
    "codigo": "string",
    "descricao": "string",
    "latitude": "string",
    "longitude": "string"
  },
  "referenciaDoEnderecoDoLocalDeDespacho": "string",
  "referenciaDoEnderecoDoLocalDeEmbarque": "string",
  "ruc": "string",
  "situacao": "string",
  "situacaoDoTratamentoAdministrativo": "string",
  "situacaoEspecial": "string",
  "situacoesDaCarga": [
    {
      "cpfOuCnpjDoResponsavel": "string",
      "urfDeDespacho": "string",
      "recintoAduaneiro": "string",
      "longitude": "string",
      "latitude": "string",
      "codigo": 0,
      "descricao": "string",
      "cargaOperada": false
    }
  ],
  "solicitacoes": [
    {
      "tipoSolicitacao": "string",
      "dataDaSolicitacao": "2019-01-29T16:56:58.504Z",
      "usuarioResponsavel": "string",
      "codigoDoStatusDaSolicitacao": 0,
      "statusDaSolicitacao": "string",
      "dataDeApreciacao": "2019-01-29T16:56:58.504Z",
      "usuarioQueAnalisou": "string",
      "motivo": "string",
      "numeroDoComprot": "string",
      "motivoDoIndeferimento": "string"
    }
  ],
  "tipo": "string",
  "tratamentoPrioritario": false,
  "unidadeLocalDeDespacho": {
    "codigo": "string",
    "descricao": "string"
  },
  "unidadeLocalDeEmbarque": {
    "codigo": "string",
    "descricao": "string"
  },
  "viaDeTransporteEspecial": {
    "codigo": 0,
    "descricao": "string"
  },
  "responsavelPeloACD": "string",
  "motivoDeDispensaDaNotaFiscal": {
    "codigo": 0,
    "descricao": "string"
  },
  "justificativaDeDispensaDaNotaFiscal": "string",
  "despachoEmRecintoDomiciliar": false,
  "dataDoCCE": "2019-01-29T16:56:58.504Z",
  "dataDeCriacao": "2019-01-29T16:56:58.504Z",
  "valorTotalMercadoria": 0,
  "dat": false,
  "oea": false
}

Model

DUERemoteDTO {
        bloqueio(boolean, optional),
        canal(string, optional) = ["VERDE" or "LARANJA" or "VERMELHO"],
        chaveDeAcesso(string, optional),
        dataDeRegistro(date - time, optional),
        declarante(PessoaDTO, optional),
        embarqueEmRecintoAlfandegado(boolean, optional),
        despachoEmRecintoAlfandegado(boolean, optional),
        enderecoDoEstabelecimentoDoLocalDeDespacho(string, optional),
        enderecoDoEstabelecimentoDoLocalDeEmbarque(string, optional),
        estabelecimentoDoLocalDeDespacho(CNPJDTO, optional),
        eventosDoHistorico(Array[EventoDoHistoricoDTO], optional),
        exigenciasFiscais(Array[ExigenciaFiscalDTO], optional),
        formaDeExportacao(string, optional) = ["POR_CONTA_PROPRIA" or "POR_CONTA_E_ORDEM_TERCEIROS" or "POR_OPERADOR_REMESSA_POSTAL"],
        impedidoDeEmbarque(boolean, optional),
        informacoesComplementares(string, optional),
        itens(Array[ItemDUERemoteDTO], optional),
        latitudeDoLocalDeEmbarque(string, optional),
        longitudeDoLocalDeEmbarque(string, optional),
        latitudeDoLocalDeDespacho(string, optional),
        longitudeDoLocalDeDespacho(string, optional),
        moeda(MoedaDTO, optional),
        numero(string, optional),
        paisImportador(PaisDTO, optional),
        recintoAduaneiroDeDespacho(RecintoAduaneiroDTO, optional),
        recintoAduaneiroDeEmbarque(RecintoAduaneiroDTO, optional),
        referenciaDoEnderecoDoLocalDeDespacho(string, optional),
        referenciaDoEnderecoDoLocalDeEmbarque(string, optional),
        ruc(string, optional),
        situacao(string, optional) = ["EM_ELABORACAO" or "REGISTRADA" or "ACD_EM_PROCESSAMENTO" or "CARGA_APRESENTADA_PARA_DESPACHO" or "LIBERADA_SEM_CONFERENCIA_ADUANEIRA" or "SELECIONADA_PARA_FISCALIZACAO" or "EMBARQUE_ANTECIPADO_COM_PENDENCIA_LPCO" or "EMBARQUE_ANTECIPADO_AUTORIZADO" or "EMBARQUE_ANTECIPADO_PENDENTE_DE_AUTORIZACAO" or "EM_ANALISE_FISCAL" or "CONCLUSAO_DA_CONFERENCIA_ADUANA" or "DESEMBARACADA_COM_PENDENCIA_LPCO" or "DESEMBARACADA" or "AVERBADA_SEM_DIVERGENCIA" or "CANCELADA_PELO_EXPORTADOR" or "CANCELADA_POR_EXPIRACAO_DE_PRAZO" or "CANCELADA_PELA_ADUANA" or "CANCELADA_PELA_ADUANA_A_PEDIDO_DO_EXPORTADOR" or "INTERROMPIDA"],
        situacaoDoTratamentoAdministrativo(string, optional) = ["DEFERIDO" or "DISPENSADO" or "PENDENTE" or "EM_PROCESSAMENTO" or "IMPEDIDO"],
        situacaoEspecial(string, optional) = ["DUE_A_POSTERIORI" or "EMBARQUE_ANTECIPADO" or "EXPORTACAO_SEM_SAIDA_PAIS"],
        situacoesDaCarga(Array[SituacaoDaCargaDTO], optional),
        solicitacoes(Array[SolicitacaoDTO], optional),
        tipo(string, optional) = ["NOTA_FISCAL_ELETRONICA" or "NOTA_FISCAL_FORMULARIO" or "SEM_NOTA"],
        tratamentoPrioritario(boolean, optional),
        unidadeLocalDeDespacho(UnidadeLocalRFBDTO, optional),
        unidadeLocalDeEmbarque(UnidadeLocalRFBDTO, optional),
        viaDeTransporteEspecial(ViaTransporteEspecialDTO, optional),
        responsavelPeloACD(string, optional) = ["REGISTRO_DA_DUE" or "RECEPCAO_NO_CCT"],
        motivoDeDispensaDaNotaFiscal(MotivoDispensaNotaFiscalDTO, optional),
        justificativaDeDispensaDaNotaFiscal(string, optional),
        despachoEmRecintoDomiciliar(boolean, optional),
        dataDoCCE(date - time, optional),
        dataDeCriacao(date - time, optional),
        valorTotalMercadoria(number, optional),
        dat(boolean, optional),
        oea(boolean, optional)
}
PessoaDTO {
        nome(string, optional),
        nacionalidade(PaisDTO, optional),
        numeroDoDocumento(string, optional),
        tipoDoDocumento(string, optional) = ["CPF" or "CNPJ" or "PASSAPORTE" or "ID"],
        estrangeiro(boolean, optional)
}
PaisDTO {
        codigo(long, optional),
        nome(string, optional),
        nomeResumido(string, optional)
}
CNPJDTO {
        nomeFantasia(string, optional),
        representante(RepresentanteDTO, optional),
        razaoSocial(string, optional),
        cnae(CNAEDTO, optional),
        codigoDaNaturezaJuridica(string, optional),
        endereco(EnderecoDTO, optional),
        numero(string, optional)
}
RepresentanteDTO {
        cpf(CPFResourceDTO, optional)
}
CPFResourceDTO {
        links(Array[Link], optional),
        numero(string, optional)
}
Link {
         title(string, optional),
        rel(string, optional),
        href(string, optional),
        method(string, optional) = ["GET" or "HEAD" or "POST" or "PUT" or "DELETE" or "OPTIONS" or "TRACE" or "PATCH"],
        type(string, optional)
}
CNAEDTO {
        codigo(string, optional),
        descricao(string, optional)
}
EnderecoDTO {
        logradouro(LogradouroDTO, optional),
        bairro(string, optional),
        municipio(string, optional),
        cep(string, optional),
        uf(string, optional)
}
LogradouroDTO {
        nome(string, optional),
        numero(string, optional)
}
EventoDoHistoricoDTO {
         evento(string, optional),
        responsavel(string, optional),
        informacoesAdicionais(string, optional),
        motivo(string, optional),
        detalhes(string, optional),
        dataEHoraDoEvento(date - time, optional)
}
ExigenciaFiscalDTO {
        orgao(string, optional),
        numeroOrdem(integer, optional),
        textoDaExigencia(string, optional),
        textoDaJustificativa(string, optional),
        dataDaExigencia(date - time, optional),
        dataDeLiberacao(date - time, optional),
        auditorDoRegistro(string, optional),
        auditorDaLiberacao(string, optional),
        situacao(string, optional) = ["PENDENTE" or "LIBERADA" or "SUBSTITUIDA" or "ENCERRADA" or "ENCERRADA_POR_OFICIO" or "CANCELADA"]
}
ItemDUERemoteDTO {
        ncm(NCMDTO, optional),
        quantidadeNaUnidadeEstatistica(number, optional),
        numero(integer, optional),
        pesoLiquidoTotal(number, optional),
        valorDaMercadoriaNaCondicaoDeVenda(number, optional),
        valorDaMercadoriaNoLocalDeEmbarque(number, optional),
        valorDaMercadoriaNoLocalDeEmbarqueEmReais(number, optional),
        valorTotalItem(number, optional),
        dataDeConversao(date - time, optional),
        itemDaNotaFiscalDeExportacao(ItemDaNotaFiscalRemoteDTO, optional),
        itensDeNotaComplementar(Array[ItemDaNotaFiscalRemoteDTO], optional),
        itensDaNotaDeRemessa(Array[ItemDaNotaFiscalRemoteDTO], optional),
        motivoDoTratamentoPrioritario(string, optional),
        descricaoDaMercadoria(string, optional),
        exportador(PessoaDTO, optional),
        unidadeComercializada(string, optional),
        percentualDeComissaoDoAgente(number, optional),
        atributos(Array[AtributoDTO], optional),
        tratamentosAdministrativos(Array[TratamentoAdministrativoDTO], optional),
        valorFinanciado(number, optional),
        documentosImportacao(Array[DocumentoImportacao], optional),
        descricaoMercadoria(string, optional),
        codigoCondicaoVenda(CondicaoVendaDTO, optional),
        nomeImportador(string, optional),
        enderecoImportador(string, optional),
        listaDeEnquadramentos(Array[EnquadramentoDTO], optional),
        listaPaisDestino(Array[PaisDTO], optional),
        valorTotalCalculadoItem(number, optional),
        descricaoComplementar(string, optional),
        quantidadeNaUnidadeComercializada(number, optional)
}
NCMDTO {
        unidadeEstatistica(string, optional),
        codigo(string, optional),
        descricao(string, optional),
        atributos(Array[AtributoDTO], optional)
}
AtributoDTO {
        codigo(string, optional),
        conteudo(string, optional)
}
ItemDaNotaFiscalRemoteDTO {
        numeroDoItem(number, optional),
        notaFiscal(NotaFiscalRemoteDTO, optional),
        cfop(integer, optional),
        codigoDoProduto(string, optional),
        descricao(string, optional),
        quantidadeEstatistica(number, optional),
        unidadeComercial(string, optional),
        valorTotalBruto(number, optional),
        valorTotalCalculado(number, optional),
        ncm(NCMDTO, optional),
        apresentadaParaDespacho(boolean, optional),
        quantidadeConsumida(number, optional)
}
NotaFiscalRemoteDTO {
        chaveDeAcesso(string, optional),
        modelo(string, optional),
        serie(integer, optional),
        numeroDoDocumento(integer, optional),
        ufDoEmissor(string, optional),
        identificacaoDoEmitente(NumeroIdentificacaoDTO, optional),
        finalidade(string, optional),
        quantidadeDeItens(integer, optional),
        notaFicalEletronica(boolean, optional)
}
NumeroIdentificacaoDTO {
        numero(string, optional),
        nome(string, optional),
        cnpj(boolean, optional),
        cpf(boolean, optional)
}
AtributoDTO {
        codigo(string, optional),
        conteudo(string, optional)
}
TratamentoAdministrativoDTO {
        codigo(string, optional),
        descricao(string, optional),
        dataDeRegistro(date - time, optional)
}
DocumentoImportacao {
        dataRegistro(date - time, optional),
        numeroProcesso(long, optional),
        numeroDI(string, optional),
        numeroDSI(string, optional),
        numeroDSIFormulario(string, optional),
        numeroEDBV(string, optional),
        complemento(string, optional),
        quantidadeUtilizada(number, optional)
}
CondicaoVendaDTO {
        codigo(string, optional),
        descricao(string, optional),
        descricaoCrt(string, optional)
}
EnquadramentoDTO {
        codigo(integer, optional),
        descricao(string, optional)
}
PaisDTO {
        codigo(long, optional),
        nome(string, optional),
        nomeResumido(string, optional)
}
MoedaDTO {
        codigo(string, optional),
        descricao(string, optional)
}
RecintoAduaneiroDTO {
        codigo(string, optional),
        descricao(string, optional),
        latitude(string, optional),
        longitude(string, optional)
}
SituacaoDaCargaDTO {
        cpfOuCnpjDoResponsavel(string, optional),
        urfDeDespacho(string, optional),
        recintoAduaneiro(string, optional),
        longitude(string, optional),
        latitude(string, optional),
        codigo(integer, optional),
        descricao(string, optional),
        cargaOperada(boolean, optional)
}
SolicitacaoDTO {
        tipoSolicitacao(string, optional) = ["RETIFICACAO" or "CANCELAMENTO"],
        dataDaSolicitacao(date - time, optional),
        usuarioResponsavel(string, optional),
        codigoDoStatusDaSolicitacao(integer, optional),
        statusDaSolicitacao(string, optional),
        dataDeApreciacao(date - time, optional),
        usuarioQueAnalisou(string, optional),
        motivo(string, optional),
        numeroDoComprot(string, optional),
        motivoDoIndeferimento(string, optional)
}
UnidadeLocalRFBDTO {
        codigo(string, optional),
        descricao(string, optional)
}
ViaTransporteEspecialDTO {
        codigo(integer, optional),
        descricao(string, optional)
}
MotivoDispensaNotaFiscalDTO {
        codigo(integer, optional),
        descricao(string, optional)
}

Exemplo de Resposta

{
  "bloqueio": false,
  "chaveDeAcesso": "18DTU000001972",
  "dataDeRegistro": "2018-09-05T16:49:07.000+0000",
  "embarqueEmRecintoAlfandegado": true,
  "despachoEmRecintoAlfandegado": true,
  "eventosDoHistorico": [
    {
      "evento": "Registro",
      "responsavel": "09445537700",
      "dataEHoraDoEvento": "2018-09-05T16:49:06.208+0000"
    },
    {
      "evento": "Apresentação para despacho",
      "responsavel": "Automático",
      "dataEHoraDoEvento": "2018-09-05T16:49:07.324+0000"
    }
  ],
  "impedidoDeEmbarque": false,
  "informacoesComplementares": "Observações Gerais",
  "itens": [
    {
      "ncm": {
        "codigo": "12011000",
        "descricao": "- PARA SEMEADURA (SEMENTEIRA*)",
        "unidadeMedidaEstatistica": "UNIDADE"
      },
      "quantidadeNaUnidadeEstatistica": 1,
      "numero": 1,
      "pesoLiquidoTotal": 49,
      "valorDaMercadoriaNaCondicaoDeVenda": 2000.1,
      "valorDaMercadoriaNoLocalDeEmbarque": 2000,
      "valorDaMercadoriaNoLocalDeEmbarqueEmReais": 7418.6,
      "dataDeConversao": "2018-09-04T01:01:34.000+0000",
      "itemDaNotaFiscalDeExportacao": {
        "numeroDoItem": 1,
        "notaFiscal": {
          "chaveDeAcesso": "35180900000000002720550900014454021000000007",
          "modelo": "55",
          "serie": 90,
          "numeroDoDocumento": 1445402,
          "ufDoEmissor": "SP",
          "identificacaoDoEmitente": {
            "numero": "00000000002720",
            "cnpj": true,
            "cpf": false
          },
          "finalidade": "NF-e normal",
          "quantidadeDeItens": 1,
          "notaFicalEletronica": true
        },
        "cfop": 7101,
        "codigoDoProduto": "000000000000021600001",
        "descricao": "PRODUTO GENERICO TESTE - GRADE COMPOSTA 34.",
        "quantidadeEstatistica": 1,
        "unidadeComercial": "UN",
        "valorTotalCalculado": 10000,
        "ncm": {
          "codigo": "12011000",
          "descricao": "- PARA SEMEADURA (SEMENTEIRA*)",
          "unidadeMedidaEstatistica": "UNIDADE"
        },
        "apresentadaParaDespacho": true
      },
      "motivoDoTratamentoPrioritario": "1",
      "descricaoDaMercadoria": "PRODUTO GENERICO TESTE - GRADE COMPOSTA 34.",
      "exportador": {
        "numeroDoDocumento": "00000000002720",
        "tipoDoDocumento": "CNPJ",
        "nacionalidade": {
          "codigo": 105,
          "nome": "BRASIL",
          "nomeResumido": "BRA"
        },
        "estrangeiro": false
      },
      "unidadeComercializada": "UN",
      "codigoCondicaoVenda": {
        "codigo": "DDP"
      },
      "nomeImportador": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
      "enderecoImportador": "RUA ELISA SILVERIO - 45 - CENTRO - EXTERIOR - 86800270 - RUSSIA",
      "listaDeEnquadramentos": [
        {
          "codigo": 80000,
          "dataRegistro": "2018-09-05T16:49:07.000+0000"
        }
      ],
      "listaPaisDestino": [
        {
          "codigo": 249
        }
      ],
      "valorTotalCalculadoItem": 10000,
      "descricaoComplementar": "Descrição complementar",
      "quantidadeNaUnidadeComercializada": 1
    }
  ],
  "moeda": {
    "codigo": 220
  },
  "numero": "18BR0000001979",
  "paisImportador": {
    "codigo": 676
  },
  "recintoAduaneiroDeDespacho": {
    "codigo": "7911101"
  },
  "recintoAduaneiroDeEmbarque": {
    "codigo": "7911101"
  },
  "ruc": "8BR00000000100000000000000000000199",
  "situacao": "CARGA_APRESENTADA_PARA_DESPACHO",
  "situacoesDaCarga": [
    {
      "cpfOuCnpjDoResponsavel": "07396865000168",
      "urfDeDespacho": "717700",
      "recintoAduaneiro": "7911101",
      "longitude": "-43.248333",
      "latitude": "-22.812222",
      "codigo": 1,
      "descricao": "Estocada",
      "cargaOperada": false
    }
  ],
  "tratamentoPrioritario": true,
  "unidadeLocalDeDespacho": {
    "codigo": "717700"
  },
  "unidadeLocalDeEmbarque": {
    "codigo": "717700"
  },
  "viaDeTransporteEspecial": {
    "codigo": 1,
    "descricao": "Meios próprios"
  },
  "responsavelPeloACD": "REGISTRO_DA_DUE",
  "despachoEmRecintoDomiciliar": false,
  "dataDeCriacao": "2018-09-05T16:49:05.000+0000",
  "valorTotalMercadoria": 10000,
  "dat": false,
  "oea": false
}

Endpoint:

GET https://<url>/due/api/ext/due/numero-da-due/{numero}

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
numero Número da DU-E String, obrigatório path param Ex.: 17BR0055562808. https://hom.pucomex.serpro.gov.br/due/api/ext/due/numero-da-due/17BR0055562808

Endpoint:

GET https://<url>/due/api/ext/due/numero-da-ruc/{numero}

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
numero Número da RUC String, obrigatório path param Ex.: 7BR00000000100000000000000000060138. https://hom.pucomex.serpro.gov.br/due/api/ext/due/numero-da-ruc/7BR00000000100000000000000000060138

Content-Type:

application/json

Observações:

O Model Schema, o Model e um exemplo de resposta podem ser visualizados ao lado.

Status Codes

Código Descrição
200 Operação realizada com sucesso
404 Recurso não encontrado

Duimp

Declaração Única de Importação

Notificação push - SEFAZ

A seguir são especificados os eventos de interesse das Secretarias da Fazenda dos estados (Sefaz), 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.

Eventos da Duimp de interesse das Sefaz

*Funcionalidade ainda não disponível nos ambientes de Validação das Empresas e Produção

A seguir, todos eventos da Duimp possíveis de notificação às Sefaz, com seus respectivos identificadores:

  1. Registro dimp-registro-sefaz
  2. Retificação dimp-retifica-sefaz
  3. Desembaraço dimp-desemb-sefaz
  4. Cancelamento dimp-cancela-sefaz
  5. Autorização de entrega de carga sem prosseguimento de despacho dimp-au-sm-pro-sefaz
  6. Autorização de entrega da carga com prosseguimento de despacho dimp-au-cm-pro-sefaz

Exemplo de conteúdo enviado na notificação:

[
  {
    "numeroDeclaracao":"18BR00000038814",
    "versaoDeclaracao":"001"
  }
]

Campos enviados:

Nome Descrição Tipo Local Detalhes
event-type Nome do evento que está sendo notificado Texto header
numeroDeclaracao Número da declaração Texto(15) body
versaoDeclaracao Versão da declaração Numérico(4) body

Obter Dados da Duimp - SEFAZ

*Funcionalidade ainda não disponível nos ambientes de Validação das Empresas e Produção

Exemplo de resposta do obter declaração

{
  "numeroDeclaracao": "19BR00000004480",
  "versaoDeclaracao": "0001",
  "situacaoDeclaracao": "Desembaraçada. Aguardando a chegada da carga e o pagamento de tributos estaduais.",
  "versaoDeclaracaoVigente": "0001",
  "dataHoraCriacao": "2019-05-03T15:05:38.000+0000",
  "dataHoraRegistro": "2019-05-03T15:06:38.000+0000",
  "dataHoraRegistroVersaoVigente": "2019-05-03T03:00:00.000+0000",
  "tipoImportador": "1",
  "niImportador": 55555000130,
  "nomeImportador": "ZXI FIQPH KXPHIKQX NH IXGFWU H UHIQBIWWQW DVNW - PH",
  "ufImportador": "PR",
  "cpfResponsavel": "99999999999",
  "canalSelecao": 1,
  "dadosCarga": {
    "uaLocalizacaoCarga": "0717600",
    "ufLocalizacaoCarga": "RJ",
    "uaAnaliseFiscal": "0717600",
    "ufAnaliseFiscal": "RJ",
    "uaEntrada": "0717600",
    "ufEntrada": "RJ",
    "codRecintoDespacho": null,
    "identificacaoCarga": "131905000284796",
    "viaTransporte": "01",
    "tipoConhecimento": "10",
    "descTipoConhecimento": "BL",
    "paisProcedencia": "Estados Unidos",
    "dataChegada": null,
    "pesoLiquido": 1,
    "moedaFreteTotal": 220,
    "valorFreteTotalMoedaUtiliza": 100,
    "valorFreteTotalEmReal": 383.44,
    "valorAFRMMDevido": 115.86,
    "valorAFRMMPago": 0,
    "indicadorAFRMMQuitado": 2,
    "moedaSeguro": 220,
    "valorSeguroMoedaUtilizada": 100,
    "valorSeguroEmReal": 383.44,
    "numeroRUC": "9US00055555100000000000000000175268"
  },
  "documentosInstrutivoDespacho": [
    {
      "tipo": {
        "codigo": "62",
        "descricao": "Nota Fiscal Eletrônica"
      },
      "palavrasChave": [
        {
          "codigo": 7,
          "valor": "13221654321385432184315354181354148631351381"
        }
      ]
    }
  ],
  "processosVinculados": [
    {
       "tipo": {
        "codigo": "1",
        "descricao": "Administrativo"
      },
      "numeroProcesso": "23165461651" 
   }
  ],
  "docDeclaracoesExportacaoEstrangeira": [
     {
       "numeroDeclaracao": "X31Y2312312",
       "faixaItemInicial": 12345,
       "faixaItemFinal": 12354
   }
  ],
  "itens": [
    {
      "caracterizacaoImportacao": {
        "numeroItem": "1",
        "indicadorImportacaoTerceiros": 0,
        "cnpjAdquirente": null,
        "ufAdquirente": null,
        "nomeAdquirente": null
      },
      "dadosProduto": {
        "codigoProduto": "13",
        "versaoProduto": "1",
        "cnpjProduto": "00055555",
        "codigoNCM": "57011012",
        "paisOrigem": null
      },
      "dadosExportadorExtrangeiro": {
        "relacaoExportadorFabricante": "0",
        "vinculacaoCompradorVendedor": "1",
        "codigoOperadorExportador": "123",
        "paisOperadorExportador": "AR"
      },
      "informacoesComplementares": {
        "atributosDinamicos": [
          {
            "codigo": "string",
            "valor": "string"
          }
        ],
        "descricaoComplementarMercadoria": "teste"
      },
      "declaracoesExportacaoExtrangeira": [ 
        {
          "tipoCertificadoMercosul": "string",
          "numeroCertificado": "string",
          "quantidadeUnidadeEstatisticaCertificado": 0
        }
      ],
      "declaracoesAduaneiraVinculadas": [
        {
          "tipo": "string",
          "numero": "string",
          "numeroItem": "string"
        }
      ],
      "condicaoVendaMercadoria": {
        "metodoValoracao": 1,
        "incoterm": "CIF",
        "incotermComplemento": null,
        "acrescimosDeducoes": [
          {
            "tipoOperacao": 0,
            "codigo": 0,
            "valor": 0,
            "valorReal": 0,
            "textoComplementar": "string",
            "moeda": 0
          }
        ]
      },
      "dadosCambiais": {
        "coberturaCambial": 4,
        "instituicaoFinanceira": 0,
        "valorCoberturaCambial": null,
        "numeroROFBacen": null,
        "motivoSemCobertura": "ADMISSAO EM REGIME ADUANEIRO ESPECIAL OU ATIPICO"
      },
      "itemTributo": {
        "valorMercadoria": {
          "valorMercadoria": 3067.52,
          "valorFreteRateado": 383.44,
          "valorSeguroRateado": 383.44,
          "valorAduaneiro": 3834.4
        },
        "tributosAplicados": [
          {
            "tributo": {
              "codigo": "string",
              "descricao": "string"
            },
            "regime": {
              "codigo": "string",
              "descricao": "string"
            },
            "fundamentoLegal": {
              "codigo": "string",
              "descricao": "string"
            },
            "atributosDinamicos": [
              {
                "codigo": "string",
                "valor": "string",
                "descricao": "string",
                "tipoAtributo": "string",
                "tipoCampoAdicional": "string"
              }
            ]
           }
        ],
        "calculosTributos": [
          {
            "imposto": {
              "codigo": "1",
              "descricao": "II"
            },
            "fundamentoLegalNormal": {
              "codigo": "0003",
              "descricao": ""
            },
            "valorBaseCalculo": 3834.4,
            "valorBaseCalculoEspecifica": null,
            "valorBaseCalculoReduzida": null,
            "percReducaoBaseCalculo": null,
            "tipoAliquota": {
              "codigo": "1",
              "descricao": "Ad valorem"
            },
            "valorAliquota": 35,
            "valorAliquotaEspecifica": null,
            "valorAliquotaReduzida": null,
            "percReducaoAliquotaReduzida": null,
            "valorCalculado": 1342.04,
            "valorAReduzir": null,
            "valorDevido": 1342.04,
            "valorSuspenso": null,
            "impostoARecolher": 1342.04,
            "valorNormal": 1342.04,
            "indicadorTributado": 1
          },
          {
            "imposto": {
              "codigo": "2",
              "descricao": "IPI"
            },
            "fundamentoLegalNormal": {
              "codigo": "1201",
              "descricao": "IPI - IMPORTAÇÃO"
            },
            "valorBaseCalculo": 5176.44,
            "valorBaseCalculoEspecifica": null,
            "valorBaseCalculoReduzida": null,
            "percReducaoBaseCalculo": null,
            "tipoAliquota": {
              "codigo": "1",
              "descricao": "Ad valorem"
            },
            "valorAliquota": 10,
            "valorAliquotaEspecifica": null,
            "valorAliquotaReduzida": null,
            "percReducaoAliquotaReduzida": null,
            "valorCalculado": 517.64,
            "valorAReduzir": null,
            "valorDevido": 517.64,
            "valorSuspenso": null,
            "impostoARecolher": 517.64,
            "valorNormal": 517.64,
            "indicadorTributado": 1
          },
          {
            "imposto": {
              "codigo": "6",
              "descricao": "PIS"
            },
            "fundamentoLegalNormal": {
              "codigo": "1100",
              "descricao": "PIS/COFINS - IMPORTAÇÃO"
            },
            "valorBaseCalculo": 3834.4,
            "valorBaseCalculoEspecifica": null,
            "valorBaseCalculoReduzida": null,
            "percReducaoBaseCalculo": null,
            "tipoAliquota": {
              "codigo": "1",
              "descricao": "Ad valorem"
            },
            "valorAliquota": 2.1,
            "valorAliquotaEspecifica": null,
            "valorAliquotaReduzida": null,
            "percReducaoAliquotaReduzida": null,
            "valorCalculado": 80.52,
            "valorAReduzir": null,
            "valorDevido": 80.52,
            "valorSuspenso": null,
            "impostoARecolher": 80.52,
            "valorNormal": 80.52,
            "indicadorTributado": 1
          },
          {
            "imposto": {
              "codigo": "7",
              "descricao": "Cofins"
            },
            "fundamentoLegalNormal": {
              "codigo": "1100",
              "descricao": "PIS/COFINS - IMPORTAÇÃO"
            },
            "valorBaseCalculo": 3834.4,
            "valorBaseCalculoEspecifica": null,
            "valorBaseCalculoReduzida": null,
            "percReducaoBaseCalculo": null,
            "tipoAliquota": {
              "codigo": "1",
              "descricao": "Ad valorem"
            },
            "valorAliquota": 10.65,
            "valorAliquotaEspecifica": null,
            "valorAliquotaReduzida": null,
            "percReducaoAliquotaReduzida": null,
            "valorCalculado": 408.36,
            "valorAReduzir": null,
            "valorDevido": 408.36,
            "valorSuspenso": null,
            "impostoARecolher": 408.36,
            "valorNormal": 408.36,
            "indicadorTributado": 1
          }
        ],
        "dadosMercadoria": {
          "tipoAplicacao": 1,
          "condicao": 1,
          "quantidadeUnidadeEstatistica": 1,
          "pesoLiquido": 1,
          "unidadeComercializada": "1",
          "quantidadeUnidadeComercializada": 1,
          "moedaNegociada": 220,
          "valorUnitarioCondicaoVenda": 1000,
          "valorMercadoriaCondicaoVendaMoedaNegociada": 1000,
          "valorMercadoriaCondicaoVendaReal": 3834.4
        }
      }
    }
  ],
  "valorTotalMercadoriaLocalEmbarque": {
    "valorTotalMercadoriaLocalEmbarqueDolar": 800,
    "valorTotalMercadoriaLocalEmbarqueReal": 3067.52,
    "valorTotalMercadoriaLocalDescargaReal": 3834.4
  },
  "dadosTributos": {
    "indicadorCumprimentoICMS": null,
    "tributosCalculados": [
      {
        "imposto": {
          "codigo": "1",
          "descricao": "II"
        },
        "valorCalculado": 1342.04,
        "valorAReduzir": null,
        "valorSuspenso": null,
        "valorDevido": 1342.04,
        "impostoARecolher": 1342.04
      },
      {
        "imposto": {
          "codigo": "2",
          "descricao": "IPI"
        },
        "valorCalculado": 517.64,
        "valorAReduzir": null,
        "valorSuspenso": null,
        "valorDevido": 517.64,
        "impostoARecolher": 517.64
      },
      {
        "imposto": {
          "codigo": "6",
          "descricao": "PIS"
        },
        "valorCalculado": 80.52,
        "valorAReduzir": null,
        "valorSuspenso": null,
        "valorDevido": 80.52,
        "impostoARecolher": 80.52
      },
      {
        "imposto": {
          "codigo": "7",
          "descricao": "Cofins"
        },
        "valorCalculado": 408.36,
        "valorAReduzir": null,
        "valorSuspenso": null,
        "valorDevido": 408.36,
        "impostoARecolher": 408.36
      },
      {
        "imposto": {
          "codigo": "I",
          "descricao": "Taxa de Utilização"
        },
        "valorCalculado": null,
        "valorAReduzir": null,
        "valorSuspenso": null,
        "valorDevido": null,
        "impostoARecolher": 214.5
      }
    ],
    "quantidadeAdicoes": 1,
    "taxaUtilizacao": 214.5
  },
  "pagamentosDebitoConta": [
    {
      "versaoDuimpPagamento": "000",
      "banco": "001",
      "agencia": "1234",
      "conta": "123456789",
      "codigoReceita": "7811",
      "descricaoReceita": "TAXA DE UTILIZAÇÃO DO SISCOMEX",
      "valorTributo": 214.5,
      "dataHoraPagamento": "2019-05-03T15:06:53.000+0000"
    },
    {
      "versaoDuimpPagamento": "000",
      "banco": "001",
      "agencia": "1234",
      "conta": "123456789",
      "codigoReceita": "1038",
      "descricaoReceita": "IPI VINCULADO A IMPORTACAO",
      "valorTributo": 517.64,
      "dataHoraPagamento": "2019-05-03T15:06:53.000+0000"
    },
    {
      "versaoDuimpPagamento": "000",
      "banco": "001",
      "agencia": "1234",
      "conta": "123456789",
      "codigoReceita": "5602",
      "descricaoReceita": "PIS PASEP IMPORTACAO",
      "valorTributo": 80.52,
      "dataHoraPagamento": "2019-05-03T15:06:53.000+0000"
    },
    {
      "versaoDuimpPagamento": "000",
      "banco": "001",
      "agencia": "1234",
      "conta": "123456789",
      "codigoReceita": "0086",
      "descricaoReceita": "IMPOSTO DE IMPORTACAO - OUTROS",
      "valorTributo": 1342.04,
      "dataHoraPagamento": "2019-05-03T15:06:53.000+0000"
    },
    {
      "versaoDuimpPagamento": "000",
      "banco": "001",
      "agencia": "1234",
      "conta": "123456789",
      "codigoReceita": "5629",
      "descricaoReceita": "COFINS IMPORTACAO",
      "valorTributo": 408.36,
      "dataHoraPagamento": "2019-05-03T15:06:53.000+0000"
    }
  ],
  "itensHistorico": [
    {
      "numeroDuimp": "19BR00000004480",
      "versaoDuimp": 1,
      "evento": "Carga Vinculada",
      "dataHora": "2019-05-03T15:06:38.000+0000"
    },
    {
      "numeroDuimp": "19BR00000004480",
      "versaoDuimp": 1,
      "evento": "Declaração registrada",
      "dataHora": "2019-05-03T15:06:38.000+0000"
    },
    {
      "numeroDuimp": "19BR00000004480",
      "versaoDuimp": 1,
      "evento": "Pagamento dos tributos federais realizado",
      "dataHora": "2019-05-03T15:06:53.000+0000"
    },
    {
      "numeroDuimp": "19BR00000004480",
      "versaoDuimp": 1,
      "evento": "Liberada sem conferência aduaneira",
      "dataHora": "2019-05-03T15:07:00.000+0000"
    },
    {
      "numeroDuimp": "19BR00000004480",
      "versaoDuimp": 1,
      "evento": "Declaração desembaraçada sem conferência",
      "dataHora": "2019-05-03T15:07:00.000+0000"
    }
  ]
}

Model


DuimpCover {
numeroDeclaracao (string, optional),
versaoDeclaracao (string, optional),
situacaoDeclaracao (string, optional),
versaoDeclaracaoVigente (string, optional),
dataHoraCriacao (date-time, optional),
dataHoraRegistro (date-time, optional),
dataHoraRegistroVersaoVigente (date-time, optional),
tipoImportador (string, optional),
niImportador (long, optional),
nomeImportador (string, optional),
ufImportador (string, optional),
cpfResponsavel (string, optional),
canalSelecao (integer, optional),
dadosCarga (CargaCover, optional),
documentosInstrutivoDespacho (Array[DocumentoInstrucaoCover], optional),
processosVinculados (Array[ProcessoCover], optional),
docDeclaracoesExportacaoEstrangeira (Array[DeclaracaoExportacaoEstrangeiraCover], optional),
itens (Array[ItemCover], optional),
valorTotalMercadoriaLocalEmbarque (ValorMercadoriaLocalEmbarqueCover, optional),
dadosTributos (DadosTributosCover, optional),
pagamentosDebitoConta (Array[PagamentoCover], optional),
itensHistorico (Array[DuimpHistEventoCover], optional)
}
CargaCover {
uaLocalizacaoCarga (string, optional),
ufLocalizacaoCarga (string, optional),
uaAnaliseFiscal (string, optional),
ufAnaliseFiscal (string, optional),
uaEntrada (string, optional),
ufEntrada (string, optional),
codRecintoDespacho (string, optional),
identificacaoCarga (string, optional),
viaTransporte (string, optional),
tipoConhecimento (string, optional),
descTipoConhecimento (string, optional),
paisProcedencia (string, optional),
dataChegada (date-time, optional),
pesoLiquido (number, optional),
moedaFreteTotal (integer, optional),
valorFreteTotalMoedaUtiliza (number, optional),
valorFreteTotalEmReal (number, optional),
valorAFRMMDevido (number, optional),
valorAFRMMPago (number, optional),
indicadorAFRMMQuitado (integer, optional),
moedaSeguro (integer, optional),
valorSeguroMoedaUtilizada (number, optional),
valorSeguroEmReal (number, optional),
numeroRUC (string, optional)
}
DocumentoInstrucaoCover {
tipo (ItemDominioGenericCoverString, optional),
palavrasChave (Array[PalavraChaveCover], optional)
}
ItemDominioGenericCoverString {
codigo (string, optional),
descricao (string, optional)
}
PalavraChaveCover {
codigo (long, optional),
valor (string, optional)
}
ProcessoCover {
tipo (ItemDominioGenericCoverString, optional),
numeroProcesso (string, optional)
}
DeclaracaoExportacaoEstrangeiraCover {
numeroDeclaracao (string, optional),
faixaItemInicial (string, optional),
faixaItemFinal (string, optional)
}
ItemCover {
caracterizacaoImportacao (CaracterizacaoImportacaoCover, optional),
dadosProduto (ProdutoCover, optional),
dadosExportadorExtrangeiro (ExportadorExtrangeiroCover, optional),
informacoesComplementares (InformacaoComplementarCover, optional),
declaracoesExportacaoExtrangeira (Array[CertificadoMercosul], optional),
declaracoesAduaneiraVinculadas (Array[DeclaracaoVinculada], optional),
condicaoVendaMercadoria (CondicaoVendaMercadoriaCover, optional),
dadosCambiais (DadosCambiaisCover, optional),
itemTributo (ItemTributoCover, optional)
}
CaracterizacaoImportacaoCover {
numeroItem (string, optional),
indicadorImportacaoTerceiros (integer, optional),
cnpjAdquirente (string, optional),
ufAdquirente (string, optional),
nomeAdquirente (string, optional)
}
ProdutoCover {
codigoProduto (string, optional),
versaoProduto (string, optional),
cnpjProduto (string, optional),
codigoNCM (string, optional),
paisOrigem (string, optional)
}
ExportadorExtrangeiroCover {
relacaoExportadorFabricante (string, optional),
vinculacaoCompradorVendedor (string, optional),
codigoOperadorExportador (string, optional),
paisOperadorExportador (string, optional)
}
InformacaoComplementarCover {
atributosDinamicos (Array[AtributoCover], optional),
descricaoComplementarMercadoria (string, optional)
}
AtributoCover {
codigo (string, optional),
valor (string, optional)
}
CertificadoMercosul {
tipoCertificadoMercosul (string, optional),
numeroCertificado (string, optional),
quantidadeUnidadeEstatisticaCertificado (number, optional)
}
DeclaracaoVinculada {
tipo (string, optional),
numero (string, optional),
numeroItem (string, optional)
}
CondicaoVendaMercadoriaCover {
metodoValoracao (integer, optional),
incoterm (string, optional),
incotermComplemento (string, optional),
acrescimosDeducoes (Array[AcrescimoDeducaoCover], optional)
}
AcrescimoDeducaoCover {
tipoOperacao (integer, optional),
codigo (integer, optional),
valor (number, optional),
valorReal (number, optional),
textoComplementar (string, optional),
moeda (integer, optional)
}
DadosCambiaisCover {
coberturaCambial (integer, optional),
instituicaoFinanceira (integer, optional),
valorCoberturaCambial (number, optional),
numeroROFBacen (string, optional),
motivoSemCobertura (string, optional)
}
ItemTributoCover {
valorMercadoria (ValorMercadoriaCover, optional),
tributosAplicados (Array[TributoAplicadoCover], optional),
calculosTributos (Array[CalculoTributoCover], optional),
dadosMercadoria (DadosMercadoriaCover, optional)
}
ValorMercadoriaCover {
valorMercadoria (number, optional),
valorFreteRateado (number, optional),
valorSeguroRateado (number, optional),
valorAduaneiro (number, optional)
}
TributoAplicadoCover {
tributo (ItemDominioGenericCoverString, optional),
regime (ItemDominioGenericCoverString, optional),
fundamentoLegal (ItemDominioGenericCoverString, optional),
atributosDinamicos (Array[AtributoTributoCover], optional)
}
AtributoTributoCover {
codigo (string, optional),
valor (string, optional),
descricao (string, optional),
tipoAtributo (string, optional),
tipoCampoAdicional (string, optional)
}
CalculoTributoCover {
imposto (ItemDominioGenericCoverString, optional),
fundamentoLegalNormal (ItemDominioGenericCoverString, optional),
valorBaseCalculo (number, optional),
valorBaseCalculoEspecifica (number, optional),
valorBaseCalculoReduzida (number, optional),
percReducaoBaseCalculo (number, optional),
tipoAliquota (ItemDominioGenericCoverString, optional),
valorAliquota (number, optional),
valorAliquotaEspecifica (number, optional),
valorAliquotaReduzida (number, optional),
percReducaoAliquotaReduzida (number, optional),
valorCalculado (number, optional),
valorAReduzir (number, optional),
valorDevido (number, optional),
valorSuspenso (number, optional),
impostoARecolher (number, optional),
valorNormal (number, optional),
indicadorTributado (integer, optional)
}
DadosMercadoriaCover {
tipoAplicacao (integer, optional),
condicao (integer, optional),
quantidadeUnidadeEstatistica (number, optional),
pesoLiquido (number, optional),
unidadeComercializada (string, optional),
quantidadeUnidadeComercializada (number, optional),
moedaNegociada (integer, optional),
valorUnitarioCondicaoVenda (number, optional),
valorMercadoriaCondicaoVendaMoedaNegociada (number, optional),
valorMercadoriaCondicaoVendaReal (number, optional)
}
ValorMercadoriaLocalEmbarqueCover {
valorTotalMercadoriaLocalEmbarqueDolar (number, optional),
valorTotalMercadoriaLocalEmbarqueReal (number, optional),
valorTotalMercadoriaLocalDescargaReal (number, optional)
}
DadosTributosCover {
indicadorCumprimentoICMS (string, optional),
tributosCalculados (Array[TributoCalculadoCover], optional),
quantidadeAdicoes (integer, optional),
taxaUtilizacao (number, optional)
}
TributoCalculadoCover {
imposto (ItemDominioGenericCoverString, optional),
valorCalculado (number, optional),
valorAReduzir (number, optional),
valorSuspenso (number, optional),
valorDevido (number, optional),
impostoARecolher (number, optional)
}
PagamentoCover {
versaoDuimpPagamento (string, optional),
banco (string, optional),
agencia (string, optional),
conta (string, optional),
codigoReceita (string, optional),
descricaoReceita (string, optional),
valorTributo (number, optional),
dataHoraPagamento (date-time, optional)
}
DuimpHistEventoCover {
numeroDuimp (string, optional),
versaoDuimp (integer, optional),
evento (string, optional),
dataHora (date-time, optional)
}


Endpoint:

GET https://<url>/dimp/api/ext/sefaz/duimp/{numeroDuimp}/{versaoDuimp}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local
numeroDuimp Número da declaração Texto (15), obrigatório body
versaoDuimp Versão da declaração Numérico (4) body

Resposta (JSON Schema):

Nome Descrição Tipo Local Detalhes
numeroDeclaracao Número da declaração Texto (15), obrigatório body
versaoDeclaracao Versão da declaração Numérico (4), obrigatório body
situacaoDeclaracao Situação Atual da Duimp Texto (50), obrigatório body
versaoDeclaracaoVigente Número de versão da declaração vigente Numérico (4), obrigatório body
dataHoraCriacao Data e hora da criação da Declaração Texto (yyyy-MM-dd'T'HH:mm:ssZ), obrigatório body
dataHoraRegistro Data do registro da Duimp (versão 0001) Texto (yyyy-MM-dd'T'HH:mm:ssZ) , obrigatório body
dataHoraRegistroVigente Data e hora do registro da versão vigente Duimp (última versão) Texto (yyyy-MM-dd'T'HH:mm:ssZ), obrigatório body
tipoImportador Tipo de Importador Númerico (2), obrigatório body Domínio(Tabelas Aduaneiras)
niImportador Número de Identificação do Importador Texto (14), obrigatório body
nomeImportador Nome do Importador Texto (60), obrigatório body
ufImportador UF de localização do Importador Texto (2), obrigatório body
cpfResponsavel CPF do Responsável pelo registro da versão da declaração Númerico (11), obrigatório body
canalSelecao Canal de Seleção Numérico (2), obrigatório body Domínio: 01 – Verde, 12 – Amarelo, 03 – Vermelho, 02 – Laranja, 15 - Cinza
dadosCarga Dados da Carga Objeto Dados da Carga, obrigatório body
documentoInstrutivosDespachos Lista de Documentos Instrutivos de Despacho Lista de Objetos Documentos Instrutivos Despacho, obrigatório body
processosVinculados Lista de Processos Vinculados Lista de Objetos Processos Vinculados body
docDeclaracoesExportacoesEstrangeiras Lista de Documento Declaração de Exportação Extrangeira Lista de Objetos Documento Declaração Exportação Extrangeira body
itens Lista de Itens Lista de Objetos Itens, obrigatório body
DadosResumo Dados do resumo da declaração Objeto Dados Resumo, obrigatório body
historico Histórico da declaração Objeto Histórico da Declaração, obrigatório body

Dados Carga:

Nome Descrição Tipo Local Detalhes
uaLocalizacaoCarga Unidade de localização da carga Numérico (7), obrigatório body
ufLocalizacaoCarga UF de localização da carga Texto (2), obrigatório body
uaAnaliseFiscal Unidade de análise fiscal Numérico (7), obrigatório body
ufAnaliseFiscal UF de análise fiscal Texto (2), obrigatório body
uaEntradaCarga Unidade de entrada/descarga da carga Numérico (7), obrigatório body
ufEntradaCarga UF de entrada/descarga da carga Texto (2), obrigatório body
codRecintoAlfandegario Código do RA de armazenamento da carga Numérico (7) body
identificacaoCarga/numeroCE Número da identificação da carga no sistema Carga. Texto (15), obrigatório body
viaTransporte Via de transporte utilizada Numérico (2), obrigatório body
valorTotal Somatório dos valores devidos + juros + multa +atualização monetária Numérico (15+2), obrigatório body
numeroControle Número de Controle da Sefaz (NossoNúmero) Texto (20), obrigatório body Domínio: Disponível nas Tabelas Aduaneiras (01 – Marítima, 02 - Fluvial, 03 - Lacustre, 04 – Aérea, 05 – Postal, 06 - Ferroviária, 07 – Rodoviária, 08 - Conduto/Rede Transmissão, 09 - Meios Próprios, 10 – Entrada/Saída FICTA, 11 - COURIER12 - EM MÃOS, 13 – POR REBOQUE)
tipoConhecimento Tipo de conhecimento da carga Texto (2), obrigatório body
descTipoConhecimento Descrição do Tipo de Conhecimento Texto (4), obrigatório body
paisProcedencia Nome do País de procedência da carga Texto (60), obrigatório body
dataChegadaCarga Data da chegada da carga na Unidade da RFB de despacho (data da atracação no porto de destino final) Texto (yyyy-MM-dd), obrigatório body
pesoLiquidoTotalCarga Somatório dos pesos líquidos dos itens declarados na Duimp Numérico (10+5), obrigatório body
moedaFreteTotal Código da moeda do enviada pelo sistema Carga Númerico (3), obrigatório body Domínio: Tabela de moedas
valorFreteTotalMoedaUtilizada Valor na Moeda do Frete Total enviada pelo sistema Carga Numérico (13+2), obrigatório body
valorFreteTotalEmReal Valor do frete total convertido em Real Numérico (13+2), obrigatório body
AfrmmDevido Valor AFRMM Devido Numérico (13+2) body
Afrmm Pago Valor AFRMM Pago Numérico (13+2) body
AfrmmQuitadoExonerado Valor AFRMM quitado ou exonerado Numérico (1) body Domínio: 1 – Sim, 2 – Não
moedaSeguro Código da moeda negociada para o seguro Numérico (3), obrigatório Domínio: Tabela de moedas
valorSeguroMoedaUtilizada Valor do seguro na moeda negociada Numérico (13+2), obrigatório
valorSeguroEmReal Valor do seguro convertido em Real Numérico (13+2), obrigatório body
numeroRuc Número do RUC Texto (15), obrigatório body

Documento Instrutivo Despacho:

Nome Descrição Tipo Local Detalhes
tipo Tipo de documento (código) recuperado a partir do sistema Anexação (e-Docex), podendo ser um tipo de documento ou vários. Objeto (codigo, descricao), obrigatório body
palavrasChave Lista de Palavras-Chave Lista de Objetos Palavras Chave body

Palavras Chave:

Nome Descrição Tipo Local Detalhes
codigo Código da palavra-chave Numérico (5) body
valor Valor da palavra-chave Texto (255) body

Processos Vínculados:

Nome Descrição Tipo Local Detalhes
tipoProcessoVinculado Tipo de processo vinculado Numérico(1) body Domínio: 1 – Administrativo
numeroProcesso Número do processo vinculado à Duimp Texto (30) body

Documento Declaração Exportação Extrangeira:

Nome Descrição Tipo Local Detalhes
numeroDeclaracao Número da declaração de exportação estrangeira Texto (16) body
faixaItemInicial Faixa de itens (Item inicial) Númerico (5) body
faixaItemFinal Faixa de itens (Item final) Númerico (5) body

Itens:

Nome Descrição Tipo Local Detalhes
caracterizacaoImportacao Dados da Caracterização da Importação Objeto, obrigatório Caracterização da Importação body
dadosProduto Dados do produto Objeto Dados Produto, obrigatório body
dadosExportadorEstrangeiro Dados do exportador estrangeiro Objeto Dados Exportador Extrangeiro, obrigatório body
informacoesComplementares informacoesComplementares Objeto Informações Complementares, obrigatório body
declaracoesExportacoesExtrageiras Lista de objetos de declaração de exportação extrangeira Lista de objetos Declaração de Exportação Extrangeira,obrigatório body
declaracoesAduaneirasVinculadas Lista de objetos de declaração Aduaneira Vinculada Lista de objetos Declaração Aduaneira Vinculada, obrigatório body
condicaoVendaMercadoria Condição de Venda de Mercadoria Objeto Condição de Venda de Mercadoria, obrigatório body
dadosCambiais Dados Cambiais Objeto Dados Cambiais, obrigatório body

Caracterização da Importação:

Nome Descrição Tipo Local Detalhes
numeroItem Número do item Numérico (5), obrigatório body
indicadorImportacaoTerceiros Indicação de Importação para Terceiros Numérico(1), obrigatório body Domínio: 1-importação direta, 2-conta e ordem, 3-encomenda
cnpjAdquirente CNPJ do Adquirente Numérico(14) body
ufAdquirente UF do Adquirene Texto (2) body
nomeAdquirente Nome do Adquirente Texto (60) body

Dados Produto:

Nome Descrição Tipo Local Detalhes
codigoProduto Código de identificação do produto no sistema catálogo de produtos Texto (25), obrigatório body
versaoProduto Versão do produto existente no catálogo no momento do registro da Duimp Texto (6), obrigatório body
cnpjProduto CNPJ associado ao Produto Numérico(14), obrigatório body
codigoNCM NCM associado ao Produto Numérico(8), obrigatório body Domínio: Disponível nas tabelas aduaneiras
paisOrigem País de origem do Produto Texto (60), obrigatório body

Dados Exportador Extrangerio:

Nome Descrição Tipo Local Detalhes
relacaoExportadorFabricante Relação entre Exportador e Fabricante/Produtor Numérico (1), obrigatório body Indica se o exportador estrangeiro é o próprio fabricante do produto. 0 - Exportador é diferente do Fabricante, 1 - Exportador é o Fabricante
vinculacaoCompradorVendedor Indicação de vinculação entre comprador e vendedor Numérico (1), obrigatório body Domínio: 1 - Não há vinculação, 2 - Vinculação sem influência no preço, 3 - Vinculação com influência no preço
codigoOperadorExportador CNPJ raiz do Operador Exportador Numérico (8), obrigatório body
paisOperadorExportador País de aquisição. País em que reside ou estiver sediado o Operador Exportador. Texto (2), obrigatório body Domínio: Sigla do país.

Informações Complementares:

Nome Descrição Tipo Local Detalhes
atributosDinamicos Lista de atributos dinâmicos Lista de Objetos Atributo Dinâmico, obrigatório body
descricaoComplementarMercadoria Campo texto livre onde o usuário poderá fornecer informações adicionais sobre a mercadoria, que não estejam previstos em campos específicos Texto (4000), obrigatório body

Atributo Dinâmico:

Nome Descrição Tipo Local Detalhes
codigo Conforme definido no cadastro de atributos Texto (10) body
valor Conforme definido no cadastro de atributos Texto(255) body

Declaração Exportação Extrangeria:

Nome Descrição Tipo Local Detalhes
tipoCertificadoMercosul Tipo do Certificado Mercosul. Identificação do certificado quando o país de procedência é pertencente ao Mercosul. Numérico(1), obrigatório body Domínio: 1 - Sem certificado, 2 - CCPTC , 3 – CCROM
numeroCertificado Número do Certificado. Número composto pelo código do país do Mercosul, número e item da declaração de importação estrangeira. Texto (23), obrigatório body
quantidadeUnidadeEstatisticaCertificado Quantidade na Unidade Estatística Associada ao Certificado Numérico(16+5), obrigatório body

Declaração Aduaneira Vinculada:

Nome Descrição Tipo Local Detalhes
tipoDeclaracao Indica o tipo da declaração vinculada informada Numérico(1), obrigatório body Domínio: 1 - DUIMP, 2 - DU-E, 3 - DI
numeroDeclaracao O número da declaração vinculada informada, conforme o tipo selecionado (DUIMP, DU-E, DI e DEE) Texto(15), obrigatório body
numeroItemDeclaracao Número do Item da Declaração Vinculada Numérico (5), obrigatório body

Condição Venda Mercadoria:

Nome Descrição Tipo Local Detalhes
metodoValoracao Método utilizado para valoração da mercadoria Numérico(2), obrigatório body Domínio: Disponível nas Tabelas Aduaneiras
codigoIncoterm Código Incoterm Texto (3), obrigatório body Domínio: Disponível nas Tabelas Aduaneiras
descricaoComplementarIncoterm Descrição Complementar do Incoterm Texto (250), obrigatório body
acrescimosDeducoes Lista de Acréscimos e Deduções Lista de Objetos Acréscimos e Deduções body

Acréscimo e Dedução:

Nome Descrição Tipo Local Detalhes
tipoOperacao Tipo da operação (acréscimo ou dedução) Numérico(1) body Domínio: 1 - Acréscimo , 2 – Dedução
codigoAcrescimoDeducao Código do acréscimo/dedução Texto (2) body Domínio: Disponível nas Tabelas Aduaneiras
moedaNegociada Moeda negociada para o acréscimo/dedução Numérico(3) body Domínio: Tabela de moedas
valorAcrescimoDeducaoMoedaNegociada Valor do acréscimo/dedução na moeda negociada Numérico(16+2) body
valorAcrescimoDeducaoReal Valor do acréscimo/dedução em Real Numérico(16+2) body
descricaoComplementar Descrição Complementar Texto (250) body

Dados Cambiais:

Nome Descrição Tipo Local Detalhes
coberturaCambial Cobertura Cambial Numérico (1), obrigatório body Domínio: 1 - Até 180 dias, 2 - De 181 até 360 dias, 3 - Acima de 360 dias, 4 - Sem cobertura cambial
instituicaoFinanceira Instituição Financiadora Numérico (2) body
valorCoberturaCambial Valor da Cobertura Cambial Numérico(16+2) body
numeroRofBacen Número do ROF/BACEN Texto (8) body
motivoSemCobertura Motivo de sem cobertura Texto (62) body

Item Tributo:

Nome Descrição Tipo Local Detalhes
valorMercadoria Valor da Mercadoria Objeto Valor Mercadoria, obrigatório body
tributoAplicado Lista de Tributos Aplicados Lista de Objetos Tributo Aplicado, obrigatório body
calculoTributo Lista de cálculo de tributos Lista de Objetos Cálculo Tributo, obrigatório body

Valor Mercadoria:

Nome Descrição Tipo Local Detalhes
ValorMercadoria Valor da Mercadoria no Local de Embarque em Real Numérico(16+7), obrigatório body
valorFreteRateado Valor do Frete rateado em Real Numérico(16+7), obrigatório body
valorSeguroRateado Valor do Seguro rateado em Real Numérico(16+7), obrigatório body
valorAduaneiro VMLD em Real - Valor Aduaneiro (Base de Cálculo ) Numérico(16+7), obrigatório body

Tributo Aplicado:

Nome Descrição Tipo Local Detalhes
tributo Código e Descrição do Tributo objeto(codigo, descrição), obrigatório body
regime Código e Decrição do Regime objeto (codigo, descrição), obrigatório body
fundamento Código e Descrição do Fundamento Legal objeto(codigo, Descrição), obrigatório body
atributosDinamicos Lista de atributos dinâmicos do Tributo Lista de Objetos Atributo Dinâmico, obrigatório body

Atributo Dinâmico Tributo:

Nome Descrição Tipo Local Detalhes
codigo Código do Atributo Numérico(2), obrigatório body
descricao Nome do Atributo Texto (100), obrigatório body
valor Valor do Atributo Texto (100), obrigatório body
tipoAtributo Tipo do Atributo Texto (100), obrigatório body
tipoCampoAdicional Tipo do Campo Adicional Texto (100), obrigatório body

Cálculo Tributo:

Nome Descrição Tipo Local Detalhes
imposto Memória de Cálculo por Código de Imposto objeto(codigo, tributo), obrigatório body 1 - Imposto de Importação, 2 - IPI, 3 - Antidumping, 4 - Cide Combustíveis, 5 - Medidas Compensatórias, 6 -PISImportação, 7 - Cofins Importação, 9 – Salvaguarda
fundamentoLegalNormal Fundamento Legal Normal Texto (200), obrigatório body
valorBaseCalculo Base de Cálculo em Real Numérico(16+7), obrigatório body
valorBaseCalculoEspecifica Base de Cálculo Específica em Real Numérico(16+7), obrigatório body
valorBaseCalculoReduzida Base de Cálculo Reduzida em Real Numérico(16+7), obrigatório body
percReducaoBaseCalculo Percentual de Redução da Base de Cálculo (%) Numérico(5+2), obrigatório body
tipoAliquota Tipo de Alíquota Numérico(1), obrigatório body 1 - Ad valorem , 2 - Específica , 3 - Ambas , 4 - Maior entre as duas , 5 - Menor entre as duas
valorAliquota Valor da alíquota Numérico(16+7), obrigatório body
valorAliquotaEspecifica Valor da alíquota Específica Numérico(16+7), obrigatório body
valorAliquotaReduzida Valor da alíquota Reduzida Numérico(16+7), obrigatório body
percReducaoAliquotaReduzida Percentual de Redução da Alíquota Reduzida (%) Numérico(5+2), obrigatório body
valorCalculado Valor Calculado em Real Numérico(16+7), obrigatório body
valorAReduzir Valor a Reduzir em Real Numérico(16+7), obrigatório body
valorDevido Valor Devido em Real Numérico(16+7), obrigatório body
valorSuspenso Valor Suspenso em Real Numérico(16+7), obrigatório body
impostoARecolher Valor a Recolher em Real Numérico(16+7), obrigatório body
valorNormal Valor Normal em Real Numérico(16+7), obrigatório body
indicadorTributado Indicador de tributado Numérico(1), obrigatório body Domínio: 1 – Sim, 2 – Não

Dados Mercadoria:

Nome Descrição Tipo Local Detalhes
tipoAplicacao Aplicação (destinação da mercadoria) Numérico(1), obrigatório body 1 - Consumo, 2 - Revenda
condicao Condição da mercadoria Numérico(1), obrigatório body Domínio: 1- Nova, 2- Usada
quantidadeUnidadeEstatistica Quantidade da mercadoria na unidade de medida estatística Numérico(9+5), obrigatório body
pesoLiquido Peso Líquido (kg) Numérico(9+5), obrigatório body
unidadeComercializada Unidade de medida utilizada na comercialização da mercadoria Texto (60), obrigatório body Domínio: Unidade Medida Mercosul (Tabelas Aduaneiras)
quantidadeUnidadeComercializada Quantidade na Unidade Comercializada Numérico(16+5), obrigatório body
moedaNegociada Moeda utilizada para a negociação da mercadoria e usada na expedição da fatura comercial Numérico(3), obrigatório body Domínio: Tabela de moedas
valorUnitarioCondicaoVenda Valor unitário da mercadoria na moeda negociada Numérico(16+7), obrigatório body
valorMercadoriaCondicaoVendaMoedaNegociada O produto entre o “Valor Unitário da Mercadoria na Moeda Negociada” e a “Quantidade na Unidade Comercializada” Numérico(16+7), obrigatório body
valorMercadoriaCondicaoVendaReal Valor da mercadoria na Condição de Venda convertida em Real Numérico(16+7), obrigatório body

Valor Total Mercadoria Local Embarque:

Nome Descrição Tipo Local Detalhes
valorTotalMercadoriaLocalEmbarqueDolar Valor da Mercadoria no Local de Embarque convertido em Dolar Numérico(13+2), obrigatório body
valorTotalMercadoriaLocalEmbarqueReal Valor da Mercadoria no Local de Embarque convertido em Real Numérico(13+2), obrigatório body
valorTotalMercadoriaLocalDescargaReal Valor da Mercadoria no Local de Descarga convertido em Real Numérico(13+2), obrigatório body

Dados Tributo:

Nome Descrição Tipo Local Detalhes
indicadorCumprimentoICMS Indicador de cumprimento de ICMS Numérico(1), obrigatório body Domínio: 1- Pago, 2 - Cancelado
tributosCalculados Lista de Impostos Federais e seus valores Lista de Objetos Tributo Calculado, obrigatório body
quantidadeAdicoes Quantidade de Adições Numérico(5), obrigatório body
taxaUtilizacao Taxa de Utilização Numérico(13+2), obrigatório body

Tributo Calculado:

Nome Descrição Tipo Local Detalhes
imposto Código e Descrição do Imposto Federal objeto(codigo, valor), obrigatório body Domínio: Denominação ou sigla dos tributos. Ex: II, IPI, PIS, Cofins, Cide, Anti Dumping
valorCalculado Imposto Calculado Numérico(13+2), obrigatório body
valorAReduzir Imposto a Reduzir Numérico(13+2), obrigatório body
valorSuspenso Imposto Suspenso Numérico(13+2), obrigatório body
valorDevido Imposto Devido Numérico(13+2), obrigatório body
impostoARecolher Imposto a Recolher Numérico(13+2), obrigatório body

Pagamento Débito em Conta:

Nome Descrição Tipo Local Detalhes
versaoDuimpPagamento Versão da Duimp na qual foi feito o pagamento Numérico(4), obrigatório body
banco Código do banco Numérico(3), obrigatório body
agencia Código da agência Numérico(5), obrigatório body
conta Código da conta na qual os tributos serão debitados Texto (19), obrigatório body
codigoReceita Código de receita tributária corresponde ao imposto a recolher e/ou da taxa de utilização do sistema Numérico(4), obrigatório body
descricaoReceita Descrição da Receita Texto (100), obrigatório body
valorTributo Valor do tributo correspondente aos impostos a recolher Numérico(13+2), obrigatório body
dataHoraPagamento Data Hora do Pagamento Texto (yyyy-MM-dd'T'HH:mm:ssZ), obrigatório body

Itens Histórico:

Nome Descrição Tipo Local Detalhes
numeroDuimp Número da declaração Numérico(15), obrigatório body
versaoDuimp Versão da Declaração Numérico(4), obrigatório body
evento Evento ocorrido que é de interesse da Sefaz Texto(100), obrigatório body Domínio: Criação, Registro, Retificação, Desembaraço, Cancelamento, Autorização de entrega da carga sem prosseguimento de despacho, Autorização de entrega da carga com prosseguimento de despacho
dataHora Data e hora da ocorrência Texto (yyyy-MM-dd'T'HH:mm:ssZ), obrigatório body

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

LPCO

Licenças, Permissões, Certificados e Outros

A primeira etapa na integração com o LPCO é saber qual o modelo do documento necessário para a operação. Para isso, a área de negócio deve pesquisar no Portal Único via tela acessando a funcionalidade “LPCO” à “Incluir Pedido” (vide manual). Após saber o número de modelo correto:

Consultar Modelos de LPCO

Exemplo de resposta para a consulta de Modelos de LPCO

[
  {
    "codigo": "E0105",
    "nome": "Substâncias e medicamentos sujeitos à controle especial"
  },
  {
    "codigo": "E0106",
    "nome": "Anuência prévia da ANVISA"
  }
]

Endpoint:

GET https://<url>/talpco/api/ext/lpco/modelo/consulta/{codigoOrgao}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
codigoOrgao Código do órgão anuente responsável pelo modelo. Texto, obrigatório query string -
dataReferencia Data de referência para filtro dos modelos. Se não informada, utiliza-se o momento atual. Data e hora, opcional query string Formato: AAAA-MM-DD’T'HH:MM.

Ex: http://<url>/talpco/api/ext/lpco/modelo/consulta/ANVISA?dataReferencia=2018-07-30T00%3A00

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
codigo Código do modelo LPCO. Texto
nome Nome do modelo LPCO. Texto

Consultar Modelo de Formulário LPCO

Exemplo de resposta para a consulta de Modelos de LPCO

{
  "modelo": {
    "orgaoAnuente": "ANVISA",
    "codigo": "E0105",
    "nome": "Substâncias e medicamentos sujeitos à controle especial",
    "informacoesExportadorImportador": null,
    "informacoesAnuente": null,
    "exibirInformacaoAdicional": true,
    "requerCatalogoProduto": false
  },
  "listaCamposFormulario": [
    {
      "codigo": "NCM",
      "nome": "NCM",
      "unidadeMedida": null,
      "tipo": "NUMERO_INTEIRO",
      "validacao": {
        "obrigatorio": true,
        "permiteMultiplosValores": false,
        "mascara": "99999999",
        "tamanhoMaximo": 8,
        "qtdCasasDecimais": null,
        "dominios": [
          {
            "id": "00000000",
            "descricao": "Descrição da NCM"
          },
          {
            "id": "00000001",
            "descricao": "Descrição da NCM"
          }
        ]
      }
    },
    {
      "codigo": "QTDE_COMERCIALIZADA",
      "nome": "Qtd. un. comercializada",
      "unidadeMedida": null,
      "tipo": "NUMERO_INTEIRO",
      "validacao": {
        "obrigatorio": false,
        "permiteMultiplosValores": false,
        "mascara": null,
        "tamanhoMaximo": 25,
        "qtdCasasDecimais": null,
        "dominios": []
      }
    }
  ],
  "listaCamposNcm": [
    {
      "codigo": "QTDE_UNIDADE_ESTATISTICA",
      "nome": "Qtd. un. estatística",
      "unidadeMedida": "KG",
      "tipo": "NUMERO_INTEIRO",
      "validacao": {
        "obrigatorio": false,
        "permiteMultiplosValores": false,
        "mascara": null,
        "tamanhoMaximo": 25,
        "qtdCasasDecimais": null,
        "dominios": []
      }
    }
  ],
  "permiteMultiplosCpfCnpjExportador": false
}

Endpoint:

GET https://<url>/talpco/api/ext/lpco/modelo/{codigoModelo}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
codigoModelo Código do modelo de pedido de LPCO. String, obrigatório query string -
dataReferencia Data de referência para filtro dos campos do modelo. Se não informada, utiliza-se o momento atual. Data e hora, opcional query string Formato AAAA-MM-DD’T'HH:MM

Ex: http://<url>/talpco/api/ext/lpco/modelo/E0105?dataReferencia=2018-07-30T00%3A00

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
orgaoAnuente Sigla do órgão anuente que gerencia o modelo LPCO. Texto
modelo Dados do modelo de pedido LPCO pesquisado. Objeto
codigo Código do modelo de pedido LPCO. Texto
nome Nome do modelo de pedido LPCO. Texto
informacoesExportadorImportador Informações adicionais para preenchimento dos LPCOs do modelo. Texto
informacoesAnuente Informações adicionais para o anuente preencher ou analisar os LPCOs do modelo. Texto
exibirInformacaoAdicional Indica se haverá um campo para preencher informações adicionais nos pedidos de LPCO Booleano “true” ou “false”
requerCatalogoProduto Indica se a informação de mercadorias será via Catálogo de Produtos Booleano “true” ou “false”
listaCamposFormulario Lista de definições de campos do formulário. Coleção
listaCamposNcm Lista de definições de campos a serem preenchidos por NCM. Coleção
codigo Código de identificação do campo. Texto
nome Nome descritivo do campo. Texto
unidadeMedida Unidade de medida a ser informada para o campo QTDE_COMERCIALIZADA. Texto Ex.: KG, UN, etc.
tipo Tipo da informação recebida pelo campo. Texto
modelo Dados do modelo de pedido LPCO pesquisado. Objeto
validacao Regras de validação do campo. Objeto
obrigatorio Indica se o campo é obrigatório. Booleano “true” ou “false”
permiteMultiplosValores Indica se o campo é obrigatório. Booleano “true” ou “false”
mascara Máscara de restrição de entrada de dados do campo. Texto 9: dígito numérico; A: dígito alfanumérico; *: dígito numérico ou alfanumérico.
tamanhoMaximo Tamanho máximo, em dígitos, do campo. Numérico
qtdCasasDecimais Quantidade de casas decimais, se o campo for um número real. Numérico
dominios Lista de valores permitidos para o campo. Objeto Informado apenas quando há uma lista pré-definida.
id Valor permitido para o campo. Texto
descricao Descrição do valor permitido para o campo. Texto
permiteMultiplosCpfCnpjExportador Depreciado. Utilize “permiteMultiplosValores” do campo CPF_CNPJ_EXPORTADOR. Booleano “true” ou “false”

Tipo de informação esperadas pelos campos do modelo :

Código Descrição
BOOLEANO Valor booleano, podendo ser “true” ou “false”.
DATA Valor é uma data.
DATA_HORA Valor é uma data e hora.
NUMERO_INTEIRO Valor númerico inteiro.
NUMERO_REAL Valor númerico com fração.
TEXTO Texto livre.
LISTA Valor deve estar dentro da lista de valores permitidos (domínio).
CRONOGRAMA Item de um cronograma (de emabrque ou de faturamento) no formato AAAA/MM - VALOR.
RUC Valor no padrão da Referência Única de Carga.

Consultar Campos do Modelo a Serem Preenchidos Individualmente Por NCM

Exemplo de resposta para a consulta de Modelos de LPCO para um NCM

{
    "ncm": "01012100",
    "descricaoNcm": "- REPRODUTORES DE RAÇA PURA__XXXXXX",
    "listaCamposNcm": [
        {
            "codigo": "PAIS_DESTINO",
            "nome": "País de destino",
            "unidadeMedida": null,
            "tipo": "LISTA",
            "validacao": {
                "obrigatorio": true,
                "permiteMultiplosValores": false,
                "mascara": null,
                "tamanhoMaximo": 60,
                "qtdCasasDecimais": null,
                "dominios": [
                  {
                    "id": "AR",
                    "descricao": "AR - ARGENTINA"
                  },
                  {
                    "id": "PY",
                    "descricao": "PY - PARAGUAI"
                  }
                ]               
            }
        },
        {
            "codigo": "QTDE_COMERCIALIZADA",
            "nome": "Qtd. un. comercializada",
            "unidadeMedida": null,
            "tipo": "NUMERO_INTEIRO",
            "validacao": {
                "obrigatorio": false,
                "permiteMultiplosValores": false,
                "mascara": null,
                "tamanhoMaximo": 25,
                "qtdCasasDecimais": null,
                "dominios": []
            }
        }
    ],
    "listaAtributosNcm": [
        {
            "codigo": "ATT_100000038",
            "nome": "Destaque",
            "unidadeMedida": null,
            "tipo": "TEXTO",
            "validacao": {
                "obrigatorio": true,
                "permiteMultiplosValores": false,
                "mascara": null,
                "tamanhoMaximo": null,
                "qtdCasasDecimais": null,
                "dominios": []              
            }
        },
        {
            "codigo": "ATT_100000082",
            "nome": "Idade",
            "unidadeMedida": null,
            "tipo": "NUMERO_INTEIRO",
            "validacao": {
                "obrigatorio": true,
                "permiteMultiplosValores": false,
                "mascara": null,
                "tamanhoMaximo": 99,
                "qtdCasasDecimais": null
            }
        }
    ],
    "unidadeMedidaEstatistica": "UN"
}

Endpoint:

GET https://<url>/talpco/api/ext/lpco/modelo/{codigoModelo}/{ncm}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
codigoModelo Código do modelo de pedido de LPCO. String, obrigatório query string -
ncm Código do NCM da mercadoria. String, obrigatório query string -
dataReferencia Data de referência para filtro dos campos do modelo. Se não informada, utiliza-se o momento atual. Data e hora, opcional query string Formato AAAA-MM-DD’T'HH:MM

Ex: http://<url>/talpco/api/ext/lpco/modelo/E0105/01012100?dataReferencia=2018-07-30T00%3A00

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
ncm Código NCM informado para pesquisa do modelo. Numérico
descricaoNcm Descrição do NCM informado para pesquisa do modelo. Texto
listaCamposNcm Lista de definições de campos a serem preenchidos por NCM. Coleção
listaAtributosNcm Lista de definições dos atributos exigidos para o o NCM no formulário. Coleção
codigo Código de identificação do campo ou do atributo. Texto
nome Nome descritivo do campo. Texto
unidadeMedida Unidade de medida a ser informada para o campo QTDE_COMERCIALIZADA, ou apenas de leitura para o campo QTDE_ESTATISTICA. Texto Ex.: KG, UN, etc.
tipo Tipo da informação recebida pelo campo. Texto
modelo Dados do modelo de pedido LPCO pesquisado. Objeto
validacao Regras de validação do campo. Objeto
obrigatorio Indica se o campo é obrigatório. Booleano “true” ou “false”
permiteMultiplosValores Indica se o campo é obrigatório. Booleano “true” ou “false”
mascara Máscara de restrição de entrada de dados do campo. Texto 9: dígito numérico; A: dígito alfanumérico; *: dígito numérico ou alfanumérico.
tamanhoMaximo Tamanho máximo, em dígitos, do campo. Numérico
qtdCasasDecimais Quantidade de casas decimais, se o campo for um número real. Numérico
dominios Lista de valores permitidos para o campo. Objeto Informado apenas quando há uma lista pré-definida.
id Valor permitido para o campo. Texto
descricao Descrição do valor permitido para o campo. Texto
unidadeMedidaEstatistica Unidade utilizada pelo NCM para medida estatística. Texto Campo apenas informativo. Não deve ser enviado na inclusão/alteração do LPCO.

Consultar Pedidos de LPCO

Exemplo de resposta para a consulta de pedidos de LPCO

[
  {
    "numero": "E0000000001",
    "dataRegistro": "01/08/2017",
    "situacao": "Para análise",
    "codigoModelo": "E00079",
    "nome": "Licença do órgão anuente apra exportação de produtos",
    "ncm": "01012100",
    "importadorExportador": "00000000000191",
    "dataFimVigencia": "01/08/2020", 
    "dueEmDespacho": "01/08/2017",
    "dueVinculada": "17BR0000000000,17BR0000000001",
    "prorrogacaoPendente": false,
    "retificacaoPendente": false
  }
]

Endpoint:

GET https://<url>/talpco/api/ext/lpco/consulta

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
offset Índice do primeiro elemento a ser retornado na pesquisa. Número query string
numero Número do pedido de LPCO. Texto query string
situacao Código da situação do pedido LPCO. Texto query string
situacaoProrrogacao Código da situação do pedido de prorrogação do LPCO. Texto query string
situacaoRetificacao Código da situação do pedido de retificação do LPCO. Texto query string
codigo-modelo Código do modelo de LPCO do pedido. String query string
orgao-anuente Sigla do órgão anuente do LPCO. Texto query string
tipo-operacao Tipo de operação solicitada no LPCO. Texto query string
importador-exportador Número do CPF ou CNPJ do Importador ou Exportador no LPCO. Número query string
data-inicial-registro Data inicial de filtro sobre o registro do pedido de LPCO. Data query string Formato AAAA-MM-DD (Depreciado: DD/MM/AAAA)
data-final-registro Data final de filtro sobre o registro do pedido de LPCO. Data query string Formato AAAA-MM-DD (Depreciado: DD/MM/AAAA)
pais-destino Nome do país de destino no pedido do LPCO. Texto query string
pais-importador Nome do país importador no pedido LPCO. Texto query string
due Número da DU-E vinculada ao LPCO. Texto query string
ncm-inicial Número NCM inicial de filtro sobre o pedido LPCO. Número query string
ncm-final Número NCM final de filtro sobre o pedido LPCO. String query string
carga-despacho Filtra os LPCOs com carga em despacho. Booleano query string “true” ou “false”
numero-documento-orgao Número do documento LPCo no órgão anuente. String query string
operacao-vinculada Filtra apenas os LPCOs vinculados a alguma DU-E, no caso da exportação. Booleano query string “true” ou “false”

Ex: http://<url>/talpco/api/ext/lpco/modelo/consulta?orgao-anuente=ANVISA

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numero Número do pedido LPCO. Texto
dataRegistro Data de registro do pedido LPCO. Data Formato DD/MM/AAAA
situacao Descrição da situação do pedido LPCO. Texto
codigoModelo Código do modelo do LPCO. Texto
nome Nome do modelo do LPCO. Texto
ncm Número do NCM do pedido LPCO. Número
importadorExportador Número do CPF ou CNPJ do importador ou exportador no LPCO. Número
dataFimVigencia Data fim de vigência do LPCO. Data Formato DD/MM/AAAA
dueEmDespacho Data de ACD se alguma DU-E vinculada possui esta data mas não a data de desembaraço. Nulo caso contrário. Data Formato DD/MM/AAAA
dueVinculada Número das DU-Es vinculadas ao LPCO. Texto Separados por vírgula
prorrogacaoPendente Indica se há um pedido de prorrogação do LPCO ainda pendente. Booleano “true” ou “false”
retificacaoPendente Indica se há um pedido de retificação do LPCO ainda pendente. Booleano “true” ou “false”

Operações para qual o LPCO é pedido :

Código Descrição
EXPORTACAO Operação de exportação.
IMPORTACAO Operação de importação.

Detalhar Pedido de LPCO

Exemplo de resposta para a consulta dos detalhes de um pedido de LPCO

{
    "numero": "E1800000001",
    "codigoModelo": "E00001",
    "orgao": "ANVISA",
    "situacao": {
        "id": "PARA_ANALISE",
        "descricao": "Para análise"
    },
    "importadorExportador": "00000000000191",
    "chaveAcesso": "8b88c22e5817466b8b942ae1da1bb16f",
    "prorrogacaoPendente": false,
    "retificacaoPendente": false,
    "declarante": "00000000000191",
    "informacaoAdicional": null,
    "listaNcm": [
        {
            "ncm": "01012100",
            "numeroItem": 1,
            "listaCamposNcm": [],
            "listaAtributosNcm": [
                {
                    "codigo": "ATT_100000038",
                    "listaValor": [ "99" ]
                },
                {
                    "codigo": "ATT_100000082",
                    "listaValor": [ "22" ]
                }
            ],
            "unidadeMedidaComercializada": "KG"
        }
    ],
    "listaCamposFormulario": [
        {
            "codigo": "CPF_CNPJ_EXPORTADOR",
            "listaValor": [ "00000000000191" ],
            "intervenientes": [
                {
                    "id": "00000000000191",
                    "nome": "ONONO NO NONONON NOONONNON",
                    "endereco": {
                        "logradouro": "NONONO ONONONONON ONONONON",
                        "bairro": "NONONONON ONONONON",
                        "municipio": "NONONONONON",
                        "cep": "99999-99",
                        "uf": "ON"
                    }
                }
            ],
        },
        {
            "codigo": "QTDE_COMERCIALIZADA",
            "listaValor": [ "100" ],
            "unidadeMedida": "KG"
        }
    ],
    "listaVinculos": [
        {
            "dataVinculo": "01/08/2018",
            "numeroDocumento": "18BR0000000000",
            "numeroDocumentoItem": 1,
            "dataACD": "01/08/2018",
            "dataDesembaraco": null,
            "dataCCE": null,
            "dataAverbacao": null,
            "dataDesvinculacao": null,
            "quantidadeComercial": null,
            "quantidadeUnidadeEstatistica": null,
            "vmle": null
        }
    ],
    "saldos": {
        "titulo": "Item 1 - NCM 01012100",
        "saldoQuantidadeComercial": 0,
        "saldoQuantidadeEstatistica": 0,
        "saldoVMLE": 0,
        "saldoPesoLiquido": 0,
        "saldoValorFinanciado": 0,
        "saldoValorCondicaoVenda": 0
    }
}

Endpoint:

GET https://<url>/talpco/api/ext/lpco/{numero}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
numero Número do pedido de LPCO Texto, obrigatório query string

Ex: https://<url>/talpco/api/ext/lpco/E1800000001

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numero Número do pedido de LPCO. Texto
codigoModelo Código do modelo de LPCO utilizado para o pedido. Texto
orgao Código do órgão anuente do documento LPCO. Texto
situacao Código e descrição da situação do pedido LPCO. Objeto
importadorExportador Número do CPF ou CNPJ do importador ou exportador no LPCO. Texto Depreciado. Utilize os campos CPF_CNPJ_EXPORTADOR ou CPF_CNPJ_IMPORTADOR do formulário.
declarante Número do CPF ou CNPJ do declarante no LPCO. Texto Depreciado. Utilize o campo CPF_CNPJ_DECLARANTE do formulário.
chaveAcesso Chave de acesso público ao LPCO. Texto
prorrogacaoPendente Indica se há um pedido de prorrogação do LPCO ainda pendente. Booleano “true” ou “false”
retificacaoPendente Indica se há um pedido de retificação do LPCO ainda pendente. Booleano “true” ou “false”
informacaoAdicional Informações adicionais prestadas pelo importador/exportador. Texto
listaNcm Lista dos NCM declarados no pedido LPCO. Objeto
ncm Número do NCM do produto declarado. Número
numeroItem Número sequencial do item NCM. Número
listaCamposNcm Lista de campos do NCM declarado. Lista de objetos
listaAtributosNcm Lista de atributos do NCM declarado. Lista de objetos
codigo Código do campo ou atributo do NCM. Texto
listaValor Lista dos valores declarados para o campo ou atributo. Lista de textos
unidadeMedidaComercializada Unidade de medida utilizada na comercialização do NCM. Texto
listaCamposFormulario Lista dos campos do formulário de pedido LPCO com os valores declarados. Lista de objetos
codigo Código do campo do formulário do pedido LPCO. Texto
listaValor Lista de valores declarados para o campo. Lista de textos
unidadeMedida Unidade de medida da quantidade informada para os campos QTDE_ESTATISTICA e QTDE_COMERCIALIZADA. Texto
intervenientes Lista com detalhes dos exportadores/importadores. Lista de objetos Presente apenas nos campos CPF_CNPJ_EXPORTADOR e CPF_CNPJ_IMPORTADOR.
id Identificação (CPF/CNPJ) do interveniente. Número
nome Nome do interveniente. Texto
endereco Dados do endereço do interveniente. Texto
logradouro Descrição do logradouro, com número. Texto
bairro Nome do bairro. Texto
municipio Nome do município. Texto
cep Código CEP com máscara. Texto Formato “99999-99”.
uf Sigla da unidade federativa. Texto
listaVinculos Lista dos vínculos com DU-Es. Lista de objetos
dataVinculo Data do vínculo com o LPCO. Data Formato DD/MM/AAAA
numeroDocumento Número do documento vinculado. Texto
numeroDocumentoItem Número do item vinculado. Inteiro
dataACD Data de apresentação de carga para despacho. Data Formato DD/MM/AAAA
dataDesembaraco Data de desembaraço. Data Formato DD/MM/AAAA
dataCCE Data de comunicação do completo embarque. Data Formato DD/MM/AAAA
dataAverbacao Data de averbação. Data Formato DD/MM/AAAA
dataDesvinculacao Data de desvinculação do LPCO. Data Formato DD/MM/AAAA
quantidadeComercial Quantidade vinculada na unidade comercial. Texto Sem separador de milhar e ’.’ como separador decimal.
quantidadeUnidadeEstatistica Quantidade vinculada na unidade estatística. Texto Sem separador de milhar e ’.’ como separador decimal.
vmle Valor vinculada de mercadoriano no local de embarque. Texto
saldos Saldos restantes da cota do LPCO. Objeto
titulo Descrição do item ao qual o saldo se refere. Texto
saldoQuantidadeComercial Quantidade na unidade comercializada. Número Máximo de 22 dígitos sendo 17 inteiros e 5 decimais.
saldoQuantidadeEstatistica Quantidade na unidade estatística. Número Máximo de 22 dígitos sendo 17 inteiros e 5 decimais.
saldoVMLE Valor da mercadoria no local de embarque. Número Máximo de 19 dígitos sendo 17 inteiros e 2 decimais.
saldoPesoLiquido Peso líquido total (kg). Número Máximo de 22 dígitos sendo 17 inteiros e 5 decimais.
saldoValorFinanciado Valor financiado. Número Máximo de 19 dígitos sendo 17 inteiros e 2 decimais.
saldoValorCondicaoVenda Valor da mercadoria na condição de venda. Número Máximo de 19 dígitos sendo 17 inteiros e 2 decimais.

Campos do formulário de pedido LPCO:

Código Descrição Operação
CHAVE_ACESSO_NFE Chave de acesso da nota fiscal eletrônica. Exportação
CNPJ_TRANSPORTADOR CNPJ do transportador. Exportação
CODIGO_FUNDAMENTO Código do fundamento Importação
CODIGO_NALADI Código Naladi-SH Importação
CODIGO_PRODUTO Código do produto. Exportação
CONDICAO_MERCADORIA Condição da mercadoria Importação
CONDICAO_VENDA Condição venda. Exportação
CPF_CNPJ_DECLARANTE CPF/CNPJ do declarante. Usado apenas pelo perfil remessa expressa. Exportação
CPF_CNPJ_EXPORTADOR CPF/CNPJ do exportador. Exportação
CPF_CNPJ_IMPORTADOR CPF/CNPJ do Importador. Importação
CRONOGRAMA_EMBARQUE Meses e valores de embarque. Formato AAAA/MM - VALOR. Exportação
CRONOGRAMA_FATURAMENTO Meses e valores de faturamento. Formato AAAA/MM - VALOR. Exportação
ENDERECO_CONSIGNATARIO Endereço do consignatário. Exportação
ENDERECO_IMPORTADOR Endereço do importador. Exportação
ENQUADRAMENTO_OPERACAO Enquadramento da operação. Exportação
FORMA_EXPORTACAO Forma de exportação Exportação
IMPORTADOR Nome do importador. Exportação
MOEDA Moeda. Exportação
MOTIVO_DISPENSA_NF Motivo de dispensa da nota fiscal. Exportação
NCM Nomenclatura comum do Mercossul para mercadoria. Ambas
NOME_CONSIGNATARIO Nome do consignatário. Exportação
NOME_TRANSPORTADOR_ESTRANGEIRO Nome do transportador estrangeiro. Exportação
NUMERO_CONTEINER Número do conteiner. Exportação
NUMERO_LACRE Número do lacre. Exportação
PAIS_AQUISICAO País de de aquisição. Importação
PAIS_DESTINO País de destino. Exportação
PAIS_IMPORTADOR País do importador. Exportação
PAIS_ORIGEM País de origem. Importação
PAIS_PROCEDENCIA País de procedência. Importação
PESO_LIQUIDO_TOTAL Peso líquido total (kg). Exportação
QTDE_COMERCIALIZADA Quantidade de unidade comercializada. Sem separador de milhar e ’.’ como separador decimal. Exportação
QTDE_ESTATISTICA Quantidade de unidade estatística. Sem separador de milhar e ’.’ como separador decimal. Exportação
RECINTO_DESPACHO Recinto aduaneiro de despacho. Exportação
RECINTO_EMBARQUE Recinto aduaneiro de embarque. Exportação
SITUACAO_ESPECIAL Situação especial. Exportação
TIPOS_EMBALAGEM Tipos de embalagem. Exportação
TRATAMENTO_PRIORITARIO Tratamento prioritário. Exportação
URF_DESPACHO Unidade da RFB de despacho. Exportação
URF_EMBARQUE Unidade da RFB de embarque. Exportação
VALOR_FINANCIADO Valor financiado. Exportação
VALOR_CONDICAO_VENDA Valor da mercadoria na condição de venda - VMCV. Sem separador de milhar e ’.’ como separador decimal. Exportação
VIA_ESPECIAL_TRANSPORTE Via especial de transporte. Exportação
VMLE Valor da mercadoria no local de embarque. Sem separador de milhar e ’.’ como separador decimal. Exportação

Situações de um pedido de LPCO:

Código Descrição Significado
PARA_ANALISE Para análise O pedido está na fila para ser analisado pelo órgão anuente.
EM_ANALISE Em análise O pedido está sendo analisado pelo órgão anuente.
INDEFERIDO Indeferido O pedido foi indeferido.
PARA_ALTERACAO Para alteração O pedido foi encaminho de volta ao solicitante para alterações.
EM_EXIGENCIA Em exigência O pedido possui uma exigência encaminhada ao solicitante.
RESPOSTA_EXIGENCIA Resposta de exigência O pedido possui uma exigência respondida pelo solicitante.
CANCELADO Cancelado O pedido foi cancelado.
ESGOTADO Esgotado Todo o estoque concedido para o documento LPCO foi utlizado por documentos de exportação ou importação.
DEFERIDO Deferido O pedido foi deferido.
VENCIDO Vencido O documento LPCO está com sua validade expirada.
ANULADO_REVOGADO Anulado/Revogado O documento LPCO foi anulado ou revogado.
EM_VERIFICACAO Em verificação O documento de exportação ou importação associado ao LPCO está em verificação.
EM_INSPECAO Em inspeção A carga de exportação ou importação, associada ao LPCO, está em inspeção.

Incluir um Pedido de LPCO

Exemplo de envio de dados para incluir um pedido de LPCO

{
    "codigoModelo": "E00001",
    "informacaoAdicional": "Número do alvará: xxxxxx",
    "dataReferencia": null,
    "listaNcm": [
        {
            "ncm": "01012100",
            "listaCamposNcm": [],
            "listaAtributosNcm": [
                {
                    "codigo": "ATT_100000038",
                    "listaValor": [ "99" ]
                },
                {
                    "codigo": "ATT_100000082",
                    "listaValor": [ "22" ]
                }
            ],
            "unidadeMedidaComercializada": "KG"
        }
    ],
    "listaCamposFormulario": [
        {
            "codigo": "CPF_CNPJ_EXPORTADOR",
            "listaValor": [ "00000000000191" ]
        },
        {
            "codigo": "QTDE_COMERCIALIZADA",
            "listaValor": [ "100" ]
        }       
    ],
    "unidadeMedidaComercializada": "KG"
}

Endpoint:

POST https://<url>/talpco/api/ext/lpco/

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
codigoModelo Código do modelo de LPCO utilizado para o pedido. Texto JSON
informacaoAdicional Informações adicionais prestadas pelo importador/exportador. Texto JSON
dataReferencia Data de referência para amissão do pedido. Se não informada, utiliza-se o momento atual. Texto, opcional JSON Formato: AAAA-MM-DD’T'HH:MM.
listaNcm Lista dos NCM declarados no pedido LPCO. Objeto JSON De acordo com o modelo de LPCO.
ncm Número do NCM do produto declarado. Número JSON
listaCamposNcm Lista de campos do NCM declarado. Lista de objetos JSON De acordo com o NCM no modelo de LPCO.
listaAtributosNcm Lista de atributos do NCM declarado. Lista de objetos JSON De acordo com o NCM no modelo de LPCO.
codigo Código do campo ou atributo do NCM. Texto JSON
listaValor Lista dos valores declarados para o campo ou atributo. Lista de textos JSON
unidadeMedidaComercializada Unidade de medida utilizada na comercialização do NCM. Necessária apenas quando há um campo Quantidade Comercializada para o NCM. Texto JSON
listaCamposFormulario Lista dos campos do formulário de pedido LPCO com os valores declarados. Lista de objetos JSON De acordo com o modelo de LPCO.
codigo Código do campo do formulário do pedido LPCO. Texto JSON
listaValor Lista de valores declarados para o campo. Lista de textos JSON
unidadeMedidaComercializada Unidade utilizada para comercialização do produto. Necessária apenas quando há um campo Quantidade Comercializada no formulário. Texto JSON

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Alterar um Pedido de LPCO

Exemplo de envio de dados para alterar um pedido de LPCO

{
    "informacaoAdicional": "Número do alvará: xxxxxx",
    "listaNcm": [
        {
            "ncm": "01012100",
            "numeroItem": 1,
            "listaCamposNcm": [],
            "listaAtributosNcm": [
                {
                    "codigo": "ATT_100000038",
                    "listaValor": [ "99" ]
                },
                {
                    "codigo": "ATT_100000082",
                    "listaValor": [ "22" ]
                }
            ],
            "unidadeMedidaComercializada": "KG"
        }
    ],
    "listaCamposFormulario": [
        {
            "codigo": "QTDE_COMERCIALIZADA",
            "listaValor": [ "100" ]
        }
    ],
    "unidadeMedidaComercializada": "KG"
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do pedido de LPCO. Texto query string
informacaoAdicional Informações adicionais prestadas pelo importador/exportador. Texto JSON
listaNcm Lista dos NCM declarados no pedido LPCO. Objeto JSON De acordo com o modelo de LPCO.
ncm Número do NCM do produto declarado. Número JSON
numeroItem Número sequencial do item NCM. Número
listaCamposNcm Lista de campos do NCM declarado. Lista de objetos JSON De acordo com o NCM no modelo de LPCO.
listaAtributosNcm Lista de atributos do NCM declarado. Lista de objetos JSON De acordo com o NCM no modelo de LPCO.
codigo Código do campo ou atributo do NCM. Texto JSON
listaValor Lista dos valores declarados para o campo ou atributo. Lista de textos JSON
unidadeMedidaComercializada Unidade de medida utilizada na comercialização do NCM. Necessária apenas quando há um campo Quantidade Comercializada para o NCM. Texto JSON
listaCamposFormulario Lista dos campos do formulário de pedido LPCO com os valores declarados. Lista de objetos JSON De acordo com o modelo de LPCO.
codigo Código do campo do formulário do pedido LPCO. Texto JSON
listaValor Lista de valores declarados para o campo. Lista de textos JSON
unidadeMedidaComercializada Unidade utilizada comercializado do produto. Necessária apenas quando há um campo Quantidade Comercializada no formulário. Texto JSON

Ex: https://<url>/talpco/api/ext/lpco/E1800000001

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Consultar as Exigências do LPCO

Exemplo de resposta para a consulta das exigências de um LPCO

[
  {
    "numero": "1",
    "exigencia": "Necessário anexar alvará.",
    "dataExigencia": "01/03/2018",
    "resposta": "Documento anexado.",
    "dataResposta": "05/03/2018",
    "justificativa": "Exigência cumprida.",
    "situacao": {
        "id": "1",
        "descricao": "Cumprida"
    }
  }
]

Endpoint:

GET https://<url>/talpco/api/ext/lpco/exigencia/{numero}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
numero Número do LPCO pesquisado. Texto, obrigatório query string -

Ex: http://<url>/talpco/api/ext/lpco/exigencia/E1800000001

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numero Número sequencial da exigência no LPCO. Número
exigencia Descrição da exigência. Texto
dataExigencia Data em que foi feita a exigência. Texto Formato DD/MM/AAAA
resposta Resposta dada à exigência. Texto
dataResposta Data da resposta dada. Texto Formato DD/MM/AAAA
justificativa Justificativa para cancelamento ou cumprimento da exigência. Texto
situacao Situação em que se encontra a exigência. Objeto
id Código da situação da exigência. Número
descricao Descrição da situação da exigência. Texto

Situações de uma exigência no LPCO :

Código Descrição
0 Pendente
1 Cumprida
2 Cancelada

Cumprir Exigência de LPCO

Exemplo de dados de entrada para cumprir uma exigência em um LPCO

{
    "justificativa": "Documento anexado."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/exigencia/cumprir/{numeroLPCO}/{numeroExigencia}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numeroLPCO Número do LPCO que possui a exigência. Texto, obrigatório query string -
numeroExigencia Número sequencial da exigência sendo cumprida. Texto, obrigatório query string -
justificativa Resposta dada para indicar o cumprimento da exigência. Texto, obrigatório JSON -

Ex: http://<url>/talpco/api/ext/lpco/exigencia/cumprir/E1800000001/1

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numero Número sequencial da exigência. Número
exigencia Descrição da exigência. Texto
dataExigencia Data em que foi feita a exigência. Texto Formato DD/MM/AAAA
resposta Resposta dada à exigência. Texto
dataResposta Data da resposta dada. Texto Formato DD/MM/AAAA
situacao Situação em que se encontra a exigência. Objeto
id Código da situação da exigência. Número
descricao Descrição da situação da exigência. Texto

Situações de uma exigência no LPCO :

Código Descrição
0 Pendente
1 Cumprida
2 Cancelada

Incluir Exigência para LPCO

Exemplo de dados de entrada para incluir uma exigência em um LPCO

{
    "justificativa": "Necessário anexar alvará."
}

Endpoint:

POST https://<url>/talpco/api/ext/lpco/exigencia/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO para qual será incluída a exigência. Texto, obrigatório query string -
justificativa Descrição da exigência criada. Texto, obrigatório JSON -

Ex: http://<url>/talpco/api/ext/lpco/exigencia/E1800000001

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numero Número sequencial da exigência no LPCO. Número
exigencia Descrição da exigência. Texto
dataExigencia Data em que foi feita a exigência. Texto Formato DD/MM/AAAA
resposta Resposta dada à exigência. Texto
dataResposta Data da resposta dada. Texto Formato DD/MM/AAAA
justificativa Justificativa para cancelamento ou cumprimento da exigência. Texto
situacao Situação em que se encontra a exigência. Objeto
id Código da situação da exigência. Número
descricao Descrição da situação da exigência. Texto

Situações de uma exigência no LPCO :

Código Descrição
0 Pendente
1 Cumprida
2 Cancelada

Cancelar Exigência de LPCO

Exemplo de envio de justificativa para cancelar uma exigência

{
    "justificativa": "Exigência foi cadastrada indevidamente."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/exigencia/cancelar/{numeroLPCO}/{numeroExigencia}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numeroLPCO Número do LPCO que possui a exigência. Texto, obrigatório query string -
numeroExigencia Número sequencial da exigência sendo cancelada. Texto, obrigatório query string -
justificativa Justificativa para o canelamento da exigência. Texto, obrigatório JSON -

Ex: http://<url>/talpco/api/ext/lpco/exigencia/cancelar/E1800000001/1

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
numero Número sequencial da exigência. Número
exigencia Descrição da exigência. Texto
dataExigencia Data em que foi feita a exigência. Texto Formato DD/MM/AAAA
resposta Resposta dada à exigência. Texto
dataResposta Data da resposta dada. Texto Formato DD/MM/AAAA
situacao Situação em que se encontra a exigência. Objeto
id Código da situação da exigência. Número
descricao Descrição da situação da exigência. Texto

Situações de uma exigência no LPCO :

Código Descrição
0 Pendente
1 Cumprida
2 Cancelada

Consultar as Possíveis Situações de Destino de LPCO

Exemplo de resposta para a consulta de situações de destino possíveis para um LPCO

[
  {
    "id": "EM_VERIFICACAO",
    "descricao": "Em verificação"
  },
  {
    "id": "DEFERIDO",
    "descricao": "Deferido"
  },
  {
    "id": "INDEFERIDO",
    "descricao": "Indeferido"
  },
  {
    "id": "EM_ANALISE",
    "descricao": "Em análise"
  }
]

Endpoint:

GET https://<url>/talpco/api/ext/lpco/situacao/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO pesquisado Texto, obrigatório query string -

Ex: http://<url>/talpco/api/ext/lpco/situacao/E1800000001

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
id Código da situação Texto
descricao Descrição da situação Texto

Alterar Situação de LPCO

Exemplo de envio de dados para alterar a situação de um LPCO

{
  "situacao": "DEFERIDO",
  "justificativa": "LPCO sendo analisado pelo anuente.",
  "dataInicioVigencia": null,
  "dataFinalVigencia": null,
  "numeroOrgaoOrigem": "5444-9",
  "requerInspecao": false,
  "validoMultiplasOperacoes": false
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/situacao/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO para alterar a situação Texto, obrigatório query string -
situacao Código da nova situação Texto, obrigatório JSON
justificativa Justificativa para a mudança de situação Texto JSON
dataInicioVigencia Data e hora do início de vigência par ao LPCO se este for deferido Texto JSON Formato DD/MM/AAAA
dataFinalVigencia Data e hora do final de vigência para o LPCO se este for deferido Texto JSON Formato DD/MM/AAAA
numeroOrgaoOrigem Número do documento no órgão anuente Texto JSON
requerInspecao Indica se haverá necessidade de inspeção de carga Booleano JSON “true” ou “false”
validoMultiplasOperacoes Indica se o LPCo poderá ser usado em mais de uma operação Booleano JSON “true” ou “false”

Ex: https://<url>/talpco/api/ext/lpco/situacao/E1800000001

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Solicitar Retificação de LPCO

Exemplo de envio de dados para solicitar retificação de LPCO já deferido

{
    "justificativa": "Complemento de informações.",
    "informacaoAdicional": "Número do alvará: xxxxxx",
    "listaNcm": [
        {
            "ncm": "01012100",
            "listaCamposNcm": [],
            "listaAtributosNcm": [
                {
                    "codigo": "ATT_100000038",
                    "listaValor": [ "99" ]
                },
                {
                    "codigo": "ATT_100000082",
                    "listaValor": [ "22" ]
                }
            ],
            "unidadeMedidaComercializada": "KG"
        }
    ],
    "listaCamposFormulario": [
        {
            "codigo": "CPF_CNPJ_EXPORTADOR",
            "listaValor": [ "00000000000191" ]
        },
        {
            "codigo": "QTDE_COMERCIALIZADA",
            "listaValor": [ "100" ]
        }       
    ],
    "unidadeMedidaComercializada": "KG"
}

Endpoint:

POST https://<url>/talpco/api/ext/lpco/retificacao/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
justificativa Justificativa para o pedido de retificação. Texto, obrigatório JSON
informacaoAdicional Informações adicionais prestadas pelo importador/exportador. Texto JSON
listaNcm Lista dos NCM declarados no pedido LPCO. Objeto JSON De acordo com o modelo de LPCO.
ncm Número do NCM do produto declarado. Número JSON
listaCamposNcm Lista de campos do NCM declarado. Lista de objetos JSON De acordo com o NCM no modelo de LPCO.
listaAtributosNcm Lista de atributos do NCM declarado. Lista de objetos JSON De acordo com o NCM no modelo de LPCO.
codigo Código do campo ou atributo do NCM. Texto JSON
listaValor Lista dos valores declarados para o campo ou atributo. Lista de textos JSON
unidadeMedidaComercializada Unidade de medida utilizada na comercialização do NCM. Necessária apenas quando há um campo Quantidade Comercializada para o NCM. Texto JSON
listaCamposFormulario Lista dos campos do formulário de pedido LPCO com os valores declarados. Lista de objetos JSON De acordo com o modelo de LPCO.
codigo Código do campo do formulário do pedido LPCO. Texto JSON
listaValor Lista de valores declarados para o campo. Lista de textos JSON
unidadeMedidaComercializada Unidade utilizada para comercialização do produto. Necessária apenas quando há um campo Quantidade Comercializada no formulário. Texto JSON

Ex: https://<url>/talpco/api/ext/lpco/retificacao/E1800000001

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Consultar Solicitação de Retificação de LPCO

Exemplo de resposta para a consulta da solicitação de retificação de LPCO já deferido

{
    "situacao": {
        "id": "PARA_ANALISE",
        "descricao": "Para análise"
    },
    "dataRegistro": "2018-10-05T10:56",
    "listaAlteracoes": [
        {
            "codigoCampo": "PESO_LIQUIDO_TOTAL",
            "origem": "Item 1 - NCM 22011000",
            "nomeCampo": "Peso Líquido Total (Kg)",
            "valorOriginal": "510",
            "valorAlterado": "550"
        }
    ]

Endpoint:

GET https://<url>/talpco/api/ext/lpco/retificacao/{numero}

Content-Type:

application/json

Nome Descrição Tipo Local Detalhes
numero Número do pedido de LPCO Texto, obrigatório query string

Ex: https://<url>/talpco/api/ext/lpco/retificacao/E1800000001

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
situacao Código e descrição da situação do pedido de retificacao. Objeto
dataRegistro Data e hora em que o pedido de retificação foi registrado. Texto Formato: AAAA-MM-DD’T'HH:MM.
codigoCampo Código do campo ou atributo do NCM. Texto
origem Descrição de qual item de NCM o campo está vincualdo ou se ao LPCO diretamente. Texto
nomeCampo Nome do campo alterado. Texto
valorOriginal Valor original do campo antes do pedido de retificação. Texto
valorAlterado Novo valor retificado do campo. Texto

Situações de um pedido de retificação do LPCO:

Código Descrição Significado
PARA_ANALISE Para análise O pedido de retificação está na fila para ser analisado pelo órgão anuente.
EM_EXIGENCIA Em exigência O pedido possui uma exigência encaminhada ao solicitante.
RESPOSTA_EXIGENCIA Resposta de exigência O pedido possui uma exigência respondida pelo solicitante.

Aceitar Solicitação de Retificação de LPCO

Exemplo de envio de dados para aceitar solicitação de retificação de LPCO deferido.

{
    "justificativa": "Alteração aceita."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/retificacao/{numero}/aceitar

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
justificativa Justificativa para o aceite. Texto JSON

Ex: https://<url>/talpco/api/ext/lpco/retificacao/E1800000001/aceitar

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Cancelar Solicitação de Retificação de LPCO

Exemplo de envio de dados para cancelar solicitação de retificação de LPCO deferido.

{
    "justificativa": "Alteração se tornou desnecessária."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/retificacao/{numero}/cancelar

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
justificativa Justificativa para o cancelamento. Texto JSON

Ex: https://<url>/talpco/api/ext/lpco/retificacao/E1800000001/cancelar

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Negar Solicitação de Retificação de LPCO

Exemplo de envio de dados para negar solicitação de retificação de LPCO deferido.

{
    "justificativa": "Alteração não permitida."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/retificacao/{numero}/negar

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
justificativa Justificativa para a negativa. Texto JSON

Ex: https://<url>/talpco/api/ext/lpco/retificacao/E1800000001/negar

Resposta (JSON Schema):

Detalhamento do pedido de LPCO.

Solicitar Prorrogação de LPCO

Exemplo de envio de dados para solicitar a prorrogação de LPCO já deferido

{
{
  "novaDataFimVigencia": "2018-10-31",
  "justificativa": "Atraso na liberação da carga."
}

Endpoint:

POST https://<url>/talpco/api/ext/lpco/prorrogacao/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
novaDataFimVigencia Data solicitada para o fim da vigência do LPCO. Texto, obrigatório JSON Formato: AAAA-MM-DD.
justificativa Justificativa para o pedido de prorrogação. Texto, obrigatório JSON

Ex: https://<url>/talpco/api/ext/lpco/prorrogacao/E1800000001

Resposta:

Apenas o código HTTP de resposta se a solicitação foi feita com sucesso.

Consultar Solicitação de Prorrogação de LPCO

Exemplo de resposta para a consulta da solicitação de prorrogação da vigência de LPCO

[
  {
    "situacao": {
        "id": "PARA_ANALISE",
        "descricao": "Para análise"
    },
    "novaDataFimVigencia": "2018-10-31",
    "dataInicioVigencia": "2018-01-01",
    "dataFimVigencia": "2018-08-30",
    "dataCadastroSolicitacao": "2018-08-25",
    "dataUltimaAlteracao": "2018-08-01",
    "justificativa": "Atraso na liberação da carga."
  }
]

Endpoint:

GET https://<url>/talpco/api/ext/lpco/prorrogacao/{numero}

Content-Type:

application/json

Nome Descrição Tipo Local Detalhes
numero Número do pedido de LPCO Texto, obrigatório query string

Ex: https://<url>/talpco/api/ext/lpco/prorrogacao/E1800000001

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
situacao Código e descrição da situação do pedido de prorrogação. Objeto
novaDataFimVigencia Nova data de fim de vigência solicitada pelo pedido de prorrogação. Texto Formato: AAAA-MM-DD.
dataInicioVigencia Data de início da vigência do LPCO. Texto Formato: AAAA-MM-DD.
dataFimVigencia Data do fim de vigência atual do LPCO. Texto Formato: AAAA-MM-DD.
dataCadastroSolicitacao Data de cadastro da solicitação de prorrogação pendente. Texto Formato: AAAA-MM-DD.
dataUltimaAlteracao Data da última alteração de situação, prorrogação ou retificação no LPCO. Texto Formato: AAAA-MM-DD.
justificativa Justificativa para o pedido de prorrogação. Texto

Situações de um pedido de prorrogação do LPCO:

Código Descrição Significado
PARA_ANALISE Para análise O pedido de prorrogação está na fila para ser analisado pelo órgão anuente.
INDEFERIDO Indeferido O pedido de prorrogação foi indeferido e o LPCO mantém a data de fim de vigência atual.
DEFERIDO Deferido O pedido de prorrogação foi deferido e o LPCO já está com a nova data de fim de vigência.

Alterar Pedido de Prorrogação de LPCO

Exemplo de envio de dados para alterar pedido de prorrogação de LPCO já deferido

{
{
  "novaDataFimVigencia": "2018-10-31",
  "justificativa": "Nova data solicitada."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/prorrogacao/{numero}

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
novaDataFimVigencia Nova data solicitada para o fim da vigência do LPCO. Texto, obrigatório JSON Formato: AAAA-MM-DD.
justificativa Nova justificativa para o pedido de prorrogação. Texto, obrigatório JSON

Ex: https://<url>/talpco/api/ext/lpco/prorrogacao/E1800000001

Resposta:

Apenas o código HTTP de resposta se a solicitação foi feita com sucesso.

Cancelar Pedido de Prorrogação de LPCO

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/prorrogacao/{numero}/cancelar

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string

Ex: https://<url>/talpco/api/ext/lpco/prorrogacao/E1800000001/cancelar

Resposta:

Apenas o código HTTP de resposta se a solicitação foi feita com sucesso.

Deferir Pedido de Prorrogação de LPCO

Exemplo de envio de dados para deferir um pedido de prorrogação da vigência de LPCO

{
  "novaDataFimVigencia": "2018-10-31"
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/prorrogacao/{numero}/deferir

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
novaDataFimVigencia Nova data aprovada para o fim da vigência do LPCO. Texto, obrigatório JSON Formato: AAAA-MM-DD.

Ex: https://<url>/talpco/api/ext/lpco/prorrogacao/E1800000001/deferir

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
novaDataFimVigencia Nova data aprovada para o fim da vigência do LPCO. Texto Formato: AAAA-MM-DD.
situacao Código e descrição da situação do pedido de prorrogação. Objeto

Indeferir Pedido de Prorrogação de LPCO

Exemplo de envio de dados para indeferir um pedido de prorrogação da vigência de LPCO

{
  "justificativa": "Prorrogação não permitida."
}

Endpoint:

PUT https://<url>/talpco/api/ext/lpco/prorrogacao/{numero}/indeferir

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
numero Número do LPCO. Texto, obrigatório query string
justificativa Justificativa que constará no histórico do LPCO para o indeferimento do pedido de prorrogação. Texto, obrigatório JSON

Ex: https://<url>/talpco/api/ext/lpco/prorrogacao/E1800000001/indeferir

Resposta:

Apenas o código HTTP de resposta se a solicitação foi feita com sucesso.

Notificação push - Anuentes

A seguir são especificados os eventos de interesse dos órgãos anuentes, 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.

Registro de LCPO

Notificação enviada para o órgão anuente no momento em que o importador/exportador registra um pedido de LPCO.

Identificador do evento: talp-registro-lpco

Exemplo de conteúdo enviado na notificação:

[
  {
    "dataEvento": "06/09/2018 11:03",
    "numeroLPCO": "E1800000720"
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) JSON
numeroLPCO Número do pedido de LPCO Texto(11) JSON

Inclusão de vínculo de LPCO com operação

Notificação enviada para o órgão anuente no momento em que o importador/exportador vincula um LPCO a uma operação.

Identificador do evento: talp-incvinc-lpco

Exemplo de conteúdo enviado na notificação:

[
  {
    "dataEvento":"06/09/2018 11:03",
    "numeroLPCO":"E1800000720",
    "numeroOperacao":"18BR0000001294"
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) JSON
numeroLPCO Número do pedido de LPCO Texto(11) JSON
numeroOperacao Número da operação Texto(14) JSON

Cancelamento de vínculo de LPCO com operação

Notificação enviada para o órgão anuente no momento em que o importador/exportador cancela o vínculo de um LPCO a uma operação.

Identificador do evento: talp-canvinc-lpco

Exemplo de conteúdo enviado na notificação:

[
  {
    "dataEvento":"06/09/2018 11:03",
    "numeroLPCO":"E1800000720",
    "numeroOperacao":"18BR0000001294"
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) JSON
numeroLPCO Número do pedido de LPCO Texto(11) JSON
numeroOperacao Número da operação Texto(14) JSON

Alteração de situação do LPCO feita pelo exportador/importador

Notificação enviada para o órgão anuente quando o importador/exportador altera a situação de um LPCO.

Identificador do evento: talp-altsit-lpco-int

Exemplo de conteúdo enviado na notificação:

[
  {
    "dataEvento":"04/09/2018 10:17",
    "numeroLPCO":"E1800000317",
    "justificativa":"Alterar a situação",
    "novaSituacao":{
      "id":"PARA_ANALISE",
      "descricao":"Para análise"
    }
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) JSON
numeroLPCO Número do pedido de LPCO Texto(11) JSON
justificativa Justificativa para a alteração de situação Texto JSON
novaSituacao Nova situação do LPCO - JSON
id Identificador da situação Texto JSON
descricao Descrição da situação Texto JSON

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çaõ de um LPCO.

Identificador do evento: talp-altsit-lpco-anu

Exemplo de conteúdo enviado na notificação:

[
  {
    "dataEvento":"04/09/2018 10:17",
    "numeroLPCO":"E1800000317",
    "justificativa":"Alterar a situação", 
    "novaSituacao":{
       "id":"PARA_ANALISE",
       "descricao":"Para análise"
    }
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) 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

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":"E1800000773",
    "exigencia":"descrição da exigência criada pelo Anuente.",
    "dataExigencia":"19/09/2018 08:33",
    "situacao":{
      "id":"PENDENTE",
      "descricao":"Pendente"
    }
  }
]

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 do registro da exigência Texto(16) JSON
situacao Situação 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":"05/09/2018 09:41",
    "numeroLPCO":"E1800000466",
    "justificativa":"justificativa para o indeferimento de prorrogação.",
    "resultado":"INDEFERIDO"
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) 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

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":"05/09/2018 09:41",
    "numeroLPCO":"E1800000466",
    "justificativa":"justificativa para o indeferimento de prorrogação.",
    "resultado":"INDEFERIDO"
  }
]

Campos enviados:

Nome Descrição Tipo Local
dataEvento Data/hora da ocorrência do evento Texto(16) 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

Catálogo de Produtos

O sistema Catálogo de Produtos permite a manutenção de catálogos de produtos e operadores estrangeiros, individualizados por empresa, visando ao reuso das informações nas operações de comércio exterior.

As informações sobre os produtos e operadores estrangeiras podem ser importadas de arquivos JSON, tanto pela interface Web, via upload de arquivo, quando pelo acionamento dos serviços descritos a seguir. A estrutura do arquivo JSON é a mesma para as duas modalidades de uso.

No arquivo com os produtos a serem importados, além dos dados básicos, devem ser preenchidos os atributos associados ao código NCM de cada produto. Os atributos preenchidos para cada produto devem respeitar os códigos do respectivo ambiente - treinamento (validação) ou produção. Devem ser considerados somente os atributos que contenham o objetivo Produto.

Nos endereços a seguir estão disponíveis as relações de atributos por NCM para cada ambiente:

Esses arquivos também estão publicados na página Como se integrar ao Portal Único de Comércio Exterior.

Incluir/Alterar Produtos

Exemplo de envio de dados para incluir um ou mais Produtos

[
  {
    "seq": 1,
    "codigo": 123,
    "descricao": "Produto Teste",
    "cpfCnpjRaiz": "00000000",
    "situacao": "ATIVADO",
    "modalidade": "EXPORTACAO",
    "ncm": "02011000",
    "codigoNaladi": 123,
    "codigoGPC": 456,
    "codigoGPCBrick": 789,
    "codigoUNSPSC": 012,
    "paisOrigem": "AR",
    "fabricanteConhecido": true,
    "codigoOperadorEstrangeiro": "123",
    "atributos": [
      {
        "atributo": "ATT_1",
        "valor": "teste"
      }
    ],
    "codigosInterno": [
      "1",
      "2"
    ]
  }
]

Endpoint:

POST https://<url>/catp/api/ext/produto

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
seq Número sequencial utilizado para identificar o produto na lista, o retorno da validação se dará através deste sequencial Número(3), obrigatório JSON
codigo Código do produto. Informar somente quando for alterar um produto já cadastrado Número(10), opcional* JSON (*) Obrigatório na alteração.
descricao Descrição complementar do produto Texto(3700), opcional JSON
cpfCnpjRaiz CPF ou CNPJ raiz da empresa responsável. Informar os 8 primeiros dígitos do CNPJ, suprimindo os pontos Texto(8), obrigatório JSON
situacao Código e descrição da situação do produto Objeto, obrigatório JSON
modalidade Código da modalidade de operacao Objeto, obrigatório JSON
ncm NCM do produto Número(8), obrigatório JSON
codigoNaladi Código Naladi Número(8), opcional JSON
codigoGPC Código GPC Número(10), opcional JSON
codigoGPCBrick codigo GPC - Brick Número(10), opcional JSON
codigoUNSPSC Código UNSPSC Número(10), opcional JSON
fabricanteConhecido Informar true para fabricante connhecido e false para fabricante desconhecido. Boleano, obrigatório JSON
paisOrigem Código do país de origem no formato ISO 3166. Texto(2), obrigatório JSON
cpfCnpjFabricante CPF/CNPJ do fabricante nacional. Texto(14), opcional* JSON () Obrigatório quando **fabricanteConhecido=true e paisOrigem for Brasil*.
codigoOperadorEstrangeiro Código do operador estrangeiro. Texto(35), opcional* JSON () Obrigatório quando **fabricanteConhecido=true e paisOrigem for diferente de Brasil*.
atributos Lista de atributos da NCM informada Lista de objetos, opcional* JSON (*) Obrigatório quando a NCM possuir Atributos de preenchimento obrigatório.
codigosInterno Lista de códigos internos do produto do Exportador/Importador Lista de textos ([Texto(60)]), opcional JSON

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
seq Número sequencial informado na lista de produtos Número
codigo Código do produto no Catálogo de Produtos Texto
erros Lista de erros encontrado na validação Lista de textos
sucesso Retorna true em caso de sucesso e false em caso do insucesso Boleano

Código e descrição da situação do produto:

Código Descrição
ATIVADO Ativado
DESATIVADO Desativado
RASCUNHO Rascunho

Código e descrição da modalidade de operacao:

Código Descrição
AMBOS Ambos
EXPORTACAO Exportação
IMPORTACAO Importação

Detalhar Produto

Exemplo de resposta para detalhar produto

{
    "seq": 1,
    "codigo": 1,
    "descricao": "Descrição produto 1",
    "cpfCnpjRaiz": "00000000",
    "situacao": "Ativado",
    "modalidade": "AMBOS",
    "ncm": "020110000",
    "versao": "1",
    "codigoNaladi": null,
    "codigoGPC": null,
    "codigoGPCBrick": null,
    "codigoUNSPSC": null,
    "paisOrigem": "AF",
    "cpfCnpjFabricante": null,
    "fabricanteConhecido": false,
    "codigoOperadorEstrangeiro": null,
    "atributos": [
        {
            "atributo": "ATT_1",
            "valor": "1"
        }
    ],
    "codigosInterno": ["1","3","4","5"]
}

Endpoint:

GET https://<url>/catp/api/ext/produto/detalhar?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local
cpfCnpjRaiz CPF ou CNPJ raiz da empresa responsável. Informar os 8 primeiros dígitos do CNPJ, suprimindo os pontos Texto(8), obrigatório query string
codigo Código do produto Número(10), obrigatório query string
versao Versão do produto Texto(6), opcional query string

Ex: https://<url>/catp/api/ext/produto/detalhar?cpfCnpjRaiz=00000000&codigo=1&...

Resposta (JSON Schema):

Nome Descrição Tipo
seq Número sequencial Número(3)
codigo Código do produto Número(10)
descricao Descrição complementar do produto Texto(3700), opcional
cpfCnpjRaiz CPF ou CNPJ raiz da empresa responsável Texto(8)
situacao Código e descrição da situação do produto Objeto
modalidade Código da modalidade de operacao Objeto
ncm NCM do produto Número(8)
codigoNaladi Código Naladi Número(8)
codigoGPC Código GPC Número(10)
codigoGPCBrick codigo GPC - Brick Número(10)
codigoUNSPSC Código UNSPSC Número(10)
fabricanteConhecido true para fabricante connhecido e false para fabricante desconhecido. Boleano
paisOrigem Código do país de origem no formato ISO 3166. Texto(2)
cpfCnpjFabricante CPF/CNPJ do fabricante nacional. Texto(14)
codigoOperadorEstrangeiro Código do operador estrangeiro. Texto(35)
atributos Lista de atributos da NCM informada Lista de objetos
codigosInterno Lista de códigos internos do produto do Exportador/Importador Lista de textos ([Texto(60)])

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Consultar Produto

Exemplo de resposta para a consulta de produtos

[
    {
        "seq": 1,
        "codigo": 1,
        "descricao": "Produto1",
        "cpfCnpjRaiz": "00000000",
        "situacao": "Desativado",
        "modalidade": "AMBOS",
        "ncm": "89061000",
        "versao": "2",
        "codigoNaladi": null,
        "codigoGPC": null,
        "codigoGPCBrick": null,
        "codigoUNSPSC": null,
        "paisOrigem": "DE",
        "cpfCnpjFabricante": null,
        "fabricanteConhecido": false,
        "codigoOperadorEstrangeiro": null,
        "atributos": [
            {
                "atributo": "ATT_1",
                "valor": "01"
            }
        ],
        "codigosInterno": ["1","3",]
    },
    {
        "seq": 2,
        "codigo": 2,
        "descricao": null,
        "cpfCnpjRaiz": "00000000",
        "situacao": "Ativado",
        "modalidade": "AMBOS",
        "ncm": "02011001",
        "versao": "6",
        "codigoNaladi": null,
        "codigoGPC": null,
        "codigoGPCBrick": null,
        "codigoUNSPSC": null,
        "paisOrigem": "AR",
        "cpfCnpjFabricante": null,
        "fabricanteConhecido": false,
        "codigoOperadorEstrangeiro": null,
        "atributos": [],
        "codigosInterno": []
    }
]

Endpoint:

GET https://<url>/catp/api/ext/produto/consultar?

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local
cpfCnpjRaiz CPF ou CNPJ raiz da empresa responsável. Informar os 8 primeiros dígitos do CNPJ, suprimindo os pontos Texto(8), obrigatório query string
codigo Código do produto Número(10), opcional query string
codigoInterno códigos internos do produto do Exportador/Importador Texto(60), opcional query string
descricao Descrição do produto Texto(3700), opcional query string
ncm NCM do produto Texto(8), opcional query string
periodoRegistroInicio Período do registro - Data inicial Data(yyyy-MM-dd), opcional query string
periodoRegistroFim Período do registro - Data inicial Data(yyyy-MM-dd), opcional query string
situacao Código e descrição da situação do produto Texto(10), opcional query string
ultimaAlteracaoInicio Período da última alteração - Data inicial Data(yyyy-MM-dd), opcional query string
ultimaAlteracaoFim Período da última alteração - Data final Data(yyyy-MM-dd), opcional query string
paisOrigem Código do país de origem no formato ISO 3166 Texto(2), opcional query string
fabricanteEstrangeiro Código do operador estrangeiro Texto(6), opcional query string
cpfCnpjFabricante CPF/CNPJ do fabricante nacional Texto(14), opcional query string
modalidade Código da modalidade de operacao Texto(10), opcional query string
dataReferencia Produtos no estado atual da data de referência Data(yyyy-MM-dd), opcional query string

Ex: https://<url>/catp/api/ext/produto/consultar?cpfCnpjRaiz=00000000&codigo=1&...

Resposta (JSON Schema):

Nome Descrição Tipo
seq Número sequencial Número(3)
codigo Código do produto Número(10)
descricao Descrição complementar do produto Texto(3700), opcional
cpfCnpjRaiz CPF ou CNPJ raiz da empresa responsável Texto(8)
situacao Código e descrição da situação do produto Objeto
modalidade Código da modalidade de operacao Objeto
ncm NCM do produto Número(8)
codigoNaladi Código Naladi Número(8)
codigoGPC Código GPC Número(10)
codigoGPCBrick codigo GPC - Brick Número(10)
codigoUNSPSC Código UNSPSC Número(10)
fabricanteConhecido true para fabricante connhecido e false para fabricante desconhecido. Boleano
paisOrigem Código do país de origem no formato ISO 3166. Texto(2)
cpfCnpjFabricante CPF/CNPJ do fabricante nacional. Texto(14)
codigoOperadorEstrangeiro Código do operador estrangeiro. Texto(35)
atributos Lista de atributos da NCM informada Lista de objetos
codigosInterno Lista de códigos internos do produto do Exportador/Importador Lista de textos ([Texto(60)])

Mensagens de alerta ou erro da consulta

Nome Descrição Tipo
codigo Código da mensagem string
mensagem Descrição detalhada da mensagem enviada string

Código e descrição da situação do produto:

Código Descrição
ATIVADO Ativado
DESATIVADO Desativado
RASCUNHO Rascunho

Código e descrição da modalidade de operacao:

Código Descrição
AMBOS Ambos
EXPORTACAO Exportação
IMPORTACAO Importação

Incluir/Alterar Operador Estrangeiro

Exemplo de envio de dados para incluir um Operadpor Estrangeiro

[
  {
    "seq": 1,
    "cpfCnpjRaiz": "00000000",
    "codigo": "123",
    "nome": "Fornecedor 123",
    "logradouro": "Rua teste, 155, Bairro teste",
    "nomeCidade": "Buenos Aires",
    "codigoSubdivisaoPais": "AR-B",
    "codigoPais": "AR",
    "cep": "12345"
  }
]

Endpoint:

POST https://<url>/catp/api/ext/operador-estrangeiro

Content-Type:

application/json

Parâmetros de Entrada (JSON Schema):

Nome Descrição Tipo Local Detalhes
seq Número sequencial utilizado para identificar o Operador Estrangeiro na lista, o retorno da validação se dará através deste sequencial Número(3), obrigatório JSON
cpfCnpjRaiz CPF ou CNPJ raiz do importador/exportador. Informar os 8 primeiros digitos do CNPJ, suprimindo os pontos Texto(8), obrigatório JSON
codigo TIN - Trade Identification Number (Número de Identificação do Operador) Texto(35), obrigatório JSON
nome Nome/Razão Social do Operador Estrangeiro Texto(70), obrigatório JSON
logradouro Logradouro do Operador Estrangeiro Texto(70), obrigatório JSON
nomeCidade Nome da Cidade Texto(35), obrigatório JSON
codigoSubdivisaoPais Código da subdivisao do país. Usar tabela ISO 3166 Texto(6), opcional* JSON
codigoPais Código do país. Usar tabela ISO 3166 Texto(2), obrigatório JSON
cep Código postal Texto(9), opcional* JSON

Resposta (JSON Schema):

Nome Descrição Tipo Detalhes
seq Número sequencial informado na lista de Operador Estrangeiro Número
codigo TIN - Trade Identification Number (Número de Identificação do Operador) Texto
erros Lista de erros encontrado na validação Lista de textos
sucesso Retorna true em caso de sucesso e false em caso do insucesso Boleano

Notificação push

A seguir são especificados os eventos de interesse dos intervenientes privados (exportadores/importadores).

Para ter acesso aos eventos, os interessados devem utilizar a API de notificação.

Produto desativado por ofício pelo anuente

Notificação enviada para o interveniente privado quando o produto é desativado via ofício.

Identificador do evento: catp-prod-desativado

Exemplo de conteúdo enviado na notificação:

{
    "titulo" : "Produtos desativados no catálogo da empresa 00000000",
    "mensagem" : "Os produtos catalogados para o código NCM 02011000 foram desativados pelo gestor do sistema em função da criação de novos atributos obrigatórios. Antes de utilizar esses produtos nas operações, será necessária a geração de novas versões para preenchimento dos novos atributos.",
    "cpfCnpjRaiz" : "00000000",
    "ncm" : "02011000",
    "codigosProduto" : []
}

Campos enviados:

Nome Descrição Tipo Local
titulo Título da mensagem Texto JSON
mensagem Corpo da mensagem Texto JSON
ncm Código NCM Texto JSON
codigosProduto Lista de produtos desativados (Campo preenchido somente quando o campo NCM não estiver preenchido e a desativação for individual por produto e não por NCM específica) Lista Texto JSON

PCCE

Pagamento Centralizado do Comércio Exterior

Notificação push - Sefaz

A seguir são especificados os eventos de interesse das Secretarias da Fazenda dos estados (Sefaz), relacionados ao fluxo de negócio dos PCCE (Pagamento Centralizado do Comércio Exterior).

Para ter acesso aos eventos, os interessados devem utilizar a API de notificação.

Cancelamento de solicitação de ICMS

* Funcionalidade ainda não disponível nos ambientes de Validação das Empresas e Produção

Notificação enviada para a Sefaz favorecida da solicitação de ICMS, no momento em que ocorre o cancelamento da solicitação.

Identificador do evento: pcce-cancela-icms

Exemplo de conteúdo enviado na notificação:

[
  {
    "idMensagemPCCE":1234,
    "dataHoraMensagem":"2019-04-26T11:54:23+0000",
    "ufFavorecida":"RJ",
    "tipoDeclaracao":"DUIMP",
    "numeroDeclaracao":"18BR00000038814",
    "versaoDeclaracao":"1"
  }
]

Campos enviados:

Nome Descrição Tipo Local Detalhes
event-type Nome do evento que está sendo notificado Texto header
dataHoraMensagem Data/hora da ocorrência do evento Texto body Formato: yyyy-MM-dd’T'HH:mm:ssZ.
ufFavorecida UF favorecida. Texto(2) body
tipoDeclaracao Tipo da Declaração no Comércio Exterior Texto(10) body Na versão atual somente será enviado DUIMP
numeroDeclaracao Número da declaração Texto(15) body
versaoDeclaracao Versão da declaração Numérico(4) body

Receber dados de declaração de ICMS da Sefaz

* Funcionalidade ainda não disponível nos ambientes de Validação das Empresas e Produção

Recebe da Sefaz os dados referentes ao cálculo de ICMS para criação automática da declaração de ICMS no Pucomex.

Exemplo - dados de uma solicitação de pagamento integral:

{
    "iniciativaSefaz": false,
    "ufFavorecida": "RJ",
    "tipoDeclaracao": "DUIMP",
    "numeroDeclaracao": "18BR00000000000",
    "versaoDeclaracao": "1",
    "tipoSolicitacao": "PAGAMENTO_INTEGRAL_DUIMP",
    "cpfSolicitante": "00000000000",
    "numeroMandadoJudicial": null,
    "numeroGlme": null,
    "autenticidadeGlme": null,
    "tipoRetorno": "CALCULADO_A_PAGAR",
    "valorCalculado": 120.00,
    "valorTotalDevido": 100.00,
    "periodoReferencia": "2019-04",
    "dataVencimento": "2019-04-01",
    "valorCIFExonerado": 0,
    "valorTotalaRecolher": 101.00,
    "dataConfirmacaoCredito": null,
    "valorTotalCredito": null,
    "justificativaIndeferimento": null,
    "guias": [
    {
        "geradorGuia": "ESTADO",
        "codigoBarrasGuia": "0009090",
        "codigoReceita": "1000064",
        "descricaoCodigoReceita": "ICMS Autuação Fiscal",
        "valorCalculado": 120.00,
        "valorDevido": 100.00,
        "valorAtualizacaoMonetaria": 0,
        "valorJuros": 1.00,
        "valorMulta": 0,
        "valorTotal": 101.00,
        "numeroControle": "8888"
    }
  ]
}

Model

SefazDadosIcmsDto {
    iniciativaSefaz (boolean),
    ufFavorecida (string) = ["AC" or "AL" or "AM" or "AP" or "BA" 
                            or "CE" or "DF" or "ES" or "GO" or "MA" 
                            or "MG" or "MS" or "MT" or "PA" or "PB" 
                            or "PE" or "PI" or "PR" or "RJ" or "RN" 
                            or "RO" or "RR" or "RS" or "SC" or "SE" 
                            or "SP" or "TO"],
    tipoDeclaracao (string) = ["DUIMP"],
    numeroDeclaracao (string),
    versaoDeclaracao (string),
    tipoSolicitacao (string) = ["PAGAMENTO_INTEGRAL_DUIMP" 
                                or "PAGAMENTO_PARCIAL_DUIMP" 
                                or "EXONERACAO_INTEGRAL_DUIMP" 
                                or "MANDADO_JUDICIAL_DUIMP"],
    cpfSolicitante (string),
    numeroMandadoJudicial (string, optional),
    numeroGlme (string, optional),
    autenticidadeGlme (string, optional),
    tipoRetorno (string) = ["CALCULADO_A_PAGAR" 
                            or "SEM_VALOR_A_PAGAR" 
                            or "INDEFERIDO"],
    valorCalculado (number),
    valorTotalDevido (number),
    periodoReferencia (string, optional),
    dataVencimento (date-time, optional),
    valorCIFExonerado (number, optional),
    valorTotalaRecolher (number, optional),
    dataConfirmacaoCredito (date-time),
    valorTotalCredito (number, optional),
    justificativaIndeferimento (string, optional),
    guias (Array[GuiaIcmsDto], optional)
}

GuiaIcmsDto {
    geradorGuia (string) = ["ESTADO" or "GNRE"],
    codigoBarrasGuia (string),
    codigoReceita (string),
    descricaoCodigoReceita (string, optional),
    valorCalculado (number),
    valorDevido (number),
    valorAtualizacaoMonetaria (number, optional),
    valorJuros (number, optional),
    valorMulta (number, optional),
    valorTotal (number),
    numeroControle (string, optional)
}

Endpoint:

POST https://<url>/pcce/api/ext/sefaz/icms

Content-Type:

application/json

Observações:

Um exemplo de requisição e o Model podem ser visualizados ao lado.

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
iniciativaSefaz Indicador de que a solicitação foi originada na Sefaz Booleano, obrigatório body
ufFavorecida UF favorecida Texto (2), obrigatório body
tipoDeclaracao Tipo da declaração no Comércio Exterior Texto, obrigatório body
numeroDeclaracao Número da declaração Texto (15), obrigatório body
versaoDeclaracao Versão da declaração Numérico (4), obrigatório body
tipoSolicitacao Tipo de solicitação Texto, obrigatório body
cpfSolicitante CPF do responsável pela declaração de ICMS Texto (11), obrigatório body
numeroMandadoJudicial Número do Mandado Judicial Texto (30) body (*) Obrigatório se tipoSolicitacao = MANDADO_JUDICIAL_DUIMP.
numeroGLME Número da GLME Texto (100) body (*) Obrigatório numeroGlme ou autenticidadeGlme se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou EXONERACAO_INTEGRAL_DUIMP.
autenticidadeGLME Código de autorização de exoneração Sefaz Texto (100) body (*) Obrigatório numeroGlme ou autenticidadeGlme se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou EXONERACAO_INTEGRAL_DUIMP.
tipoRetorno Tipo de retorno Texto, obrigatório body
valorCalculado Valor calculado sem benefícios Numérico (15+2), obrigatório body
valorTotalDevido Valor total devido (a pagar ou pago) Numérico (15+2), obrigatório body
periodoReferencia Período de referência Texto (yyyy-MM) body
dataVencimento Data de vencimento Texto (yyyy-MM-dd) body (*) Obrigatório se tipoRetorno = CALCULADO_A_PAGAR.
valorCIFExonerado Valor CIF Exonerado (abatido da base de cálculo de ICMS) Numérico (15+2) body (*) Obrigatório se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou EXONERACAO_INTEGRAL_DUIMP.
valorTotalaRecolher Somatório dos valores devidos + juros + multa +atualização monetária Numérico (15+2) body (*) Obrigatório se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou PAGAMENTO_INTEGRAL_DUIMP.
dataConfirmacaoCredito Data e hora da confirmação do crédito de ICMS Texto (yyyy-MM-dd'T'HH:mm:ssZ) body (*) Obrigatório se tipoRetorno = SEM_VALOR_A_PAGAR.
valorTotalCredito Valor total do crédito Numérico (15+2) body (*) Obrigatório se tipoRetorno = SEM_VALOR_A_PAGAR.
justificativaIndeferimento Justificativa para o indeferimento da solicitação de declaração de ICMS Texto (300) body (*) Obrigatório se tipoRetorno = INDEFERIDO.
guias Lista de guias de pagamento de ICMS Lista de objetos Guia de ICMS body (*) Obrigatório se tipoRetorno = CALCULADO_A_PAGAR.

(*) Somente pode ser informado nos casos onde é obrigatório.

Guia ICMS:

Nome Descrição Tipo Local Detalhes
geradorGuia Responsável pela geração da guia Numérico (1), obrigatório body
codigoBarrasGuia Codigo de barras da guia (Portal GNRE ou do próprio Estado) Texto (100), obrigatório body
codigoReceita Codigo da Receita utilizado pelo Estado Texto (6), obrigatório body
descricaoCodigoReceita Descrição do código Receita Texto (100), body
valorCalculado Valor calculado sem benefícios/onerações para o código de receita Numérico (15+2), obrigatório body
valorDevido Valor devido efetivamente Numérico (15+2), obrigatório body
valorAtualizacaoMonetaria Valor da atualização monetária Numérico (15+2) body
valorJuros Valor dos juros Numérico (15+2) body
valorMulta Valor da multa Numérico (15+2) body
valorTotal Somatório dos valores devidos + juros + multa +atualização monetária Numérico (15+2), obrigatório body
numeroControle Número de Controle da Sefaz (NossoNúmero) Texto (20) body

Resposta:

Códigos de Retorno.

Confirmar crédito de pagamento de ICMS

* Funcionalidade ainda não disponível nos ambientes de Validação das Empresas e Produção

Recebe da Sefaz a confirmação de crédito de pagamento de ICMS.

Exemplo de confirmação de crédito:

{
  "ufFavorecida": "RJ",
  "tipoDeclaracao": "DUIMP",
  "numeroDeclaracao": "18BR00000000000",
  "versaoDeclaracao": "1",
  "tipoSolicitacao": "PAGAMENTO_INTEGRAL_DUIMP",
  "dataConfirmacaoCredito": "2019-04-01T12:00:00Z",
  "valorTotalCredito": 101.90
}

Model

SefazCreditoIcmsDto {
    ufFavorecida (string) = ["AC" or "AL" or "AM" or "AP" or "BA" 
                            or "CE" or "DF" or "ES" or "GO" or "MA" 
                            or "MG" or "MS" or "MT" or "PA" or "PB" 
                            or "PE" or "PI" or "PR" or "RJ" or "RN" 
                            or "RO" or "RR" or "RS" or "SC" or "SE" 
                            or "SP" or "TO"],
    tipoDeclaracao (string) = ["DUIMP"],
    numeroDeclaracao (string),
    versaoDeclaracao (string),
    tipoSolicitacao (string) = ["PAGAMENTO_INTEGRAL_DUIMP" 
                                or "PAGAMENTO_PARCIAL_DUIMP" 
                                or "EXONERACAO_INTEGRAL_DUIMP" 
                                or "MANDADO_JUDICIAL_DUIMP"],
    dataConfirmacaoCredito (date-time),
    valorTotalCredito (number, optional)
}

Endpoint:

POST https://<url>/pcce/api/ext/sefaz/icms/credito

Content-Type:

application/json

Observações:

Um exemplo de requisição e o Model podem ser visualizados ao lado.

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
ufFavorecida UF favorecida Texto (2), obrigatório body
tipoDeclaracao Tipo da declaração no Comércio Exterior Texto (10), obrigatório body
numeroDeclaracao Número da declaração Texto (15), obrigatório body
versaoDeclaracao Versão da declaração Numérico (4), obrigatório body
dataConfirmacaoCredito Data e hora da confirmação do crédito de ICMS Texto (yyyy-MM-dd'T'HH:mm:ssZ), obrigatório body
valorTotalCredito Valor total do crédito Numérico (15+2), obrigatório body

Resposta:

Códigos de Retorno.

Notificação de eventos push

O Portal Único de Comércio Exterior fornece um serviço de envio de notificações para eventos relacionados a mudanças de status das operações em andamento. Os interessados em receber as notificações devem utilizar a API de subscrição descrita a seguir, que é baseada no conceito de webhook – uma estratégia de integração em que a parte interessada é notificada a partir de um endpoint previamente cadastrado.

As seções abaixo definem os serviços da API de notificação, que devem ser acessados depois de realizada a autenticação no Portal.


Documentação adicional:

Subscrever evento

Exemplo de envio de dados para subscrição de evento:

[
  {
    "evento": "id_evento",
    "endpoint": "https://endpoint_a_ser_notificado"
  }
]

Endpoint:

POST https://<url>/portal/api/ext/webhook

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
evento Identificador do evento (consultar na seção ‘Relação de eventos para subscrição’) Texto(40), obrigatório JSON
endpoint Endpoint a ser notificado na ocorrência do evento Texto(500), obrigatório JSON Deve ser uma URL segura (HTTPS).

Resposta:

Nome Descrição Tipo
id Identificador da subscrição Número(10)
evento Identificador do evento (consultar na seção ‘Relação de eventos para subscrição’) Texto(40)
endpoint Endpoint a ser notificado na ocorrência do evento Texto(500)

Listar subscrições

Lista as subscrições ativas para o usuário.

Endpoint:

GET https://<url>/portal/api/ext/webhook

Content-Type:

application/json

Parâmetros de Entrada:

Não há parâmetros de entrada.

Resposta:

Nome Descrição Tipo
id Identificador da subscrição Número(10)
evento Identificador do evento Texto(40)
endpoint Endpoint notificado na ocorrência do evento Texto(500)

Alterar subscrição

Exemplo de envio de dados para alteração de uma subscrição ativa:

[
  {
    "id": 8, 
    "evento": "id_evento",
    "endpoint": "https://endpoint_a_ser_notificado"
  }
]

Endpoint:

PUT https://<url>/portal/api/ext/webhook/{id}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
id Identificador da subscrição Número(10), obrigatório JSON
evento Identificador do evento Texto(40), obrigatório JSON
endpoint Endpoint a ser notificado na ocorrência do evento Texto(500), obrigatório JSON Deve ser uma URL segura (HTTPS).

Resposta:

Nome Descrição Tipo
id Identificador da subscrição Número(10)
evento Identificador do evento (consultar na seção ‘Relação de eventos para subscrição’) Texto(40)
endpoint Endpoint a ser notificado na ocorrência do evento Texto(500)

Excluir subscrição

Exemplo de envio de dados para exclusão de uma subscrição ativa:

[
  {
    "id": 8
  }
]

Endpoint:

PUT https://<url>/portal/api/ext/webhook/{id}

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
id Identificador da subscrição Número(10), obrigatório JSON

Resposta:

Não há parâmetros na resposta.

Consultar falhas

Permite consultar falhas no envio de eventos subscritos pelo usuário.

Exemplo de envio de dados para consultar falhas de envio:

[
  {
    "data": 17092018
  }
]

Endpoint:

GET https://<url>/portal/api/ext/webhook/falhas

Content-Type:

application/json

Parâmetros de Entrada:

Nome Descrição Tipo Local Detalhes
data Data do registro no formato ddMMyyyy Texto(8), opcional JSON Quando não informada, será considerada a data corrente.

Resposta:

Nome Descrição Tipo
id Identificador do registro Número(10)
data Data do registro Texto(8)
descricao Descrição do erro Texto
evento Identificador do evento relacionado Texto(40)
conteudo Conteudo enviado ao endpoint Texto

Eventos disponíveis

Os eventos disponíveis para subscrição estão documentados nas páginas a seguir:

Tabelas de Domínio

Sistema de Tabelas Aduaneiras

Conforme mostrado na documentação específica de cada serviço, os domínios de alguns campos são oriundos de tabelas já utilizadas no comércio exterior. Para ter acesso ao conteúdo destas tabelas, basta acessar o seguintes endereços:

Release notes

Versão implantada no dia 27/01/2019

Versão implantada no dia 11/11/2018

Versão implantada no dia 30/09/2018

Versão implantada no dia 24/06/2018

Versão implantada no dia 24/01/2018

Versão implantada no dia 27/12/2017

Versão implantada no dia 01/11/2017

Versão implantada no dia 29/09/2017

Versão implantada no dia 30/06/2017

Versão implantada no dia 26/06/2017