Integra Comex - Declaração de Importação Documentação da API
Introdução
Para tornar o acesso aos sistemas governamentais mais eficiente e inteligente, estamos disponibilizando o barramento de serviços Integra Comex.
O Integra Comex permite aos Operadores de Comércio Exterior se integrarem diretamente às bases governamentais que controlam operações de importação, exportação e gestão de cargas.
O principal ganho deste barramento é permitir consultas orientadas por operação, isto é, todas as informações relacionadas a uma determinada operação serão retornadas em uma única consulta, agregando informações que hoje estão fragmentadas em diversos sistemas e consultas
As consultas classificam-se em dois grupos: Pública e Restrita
Pública: A visibilidade é Irrestrita pois não possui sigilo comercial e fiscal. Será disponibilizado a “data da última alteração” vinculada à DI. As alterações poderão ser motivadas por inclusões e alterações na base de dados do sistema Importação DI. Não é objetivo desta API indicar o motivo da alteração e sim indicar que alguma informação foi alterada naquela data/hora.Documentação disponível em https://siscomex-di.estaleiro.serpro.gov.br/siscomex-di-api/
Restrita: A visibilidade é restrita pois possui informações com sigilo comercial e fiscal. O acesso será via certificado digital (e-CPF) e credenciais API Serpro que são disponibilizadas após contratação. A obrigatoriedade da utilização do certificado digital e-CPF obedece o padrão de acesso aos sistemas da família Siscomex e estão baseadas na resolução CTIC/MF N°10 de 10/08/2017. A presente documentação trata destas consultas classificadas como restritas.
Para testar o ambiente de validação, acesse a documentação técnica de apoio em
https://atendimento.serpro.gov.br/integracomex/documentacao
Autenticação
As APIs disponibilizadas pela plataforma API Serpro utilizam o protocolo Oauth2 para realizar a autenticação e autorização de acesso das APIs contratadas
Fase Contratual - Realizada para obter as credenciais de acesso Para consumir as APIs, é necessário utilizar as credenciais de acesso (Consumer Key e Consumer Secret) disponibilizados no portal do Cliente. Esses códigos servem para identificar o contrato.
Exemplos de código:
- Consumer Key: HKnrRYUDaydyhfO1YsyeLWptwUMa
- Consumer Secret: TDe9ecUDEl1Nxu1q33cklyV5Io0a
Para garantir a irretratabilidade (não repúdio), o portal do cliente exigirá o certificado digital e-CNPJ (cadeia ICP Brasil) da contratante para visualizar essas credenciais de acesso.
Fase Operacional
Consumo da API - Token de Acesso (Bearer)
Para consultar as APIs disponibilizadas pelo SERPRO, é necessário obter um Token de Acesso Temporário (Bearer)
.
Esse token possui um tempo de validade e, sempre que expirar, a solicitação de um novo token de acesso deve ser feita.
Para solicitar o token temporário é necessário realizar uma requisição HTTP POST para o endpoint Token URL_BASE_AUTENTICACAO/authenticate com as seguintes características:
- Certificado Digital e-CPF padrão ICP-Brasil válido
- HTTP Header contendo:
- "Authorization": Basic (base64(consumerKey:consumerSecret)) - Credenciais de acesso (consumerKey:consumerSecret) no HTTP Header Authorization, no formato base64
- "role-type": "IMPEXP"
- "content-type": "application/json"
Exemplo:
"request":{
"method": "POST",
"headers":{
"authorization": "Basic NlhvWUlEUjIybWhrMWJlcV9kcVczMVR4NlhzYTpQSWk5YmdwVzJWczhUTkdLcFowTzZ4cHBGOEFh",
"role-type": "IMPEXP",
"content-type": "application/json"
},
"uri": "${"URL_SAPI"}"
}
O retorno da autenticação será um token temporário para ser utilizado no consumo dos serviços. Esse token temporário é composto por:
{"expires_in": 2008, "scope": "am_application_scope default" "token_type": "Bearer""access_token": "ce6112ab644f06a31b238fe9739f38a4" "jwt_token": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIwMDA0ODc0NzQ5MSIsInRpcG8iOiJQRiIsImFjY2VzcyI6ImNlNjExMmFiNjQ0ZjA2YTMxYjIzOGZlOTczOWYzOGE0IiwiaXAiOiIxMC4zNC4yMDUuMTA3Iiwicm9sZXMiOlt7ImlkIjoiSU1QRVhQIiwiZGVzYyI6IkltcG9ydGFkb3JcL0V4cG9ydGFkb3IiLCJ0cmFucyI6WyJERUZBVUxUIl19XSwiaXNzIjoiU0FQSSIsImNwZiI6IjAwMDQ4NzQ3NDkxIiwibm9tZSI6IjAwMDQ4NzQ3NDkxIC0gSE9NT0xPR0FDQU8iLCJleHAiOjE1NzM2NzQ4OTEsImlhdCI6MTU3MzY3Mjg4MywiZGVzYyI6IjAwMDQ4NzQ3NDkxIC0gSE9NT0xPR0FDQU8ifQ.RjgRhVSxzJ1eEtz5ZlQbUc8qI3bZhSY7IkBXakYJbv-8-B_fECVJ346atkY4zKhOAi3mAu_S5CsbEUe6wWTkAFNycudkn29ZvLFELvdvKLN4-IXs8p6jP8i1rexFPy-LqhL0_gdiFTExi_mXqw3Q1rIInu3BW5YmYTLfHWgrrp0O6tZScPRj6d-MCjvWPXItWOWgGiRF8LFhQEPv3QzaYfT05HHbhD_IQDtbec5AtPM0rdiNVXVk1M7JPrbE1mVaP9Ur3e7cajrip-yTTTwPJj9w4MCQ1zmK9lgfO9YeS9iKf7fZpik2JXphafedbPlScgFAcV5rT-j6N3-ArHM5Jw"}
Onde
- expires_in: Tempo para expirar o token temporário Integra Comex
- scope: Escopo padrão
- token_type: Classifica o tipo de token temporário
-
acess_token: Gerado com base nas credenciais contratuais da API Serpro, disponíveis na área do cliente mediante e-CNPJ.
Possui controle de expiração por parte do plataforma API Serpro -
jwt_token: Seu objetivo é prover uma comunicação eficiente e leve entre API’s e microservices e armazena conteúdo do certificado digital do usuário.
O JWT é um padrão (RFC-7519) de mercado que define como transmitir e armazenar objetos JSON de forma compacta e segura entre diferentes aplicações.
Os dados nele contidos podem ser validados a qualquer momento pois o token é assinado digitalmente pela própria aplicação Integra Comex e não pode alterado.
A cada requisição isso é verificado. Caso ocorra uma falsificação do JWT, a assinatura ficará inválida e o JWT rejeitado.
No JWT estará contido o e-CPF do usuário, onde ele será usando para acesso autorizado às informações via representação Siscomex.
Ao acionar o serviço de autenticação, será preciso realizar o processo de handshake SSL entre a aplicação cliente e o Integra Comex, apresentando um certificado digital e-CPF A1 ou A3, padrão ICP-Brasil.
Versão: 1.0.0
Endereços de acesso à API
URL_BASE_AUTENTICACAO
Validação:
https://hom-siscomex-sapi.estaleiro.serpro.gov.br/authenticateProdução:
https://siscomex-sapi.estaleiro.serpro.gov.br/authenticateURL_BASE_INTEGRA_COMEX
Validação:
https://gateway.apiserpro.serpro.gov.br/integra-comex-di-hom/v1Produção:
https://gateway.apiserpro.serpro.gov.br/integra-comex-di/v1Dados de Adições
Consultar as adições de uma Declaração de Importação.
Consultar as adições de uma Declaração de Importação no PathVariable.
Quando o número de adições exceder a capacidade de retorno em uma requisição, o response irá disponibilizar o atributo 'links' em seu header contendo:
- O link para recuperação da próxima página ( rel-next)
- O link da requisição originou esta resposta ( rel-self).
Exemplo do header 'links' com informações de paginação no response:
"links": URL_BASE_INTEGRA_COMEX/declaracao-importacao/2000000179/adicoes/ rel="self" , URL_BASE_INTEGRA_COMEX/declaracao-importacao/2000000179/adicoes/011/continuar; rel="next"
O link fornecido em 'rel="next"' deve ser utilizado para recuperar a próxima página
Exemplos:
URL_BASE_INTEGRA_COMEX/declaracao-importacao/2000000179/adicoes
URL_BASE_INTEGRA_COMEX/declaracao-importacao/2000000179/adicoes/011/continuar
Número da Declaração de Importação
Número da Adição
Token JWT fornecido pelo serviço de autenticação (SAPI)
Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. (Bearer)
OK
Requisição mal formatada
Usuário não tem permissão para acessar o recurso solicitado
Recurso não encontrado
Erro de negócio
Erro inesperado
Content-Types do Response: application/json
Exemplo de Response (200 OK)
[
{
"acrescimos": [
{
"codigoAcrescimo": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
],
"antiDumping": {
"aliquotaAdValorem": "123.12",
"aliquotaBaseCalculo": "1234567890123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "098123192",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"atoLegalAno": "9999",
"atoLegalDescricao": "string",
"atoLegalEX": "999",
"atoLegalNumero": "string",
"atoLegalOrgaoEmissor": "string",
"codigoAtoLegal": "9"
},
"carga": {
"dadosCargaPaisProcedenciaCodigo": "999",
"dadosCargaUrfEntradaCodigo": "9999999",
"dadosCargaViaTransporteCodigo": "99",
"frete": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisFreteInternacional": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisSeguroInternacional": "1234567890123.12"
}
},
"certificadoMercosul": {
"declaracaoExportacaoEstrangeira": [
"string"
],
"tipoCertificado": "string"
},
"cideImposto": {
"quantidade": "string",
"valorAliquotaEspecifica": "12345.12345",
"valorDevido": "1234567890123.12",
"valorRecolher": "1234567890123.12"
},
"cofinsImposto": {
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
},
"compradorVendedor": {
"relacao": "string",
"vinculo": "string"
},
"condicaoVenda": {
"incoterm": "string",
"local": "string",
"metodoValoracao": "string",
"moeda": "string",
"valorMoeda": "1234567890123.12",
"valorMoedaReal": "1234567890123.12",
"valorTotal": "2342450000000.8100012"
},
"dadosCambiais": {
"coberturaCambial": "string",
"instituicaoFinanciadora": "99",
"motivoSemCobertura": "99",
"numeroROF": "99999999",
"valorRealCambio": "1234567890123.12"
},
"dadosGerais": {
"numeroAdicao": "999",
"numeroDI": "2000001849",
"numeroLI": "2000001849",
"sequencialRetificacao": "99"
},
"dcrDemonstCoeficienteReducao": {
"coeficienteReducao": "123.12",
"identificacao": "99999999",
"valorDevido": "1234567890123.12",
"valorDolar": "1234567890123.12",
"valorReal": "1234567890123.12",
"valorRecolher": "1234567890123.12"
},
"deducoes": [
{
"codigoDeducao": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
],
"destaqueNcm": [
{
"numeroDestaque": "string"
}
],
"documentosVinculados": [
{
"codigoTipo": "string",
"nomeTipo": "string",
"numero": "string"
}
],
"exportador": {
"codigoPaisAquisicaoMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
},
"fabricante": {
"codigoPaisOrigemMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
},
"iiImposto": {
"acordoTarifarioAladiNome": "string",
"acordoTarifarioAtoLegalAno": "9999",
"acordoTarifarioAtoLegalDescricao": "string",
"acordoTarifarioAtoLegalEX": "999",
"acordoTarifarioAtoLegalNumero": "string",
"acordoTarifarioAtoLegalOrgaoEmissor": "string",
"acordoTarifarioTipoNome": "string",
"aliquotaAcordo": "123.12",
"aliquotaAdValorem": "123.12",
"aliquotaPercentualReducao": "123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"baseCalculo": "1234567890123.12",
"codigoAcordoTarifarioAladi": "string",
"codigoAcordoTarifarioAtoLegal": "9",
"codigoAcordoTarifarioTipo": "9",
"codigoExTarifarioAtoLegal": "9",
"codigoFundamentoLegal": "99",
"codigoMotivoAdmissaoTemporaria": "99",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"fundamentoLegalNome": "string",
"motivoAdmissaoTemporariaNome": "string",
"regimeTributacaoNome": "string"
},
"ipiImposto": {
"aliquotaAdValorem": "12345.12345",
"aliquotaEspecificaCapacidadeRecipiente": "12345",
"aliquotaEspecificaQuantidadeUnidadeMedida": "123456789",
"aliquotaEspecificaTipoRecipienteCodigo": "99",
"aliquotaEspecificaUnidadeMedida": "90123.14322",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaEspecificaValorUnidadeMedida": "12345.12345",
"aliquotaNotaComplementarTIPI": "99",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"beneficioFiscalAtoLegalAno": "2000",
"beneficioFiscalAtoLegalDescricao": "string",
"beneficioFiscalAtoLegalEX": "999",
"beneficioFiscalAtoLegalNumero": "123456",
"beneficioFiscalAtoLegalOrgaoEmissor": "string",
"codigoBeneficioFiscalAtoLegal": "9999",
"codigoExTarifarioAtoLegal": "9",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"regimeTributacaoNome": "string"
},
"itens": [
{
"descricaoMercadoria": "string",
"numeroSequencialItem": "99",
"quantidade": "123456789.12345",
"unidadeMedida": "string",
"valorUnitario": "1234567890123.1234567 "
}
],
"mercadoria": {
"aplicacao": "string",
"codigoNaladiNCCA": "9999999",
"codigoNaladiSH": "9999999",
"codigoNcm": "99910000",
"condicao": "string",
"pesoLiquido": "1234567890.12345",
"quantidadeMedidaEstatistica": "123456789.12345",
"unidadeMedidaEstatistica": "string"
},
"multaAdministrativa": {
"valorMultaARecolher": "1234567890123.12",
"valorMultaARecolherAjustado": "1234567890123.12"
},
"nomenclaturaValorAduaneiro": [
"string"
],
"pisCofinsDadosComuns": {
"baseCalculoAliquotaICMS": "1234567890123.12",
"baseCalculoFundamentoLegalNome": "string",
"baseCalculoPercentualReducao": "123.12",
"baseCalculoValor": "1234567890123.12",
"codigoBaseCalculoFundamentoLegal": "99",
"codigoFundamentoLegalReducao": "99",
"fundamentoLegalReducaoNome": "string",
"regimeTributacaoCodigo": "9",
"regimeTributacaoNome": "string"
},
"pisPasepImposto": {
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
},
"textoComplementoValorAduaneiro": "string"
}
]
Exemplo de Response (400 Bad Request)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (403 Forbidden)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (404 Not Found)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (422 Unprocessable Entity)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (500 Internal Server Error)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Consultar os dados de uma Adição.
Consultar os dados de uma Adição no PathVariable.
Exemplo: /declaracao-importacao/2000000179/adicoes/1
Número da Declaração de Importação
Número da Adição
Token JWT fornecido pelo serviço de autenticação (SAPI)
Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. (Bearer)
OK
Requisição mal formatada
Usuário não tem permissão para acessar o recurso solicitado
Recurso não encontrado
Erro de negócio
Erro inesperado
Content-Types do Response: application/json
Exemplo de Response (200 OK)
[
{
"acrescimos": [
{
"codigoAcrescimo": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
],
"antiDumping": {
"aliquotaAdValorem": "123.12",
"aliquotaBaseCalculo": "1234567890123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "098123192",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"atoLegalAno": "9999",
"atoLegalDescricao": "string",
"atoLegalEX": "999",
"atoLegalNumero": "string",
"atoLegalOrgaoEmissor": "string",
"codigoAtoLegal": "9"
},
"carga": {
"dadosCargaPaisProcedenciaCodigo": "999",
"dadosCargaUrfEntradaCodigo": "9999999",
"dadosCargaViaTransporteCodigo": "99",
"frete": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisFreteInternacional": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisSeguroInternacional": "1234567890123.12"
}
},
"certificadoMercosul": {
"declaracaoExportacaoEstrangeira": [
"string"
],
"tipoCertificado": "string"
},
"cideImposto": {
"quantidade": "string",
"valorAliquotaEspecifica": "12345.12345",
"valorDevido": "1234567890123.12",
"valorRecolher": "1234567890123.12"
},
"cofinsImposto": {
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
},
"compradorVendedor": {
"relacao": "string",
"vinculo": "string"
},
"condicaoVenda": {
"incoterm": "string",
"local": "string",
"metodoValoracao": "string",
"moeda": "string",
"valorMoeda": "1234567890123.12",
"valorMoedaReal": "1234567890123.12",
"valorTotal": "2342450000000.8100012"
},
"dadosCambiais": {
"coberturaCambial": "string",
"instituicaoFinanciadora": "99",
"motivoSemCobertura": "99",
"numeroROF": "99999999",
"valorRealCambio": "1234567890123.12"
},
"dadosGerais": {
"numeroAdicao": "999",
"numeroDI": "2000001849",
"numeroLI": "2000001849",
"sequencialRetificacao": "99"
},
"dcrDemonstCoeficienteReducao": {
"coeficienteReducao": "123.12",
"identificacao": "99999999",
"valorDevido": "1234567890123.12",
"valorDolar": "1234567890123.12",
"valorReal": "1234567890123.12",
"valorRecolher": "1234567890123.12"
},
"deducoes": [
{
"codigoDeducao": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
],
"destaqueNcm": [
{
"numeroDestaque": "string"
}
],
"documentosVinculados": [
{
"codigoTipo": "string",
"nomeTipo": "string",
"numero": "string"
}
],
"exportador": {
"codigoPaisAquisicaoMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
},
"fabricante": {
"codigoPaisOrigemMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
},
"iiImposto": {
"acordoTarifarioAladiNome": "string",
"acordoTarifarioAtoLegalAno": "9999",
"acordoTarifarioAtoLegalDescricao": "string",
"acordoTarifarioAtoLegalEX": "999",
"acordoTarifarioAtoLegalNumero": "string",
"acordoTarifarioAtoLegalOrgaoEmissor": "string",
"acordoTarifarioTipoNome": "string",
"aliquotaAcordo": "123.12",
"aliquotaAdValorem": "123.12",
"aliquotaPercentualReducao": "123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"baseCalculo": "1234567890123.12",
"codigoAcordoTarifarioAladi": "string",
"codigoAcordoTarifarioAtoLegal": "9",
"codigoAcordoTarifarioTipo": "9",
"codigoExTarifarioAtoLegal": "9",
"codigoFundamentoLegal": "99",
"codigoMotivoAdmissaoTemporaria": "99",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"fundamentoLegalNome": "string",
"motivoAdmissaoTemporariaNome": "string",
"regimeTributacaoNome": "string"
},
"ipiImposto": {
"aliquotaAdValorem": "12345.12345",
"aliquotaEspecificaCapacidadeRecipiente": "12345",
"aliquotaEspecificaQuantidadeUnidadeMedida": "123456789",
"aliquotaEspecificaTipoRecipienteCodigo": "99",
"aliquotaEspecificaUnidadeMedida": "90123.14322",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaEspecificaValorUnidadeMedida": "12345.12345",
"aliquotaNotaComplementarTIPI": "99",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"beneficioFiscalAtoLegalAno": "2000",
"beneficioFiscalAtoLegalDescricao": "string",
"beneficioFiscalAtoLegalEX": "999",
"beneficioFiscalAtoLegalNumero": "123456",
"beneficioFiscalAtoLegalOrgaoEmissor": "string",
"codigoBeneficioFiscalAtoLegal": "9999",
"codigoExTarifarioAtoLegal": "9",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"regimeTributacaoNome": "string"
},
"itens": [
{
"descricaoMercadoria": "string",
"numeroSequencialItem": "99",
"quantidade": "123456789.12345",
"unidadeMedida": "string",
"valorUnitario": "1234567890123.1234567 "
}
],
"mercadoria": {
"aplicacao": "string",
"codigoNaladiNCCA": "9999999",
"codigoNaladiSH": "9999999",
"codigoNcm": "99910000",
"condicao": "string",
"pesoLiquido": "1234567890.12345",
"quantidadeMedidaEstatistica": "123456789.12345",
"unidadeMedidaEstatistica": "string"
},
"multaAdministrativa": {
"valorMultaARecolher": "1234567890123.12",
"valorMultaARecolherAjustado": "1234567890123.12"
},
"nomenclaturaValorAduaneiro": [
"string"
],
"pisCofinsDadosComuns": {
"baseCalculoAliquotaICMS": "1234567890123.12",
"baseCalculoFundamentoLegalNome": "string",
"baseCalculoPercentualReducao": "123.12",
"baseCalculoValor": "1234567890123.12",
"codigoBaseCalculoFundamentoLegal": "99",
"codigoFundamentoLegalReducao": "99",
"fundamentoLegalReducaoNome": "string",
"regimeTributacaoCodigo": "9",
"regimeTributacaoNome": "string"
},
"pisPasepImposto": {
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
},
"textoComplementoValorAduaneiro": "string"
}
]
Exemplo de Response (400 Bad Request)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (403 Forbidden)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (404 Not Found)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (422 Unprocessable Entity)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (500 Internal Server Error)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Dados de DI
Consultar os dados de uma Declaração de Importação.
Consultar os dados de uma Declaração de Importação no PathVariable.
Número da Declaração de Importação
Token JWT fornecido pelo serviço de autenticação (SAPI)
Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. (Bearer)
OK
Requisição mal formatada
Usuário não tem permissão para acessar o recurso solicitado
Recurso não encontrado
Erro de negócio
Erro inesperado
Content-Types do Response: application/json
Exemplo de Response (200 OK)
[
{
"caracterizacaoOperacao": {
"adquirente": {
"nomeAdquirente": "string",
"numeroAdquirente": "00000000000191"
},
"caracterizacaoOperacaoTipo": "string",
"nomeTransportadorPorta": "string",
"numeroTransportadorPorta": "00000000000191"
},
"carga": {
"armazenamento": {
"armazens": [
"string"
],
"codigoRecintoAduaneiro": "0717700",
"setor": "123"
},
"basicoCarga": {
"codigoPaisProcedencia": "221",
"codigoUrfEntrada": "0717700",
"conhecimentoCarga": {
"dataEmbarque": "2020-03-21",
"idConhecimento": "10987654321654321",
"idMaster": "10987654321654321",
"localEmbarque": "string",
"tipoConhecimento": "string",
"utilizacao": "string"
},
"dataChegada": "2020-02-21T10:40:19",
"documentoChegadaCargaCodigoTipo": "1",
"documentoChegadaCargaNomeTipo": "string",
"numeroAgente": "N/I",
"numeroDocumentoChegadaCarga": "191919191919191",
"pesoBruto": "1000000000.50000",
"pesoLiquido": "2450000000.81000"
},
"embalagens": [
{
"codigoTipoEmbalagem": "string",
"quantidadeVolume": "string"
}
],
"frete": {
"codigoMoedaNegociada": "220",
"totalMoeda": "1234567890123.12",
"totalReais": "1234567890123.12",
"valorCollect": "1234567890123.12",
"valorEmTerritorioNacional": "1234567890123.12",
"valorPrepaid": "1234567890123.12",
"valorTotalDolares": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "220",
"valorSeguroTotalMoedaNegociada": "1234567890123.12",
"valorTotalDolares": "1234567890123.12",
"valorTotalReais": "1234567890123.12"
}
},
"dadosDespacho": {
"canalSelecaoParametrizada": "string",
"dataHoraAutorizacaoEntrega": "2020-01-05T15:12:08",
"dataHoraDesembaraco": "2020-03-11T10:24:10",
"dataHoraRegistro": "2020-04-29T09:53:19",
"modalidadeDespacho": "string",
"operacaoFundap": "S",
"tipoAutorizacaoEntrega": "string",
"tipoDeclaracaoCodigo": "string",
"urfDespachoCodigo": "0717600"
},
"dadosGerais": {
"numeroAdicao": "999",
"numeroDI": "2000001849",
"numeroLI": "2000001849",
"sequencialRetificacao": "99"
},
"declaracoesEstrangeiras": [
{
"faixaItens": {
"numeroREFinal": "string",
"numeroREInicial": "string"
},
"numeroDaDE": "string"
}
],
"documentosInstrucaoDespacho": [
{
"codigoTipoDocumentoDespacho": "01",
"numeroDocumentoDespacho": "string"
}
],
"dossies": [
{
"dataHoraVinculacao": "2020-04-29T09:53:19",
"numeroDossie": "000000000000000"
}
],
"icms": [
{
"agencia": "string",
"banco": "053",
"contaCorrente": "0000000000000000000",
"cpf": "00000000191",
"dataHoraRegistro": "2020-02-21T10:40:19",
"dataPagamento": "2020-02-21T10:40:19",
"mandadoJudicial": "string",
"nrSequencial": "001",
"protocoloDebitoConta": "0000000000",
"tipoDeclaracao": "string",
"tipoRecolhimento": "string",
"uf": "RJ",
"valor": "1234567890123.12"
}
],
"importador": {
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
},
"nomeImportador": "string",
"numeroIdentificacao": "00000000000191",
"representanteLegal": {
"cpf": "00000000191",
"nome": "string"
},
"tipo": "string"
},
"informacaoComplementar": "string",
"multaRestricaoEmbarque": {
"valorTotalMultaARecolher": "1234567890123.12",
"valorTotalMultaARecolherAjustado": "1234567890123.12"
},
"pagamentos": [
{
"codigoReceita": "string",
"codigoTipoPagamento": "1",
"dadosBancarios": {
"agenciaPagamento": "99999",
"bancoPagamento": "001",
"contaPagamento": "string"
},
"dataPagamento": "2020-01-01",
"nomeTipoPagamento": "string",
"numeroRetificacao": "99",
"valorJurosEncargos": "1234567.12",
"valorMulta": "1234567.12",
"valorReceita": "1234567890123.12",
"valorTotal": "1234567890123.12"
}
],
"processos": [
{
"identificacaoProcesso": "string",
"tipoProcesso": "string"
}
],
"transporte": {
"codigoViaTransporte": "99",
"codigoViaTransportePaisTransportador": "01",
"indicadorViaTransporteMultimodal": "S",
"nomeTransportador": "string",
"nomeVeiculo": "string",
"numeroVeiculo": "string"
},
"valorMercadoriaDescarga": {
"totalDolares": "1234567890123.12",
"totalReais": "1234567890123.12"
},
"valorMercadoriaEmbarque": {
"totalDolares": "1234567890123.12",
"totalReais": "1234567890123.22"
}
}
]
Exemplo de Response (400 Bad Request)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (403 Forbidden)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (404 Not Found)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (422 Unprocessable Entity)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Exemplo de Response (500 Internal Server Error)
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Definições de Esquema
Acrescimo: object
- codigoAcrescimo: string
-
Código do acréscimo, conforme a tabela “Acréscimos”.
Tamanho: 2
Formato: "AA" - codigoMoedaNegociada: string
-
Código da moeda conforme a tabela “Moedas".
Tamanho: 3
Formato: "NNN" - valorMoedaNegociada: string
-
Valor na moeda negociada do acréscimo.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReais: string
-
Valor em reais do acréscimo.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoAcrescimo": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
AdicaoConsultaRepresentation: object
- acrescimos: Acrescimo
-
Acrescimo - antiDumping:
- carga:
- certificadoMercosul:
- cideImposto:
- cofinsImposto:
- compradorVendedor:
- condicaoVenda:
- dadosCambiais:
- dadosGerais:
- dcrDemonstCoeficienteReducao:
- deducoes: Deducao
-
Deduções
-
Deducao - destaqueNcm: DestaquesNcm
-
DestaquesNcm - documentosVinculados: DocumentosVinculados
-
DocumentosVinculados - exportador:
- fabricante:
- iiImposto:
- ipiImposto:
- itens: Itens
-
Itens - mercadoria:
- multaAdministrativa:
- nomenclaturaValorAduaneiro: string[]
-
string - pisCofinsDadosComuns:
- pisPasepImposto:
- textoComplementoValorAduaneiro: string
Exemplo
{
"acrescimos": [
{
"codigoAcrescimo": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
],
"antiDumping": {
"aliquotaAdValorem": "123.12",
"aliquotaBaseCalculo": "1234567890123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "098123192",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"atoLegalAno": "9999",
"atoLegalDescricao": "string",
"atoLegalEX": "999",
"atoLegalNumero": "string",
"atoLegalOrgaoEmissor": "string",
"codigoAtoLegal": "9"
},
"carga": {
"dadosCargaPaisProcedenciaCodigo": "999",
"dadosCargaUrfEntradaCodigo": "9999999",
"dadosCargaViaTransporteCodigo": "99",
"frete": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisFreteInternacional": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisSeguroInternacional": "1234567890123.12"
}
},
"certificadoMercosul": {
"declaracaoExportacaoEstrangeira": [
"string"
],
"tipoCertificado": "string"
},
"cideImposto": {
"quantidade": "string",
"valorAliquotaEspecifica": "12345.12345",
"valorDevido": "1234567890123.12",
"valorRecolher": "1234567890123.12"
},
"cofinsImposto": {
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
},
"compradorVendedor": {
"relacao": "string",
"vinculo": "string"
},
"condicaoVenda": {
"incoterm": "string",
"local": "string",
"metodoValoracao": "string",
"moeda": "string",
"valorMoeda": "1234567890123.12",
"valorMoedaReal": "1234567890123.12",
"valorTotal": "2342450000000.8100012"
},
"dadosCambiais": {
"coberturaCambial": "string",
"instituicaoFinanciadora": "99",
"motivoSemCobertura": "99",
"numeroROF": "99999999",
"valorRealCambio": "1234567890123.12"
},
"dadosGerais": {
"numeroAdicao": "999",
"numeroDI": "2000001849",
"numeroLI": "2000001849",
"sequencialRetificacao": "99"
},
"dcrDemonstCoeficienteReducao": {
"coeficienteReducao": "123.12",
"identificacao": "99999999",
"valorDevido": "1234567890123.12",
"valorDolar": "1234567890123.12",
"valorReal": "1234567890123.12",
"valorRecolher": "1234567890123.12"
},
"deducoes": [
{
"codigoDeducao": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
],
"destaqueNcm": [
{
"numeroDestaque": "string"
}
],
"documentosVinculados": [
{
"codigoTipo": "string",
"nomeTipo": "string",
"numero": "string"
}
],
"exportador": {
"codigoPaisAquisicaoMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
},
"fabricante": {
"codigoPaisOrigemMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
},
"iiImposto": {
"acordoTarifarioAladiNome": "string",
"acordoTarifarioAtoLegalAno": "9999",
"acordoTarifarioAtoLegalDescricao": "string",
"acordoTarifarioAtoLegalEX": "999",
"acordoTarifarioAtoLegalNumero": "string",
"acordoTarifarioAtoLegalOrgaoEmissor": "string",
"acordoTarifarioTipoNome": "string",
"aliquotaAcordo": "123.12",
"aliquotaAdValorem": "123.12",
"aliquotaPercentualReducao": "123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"baseCalculo": "1234567890123.12",
"codigoAcordoTarifarioAladi": "string",
"codigoAcordoTarifarioAtoLegal": "9",
"codigoAcordoTarifarioTipo": "9",
"codigoExTarifarioAtoLegal": "9",
"codigoFundamentoLegal": "99",
"codigoMotivoAdmissaoTemporaria": "99",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"fundamentoLegalNome": "string",
"motivoAdmissaoTemporariaNome": "string",
"regimeTributacaoNome": "string"
},
"ipiImposto": {
"aliquotaAdValorem": "12345.12345",
"aliquotaEspecificaCapacidadeRecipiente": "12345",
"aliquotaEspecificaQuantidadeUnidadeMedida": "123456789",
"aliquotaEspecificaTipoRecipienteCodigo": "99",
"aliquotaEspecificaUnidadeMedida": "90123.14322",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaEspecificaValorUnidadeMedida": "12345.12345",
"aliquotaNotaComplementarTIPI": "99",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"beneficioFiscalAtoLegalAno": "2000",
"beneficioFiscalAtoLegalDescricao": "string",
"beneficioFiscalAtoLegalEX": "999",
"beneficioFiscalAtoLegalNumero": "123456",
"beneficioFiscalAtoLegalOrgaoEmissor": "string",
"codigoBeneficioFiscalAtoLegal": "9999",
"codigoExTarifarioAtoLegal": "9",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"regimeTributacaoNome": "string"
},
"itens": [
{
"descricaoMercadoria": "string",
"numeroSequencialItem": "99",
"quantidade": "123456789.12345",
"unidadeMedida": "string",
"valorUnitario": "1234567890123.1234567 "
}
],
"mercadoria": {
"aplicacao": "string",
"codigoNaladiNCCA": "9999999",
"codigoNaladiSH": "9999999",
"codigoNcm": "99910000",
"condicao": "string",
"pesoLiquido": "1234567890.12345",
"quantidadeMedidaEstatistica": "123456789.12345",
"unidadeMedidaEstatistica": "string"
},
"multaAdministrativa": {
"valorMultaARecolher": "1234567890123.12",
"valorMultaARecolherAjustado": "1234567890123.12"
},
"nomenclaturaValorAduaneiro": [
"string"
],
"pisCofinsDadosComuns": {
"baseCalculoAliquotaICMS": "1234567890123.12",
"baseCalculoFundamentoLegalNome": "string",
"baseCalculoPercentualReducao": "123.12",
"baseCalculoValor": "1234567890123.12",
"codigoBaseCalculoFundamentoLegal": "99",
"codigoFundamentoLegalReducao": "99",
"fundamentoLegalReducaoNome": "string",
"regimeTributacaoCodigo": "9",
"regimeTributacaoNome": "string"
},
"pisPasepImposto": {
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
},
"textoComplementoValorAduaneiro": "string"
}
Adquirente: object
- nomeAdquirente: string
-
Nome completo da razão social da pessoa jurídica.
Tamanho mínimo: 1
Tamanho máximo: 60 - numeroAdquirente: string
-
Número de inscrição do consignatário da operação no CNPJ.
Tamanho: 14
Formato: "NNNNNNNNNNNNNN"
Exemplo
{
"nomeAdquirente": "string",
"numeroAdquirente": "00000000000191"
}
AntiDumping: object
- aliquotaAdValorem: string
-
Alíquota vigente, conforme a Tarifa Externa Comum (TEC).
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaBaseCalculo: string
-
Valor tributável apurado de acordo com as normas de valoração aduaneira.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaQuantidadeUnidade: string
-
Quantidade de mercadoria expressa na unidade de medida estabelecida em ato legal.
Tamanho máximo: 9
Formato: Inteiro, com até 9 dígitos. - aliquotaEspecificaUnidadeMedida: string
-
Quantidade de mercadoria expressa na unidade de medida estabelecida em ato legal.
Tamanho máximo: 9
Formato: NNNNNNNNN - aliquotaEspecificaValor: string
-
Valor, em real, por unidade de medida a ser aplicado sobre a base de cálculo.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - aliquotaEspecificaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - atoLegalAno: string
-
Ano que foi emitido o ato legal.
Tamanho: 4
Formato: "NNNN" - atoLegalDescricao: string
-
Tipo de ato legal, conforme a tabela “Atos Legais”.
Tamanho mínimo: 1
Tamanho máximo: 5 - atoLegalEX: string
-
Destaque da mercadoria dentro do código NCM ou NBM.
Tamanho: 3
Formato: "NNN" - atoLegalNumero: string
-
Número que identifica o ato legal.
Tamanho máximo: 6
Formato: Inteiro, com até 6 dígitos. - atoLegalOrgaoEmissor: string
-
Sigla do órgão que emitiu o ato legal.
Tamanho mínimo: 1
Tamanho máximo: 6 - codigoAtoLegal: string
-
Código do Ato LegalInstrumento jurídico que ampara o direito exigível.
Tamanho: 1
Formato: "N"
Exemplo
{
"aliquotaAdValorem": "123.12",
"aliquotaBaseCalculo": "1234567890123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "098123192",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"atoLegalAno": "9999",
"atoLegalDescricao": "string",
"atoLegalEX": "999",
"atoLegalNumero": "string",
"atoLegalOrgaoEmissor": "string",
"codigoAtoLegal": "9"
}
ApiError: object
- error: string
-
Código interno de erro.
- message: string
-
Mensagem de erro relacionada ao codigo de erro.
- path: string
-
caminho do recurso com erro.
- statusCode: number
-
Código de erro padrão HTML.
- timestamp: string (date-time)
-
Data e hora em que ocorreu o problema (no formato ISO 8601)
- trackerId: string
-
Identificação única da requsição utilizada para rastrear a falha. (envie para o suporte em caso de erro inesperado)
Exemplo
{
"error": "AD0001",
"message": "Mensagem do codigo AD0001",
"path": "https://servidor-integra-comex/api/declaracao-importacao/1900000017",
"statusCode": 400,
"timestamp": "2020-01-01T20:40:45.000",
"trackerId": "TRK-A34ZM2"
}
Armazenamento: object
- armazens: string[]
-
string - codigoRecintoAduaneiro: string
-
Código do recinto alfandegado conforme a tabela "Recintos Alfandegados.
Tamanho: 7
Formato: "NNNNNNN" - setor: string
-
Código do setor que controla o local de armazenagem.
Tamanho: 3
Formato: "NNN"
Exemplo
{
"armazens": [
"string"
],
"codigoRecintoAduaneiro": "0717700",
"setor": "123"
}
BasicoCarga: object
- codigoPaisProcedencia: string
-
Código do país de procedência da mercadoria conforme a tabela "Países".
Tamanho: 3
Formato: "NNN" - codigoUrfEntrada: string
-
Unidade da Receita Federal que jurisdiciona o local de entrada da mercadoria no País.
Tamanho: 7
Formato: "NNNNNNN" - conhecimentoCarga:
- dataChegada: string
-
Data em que ocorreu a chegada da carga na URF de despacho,constante de um dos seguintes documentos: termo de visita, termo de entrada ou aviso de recebimento do correio, ou ainda a data da conclusão da operação de trânsito aduaneiro.
Formato: "yyyy-MM-ddTHH:mm:ss" - documentoChegadaCargaCodigoTipo: string
-
Informado segundo a via de transporte internacional.
Tamanho: 1
Formato: N - documentoChegadaCargaNomeTipo: string
-
Informado segundo a via de transporte internacional.
Tamanho: 18 - numeroAgente: string
-
Pessoa física ou jurídica nacional, representante do transportador.
Tamanho: 14
Formato: "NNNNNNNNNNNNNN" - numeroDocumentoChegadaCarga: string
-
Documento que comprova a chegada da carga no recinto alfandegado sob a jurisdição da URF de despacho.
Tamanho: 15
Formato: "NNNNNNNNNNNNNNN" - pesoBruto: string
-
Somatório dos pesos brutos dos volumes objeto do despacho (peso líquido da mercadoria somado ao da embalagem e envoltório, inclusive “pallet” em que a mercadoriaesteja acondicionada), expresso em Kg (quilograma) e fração de cinco (5) casas decimais.
Tamanho: 10,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - pesoLiquido: string
-
Somatório dos pesos líquidos das mercadorias objeto do despacho, expresso em Kg (quilograma) e fração de cinco (5) casas decimais.
Tamanho: 10,5
Formato: Decimal, com até 5 casas decimais separadas por ponto.
Exemplo
{
"codigoPaisProcedencia": "221",
"codigoUrfEntrada": "0717700",
"conhecimentoCarga": {
"dataEmbarque": "2020-03-21",
"idConhecimento": "10987654321654321",
"idMaster": "10987654321654321",
"localEmbarque": "string",
"tipoConhecimento": "string",
"utilizacao": "string"
},
"dataChegada": "2020-02-21T10:40:19",
"documentoChegadaCargaCodigoTipo": "1",
"documentoChegadaCargaNomeTipo": "string",
"numeroAgente": "N/I",
"numeroDocumentoChegadaCarga": "191919191919191",
"pesoBruto": "1000000000.50000",
"pesoLiquido": "2450000000.81000"
}
CaracterizacaoOperacao: object
- adquirente:
- caracterizacaoOperacaoTipo: string IMPORTACAO_PROPRIA, IMPORTACAO_CONTA_ORDEM, TRANSPORTADOR_PORTA_PORTA
-
Define o tipo e o responsável pela importação
- nomeTransportadorPorta: string
-
Nome completo da razão social da pessoa jurídica.
Tamanho mínimo: 1
Tamanho máximo: 60" - numeroTransportadorPorta: string
-
Número de inscrição do transportador da operação no CNPJ.
Tamanho: 14
Formato: "NNNNNNNNNNNNNN"
Exemplo
{
"adquirente": {
"nomeAdquirente": "string",
"numeroAdquirente": "00000000000191"
},
"caracterizacaoOperacaoTipo": "string",
"nomeTransportadorPorta": "string",
"numeroTransportadorPorta": "00000000000191"
}
Carga: object
- dadosCargaPaisProcedenciaCodigo: string
-
Código do país de procedência, conforme a tabela “Países”.
Tamanho: 3
Formato: "NNN" - dadosCargaUrfEntradaCodigo: string
-
Código da URF, conforme a tabela “Órgãos da SRF”.
Tamanho: 7
Formato: "NNNNNNN" - dadosCargaViaTransporteCodigo: string
-
Meio utilizado no transporte da carga. Na modalidade multimodal, deverá ser indicada apenas a última via utilizada até o local de entrada no Brasil.
Tamanho: 2
Formato: "NN" - frete:
- seguro:
Exemplo
{
"dadosCargaPaisProcedenciaCodigo": "999",
"dadosCargaUrfEntradaCodigo": "9999999",
"dadosCargaViaTransporteCodigo": "99",
"frete": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisFreteInternacional": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisSeguroInternacional": "1234567890123.12"
}
}
CargaRepresentation: object
Exemplo
{
"armazenamento": {
"armazens": [
"string"
],
"codigoRecintoAduaneiro": "0717700",
"setor": "123"
},
"basicoCarga": {
"codigoPaisProcedencia": "221",
"codigoUrfEntrada": "0717700",
"conhecimentoCarga": {
"dataEmbarque": "2020-03-21",
"idConhecimento": "10987654321654321",
"idMaster": "10987654321654321",
"localEmbarque": "string",
"tipoConhecimento": "string",
"utilizacao": "string"
},
"dataChegada": "2020-02-21T10:40:19",
"documentoChegadaCargaCodigoTipo": "1",
"documentoChegadaCargaNomeTipo": "string",
"numeroAgente": "N/I",
"numeroDocumentoChegadaCarga": "191919191919191",
"pesoBruto": "1000000000.50000",
"pesoLiquido": "2450000000.81000"
},
"embalagens": [
{
"codigoTipoEmbalagem": "string",
"quantidadeVolume": "string"
}
],
"frete": {
"codigoMoedaNegociada": "220",
"totalMoeda": "1234567890123.12",
"totalReais": "1234567890123.12",
"valorCollect": "1234567890123.12",
"valorEmTerritorioNacional": "1234567890123.12",
"valorPrepaid": "1234567890123.12",
"valorTotalDolares": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "220",
"valorSeguroTotalMoedaNegociada": "1234567890123.12",
"valorTotalDolares": "1234567890123.12",
"valorTotalReais": "1234567890123.12"
}
}
CertificadoMercosul: object
- declaracaoExportacaoEstrangeira: string[]
-
string - tipoCertificado: string
-
Indica se há certificado e em havendo qual o tipo do mesmo .
Tamanho mínimo: 1
Tamanho máximo: 15
Exemplo
{
"declaracaoExportacaoEstrangeira": [
"string"
],
"tipoCertificado": "string"
}
Cide: object
- quantidade: string
- valorAliquotaEspecifica: string
-
Valor, em real, por unidade de medida a ser aplicado sobre a base de cálculo.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - valorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"quantidade": "string",
"valorAliquotaEspecifica": "12345.12345",
"valorDevido": "1234567890123.12",
"valorRecolher": "1234567890123.12"
}
Cofins: object
- aliquotaAdValorem: string
-
Alíquota vigente, conforme a Tarifa Externa Comum (TEC).
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaQuantidadeUnidade: string
-
Quantidade de mercadoria expressa na unidade de medida estabelecida em ato legal.
Tamanho máximo: 9
Formato: Inteiro, com até 9 dígitos. - aliquotaEspecificaUnidadeMedida: string
-
Unidade de medida estabelecida em ato legal para a mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 15 - aliquotaEspecificaValor: string
-
Valor, em real, por unidade de medida a ser aplicado sobre a base de cálculo.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - aliquotaEspecificaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaReduzida: string
-
Alíquota “ad valorem” reduzida incidente sobre a base de cálculo do imposto.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
}
CompradorVendedor: object
- relacao: string FABRICANTE_EXPORTADOR, FABRICANTE_NAO_EXPORTADOR, FABRICANTE_DESCONHECIDO
-
Relação entre comprador e vendedor
- vinculo: string SEM_VINCULACAO, VINCULACAO_SEM_INFLUENCIA_PRECO, VINCULACAO_COM_INFLUENCIA_PRECO
-
Vínculo entre comprador e vendedor.
Exemplo
{
"relacao": "string",
"vinculo": "string"
}
CondicaoVenda: object
- incoterm: string
-
Código da condição de negociação.
Tamanho: 3
Formato: "AAA" - local: string
-
Ponto ou local até onde o vendedor é responsável pelos custos dos elementos próprios da condição.
Tamanho mínimo: 1
Tamanho máximo: 60 - metodoValoracao: string
-
Método utilizado para valoração da mercadoria.
Tamanho: 3
Formato: "NNN" - moeda: string
-
Moeda utilizada na valoração da mercadoria.
Tamanho: 3
Formato: "NNN" - valorMoeda: string
-
Valor total das mercadorias constantes da adição, na condição de venda e na moeda negociada, conforme a fatura comercial.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorMoedaReal: string
-
Valor total das mercadorias constantes da adição, expresso em real.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorTotal: string
-
Valor total das mercadorias constantes da adição.
Tamanho: 13,7
Formato: Decimal, com até 7 casas decimais separadas por ponto.
Exemplo
{
"incoterm": "string",
"local": "string",
"metodoValoracao": "string",
"moeda": "string",
"valorMoeda": "1234567890123.12",
"valorMoedaReal": "1234567890123.12",
"valorTotal": "2342450000000.8100012"
}
ConhecimentoCarga: object
- dataEmbarque: string
-
Data de emissão do conhecimento de transporte ou da postagem da mercadoria ou, quando não houver conhecimento de transporte, da partida da mercadoria do local de embarque.
Formato: "yyyy-MM-dd" - idConhecimento: string
-
Número do conhecimento de transporte.
Tamanho: 18 - idMaster: string
-
Identificação do documento de transporte da carga consolidada ("master"), que indica conhecimento "house" informado.
Tamanho: 18 - localEmbarque: string
-
Denominação da localidade onde a carga foi ou será embarcada, de acordo com o conhecimento de transporte. Local de postagem ou de partida, nos demais casos.
Tamanho: 50 - tipoConhecimento: string BL, HBL, AWB, HAWB, DSIC, CRT, RWB, HRWB, TIF_DTA, CODIGO_BARRA
-
Indicação do tipo de documento de conhecimento de transporte.
- utilizacao: string TOTAL, PARCIAL, MAIS_DE_UM_CONHECIMENTO
-
Indicativo da utilização do conhecimento de transporte no despacho.
Exemplo
{
"dataEmbarque": "2020-03-21",
"idConhecimento": "10987654321654321",
"idMaster": "10987654321654321",
"localEmbarque": "string",
"tipoConhecimento": "string",
"utilizacao": "string"
}
DCRDemonstrativo: object
- coeficienteReducao: string
-
Percentual de redução incidente sobre a alíquota “ad valorem”, conforme DCR.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - identificacao: string
-
Número identificador constante do Demonstrativo do Coeficiente de Redução.
Tamanho: 8
Formato: "NNNNNNNN" - valorDevido: string
-
Valor do imposto após a aplicação do coeficiente de redução. Aplicação do coeficiente de redução sobre o resultado da multiplicação do imposto de importação em real pela quantidade de mercadoria.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorDolar: string
-
Valor do imposto devido na aquisição de insumos/componentes importados, conforme DCR, expresso em dolar dos EUA.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReal: string
-
Valor do imposto devido na aquisição de insumos/componentes importados, conforme DCR, expresso em Real.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorRecolher: string
-
Valor do imposto a ser recolhido. Será diferente do imposto devido se houver imunidade ou isenção.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"coeficienteReducao": "123.12",
"identificacao": "99999999",
"valorDevido": "1234567890123.12",
"valorDolar": "1234567890123.12",
"valorReal": "1234567890123.12",
"valorRecolher": "1234567890123.12"
}
DadosBancarios: object
- agenciaPagamento: string
-
Código da agência arrecadadora do tributo.
Tamanho: 5
Formato: "NNNNN" - bancoPagamento: string
-
Código do banco arrecadador do tributo.
Tamanho: 3
Formato: "NNN" - contaPagamento: string
-
Código da conta arrecadadora do tributo.
Tamanho mínimo: 1
Tamanho máximo: 19
Exemplo
{
"agenciaPagamento": "99999",
"bancoPagamento": "001",
"contaPagamento": "string"
}
DadosCambiais: object
- coberturaCambial: string ATE_180_DIAS, 181_ATE_360, ACIMA_360, SEM_COBERTURA
-
Código da natureza cambial, conforme a tabela “Cobertura Cambial”.
- instituicaoFinanciadora: string
-
Código da instituição financiadora, conforme a tabela “Instituições Financiadoras”.
Tamanho: 2
Formato: "NN" - motivoSemCobertura: string
-
Código do motivo da importação sem cobertura cambial, conforme a tabela “Motivo da Importação Sem Cobertura Cambial”.
Tamanho: 2
Formato: "NN" - numeroROF: string
-
Número do registro da operação atribuído pelo BACEN.
Tamanho: 8
Formato: "NNNNNNNN" - valorRealCambio: string
-
Valor do montante financiado, na moeda da condição de venda.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"coberturaCambial": "string",
"instituicaoFinanciadora": "99",
"motivoSemCobertura": "99",
"numeroROF": "99999999",
"valorRealCambio": "1234567890123.12"
}
DadosGerais: object
- numeroAdicao: string
-
Número sequencial agregado ao número da declaração, que identifica o conjunto de informações específicas da mercadoria.
Tamanho: 3
Formato: "NNN" - numeroDI: string
-
Número sequencial, anual, em âmbito nacional, identificador da declaração de importação.
Tamanho: 10
Formato: "NNNNNNNNNN" - numeroLI: string
-
Número sequencial agregado ao número da declaração, que identifica o conjunto de informações específicas da mercadoria.
Tamanho: 10
Formato: "NNNNNNNNNN" - sequencialRetificacao: string
-
Número sequencial agregado ao número da declaração já registrada, que identifica a declaração de retificação.
Tamanho: 2
Formato: "NN"
Exemplo
{
"numeroAdicao": "999",
"numeroDI": "2000001849",
"numeroLI": "2000001849",
"sequencialRetificacao": "99"
}
DeclaracaoEstrangeira: object
- faixaItens:
- numeroDaDE: string
-
Identificação da declaração estrangeira gerada no exterior para entrada no Mercosul.
Tamanho: 16
Exemplo
{
"faixaItens": {
"numeroREFinal": "string",
"numeroREInicial": "string"
},
"numeroDaDE": "string"
}
Deducao: object
- codigoDeducao: string
-
Código de dedução, conforme a tabela “Deduções”.
Tamanho: 2
Formato: "AA" - codigoMoedaNegociada: string
-
Código da moeda conforme a tabela “Moedas".
Tamanho: 3
Formato: "NNN" - valorMoedaNegociada: string
-
Valor na moeda negociada da dedução.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReais: string
-
Valor em reais da dedução.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoDeducao": "string",
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12"
}
Despacho: object
- canalSelecaoParametrizada: string
-
Canal recebido pela declaração após análise do sistema seleção parametrizada.
Tamanho: 1 - dataHoraAutorizacaoEntrega: string
-
Data e hora em que foi efetivado a autorização de entrega da declaração
Formato: "yyyy-MM-ddTHH:mm:ss" - dataHoraDesembaraco: string
-
Data e hora em que foi efetivado o desembaraço da declaração
Formato: "yyyy-MM-ddTHH:mm:ss" - dataHoraRegistro: string
-
Data e hora em que foi efetivado o registro da declaração
Formato: "yyyy-MM-ddTHH:mm:ss" - modalidadeDespacho: string NORMAL, ANTECIPADO, SIMPLIFICADO, ANTECIPADO_E_SIMPLIFICADO, ENTREGA_FRACIONADA, ANTECIPADO_COM_ENTREGA_FRACIONADA, SOBRE_AGUAS_OEA
-
Define a forma que a autorização de entrega foi autorizada em relação a continuidade do despacho
- operacaoFundap: string
-
Indicativo de operação de importação efetuada por empresa integrante do sistema FUNDAP - Fundo para o Desenvolvimento das Atividades Portuárias.
Tamanho: 1 - tipoAutorizacaoEntrega: string
-
Define a forma que a autorização de entrega foi autorizada em relação a continuidade do despacho.
Tamanho: 31 - tipoDeclaracaoCodigo: string
-
Código correspondente ao tipo de declaração, conforme a tabela "Tipo de Declaração".
Tamanho: 2 - urfDespachoCodigo: string
-
Unidade da Receita Federal responsável pela execução dos procedimentos necessários ao desembaraço aduaneiro da mercadoria importada.
Tamanho: 7
Formato: "NNNNNNN"
Exemplo
{
"canalSelecaoParametrizada": "string",
"dataHoraAutorizacaoEntrega": "2020-01-05T15:12:08",
"dataHoraDesembaraco": "2020-03-11T10:24:10",
"dataHoraRegistro": "2020-04-29T09:53:19",
"modalidadeDespacho": "string",
"operacaoFundap": "S",
"tipoAutorizacaoEntrega": "string",
"tipoDeclaracaoCodigo": "string",
"urfDespachoCodigo": "0717600"
}
DestaquesNcm: object
- numeroDestaque: string
-
Destaque da mercadoria, dentro do código NCM, para fins de licenciamento da importação.
Tamanho: 3
Formato: "NNN"
Exemplo
{
"numeroDestaque": "string"
}
DiConsultaRepresentation: object
- caracterizacaoOperacao:
- carga:
- dadosDespacho:
- dadosGerais:
- declaracoesEstrangeiras: DeclaracaoEstrangeira
-
Declaração Estrangeira
-
DeclaracaoEstrangeira - documentosInstrucaoDespacho: DocumentoInstrucao
-
DocumentoInstrucao - dossies: Dossie
-
Dossie - icms: Icms
-
ICMS
-
Icms - importador:
- informacaoComplementar: string
-
Informações adicionais e esclarecimentos sobre a declaração ou sobre o despacho aduaneiro, tais como: a identificação dos conteineres, o termo de responsabilidade, os dados da carga quando houver mais de um conhecimento e o assunto quando citado processo administrativo ou judicial.
Tamanho: 7800 - multaRestricaoEmbarque:
- pagamentos: Pagamento
-
pagamento
-
Pagamento - processos: Processo
-
Processo - transporte:
- valorMercadoriaDescarga:
- valorMercadoriaEmbarque:
Exemplo
{
"caracterizacaoOperacao": {
"adquirente": {
"nomeAdquirente": "string",
"numeroAdquirente": "00000000000191"
},
"caracterizacaoOperacaoTipo": "string",
"nomeTransportadorPorta": "string",
"numeroTransportadorPorta": "00000000000191"
},
"carga": {
"armazenamento": {
"armazens": [
"string"
],
"codigoRecintoAduaneiro": "0717700",
"setor": "123"
},
"basicoCarga": {
"codigoPaisProcedencia": "221",
"codigoUrfEntrada": "0717700",
"conhecimentoCarga": {
"dataEmbarque": "2020-03-21",
"idConhecimento": "10987654321654321",
"idMaster": "10987654321654321",
"localEmbarque": "string",
"tipoConhecimento": "string",
"utilizacao": "string"
},
"dataChegada": "2020-02-21T10:40:19",
"documentoChegadaCargaCodigoTipo": "1",
"documentoChegadaCargaNomeTipo": "string",
"numeroAgente": "N/I",
"numeroDocumentoChegadaCarga": "191919191919191",
"pesoBruto": "1000000000.50000",
"pesoLiquido": "2450000000.81000"
},
"embalagens": [
{
"codigoTipoEmbalagem": "string",
"quantidadeVolume": "string"
}
],
"frete": {
"codigoMoedaNegociada": "220",
"totalMoeda": "1234567890123.12",
"totalReais": "1234567890123.12",
"valorCollect": "1234567890123.12",
"valorEmTerritorioNacional": "1234567890123.12",
"valorPrepaid": "1234567890123.12",
"valorTotalDolares": "1234567890123.12"
},
"seguro": {
"codigoMoedaNegociada": "220",
"valorSeguroTotalMoedaNegociada": "1234567890123.12",
"valorTotalDolares": "1234567890123.12",
"valorTotalReais": "1234567890123.12"
}
},
"dadosDespacho": {
"canalSelecaoParametrizada": "string",
"dataHoraAutorizacaoEntrega": "2020-01-05T15:12:08",
"dataHoraDesembaraco": "2020-03-11T10:24:10",
"dataHoraRegistro": "2020-04-29T09:53:19",
"modalidadeDespacho": "string",
"operacaoFundap": "S",
"tipoAutorizacaoEntrega": "string",
"tipoDeclaracaoCodigo": "string",
"urfDespachoCodigo": "0717600"
},
"dadosGerais": {
"numeroAdicao": "999",
"numeroDI": "2000001849",
"numeroLI": "2000001849",
"sequencialRetificacao": "99"
},
"declaracoesEstrangeiras": [
{
"faixaItens": {
"numeroREFinal": "string",
"numeroREInicial": "string"
},
"numeroDaDE": "string"
}
],
"documentosInstrucaoDespacho": [
{
"codigoTipoDocumentoDespacho": "01",
"numeroDocumentoDespacho": "string"
}
],
"dossies": [
{
"dataHoraVinculacao": "2020-04-29T09:53:19",
"numeroDossie": "000000000000000"
}
],
"icms": [
{
"agencia": "string",
"banco": "053",
"contaCorrente": "0000000000000000000",
"cpf": "00000000191",
"dataHoraRegistro": "2020-02-21T10:40:19",
"dataPagamento": "2020-02-21T10:40:19",
"mandadoJudicial": "string",
"nrSequencial": "001",
"protocoloDebitoConta": "0000000000",
"tipoDeclaracao": "string",
"tipoRecolhimento": "string",
"uf": "RJ",
"valor": "1234567890123.12"
}
],
"importador": {
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
},
"nomeImportador": "string",
"numeroIdentificacao": "00000000000191",
"representanteLegal": {
"cpf": "00000000191",
"nome": "string"
},
"tipo": "string"
},
"informacaoComplementar": "string",
"multaRestricaoEmbarque": {
"valorTotalMultaARecolher": "1234567890123.12",
"valorTotalMultaARecolherAjustado": "1234567890123.12"
},
"pagamentos": [
{
"codigoReceita": "string",
"codigoTipoPagamento": "1",
"dadosBancarios": {
"agenciaPagamento": "99999",
"bancoPagamento": "001",
"contaPagamento": "string"
},
"dataPagamento": "2020-01-01",
"nomeTipoPagamento": "string",
"numeroRetificacao": "99",
"valorJurosEncargos": "1234567.12",
"valorMulta": "1234567.12",
"valorReceita": "1234567890123.12",
"valorTotal": "1234567890123.12"
}
],
"processos": [
{
"identificacaoProcesso": "string",
"tipoProcesso": "string"
}
],
"transporte": {
"codigoViaTransporte": "99",
"codigoViaTransportePaisTransportador": "01",
"indicadorViaTransporteMultimodal": "S",
"nomeTransportador": "string",
"nomeVeiculo": "string",
"numeroVeiculo": "string"
},
"valorMercadoriaDescarga": {
"totalDolares": "1234567890123.12",
"totalReais": "1234567890123.12"
},
"valorMercadoriaEmbarque": {
"totalDolares": "1234567890123.12",
"totalReais": "1234567890123.22"
}
}
DocumentoInstrucao: object
- codigoTipoDocumentoDespacho: string
-
Documentos necessários para instruir o despacho aduaneiro de importação.
Tamanho: 2 - numeroDocumentoDespacho: string
-
Identificação alfanumérica constante do documento.
Tamanho: 25
Exemplo
{
"codigoTipoDocumentoDespacho": "01",
"numeroDocumentoDespacho": "string"
}
DocumentosVinculados: object
- codigoTipo: string
-
Indicação do tipo do documento vinculado.
Tamanho: 1
Formato: "N" - nomeTipo: string
-
Nome do documento vinculado.
Tamanho: 2
Domínio:
DI
RE - numero: string
-
Número identificador do documento vinculado.
Tamanho mínimo: 1
Tamanho máximo: 15
Exemplo
{
"codigoTipo": "string",
"nomeTipo": "string",
"numero": "string"
}
Dossie: object
- dataHoraVinculacao: string
-
Data e hora que o dossiê foi associado a DI.
Formato: "yyyy-MM-ddTHH:mm:ss" - numeroDossie: string
-
Número que identifica o dossiê associado a DI, gerado no anexação.
Valor: 15
Formato: "NNNNNNNNNNNNNNN"
Exemplo
{
"dataHoraVinculacao": "2020-04-29T09:53:19",
"numeroDossie": "000000000000000"
}
Embalagem: object
- codigoTipoEmbalagem: string
-
Espécie ou tipo de embalagem utilizada no transporte da mercadoria submetida a despacho, conforme tabela "Embalagens".
Tamanho: 2
Formato: "NN" - quantidadeVolume: string
-
Número de volumes objeto do despacho, exceto para mercadorias a granel.
Tamanho: 5
Formato: "NNNNN"
Exemplo
{
"codigoTipoEmbalagem": "string",
"quantidadeVolume": "string"
}
Endereco: object
- cidade: string
-
Cidade do exportador ou fabricante da mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 25 - complemento: string
-
Complemento do exportador ou fabricante da mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 21 - estado: string
-
Estado do exportador ou fabricante da mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 25 - logradouro: string
-
Logradouro do exportador ou fabricante da mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 40 - nome: string
-
Nome completo do exportador ou fabricante da mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 60 - numero: string
-
Número do exportador ou fabricante da mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 6
Exemplo
{
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
Exportador: object
- codigoPaisAquisicaoMercadoria: string
-
País em que residir ou estiver sediado o exportador.
Tamanho: 3
Formato: "NNN" - endereco:
Exemplo
{
"codigoPaisAquisicaoMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
}
Fabricante: object
- codigoPaisOrigemMercadoria: string
-
País onde a mercadoria foi fabricada ou onde a mesma tenha sofrido o último processo de industrialização.
Tamanho: 3
Formato: "NNN" - endereco:
Exemplo
{
"codigoPaisOrigemMercadoria": "999",
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
}
}
FaixaItens: object
- numeroREFinal: string
-
Número final do item estrangeiro.
Tamanho: 4 - numeroREInicial: string
-
Número inicial do item estrangeiro.
Tamanho: 4
Exemplo
{
"numeroREFinal": "string",
"numeroREInicial": "string"
}
Frete: object
- codigoMoedaNegociada: string
-
Código da moeda negociada, conforme a tabela "Moedas".
Tamanho: 3
Formato: "NNN" - totalMoeda: string
-
Valor total do frete, ("prepaid" + "collect" - valor em território nacional), expresso na moeda negociada.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - totalReais: string
-
Valor do frete internacional ("prepaid" + "collect" - valor em território nacional), expresso em Real.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorCollect: string
-
Valor do frete constante do conhecimento de transporte, a ser pago no Brasil, inclusive "valor em território nacional", se for o caso.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorEmTerritorioNacional: string
-
Valor da parcela do frete, correspondente ao transporte dentro do território nacional.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorPrepaid: string
-
Valor do frete, constante do conhecimento de transporte, pago no exterior antecipadamente ao embarque, inclusive "valor em território nacional", se for o caso.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorTotalDolares: string
-
Valor do frete internacional ("prepaid" + "collect" - valor em território nacional), expresso em dólar dos EUA.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoMoedaNegociada": "220",
"totalMoeda": "1234567890123.12",
"totalReais": "1234567890123.12",
"valorCollect": "1234567890123.12",
"valorEmTerritorioNacional": "1234567890123.12",
"valorPrepaid": "1234567890123.12",
"valorTotalDolares": "1234567890123.12"
}
FreteCarga: object
- codigoMoedaNegociada: string
-
Moeda utilizada para negociação do frete.
Tamanho: 3
Formato: "NNN" - valorMoedaNegociada: string
-
Valor do frete na moeda negociada.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReais: string
-
Valor do frete em reais.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReaisFreteInternacional: string
-
Valor total do frete em reais.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisFreteInternacional": "1234567890123.12"
}
Icms: object
- agencia: string
-
Agência de destino da arrecadação da declaração de ICMS.
Tamanho: 5 - banco: string
-
Banco de destino da arrecadação da declaração de ICMS.
Tamanho: 3
Formato: NNN - contaCorrente: string
-
Conta de destino da arrecadação da declaração de ICMS.
Tamanho: 19 - cpf: string
-
Número do CPF de quem fez a declaração do ICMS.
Tamanho: 11
Formato: "NNNNNNNNNNN" - dataHoraRegistro: string
-
Data e hora em que foi efetivado o registro da declaração de ICMS.
Formato: "yyyy-MM-ddTHH:mm:ss" - dataPagamento: string
-
Data de efetivação da arrecadação do ICMS.
Formato: "yyyy-MM-ddTHH:mm:ss" - mandadoJudicial: string
-
Número do mandado judicial utilizado para cumprir o ICMS.
Tamanho: 40 - nrSequencial: string
-
Número sequencial do registro da declaração de ICMS.
Tamanho: 3
Formato: "NNN" - protocoloDebitoConta: string
-
Número de protocolo utilizado para solicitar o débito dos valores ao banco.
Tamanho: 10
Formato: NNNNNNNNNN - tipoDeclaracao: string
-
Tipo da declaração que foi feita.
Tamanho: 19 - tipoRecolhimento: string
-
Define o tipo de recolhimento feito para declaração de ICMS.
Tamanho: 55 - uf: string
-
UF de destino para arrecadação da declaração de ICMS.
Tamanho: 2 - valor: string
-
Valor arrecadado ou declarado do ICMS.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"agencia": "string",
"banco": "053",
"contaCorrente": "0000000000000000000",
"cpf": "00000000191",
"dataHoraRegistro": "2020-02-21T10:40:19",
"dataPagamento": "2020-02-21T10:40:19",
"mandadoJudicial": "string",
"nrSequencial": "001",
"protocoloDebitoConta": "0000000000",
"tipoDeclaracao": "string",
"tipoRecolhimento": "string",
"uf": "RJ",
"valor": "1234567890123.12"
}
Importador: object
- endereco:
- nomeImportador: string
-
Nome completo se pessoa física, razão social se pessoa jurídica, ou denominação se missão diplomática ou representações de organismo internacional.
Tamanho mínimo: 1
Tamanho máximo: 60 - numeroIdentificacao: string
-
Número que identifica o Importador.
Valor: 11 ou 14
Formato: "NNNNNNNNNNNNNN" - representanteLegal:
- tipo: string PESSOA_JURIDICA, PESSOA_FISICA_DOMICILIADA_NO_PAIS, PESSOA_FISICA_DOMICILIADA_NO_EXTERIOR, MISSAO_DIPLOMATICA_OU_REPRESENTACAO_INTERNACIONAL, TRANSPORTADOR_PORTA_A_PORTA
-
Indicação do tipo de importador
Exemplo
{
"endereco": {
"cidade": "string",
"complemento": "string",
"estado": "string",
"logradouro": "string",
"nome": "string",
"numero": "string"
},
"nomeImportador": "string",
"numeroIdentificacao": "00000000000191",
"representanteLegal": {
"cpf": "00000000191",
"nome": "string"
},
"tipo": "string"
}
ImpostoImportacao: object
- acordoTarifarioAladiNome: string
-
Nome do tipo de Acordo ALADI.
Tamanho mínimo: 1
Tamanho máximo: 60 - acordoTarifarioAtoLegalAno: string
-
Ano que foi emitido o acordo tarifário.
Tamanho: 4
Formato: "NNNN" - acordoTarifarioAtoLegalDescricao: string
-
Tipo acordo conforme a tabela “Atos Legais”.
Tamanho mínimo: 1
Tamanho máximo: 5 - acordoTarifarioAtoLegalEX: string
-
Destaque da mercadoria dentro do código NCM ou NBM.
Tamanho: 3
Formato: "NNN" - acordoTarifarioAtoLegalNumero: string
-
Número que identifica o acordo.
Tamanho mínimo: 1
Tamanho máximo: 6 - acordoTarifarioAtoLegalOrgaoEmissor: string
-
Sigla do órgão que emitiu o acordo.
Tamanho mínimo: 1
Tamanho máximo: 6 - acordoTarifarioTipoNome: string
-
Nome do tipo de Acordo.
Tamanho mínimo: 1
Tamanho máximo: 60 - aliquotaAcordo: string
-
Alíquota estabelecida no Acordo para a mercadoria.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaAdValorem: string
-
Alíquota vigente, conforme a Tarifa Externa Comum (TEC).
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaPercentualReducao: string
-
Percentual de redução aplicável sobre o valor do imposto devido.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaReduzida: string
-
Alíquota “ad valorem” reduzida incidente sobre a base de cálculo do imposto.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorCalculado: string
-
Imposto calculado com base na alíquota constante da Tarifa Externa Comum.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorReduzido: string
-
Imposto calculado com base na alíquota reduzida, inclusive em decorrência de acordo tarifário.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - baseCalculo: string
-
Valor tributável apurado de acordo com as normas de valoração aduaneira.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - codigoAcordoTarifarioAladi: string
-
Código do Acordo ALADI, conforme a tabela “Acordos ALADI”.
Tamanho: 3
Formato: "AAA" - codigoAcordoTarifarioAtoLegal: string
-
Acordo que institui o “ex” na NCM.
Tamanho: 1
Formato: "N" - codigoAcordoTarifarioTipo: string
-
Código do tipo de Acordo, conforme a tabela “ Tipos de Acordos”.
Tamanho: 1
Formato: "N" - codigoExTarifarioAtoLegal: string
-
Ato legal que institui o “ex” na NCM.
Tamanho: 1
Formato: "N" - codigoFundamentoLegal: string
-
Código do fundamento legal, conforme a tabela “Fundamentação Legal”.
Tamanho: 2
Formato: "NN" - codigoMotivoAdmissaoTemporaria: string
-
Código do motivo da admissão temporária, conforme Tabela "Motivos de Admissão”.
Tamanho: 2
Formato: "NN" - codigoRegimeTributacao: string
-
Código do regime de tributação, conforme a tabela “Regimes de Tributação”.
Tamanho: 1
Formato: "N" - exTarifarioAtoLegalAno: string
-
Ano que foi emitido o ato legal.
Tamanho: 4
Formato: "NNNN" - exTarifarioAtoLegalDescricao: string
-
Tipo de ato legal conforme a tabela “Atos Legais.
Tamanho: 5
Formato: "AAAAA" - exTarifarioAtoLegalEX: string
-
Destaque da mercadoria dentro do código NCM.
Tamanho: 3
Formato: "NNN" - exTarifarioAtoLegalNumero: string
-
Número que identifica o ato legal.
Tamanho máximo: 6
Formato: Inteiro, com até 6 dígitos - exTarifarioAtoLegalOrgaoEmissor: string
-
Sigla do órgão que emitiu o ato legal.
Tamanho mínimo: 1
Tamanho máximo: 6 - fundamentoLegalNome: string
-
Nome do fundamento legal .
Tamanho mínimo: 1
Tamanho máximo: 60 - motivoAdmissaoTemporariaNome: string
-
Nome do motivo da admissão temporária.
Tamanho mínimo: 1
Tamanho máximo: 60 - regimeTributacaoNome: string
-
Nome do regime de tributação.
Tamanho mínimo: 1
Tamanho máximo: 60
Exemplo
{
"acordoTarifarioAladiNome": "string",
"acordoTarifarioAtoLegalAno": "9999",
"acordoTarifarioAtoLegalDescricao": "string",
"acordoTarifarioAtoLegalEX": "999",
"acordoTarifarioAtoLegalNumero": "string",
"acordoTarifarioAtoLegalOrgaoEmissor": "string",
"acordoTarifarioTipoNome": "string",
"aliquotaAcordo": "123.12",
"aliquotaAdValorem": "123.12",
"aliquotaPercentualReducao": "123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"baseCalculo": "1234567890123.12",
"codigoAcordoTarifarioAladi": "string",
"codigoAcordoTarifarioAtoLegal": "9",
"codigoAcordoTarifarioTipo": "9",
"codigoExTarifarioAtoLegal": "9",
"codigoFundamentoLegal": "99",
"codigoMotivoAdmissaoTemporaria": "99",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"fundamentoLegalNome": "string",
"motivoAdmissaoTemporariaNome": "string",
"regimeTributacaoNome": "string"
}
Ipi: object
- aliquotaAdValorem: string
-
Valor por unidade de medida a ser aplicado sobre a base de cálculo, expresso em real.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - aliquotaEspecificaCapacidadeRecipiente: string
-
Capacidade do recipiente, expressa em ml (mililitros), para mercadorias enquadradas no Decreto nº 97.976/89.
Tamanho máximo: 5
Formato: Inteiro, com até 5 dígitos - aliquotaEspecificaQuantidadeUnidadeMedida: string
-
Quantidade de mercadoria expressa na unidade de medida estabelecida em ato legal.
Tamanho máximo: 9
Formato: Inteiro, com até 9 dígitos - aliquotaEspecificaTipoRecipienteCodigo: string
-
Código do tipo de recipiente, conforme tabela “Tipos de Recipiente”.
Tamanho: 2
Formato: "NN" - aliquotaEspecificaUnidadeMedida: string
-
Valor, em real, por unidade de medida a ser aplicado sobre a base de cálculo.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - aliquotaEspecificaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaValorUnidadeMedida: string
-
Valor, em real, por unidade de medida a ser aplicado sobre a base de cálculo.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - aliquotaNotaComplementarTIPI: string
-
Descrição: Número da nota complementar (NC) prevista na Tabela de Incidência do Imposto sobre Produtos Industrializados (TIPI) relativa à alíquota “ad valorem” do IPI.
Tamanho: 2
Formato: "NN" - aliquotaReduzida: string
-
Alíquota “ad valorem” reduzida incidente sobre a base de cálculo do imposto.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorCalculado: string
-
Imposto calculado com base na alíquota constante da Tarifa Externa Comum.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorReduzido: string
-
Imposto calculado com base na alíquota reduzida, inclusive em decorrência de acordo tarifário.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - beneficioFiscalAtoLegalAno: string
-
Ano que foi emitido o benefício.
Tamanho: 4
Formato: "NNNN" - beneficioFiscalAtoLegalDescricao: string
-
Tipo de ato legal conforme a tabela “Atos Legais”.
Tamanho: 5
Formato: "AAAAA" - beneficioFiscalAtoLegalEX: string
-
Destaque da mercadoria dentro do código NBM.
Tamanho: 3
Formato: "NNN" - beneficioFiscalAtoLegalNumero: string
-
Número que identifica o benefício.
Tamanho máximo: 6
Formato: Inteiro, com até 6 dígitos - beneficioFiscalAtoLegalOrgaoEmissor: string
-
Sigla do órgão que emitiu o benefício.
Tamanho mínimo: 1
Tamanho máximo: 6 - codigoBeneficioFiscalAtoLegal: string
-
Ato legal que ampara o benefício fiscal pretendido para o I.P.I.
Tamanho: 4
Formato: "NNNN" - codigoExTarifarioAtoLegal: string
-
Código do EX tarifárioAto legal que institui o “ex” na NCM.
Tamanho: 1
Formato: "N" - codigoRegimeTributacao: string
-
Código do regime de tributação, conforme a tabela “Regimes de Tributação”.
Tamanho: 1
Formato: "N" - exTarifarioAtoLegalAno: string
-
Ano que foi emitido o ato legal.
Tamanho: 4
Formato: "NNNN" - exTarifarioAtoLegalDescricao: string
-
Tipo de ato legal conforme a tabela “Atos Legais”.
Tamanho: 5
Formato: "AAAAA" - exTarifarioAtoLegalEX: string
-
Destaque da mercadoria dentro do código NCM ou NBM.
Tamanho: 3
Formato: "NNN" - exTarifarioAtoLegalNumero: string
-
Número que identifica o ato legal.
Tamanho máximo: 6
Formato: Inteiro, com até 6 dígitos - exTarifarioAtoLegalOrgaoEmissor: string
-
Sigla do órgão que emitiu o ato legal.
Tamanho mínimo: 1
Tamanho máximo: 6 - regimeTributacaoNome: string
-
Nome do regime de tributação.
Tamanho mínimo: 1
Tamanho máximo: 60
Exemplo
{
"aliquotaAdValorem": "12345.12345",
"aliquotaEspecificaCapacidadeRecipiente": "12345",
"aliquotaEspecificaQuantidadeUnidadeMedida": "123456789",
"aliquotaEspecificaTipoRecipienteCodigo": "99",
"aliquotaEspecificaUnidadeMedida": "90123.14322",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaEspecificaValorUnidadeMedida": "12345.12345",
"aliquotaNotaComplementarTIPI": "99",
"aliquotaReduzida": "123.12",
"aliquotaValorCalculado": "1234567890123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12",
"aliquotaValorReduzido": "1234567890123.12",
"beneficioFiscalAtoLegalAno": "2000",
"beneficioFiscalAtoLegalDescricao": "string",
"beneficioFiscalAtoLegalEX": "999",
"beneficioFiscalAtoLegalNumero": "123456",
"beneficioFiscalAtoLegalOrgaoEmissor": "string",
"codigoBeneficioFiscalAtoLegal": "9999",
"codigoExTarifarioAtoLegal": "9",
"codigoRegimeTributacao": "9",
"exTarifarioAtoLegalAno": "9999",
"exTarifarioAtoLegalDescricao": "string",
"exTarifarioAtoLegalEX": "999",
"exTarifarioAtoLegalNumero": "123456",
"exTarifarioAtoLegalOrgaoEmissor": "string",
"regimeTributacaoNome": "string"
}
Itens: object
- descricaoMercadoria: string
-
Espécie, tipo, marca, número, série, referência, medida, nome científico e/ou comercial, etc. da mercadoria (se for composta de apenas um produto) ou de cada produto (se composta de mais de um produto). Informação obrigatória.
Tamanho mínimo: 1
Tamanho máximo: 3900 - numeroSequencialItem: string
-
Número sequencial que identifica um item especifico em uma adição.
Tamanho: 2
Formato: "NN" - quantidade: string
-
Descrição: Número de unidades de cada especificação da mercadoria, na unidade de medida comercializada.
Tamanho: 9,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - unidadeMedida: string
-
Unidade de medida utilizada na comercialização de cada especificação da mercadoria, constante da fatura comercial.
Tamanho mínimo: 1
Tamanho máximo: 20 - valorUnitario: string
-
Valor da mercadoria por unidade comercializada, na condição de venda (“INCOTERM”), de acordo com a fatura comercial, na moeda negociada.
Tamanho: 13,7
Formato: Decimal, com até 7 casas decimais separadas por ponto.
Exemplo
{
"descricaoMercadoria": "string",
"numeroSequencialItem": "99",
"quantidade": "123456789.12345",
"unidadeMedida": "string",
"valorUnitario": "1234567890123.1234567 "
}
Mercadoria: object
- aplicacao: string CONSUMO, REVENDA
-
Toda a utilização da mercadoria que não implique em venda imediata, tal como a industrialização ou a integração em ativo permanente, deve ser considerada como consumo.
- codigoNaladiNCCA: string
-
Classificação da mercadoria, segundo a Nomenclatura da Associação Latino-Americana de Integração (NALADI) com base na Nomenclatura do Conselho de Cooperação Aduaneira (NCCA).
Tamanho: 7
Formato: "NNNNNNN" - codigoNaladiSH: string
-
Classificação da mercadoria, segundo a Nomenclatura da Associação Latino-Americana de Integração (NALADI) com base no Sistema Harmonizado de Codificação e Designação de Mercadorias (SH).
Tamanho: 7
Formato: "NNNNNNN" - codigoNcm: string
-
Classificação da mercadoria, segundo a Nomenclatura Comum do MERCOSUL (NCM) e Nomenclatura Brasileira de Mercadorias.
Tamanho: 8
Formato: "NNNNNNNN" - condicao: string NOVA, MATERIAL_USADO, BEM_SOB_ENCOMENDA
-
Indicativos da condição da mercadoria objeto da adição.
- pesoLiquido: string
-
Peso líquido das mercadorias constantes da adição, expresso em quilograma e fração de cinco (5) casas decimais.
Tamanho: 10,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - quantidadeMedidaEstatistica: string
-
Quantidade da mercadoria expressa na unidade de medida estatística.
Tamanho: 9,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - unidadeMedidaEstatistica: string
-
Unidade de medida da mercadoria conforme a tabela “Unidades de Medida”.
Tamanho mínimo: 1
Tamanho máximo: 60
Exemplo
{
"aplicacao": "string",
"codigoNaladiNCCA": "9999999",
"codigoNaladiSH": "9999999",
"codigoNcm": "99910000",
"condicao": "string",
"pesoLiquido": "1234567890.12345",
"quantidadeMedidaEstatistica": "123456789.12345",
"unidadeMedidaEstatistica": "string"
}
MultaAdministrativa: object
- valorMultaARecolher: string
-
Valor da multa administrativa calculada pelo sistema.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorMultaARecolherAjustado: string
-
Valor da multa administrativa calculada pelo sistema com ajuste.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"valorMultaARecolher": "1234567890123.12",
"valorMultaARecolherAjustado": "1234567890123.12"
}
MultaRestricaoEmbarque: object
- valorTotalMultaARecolher: string
-
Valor da multa aplicada em relação a data de embarque anterior a autorização do LI.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorTotalMultaARecolherAjustado: string
-
Valor da multa aplicada em relação a data de embarque anterior a autorização do LI, ajustado.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"valorTotalMultaARecolher": "1234567890123.12",
"valorTotalMultaARecolherAjustado": "1234567890123.12"
}
Pagamento: object
- codigoReceita: string
-
Código de receita tributária conforme a "Tabela Orçamentária."
Tamanho: 4
Formato: "NNNN" - codigoTipoPagamento: string
-
Define a forma que vai ser feito o pagamento.
Tamanho:1
Domínio:
1 - Débito em conta
2 – DARF - dadosBancarios:
- dataPagamento: string (date-time)
-
Data do pagamento do tributo.
Formato: YYYY-MM-DD - nomeTipoPagamento: string
-
Nome da forma que vai ser feito o pagamento.
Tamanho mínimo: 1
Tamanho máximo: 15 - numeroRetificacao: string
-
Sequencial de retificação em que ocorreu determinado pagamento.
Tamanho: 2
Formato: "NN" - valorJurosEncargos: string
-
Valor dos juros decorrentes do atraso no pagamento do tributo.
Tamanho: 7,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorMulta: string
-
Valor da multa por atraso no pagamento do tributo.
Tamanho: 7,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReceita: string
-
Valor do tributo pago constante da autenticação mecânica.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorTotal: string
-
Valor total do somatório do valor da receita + juro + multa.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoReceita": "string",
"codigoTipoPagamento": "1",
"dadosBancarios": {
"agenciaPagamento": "99999",
"bancoPagamento": "001",
"contaPagamento": "string"
},
"dataPagamento": "2020-01-01",
"nomeTipoPagamento": "string",
"numeroRetificacao": "99",
"valorJurosEncargos": "1234567.12",
"valorMulta": "1234567.12",
"valorReceita": "1234567890123.12",
"valorTotal": "1234567890123.12"
}
PisCofins: object
- baseCalculoAliquotaICMS: string
-
Valor tributável apurado de acordo com as normas de valoração aduaneira para o ICMS.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - baseCalculoFundamentoLegalNome: string
-
Nome do fundamento legal, conforme a tabela “Fundamentação Legal.
Tamanho mínimo: 1
Tamanho máximo: 60 - baseCalculoPercentualReducao: string
-
Percentual de redução aplicável sobre o valor do imposto devido.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - baseCalculoValor: string
-
Valor tributável apurado de acordo com as normas de valoração aduaneira.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - codigoBaseCalculoFundamentoLegal: string
-
Código do fundamento legal, conforme a tabela “Fundamentação Legal.
Tamanho: 2
Formato: "NN" - codigoFundamentoLegalReducao: string
-
Código do fundamento legal, conforme a tabela “Fundamentação Legal.
Tamanho: 2
Formato: "NN" - fundamentoLegalReducaoNome: string
-
Denominação do fundamento legal da reduçãoNome do fundamento legal, conforme a tabela “Fundamentação Legal.
Tamanho mínimo: 1
Tamanho máximo: 60 - regimeTributacaoCodigo: string
-
Código do regime de tributação, conforme a tabela “Regimes de Tributação”.
Tamanho: 1
Formato: "N" - regimeTributacaoNome: string
-
Nome do regime de tributação, conforme a tabela “Regimes de Tributação”.
Tamanho mínimo: 1
Tamanho máximo: 60
Exemplo
{
"baseCalculoAliquotaICMS": "1234567890123.12",
"baseCalculoFundamentoLegalNome": "string",
"baseCalculoPercentualReducao": "123.12",
"baseCalculoValor": "1234567890123.12",
"codigoBaseCalculoFundamentoLegal": "99",
"codigoFundamentoLegalReducao": "99",
"fundamentoLegalReducaoNome": "string",
"regimeTributacaoCodigo": "9",
"regimeTributacaoNome": "string"
}
PisPasep: object
- aliquotaAdValorem: string
-
Alíquota vigente, conforme a Tarifa Externa Comum (TEC).
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaQuantidadeUnidade: string
-
Quantidade de mercadoria expressa na unidade de medida estabelecida em ato legal.
Tamanho máximo: 9
Formato: Inteiro, com até 9 dígitos. - aliquotaEspecificaUnidadeMedida: string
-
Unidade de medida estabelecida em ato legal para a mercadoria.
Tamanho mínimo: 1
Tamanho máximo: 15 - aliquotaEspecificaValor: string
-
Valor, em real, por unidade de medida a ser aplicado sobre a base de cálculo.
Tamanho: 5,5
Formato: Decimal, com até 5 casas decimais separadas por ponto. - aliquotaEspecificaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição .
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaEspecificaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaReduzida: string
-
Alíquota “ad valorem” reduzida incidente sobre a base de cálculo do imposto.
Tamanho: 3,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorDevido: string
-
Valor do imposto calculado com base na alíquota indicada na adição.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - aliquotaValorRecolher: string
-
Imposto a ser recolhido.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"aliquotaAdValorem": "123.12",
"aliquotaEspecificaQuantidadeUnidade": "123456789",
"aliquotaEspecificaUnidadeMedida": "string",
"aliquotaEspecificaValor": "12345.12345",
"aliquotaEspecificaValorDevido": "1234567890123.12",
"aliquotaEspecificaValorRecolher": "1234567890123.12",
"aliquotaReduzida": "123.12",
"aliquotaValorDevido": "1234567890123.12",
"aliquotaValorRecolher": "1234567890123.12"
}
Processo: object
- identificacaoProcesso: string
-
Número identificador do processo.
Tamanho mínimo: 1
Tamanho máximo: 20 - tipoProcesso: string PROCESSO_ADMINISTRATIVO, PROCESSO_JUDICIAL, DECLARACAO_PRELIMINAR, JUDICIAL_EXCLUSIVO_DARF
-
Indicação do tipo de processo
Exemplo
{
"identificacaoProcesso": "string",
"tipoProcesso": "string"
}
RepresentanteLegal: object
- cpf: string
-
Número de inscrição no cadastro de pessoas físicas (CPF).
Tamanho: 11
Formato: "NNNNNNNNNNN" - nome: string
-
Nome completo do representante.
Tamanho mínimo: 1
Tamanho máximo: 60
Exemplo
{
"cpf": "00000000191",
"nome": "string"
}
Seguro: object
- codigoMoedaNegociada: string
-
Código da moeda negociada, conforme a tabela "Moedas".
Tamanho: "3"
Formato: "NNN" - valorSeguroTotalMoedaNegociada: string
-
Valor do prêmio de seguro, expresso na moeda negociada.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorTotalDolares: string
-
Valor do prêmio de seguro, expresso em dólar do EUA.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorTotalReais: string
-
Valor do prêmio de seguro, expresso em Real.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoMoedaNegociada": "220",
"valorSeguroTotalMoedaNegociada": "1234567890123.12",
"valorTotalDolares": "1234567890123.12",
"valorTotalReais": "1234567890123.12"
}
SeguroCarga: object
- codigoMoedaNegociada: string
-
Moeda utilizada para negociação do seguro.
Tamanho: 3
Formato: "NNN" - valorMoedaNegociada: string
-
Valor do seguro na moeda negociada.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReais: string
-
Valor do seguro em reais.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - valorReaisSeguroInternacional: string
-
Valor do seguro total em reais.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"codigoMoedaNegociada": "999",
"valorMoedaNegociada": "1234567890123.12",
"valorReais": "1234567890123.12",
"valorReaisSeguroInternacional": "1234567890123.12"
}
Transporte: object
- codigoViaTransporte: string
-
Meio utilizado no transporte internacional da carga. Informação obrigatória nos casos de declaração de importação de mercadorias que procedam diretamente do exterior e nas nacionalizações de mercadorias em regime de admissão temporária, de entreposto aduaneiro e de EIZOF.
Tamanho: 2
Formato: "NN" - codigoViaTransportePaisTransportador: string
-
Código da via de transporte, conforme a tabela "Vias de Transporte".
Tamanho: 2
Formato: NN - indicadorViaTransporteMultimodal: string
-
Indicativo da utilização de mais de uma via, de acordo com o conhecimento de transporte internacional.
Tamanho:1
Domínio:
S - Houve Transporte Intermodal
N - Não houve transporte Intermodal ou nas internações de ZFM e ALC - nomeTransportador: string
-
Razão social do transportador.
Tamanho mínimo: 1
Tamanho máximo: 60 - nomeVeiculo: string
-
Nome de identificação do veículo que realizou o transporte internacional da carga.
Tamanho mínimo: 1
Tamanho máximo: 30 - numeroVeiculo: string
-
Número de identificação do veículo que realizou o transporte internacional da carga.
Tamanho mínimo: 1
Tamanho máximo: 15
Exemplo
{
"codigoViaTransporte": "99",
"codigoViaTransportePaisTransportador": "01",
"indicadorViaTransporteMultimodal": "S",
"nomeTransportador": "string",
"nomeVeiculo": "string",
"numeroVeiculo": "string"
}
ValorMercadoriaDescarga: object
- totalDolares: string
-
Valor total das mercadorias no local de desembarque, expresso em dólar dos EUA.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - totalReais: string
-
Valor total das mercadorias no local de desembarque, expresso em reais.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"totalDolares": "1234567890123.12",
"totalReais": "1234567890123.12"
}
ValorMercadoriaEmbarque: object
- totalDolares: string
-
Valor total das mercadorias no local de embarque, expresso em dólar dos EUA.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto. - totalReais: string
-
Valor total das mercadorias no local de embarque, expresso em Reais.
Tamanho: 13,2
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Exemplo
{
"totalDolares": "1234567890123.12",
"totalReais": "1234567890123.22"
}