Tamanho: 20
Formato: AAAAAAAAAAAAAAAAAAAA") + /** + * Número do contêiner que será desunitizado
Tamanho: 20
Formato: AAAAAAAAAAAAAAAAAAAA + **/ + private String numeroConteiner = null; + + @XmlElement(name = "documentos", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Documentos documentos = null; + + /** + * Número do contêiner que será desunitizado<br>Tamanho: 20<br>Formato: AAAAAAAAAAAAAAAAAAAA + * + * @return numeroConteiner + **/ + @JsonProperty("numeroConteiner") + @NotNull + public String getNumeroConteiner() { + return numeroConteiner; + } + + public void setNumeroConteiner(String numeroConteiner) { + this.numeroConteiner = numeroConteiner; + } + + public Desunitizacao numeroConteiner(String numeroConteiner) { + this.numeroConteiner = numeroConteiner; + return this; + } + + /** + * Get documentos + * + * @return documentos + **/ + @JsonProperty("documentos") + @NotNull + public Documentos getDocumentos() { + return documentos; + } + + public void setDocumentos(Documentos documentos) { + this.documentos = documentos; + } + + public Desunitizacao documentos(Documentos documentos) { + this.documentos = documentos; + return this; + } + + + @Override + public String toString() { + + String sb = "class Desunitizacao {\n" + + " numeroConteiner: " + toIndentedString(numeroConteiner) + "\n" + + " documentos: " + toIndentedString(documentos) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Desunitizacoes.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Desunitizacoes.java new file mode 100644 index 0000000..66caca7 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Desunitizacoes.java @@ -0,0 +1,83 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.util.ArrayList; +import java.util.List; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "Desunitizacoes", propOrder = + {"desunitizacao" + }) + +@XmlRootElement(name = "Desunitizacoes") +/** + * Lista das desunitizações + **/ +@ApiModel(description = "Lista das desunitizações") +public class Desunitizacoes { + + @XmlElement(name = "desunitizacao", required = true) + @ApiModelProperty(required = true, value = "Lista das desunitizações") + @Valid + /** + * Lista das desunitizações + **/ + private List
Para Desunitização, pelo menos 1 tipo (Carga Solta, Granel ou Veículo) é obrigatório.
Para Recepção e Entrega, os 3 tipos são opcionais. + **/ +@ApiModel(description = "Documento de carga de importação envolvido na entrega (DUIMP)
Para Desunitização, pelo menos 1 tipo (Carga Solta, Granel ou Veículo) é obrigatório.
Para Recepção e Entrega, os 3 tipos são opcionais.") +public class Documento { + + @XmlElement(name = "numeroDUIMP", required = true) + @ApiModelProperty(example = "24BR00001058587", required = true, value = "Número da DUIMP
Tamanho: 14
Formato: AABRSSSSSSSSSD
Descrição Formato
AA - Ano
BR - Brasil
SSSSSSSSS - Numeração sequencial
D - DV") + /** + * Número da DUIMP
Tamanho: 14
Formato: AABRSSSSSSSSSD
Descrição Formato
AA - Ano
BR - Brasil
SSSSSSSSS - Numeração sequencial
D - DV + **/ + private String numeroDUIMP = null; + + @XmlElement(name = "cargaSolta") + @ApiModelProperty(value = "") + @Valid + private CargaSolta cargaSolta = null; + + @XmlElement(name = "granel") + @ApiModelProperty(value = "") + @Valid + private Granel granel = null; + + @XmlElement(name = "veiculo") + @ApiModelProperty(value = "") + @Valid + private Veiculos veiculo = null; + + /** + * Número da DUIMP<br>Tamanho: 14<br>Formato: AABRSSSSSSSSSD <br>Descrição Formato<br>AA - Ano<br>BR - Brasil<br>SSSSSSSSS - Numeração sequencial<br>D - DV + * + * @return numeroDUIMP + **/ + @JsonProperty("numeroDUIMP") + @NotNull + public String getNumeroDUIMP() { + return numeroDUIMP; + } + + public void setNumeroDUIMP(String numeroDUIMP) { + this.numeroDUIMP = numeroDUIMP; + } + + public Documento numeroDUIMP(String numeroDUIMP) { + this.numeroDUIMP = numeroDUIMP; + return this; + } + + /** + * Get cargaSolta + * + * @return cargaSolta + **/ + @JsonProperty("cargaSolta") + public CargaSolta getCargaSolta() { + return cargaSolta; + } + + public void setCargaSolta(CargaSolta cargaSolta) { + this.cargaSolta = cargaSolta; + } + + public Documento cargaSolta(CargaSolta cargaSolta) { + this.cargaSolta = cargaSolta; + return this; + } + + /** + * Get granel + * + * @return granel + **/ + @JsonProperty("granel") + public Granel getGranel() { + return granel; + } + + public void setGranel(Granel granel) { + this.granel = granel; + } + + public Documento granel(Granel granel) { + this.granel = granel; + return this; + } + + /** + * Get veiculo + * + * @return veiculo + **/ + @JsonProperty("veiculo") + public Veiculos getVeiculo() { + return veiculo; + } + + public void setVeiculo(Veiculos veiculo) { + this.veiculo = veiculo; + } + + public Documento veiculo(Veiculos veiculo) { + this.veiculo = veiculo; + return this; + } + + + @Override + public String toString() { + + String sb = "class Documento {\n" + + " numeroDUIMP: " + toIndentedString(numeroDUIMP) + "\n" + + " cargaSolta: " + toIndentedString(cargaSolta) + "\n" + + " granel: " + toIndentedString(granel) + "\n" + + " veiculo: " + toIndentedString(veiculo) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Documentos.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Documentos.java new file mode 100644 index 0000000..adf4892 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Documentos.java @@ -0,0 +1,83 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.util.ArrayList; +import java.util.List; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "Documentos", propOrder = + {"documento" + }) + +@XmlRootElement(name = "Documentos") +/** + * Documentos de carga de importação envolvidos na entrega (DUIMP) + **/ +@ApiModel(description = "Documentos de carga de importação envolvidos na entrega (DUIMP)") +public class Documentos { + + @XmlElement(name = "documento", required = true) + @ApiModelProperty(required = true, value = "Documentos de carga de importação envolvidos na entrega (DUIMP)") + @Valid + /** + * Documentos de carga de importação envolvidos na entrega (DUIMP) + **/ + private List
Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada entrega no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.") + /** + * Identificação da Entrega
Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada entrega no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas. + **/ + private String identificacaoEntrega = null; + + @XmlElement(name = "identificacaoPessoaJuridica", required = true) + @ApiModelProperty(example = "15573459000106", required = true, value = "CNPJ do responsável pela Entrega
Tamanho: 14
Formato: NNNNNNNNNNNNNN") + /** + * CNPJ do responsável pela Entrega
Tamanho: 14
Formato: NNNNNNNNNNNNNN + **/ + private String identificacaoPessoaJuridica = null; + + @XmlElement(name = "local", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Local local = null; + + @XmlElement(name = "documentos", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Documentos documentos = null; + + @XmlElement(name = "recebedor", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Recebedor recebedor = null; + + @XmlElement(name = "observacoes") + @ApiModelProperty(value = "Dados do interveniente que está recebendo a carga") + /** + * Dados do interveniente que está recebendo a carga + **/ + private String observacoes = null; + + /** + * Identificação da Entrega<br>Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada entrega no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas. + * + * @return identificacaoEntrega + **/ + @JsonProperty("identificacaoEntrega") + @NotNull + public String getIdentificacaoEntrega() { + return identificacaoEntrega; + } + + public void setIdentificacaoEntrega(String identificacaoEntrega) { + this.identificacaoEntrega = identificacaoEntrega; + } + + public EntregaDocumentoCarga identificacaoEntrega(String identificacaoEntrega) { + this.identificacaoEntrega = identificacaoEntrega; + return this; + } + + /** + * CNPJ do responsável pela Entrega<br>Tamanho: 14<br>Formato: NNNNNNNNNNNNNN + * + * @return identificacaoPessoaJuridica + **/ + @JsonProperty("identificacaoPessoaJuridica") + @NotNull + public String getIdentificacaoPessoaJuridica() { + return identificacaoPessoaJuridica; + } + + public void setIdentificacaoPessoaJuridica(String identificacaoPessoaJuridica) { + this.identificacaoPessoaJuridica = identificacaoPessoaJuridica; + } + + public EntregaDocumentoCarga identificacaoPessoaJuridica(String identificacaoPessoaJuridica) { + this.identificacaoPessoaJuridica = identificacaoPessoaJuridica; + return this; + } + + /** + * Get local + * + * @return local + **/ + @JsonProperty("local") + @NotNull + public Local getLocal() { + return local; + } + + public void setLocal(Local local) { + this.local = local; + } + + public EntregaDocumentoCarga local(Local local) { + this.local = local; + return this; + } + + /** + * Get documentos + * + * @return documentos + **/ + @JsonProperty("documentos") + @NotNull + public Documentos getDocumentos() { + return documentos; + } + + public void setDocumentos(Documentos documentos) { + this.documentos = documentos; + } + + public EntregaDocumentoCarga documentos(Documentos documentos) { + this.documentos = documentos; + return this; + } + + /** + * Get recebedor + * + * @return recebedor + **/ + @JsonProperty("recebedor") + @NotNull + public Recebedor getRecebedor() { + return recebedor; + } + + public void setRecebedor(Recebedor recebedor) { + this.recebedor = recebedor; + } + + public EntregaDocumentoCarga recebedor(Recebedor recebedor) { + this.recebedor = recebedor; + return this; + } + + /** + * Dados do interveniente que está recebendo a carga + * + * @return observacoes + **/ + @JsonProperty("observacoes") + public String getObservacoes() { + return observacoes; + } + + public void setObservacoes(String observacoes) { + this.observacoes = observacoes; + } + + public EntregaDocumentoCarga observacoes(String observacoes) { + this.observacoes = observacoes; + return this; + } + + + @Override + public String toString() { + + String sb = "class EntregaDocumentoCarga {\n" + + " identificacaoEntrega: " + toIndentedString(identificacaoEntrega) + "\n" + + " identificacaoPessoaJuridica: " + toIndentedString(identificacaoPessoaJuridica) + "\n" + + " local: " + toIndentedString(local) + "\n" + + " documentos: " + toIndentedString(documentos) + "\n" + + " recebedor: " + toIndentedString(recebedor) + "\n" + + " observacoes: " + toIndentedString(observacoes) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Entregador.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Entregador.java new file mode 100644 index 0000000..c64e986 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Entregador.java @@ -0,0 +1,126 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "Entregador", propOrder = + {"cnpj", "cpf", "nomeEstrangeiro" + }) + +@XmlRootElement(name = "Entregador") +/** + * Dados do Entregador
É obrigatório informar apenas um dos dois: CNPJ ou CPF. + **/ +@ApiModel(description = "Dados do Entregador
É obrigatório informar apenas um dos dois: CNPJ ou CPF.") +public class Entregador { + + @XmlElement(name = "cnpj") + @ApiModelProperty(example = "99999999999999", value = "CNPJ do entregador
Tamanho: 14
Formato: NNNNNNNNNNNNNN
Informado apenas quando o entregador for nacional e pessoa jurídica.") + /** + * CNPJ do entregador
Tamanho: 14
Formato: NNNNNNNNNNNNNN
Informado apenas quando o entregador for nacional e pessoa jurídica. + **/ + private String cnpj = null; + + @XmlElement(name = "cpf") + @ApiModelProperty(example = "99999999999", value = "CPF do entregador
Tamanho: 11
Formato: NNNNNNNNNNN
Informado apenas quando o recebedor for nacional e pessoa física.") + /** + * CPF do entregador
Tamanho: 11
Formato: NNNNNNNNNNN
Informado apenas quando o recebedor for nacional e pessoa física. + **/ + private String cpf = null; + + @XmlElement(name = "nomeEstrangeiro") + @ApiModelProperty(example = "Nome do entregador", value = "Nome do entregador
Tamanho: 60") + /** + * Nome do entregador
Tamanho: 60 + **/ + private String nomeEstrangeiro = null; + + /** + * CNPJ do entregador<br>Tamanho: 14<br>Formato: NNNNNNNNNNNNNN<br>Informado apenas quando o entregador for nacional e pessoa jurídica. + * + * @return cnpj + **/ + @JsonProperty("cnpj") + public String getCnpj() { + return cnpj; + } + + public void setCnpj(String cnpj) { + this.cnpj = cnpj; + } + + public Entregador cnpj(String cnpj) { + this.cnpj = cnpj; + return this; + } + + /** + * CPF do entregador<br>Tamanho: 11<br><br>Formato: NNNNNNNNNNN<br>Informado apenas quando o recebedor for nacional e pessoa física. + * + * @return cpf + **/ + @JsonProperty("cpf") + public String getCpf() { + return cpf; + } + + public void setCpf(String cpf) { + this.cpf = cpf; + } + + public Entregador cpf(String cpf) { + this.cpf = cpf; + return this; + } + + /** + * Nome do entregador<br>Tamanho: 60 + * + * @return nomeEstrangeiro + **/ + @JsonProperty("nomeEstrangeiro") + public String getNomeEstrangeiro() { + return nomeEstrangeiro; + } + + public void setNomeEstrangeiro(String nomeEstrangeiro) { + this.nomeEstrangeiro = nomeEstrangeiro; + } + + public Entregador nomeEstrangeiro(String nomeEstrangeiro) { + this.nomeEstrangeiro = nomeEstrangeiro; + return this; + } + + + @Override + public String toString() { + + String sb = "class Entregador {\n" + + " cnpj: " + toIndentedString(cnpj) + "\n" + + " cpf: " + toIndentedString(cpf) + "\n" + + " nomeEstrangeiro: " + toIndentedString(nomeEstrangeiro) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/EntregasDocumentoCarga.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/EntregasDocumentoCarga.java new file mode 100644 index 0000000..8c44284 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/EntregasDocumentoCarga.java @@ -0,0 +1,83 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.util.ArrayList; +import java.util.List; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "EntregasDocumentoCarga", propOrder = + {"entregaDocumentoCarga" + }) + +@XmlRootElement(name = "EntregasDocumentoCarga") +/** + * Entregas por Documento de Carga de Importação
Máximo de ocorrências: 1 + **/ +@ApiModel(description = "Entregas por Documento de Carga de Importação
Máximo de ocorrências: 1") +public class EntregasDocumentoCarga { + + @XmlElement(name = "entregaDocumentoCarga", required = true) + @ApiModelProperty(required = true, value = "Entrega por Documento de Carga de Importacao") + @Valid + /** + * Entrega por Documento de Carga de Importacao + **/ + private List
Tamanho: 7
Formato: NNNNNNN
Domínio: Tabela de Unidades da RFB de Despacho") + /** + * Código da Unidade da Receita Federal de Despacho
Tamanho: 7
Formato: NNNNNNN
Domínio: Tabela de Unidades da RFB de Despacho + **/ + private String codigoURF = null; + + @XmlElement(name = "codigoRA", required = true) + @ApiModelProperty(example = "8911101", required = true, value = "Código do Recinto Alfandegado
Tamanho: 7
Formato: NNNNNNN
Domínio: Tabela de Recintos Alfandegados.
Deve ser informado somente quando o atributo coordenadas não for informado.") + /** + * Código do Recinto Alfandegado
Tamanho: 7
Formato: NNNNNNN
Domínio: Tabela de Recintos Alfandegados.
Deve ser informado somente quando o atributo coordenadas não for informado. + **/ + private String codigoRA = null; + + /** + * Código da Unidade da Receita Federal de Despacho<br>Tamanho: 7<br>Formato: NNNNNNN<br>Domínio: Tabela de Unidades da RFB de Despacho + * + * @return codigoURF + **/ + @JsonProperty("codigoURF") + @NotNull + public String getCodigoURF() { + return codigoURF; + } + + public void setCodigoURF(String codigoURF) { + this.codigoURF = codigoURF; + } + + public Local codigoURF(String codigoURF) { + this.codigoURF = codigoURF; + return this; + } + + /** + * Código do Recinto Alfandegado<br>Tamanho: 7<br>Formato: NNNNNNN<br>Domínio: Tabela de Recintos Alfandegados.<br>Deve ser informado somente quando o atributo coordenadas não for informado. + * + * @return codigoRA + **/ + @JsonProperty("codigoRA") + @NotNull + public String getCodigoRA() { + return codigoRA; + } + + public void setCodigoRA(String codigoRA) { + this.codigoRA = codigoRA; + } + + public Local codigoRA(String codigoRA) { + this.codigoRA = codigoRA; + return this; + } + + + @Override + public String toString() { + + String sb = "class Local {\n" + + " codigoURF: " + toIndentedString(codigoURF) + "\n" + + " codigoRA: " + toIndentedString(codigoRA) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/LocalDTO.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/LocalDTO.java new file mode 100644 index 0000000..e8e1715 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/LocalDTO.java @@ -0,0 +1,175 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "LocalDTO", propOrder = + {"urf", "recinto", "latitude", "longitude", "responsavel" + }) + +@XmlRootElement(name = "LocalDTO") +/** + * Dados que descrevem o local da carga + **/ +@ApiModel(description = "Dados que descrevem o local da carga") +public class LocalDTO { + + @XmlElement(name = "urf") + @ApiModelProperty(value = "") + @Valid + private UrfDTO urf = null; + + @XmlElement(name = "recinto") + @ApiModelProperty(value = "") + @Valid + private RecintoDTO recinto = null; + + @XmlElement(name = "latitude") + @ApiModelProperty(example = "-20.812222", value = "Latitude") + /** + * Latitude + **/ + private String latitude = null; + + @XmlElement(name = "longitude") + @ApiModelProperty(example = "-40.248333", value = "Longitude") + /** + * Longitude + **/ + private String longitude = null; + + @XmlElement(name = "responsavel") + @ApiModelProperty(value = "") + @Valid + private ResponsavelEstoqueDTO responsavel = null; + + /** + * Get urf + * + * @return urf + **/ + @JsonProperty("urf") + public UrfDTO getUrf() { + return urf; + } + + public void setUrf(UrfDTO urf) { + this.urf = urf; + } + + public LocalDTO urf(UrfDTO urf) { + this.urf = urf; + return this; + } + + /** + * Get recinto + * + * @return recinto + **/ + @JsonProperty("recinto") + public RecintoDTO getRecinto() { + return recinto; + } + + public void setRecinto(RecintoDTO recinto) { + this.recinto = recinto; + } + + public LocalDTO recinto(RecintoDTO recinto) { + this.recinto = recinto; + return this; + } + + /** + * Latitude + * + * @return latitude + **/ + @JsonProperty("latitude") + public String getLatitude() { + return latitude; + } + + public void setLatitude(String latitude) { + this.latitude = latitude; + } + + public LocalDTO latitude(String latitude) { + this.latitude = latitude; + return this; + } + + /** + * Longitude + * + * @return longitude + **/ + @JsonProperty("longitude") + public String getLongitude() { + return longitude; + } + + public void setLongitude(String longitude) { + this.longitude = longitude; + } + + public LocalDTO longitude(String longitude) { + this.longitude = longitude; + return this; + } + + /** + * Get responsavel + * + * @return responsavel + **/ + @JsonProperty("responsavel") + public ResponsavelEstoqueDTO getResponsavel() { + return responsavel; + } + + public void setResponsavel(ResponsavelEstoqueDTO responsavel) { + this.responsavel = responsavel; + } + + public LocalDTO responsavel(ResponsavelEstoqueDTO responsavel) { + this.responsavel = responsavel; + return this; + } + + + @Override + public String toString() { + + String sb = "class LocalDTO {\n" + + " urf: " + toIndentedString(urf) + "\n" + + " recinto: " + toIndentedString(recinto) + "\n" + + " latitude: " + toIndentedString(latitude) + "\n" + + " longitude: " + toIndentedString(longitude) + "\n" + + " responsavel: " + toIndentedString(responsavel) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/MensagemErro.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/MensagemErro.java new file mode 100644 index 0000000..17c0109 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/MensagemErro.java @@ -0,0 +1,94 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "MensagemErro", propOrder = + {"codigo", "mensagem" + }) + +@XmlRootElement(name = "MensagemErro") +public class MensagemErro { + + @XmlElement(name = "codigo") + @ApiModelProperty(example = "CCTR-ER0001", value = "Código da mensagem") + /** + * Código da mensagem + **/ + private String codigo = null; + + @XmlElement(name = "mensagem") + @ApiModelProperty(example = "Ação não permitida", value = "Descrição da mensagem") + /** + * Descrição da mensagem + **/ + private String mensagem = null; + + /** + * Código da mensagem + * + * @return codigo + **/ + @JsonProperty("codigo") + public String getCodigo() { + return codigo; + } + + public void setCodigo(String codigo) { + this.codigo = codigo; + } + + public MensagemErro codigo(String codigo) { + this.codigo = codigo; + return this; + } + + /** + * Descrição da mensagem + * + * @return mensagem + **/ + @JsonProperty("mensagem") + public String getMensagem() { + return mensagem; + } + + public void setMensagem(String mensagem) { + this.mensagem = mensagem; + } + + public MensagemErro mensagem(String mensagem) { + this.mensagem = mensagem; + return this; + } + + + @Override + public String toString() { + + String sb = "class MensagemErro {\n" + + " codigo: " + toIndentedString(codigo) + "\n" + + " mensagem: " + toIndentedString(mensagem) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/MensagemServico.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/MensagemServico.java new file mode 100644 index 0000000..e8aef6b --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/MensagemServico.java @@ -0,0 +1,160 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "MensagemServico", propOrder = + {"idOperacao", "msgxsd", "numero", "codigoErro", "mensagem" + }) + +@XmlRootElement(name = "MensagemServico") +public class MensagemServico { + + @XmlElement(name = "idOperacao") + @ApiModelProperty(value = "") + private String idOperacao = null; + + @XmlElement(name = "msgxsd") + @ApiModelProperty(value = "") + private String msgxsd = null; + + @XmlElement(name = "numero") + @ApiModelProperty(value = "") + private String numero = null; + + @XmlElement(name = "codigoErro") + @ApiModelProperty(value = "") + private String codigoErro = null; + + @XmlElement(name = "mensagem") + @ApiModelProperty(value = "") + private String mensagem = null; + + /** + * Get idOperacao + * + * @return idOperacao + **/ + @JsonProperty("idOperacao") + public String getIdOperacao() { + return idOperacao; + } + + public void setIdOperacao(String idOperacao) { + this.idOperacao = idOperacao; + } + + public MensagemServico idOperacao(String idOperacao) { + this.idOperacao = idOperacao; + return this; + } + + /** + * Get msgxsd + * + * @return msgxsd + **/ + @JsonProperty("msgxsd") + public String getMsgxsd() { + return msgxsd; + } + + public void setMsgxsd(String msgxsd) { + this.msgxsd = msgxsd; + } + + public MensagemServico msgxsd(String msgxsd) { + this.msgxsd = msgxsd; + return this; + } + + /** + * Get numero + * + * @return numero + **/ + @JsonProperty("numero") + public String getNumero() { + return numero; + } + + public void setNumero(String numero) { + this.numero = numero; + } + + public MensagemServico numero(String numero) { + this.numero = numero; + return this; + } + + /** + * Get codigoErro + * + * @return codigoErro + **/ + @JsonProperty("codigoErro") + public String getCodigoErro() { + return codigoErro; + } + + public void setCodigoErro(String codigoErro) { + this.codigoErro = codigoErro; + } + + public MensagemServico codigoErro(String codigoErro) { + this.codigoErro = codigoErro; + return this; + } + + /** + * Get mensagem + * + * @return mensagem + **/ + @JsonProperty("mensagem") + public String getMensagem() { + return mensagem; + } + + public void setMensagem(String mensagem) { + this.mensagem = mensagem; + } + + public MensagemServico mensagem(String mensagem) { + this.mensagem = mensagem; + return this; + } + + + @Override + public String toString() { + + String sb = "class MensagemServico {\n" + + " idOperacao: " + toIndentedString(idOperacao) + "\n" + + " msgxsd: " + toIndentedString(msgxsd) + "\n" + + " numero: " + toIndentedString(numero) + "\n" + + " codigoErro: " + toIndentedString(codigoErro) + "\n" + + " mensagem: " + toIndentedString(mensagem) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Operacao.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Operacao.java new file mode 100644 index 0000000..59b9ce8 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Operacao.java @@ -0,0 +1,96 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.util.List; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "Operacao", propOrder = + {"id", "listaMensagem" + }) + +@XmlRootElement(name = "Operacao") +public class Operacao { + + @XmlElement(name = "id") + @ApiModelProperty(value = "") + private String id = null; + + @XmlElement(name = "listaMensagem") + @ApiModelProperty(value = "") + @Valid + private List
Máximo de ocorrências: 1 + **/ +@ApiModel(description = "Desunitização de carga
Máximo de ocorrências: 1") +public class OperacaoDesunitizacao { + + @XmlElement(name = "identificacaoResponsavelDesunitizacao", required = true) + @ApiModelProperty(example = "27657485000147", required = true, value = "CNPJ do responsável pela Desunitização
Tamanho: 14
Formato: NNNNNNNNNNNNNN") + /** + * CNPJ do responsável pela Desunitização
Tamanho: 14
Formato: NNNNNNNNNNNNNN + **/ + private String identificacaoResponsavelDesunitizacao = null; + + @XmlElement(name = "local", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Local local = null; + + @XmlElement(name = "desunitizacoes", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Desunitizacoes desunitizacoes = null; + + /** + * CNPJ do responsável pela Desunitização<br>Tamanho: 14<br>Formato: NNNNNNNNNNNNNN + * + * @return identificacaoResponsavelDesunitizacao + **/ + @JsonProperty("identificacaoResponsavelDesunitizacao") + @NotNull + public String getIdentificacaoResponsavelDesunitizacao() { + return identificacaoResponsavelDesunitizacao; + } + + public void setIdentificacaoResponsavelDesunitizacao(String identificacaoResponsavelDesunitizacao) { + this.identificacaoResponsavelDesunitizacao = identificacaoResponsavelDesunitizacao; + } + + public OperacaoDesunitizacao identificacaoResponsavelDesunitizacao(String identificacaoResponsavelDesunitizacao) { + this.identificacaoResponsavelDesunitizacao = identificacaoResponsavelDesunitizacao; + return this; + } + + /** + * Get local + * + * @return local + **/ + @JsonProperty("local") + @NotNull + public Local getLocal() { + return local; + } + + public void setLocal(Local local) { + this.local = local; + } + + public OperacaoDesunitizacao local(Local local) { + this.local = local; + return this; + } + + /** + * Get desunitizacoes + * + * @return desunitizacoes + **/ + @JsonProperty("desunitizacoes") + @NotNull + public Desunitizacoes getDesunitizacoes() { + return desunitizacoes; + } + + public void setDesunitizacoes(Desunitizacoes desunitizacoes) { + this.desunitizacoes = desunitizacoes; + } + + public OperacaoDesunitizacao desunitizacoes(Desunitizacoes desunitizacoes) { + this.desunitizacoes = desunitizacoes; + return this; + } + + + @Override + public String toString() { + + String sb = "class OperacaoDesunitizacao {\n" + + " identificacaoResponsavelDesunitizacao: " + toIndentedString(identificacaoResponsavelDesunitizacao) + "\n" + + " local: " + toIndentedString(local) + "\n" + + " desunitizacoes: " + toIndentedString(desunitizacoes) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Recebedor.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Recebedor.java new file mode 100644 index 0000000..e876532 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Recebedor.java @@ -0,0 +1,155 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "Recebedor", propOrder = + {"cnpj", "cpf", "nomeEstrangeiro", "viaTransporte" + }) + +@XmlRootElement(name = "Recebedor") +/** + * Dados do interveniente que está recebendo a carga.
É obrigatório informar apenas um dos dois: CNPJ ou CPF. + **/ +@ApiModel(description = "Dados do interveniente que está recebendo a carga.
É obrigatório informar apenas um dos dois: CNPJ ou CPF.") +public class Recebedor { + + @XmlElement(name = "cnpj") + @ApiModelProperty(example = "15573459000106", value = "CNPJ do recebedor
Tamanho: 14
Formato: NNNNNNNNNNNNNN
Informado apenas quando o recebedor for nacional e pessoa jurídica.") + /** + * CNPJ do recebedor
Tamanho: 14
Formato: NNNNNNNNNNNNNN
Informado apenas quando o recebedor for nacional e pessoa jurídica. + **/ + private String cnpj = null; + + @XmlElement(name = "cpf") + @ApiModelProperty(example = "15573459106", value = "CPF do recebedor
Tamanho: 11
Formato: NNNNNNNNNNN
Informado apenas quando o recebedor for nacional e pessoa física.") + /** + * CPF do recebedor
Tamanho: 11
Formato: NNNNNNNNNNN
Informado apenas quando o recebedor for nacional e pessoa física. + **/ + private String cpf = null; + + @XmlElement(name = "nomeEstrangeiro") + @ApiModelProperty(example = "Nome Estrangeiro", value = "Nome do recebedor
Tamanho: 60
Informado apenas quando o recebedor for estrangeiro.") + /** + * Nome do recebedor
Tamanho: 60
Informado apenas quando o recebedor for estrangeiro. + **/ + private String nomeEstrangeiro = null; + + @XmlElement(name = "viaTransporte", required = true) + @ApiModelProperty(example = "1", required = true, value = "Código da via de transporte
Tamanho: 2
Formato: NN") + /** + * Código da via de transporte
Tamanho: 2
Formato: NN + **/ + private Integer viaTransporte = null; + + /** + * CNPJ do recebedor<br>Tamanho: 14<br>Formato: NNNNNNNNNNNNNN<br>Informado apenas quando o recebedor for nacional e pessoa jurídica. + * + * @return cnpj + **/ + @JsonProperty("cnpj") + public String getCnpj() { + return cnpj; + } + + public void setCnpj(String cnpj) { + this.cnpj = cnpj; + } + + public Recebedor cnpj(String cnpj) { + this.cnpj = cnpj; + return this; + } + + /** + * CPF do recebedor<br>Tamanho: 11<br>Formato: NNNNNNNNNNN<br>Informado apenas quando o recebedor for nacional e pessoa física. + * + * @return cpf + **/ + @JsonProperty("cpf") + public String getCpf() { + return cpf; + } + + public void setCpf(String cpf) { + this.cpf = cpf; + } + + public Recebedor cpf(String cpf) { + this.cpf = cpf; + return this; + } + + /** + * Nome do recebedor<br>Tamanho: 60<br>Informado apenas quando o recebedor for estrangeiro. + * + * @return nomeEstrangeiro + **/ + @JsonProperty("nomeEstrangeiro") + public String getNomeEstrangeiro() { + return nomeEstrangeiro; + } + + public void setNomeEstrangeiro(String nomeEstrangeiro) { + this.nomeEstrangeiro = nomeEstrangeiro; + } + + public Recebedor nomeEstrangeiro(String nomeEstrangeiro) { + this.nomeEstrangeiro = nomeEstrangeiro; + return this; + } + + /** + * Código da via de transporte<br>Tamanho: 2<br>Formato: NN + * + * @return viaTransporte + **/ + @JsonProperty("viaTransporte") + @NotNull + public Integer getViaTransporte() { + return viaTransporte; + } + + public void setViaTransporte(Integer viaTransporte) { + this.viaTransporte = viaTransporte; + } + + public Recebedor viaTransporte(Integer viaTransporte) { + this.viaTransporte = viaTransporte; + return this; + } + + + @Override + public String toString() { + + String sb = "class Recebedor {\n" + + " cnpj: " + toIndentedString(cnpj) + "\n" + + " cpf: " + toIndentedString(cpf) + "\n" + + " nomeEstrangeiro: " + toIndentedString(nomeEstrangeiro) + "\n" + + " viaTransporte: " + toIndentedString(viaTransporte) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/RecepcaoDocumentoCarga.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/RecepcaoDocumentoCarga.java new file mode 100644 index 0000000..4ee40c4 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/RecepcaoDocumentoCarga.java @@ -0,0 +1,291 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.math.BigDecimal; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "RecepcaoDocumentoCarga", propOrder = + {"identificacaoRecepcao", "identificacaoPessoaJuridica", "local", "documentos", "entregador", "pesoAferido", "motivoNaoPesagem", "localArmazenamento", "observacoes" + }) + +@XmlRootElement(name = "RecepcaoDocumentoCarga") +/** + * Recepção por Documento de Carga + **/ +@ApiModel(description = "Recepção por Documento de Carga ") +public class RecepcaoDocumentoCarga { + + @XmlElement(name = "identificacaoRecepcao", required = true) + @ApiModelProperty(example = "REC001", required = true, value = "Identificação da Recepção
Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas.") + /** + * Identificação da Recepção
Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas. + **/ + private String identificacaoRecepcao = null; + + @XmlElement(name = "identificacaoPessoaJuridica", required = true) + @ApiModelProperty(example = "07396865000168", required = true, value = "CNPJ do responsável pela recepção
Tamanho: 14
Formato: NNNNNNNNNNNNNN") + /** + * CNPJ do responsável pela recepção
Tamanho: 14
Formato: NNNNNNNNNNNNNN + **/ + private String identificacaoPessoaJuridica = null; + + @XmlElement(name = "local", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Local local = null; + + @XmlElement(name = "documentos", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Documentos documentos = null; + + @XmlElement(name = "entregador", required = true) + @ApiModelProperty(required = true, value = "") + @Valid + private Entregador entregador = null; + + @XmlElement(name = "pesoAferido") + @ApiModelProperty(value = "Peso aferido na balança do recinto em Kg
Tamanho: 12.3
Formato: NNNNNNNNNNNN.NNN
Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório.") + @Valid + /** + * Peso aferido na balança do recinto em Kg
Tamanho: 12.3
Formato: NNNNNNNNNNNN.NNN
Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório. + **/ + private BigDecimal pesoAferido = null; + + @XmlElement(name = "motivoNaoPesagem") + @ApiModelProperty(example = "Motivo da não realização da pesagem", value = "Motivo da não realização da pesagem
Tamanho: 250
Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório.") + /** + * Motivo da não realização da pesagem
Tamanho: 250
Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório. + **/ + private String motivoNaoPesagem = null; + + @XmlElement(name = "localArmazenamento") + @ApiModelProperty(value = "Local de armazenamento da carga
Tamanho: 150") + /** + * Local de armazenamento da carga
Tamanho: 150 + **/ + private String localArmazenamento = null; + + @XmlElement(name = "observacoes") + @ApiModelProperty(example = "Observações gerais", value = "Observações gerais
Tamanho: 250") + /** + * Observações gerais
Tamanho: 250 + **/ + private String observacoes = null; + + /** + * Identificação da Recepção<br>Esta informação não será armazenada pelo sistema, servindo apenas como uma identificação de cada recepção no momento da exibição de eventuais mensagens de erro. Este campo não admite duplicatas. + * + * @return identificacaoRecepcao + **/ + @JsonProperty("identificacaoRecepcao") + @NotNull + public String getIdentificacaoRecepcao() { + return identificacaoRecepcao; + } + + public void setIdentificacaoRecepcao(String identificacaoRecepcao) { + this.identificacaoRecepcao = identificacaoRecepcao; + } + + public RecepcaoDocumentoCarga identificacaoRecepcao(String identificacaoRecepcao) { + this.identificacaoRecepcao = identificacaoRecepcao; + return this; + } + + /** + * CNPJ do responsável pela recepção<br>Tamanho: 14<br>Formato: NNNNNNNNNNNNNN + * + * @return identificacaoPessoaJuridica + **/ + @JsonProperty("identificacaoPessoaJuridica") + @NotNull + public String getIdentificacaoPessoaJuridica() { + return identificacaoPessoaJuridica; + } + + public void setIdentificacaoPessoaJuridica(String identificacaoPessoaJuridica) { + this.identificacaoPessoaJuridica = identificacaoPessoaJuridica; + } + + public RecepcaoDocumentoCarga identificacaoPessoaJuridica(String identificacaoPessoaJuridica) { + this.identificacaoPessoaJuridica = identificacaoPessoaJuridica; + return this; + } + + /** + * Get local + * + * @return local + **/ + @JsonProperty("local") + @NotNull + public Local getLocal() { + return local; + } + + public void setLocal(Local local) { + this.local = local; + } + + public RecepcaoDocumentoCarga local(Local local) { + this.local = local; + return this; + } + + /** + * Get documentos + * + * @return documentos + **/ + @JsonProperty("documentos") + @NotNull + public Documentos getDocumentos() { + return documentos; + } + + public void setDocumentos(Documentos documentos) { + this.documentos = documentos; + } + + public RecepcaoDocumentoCarga documentos(Documentos documentos) { + this.documentos = documentos; + return this; + } + + /** + * Get entregador + * + * @return entregador + **/ + @JsonProperty("entregador") + @NotNull + public Entregador getEntregador() { + return entregador; + } + + public void setEntregador(Entregador entregador) { + this.entregador = entregador; + } + + public RecepcaoDocumentoCarga entregador(Entregador entregador) { + this.entregador = entregador; + return this; + } + + /** + * Peso aferido na balança do recinto em Kg<br>Tamanho: 12.3<br>Formato: NNNNNNNNNNNN.NNN<br>Deve ser informado somente quando há informação de pesagem. Neste caso, é obrigatório. + * + * @return pesoAferido + **/ + @JsonProperty("pesoAferido") + public BigDecimal getPesoAferido() { + return pesoAferido; + } + + public void setPesoAferido(BigDecimal pesoAferido) { + this.pesoAferido = pesoAferido; + } + + public RecepcaoDocumentoCarga pesoAferido(BigDecimal pesoAferido) { + this.pesoAferido = pesoAferido; + return this; + } + + /** + * Motivo da não realização da pesagem<br>Tamanho: 250<br>Deve ser informado somente quando não há informação de pesagem. Neste caso, é obrigatório. + * + * @return motivoNaoPesagem + **/ + @JsonProperty("motivoNaoPesagem") + public String getMotivoNaoPesagem() { + return motivoNaoPesagem; + } + + public void setMotivoNaoPesagem(String motivoNaoPesagem) { + this.motivoNaoPesagem = motivoNaoPesagem; + } + + public RecepcaoDocumentoCarga motivoNaoPesagem(String motivoNaoPesagem) { + this.motivoNaoPesagem = motivoNaoPesagem; + return this; + } + + /** + * Local de armazenamento da carga<br>Tamanho: 150 + * + * @return localArmazenamento + **/ + @JsonProperty("localArmazenamento") + public String getLocalArmazenamento() { + return localArmazenamento; + } + + public void setLocalArmazenamento(String localArmazenamento) { + this.localArmazenamento = localArmazenamento; + } + + public RecepcaoDocumentoCarga localArmazenamento(String localArmazenamento) { + this.localArmazenamento = localArmazenamento; + return this; + } + + /** + * Observações gerais<br>Tamanho: 250 + * + * @return observacoes + **/ + @JsonProperty("observacoes") + public String getObservacoes() { + return observacoes; + } + + public void setObservacoes(String observacoes) { + this.observacoes = observacoes; + } + + public RecepcaoDocumentoCarga observacoes(String observacoes) { + this.observacoes = observacoes; + return this; + } + + + @Override + public String toString() { + + String sb = "class RecepcaoDocumentoCarga {\n" + + " identificacaoRecepcao: " + toIndentedString(identificacaoRecepcao) + "\n" + + " identificacaoPessoaJuridica: " + toIndentedString(identificacaoPessoaJuridica) + "\n" + + " local: " + toIndentedString(local) + "\n" + + " documentos: " + toIndentedString(documentos) + "\n" + + " entregador: " + toIndentedString(entregador) + "\n" + + " pesoAferido: " + toIndentedString(pesoAferido) + "\n" + + " motivoNaoPesagem: " + toIndentedString(motivoNaoPesagem) + "\n" + + " localArmazenamento: " + toIndentedString(localArmazenamento) + "\n" + + " observacoes: " + toIndentedString(observacoes) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/RecepcoesDocumentoCarga.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/RecepcoesDocumentoCarga.java new file mode 100644 index 0000000..4ebc76b --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/RecepcoesDocumentoCarga.java @@ -0,0 +1,83 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.util.ArrayList; +import java.util.List; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "RecepcoesDocumentoCarga", propOrder = + {"recepcaoDocumentoCarga" + }) + +@XmlRootElement(name = "RecepcoesDocumentoCarga") +/** + * Recepções por Documento de Carga
Máximo de ocorrências: 1 + **/ +@ApiModel(description = "Recepções por Documento de Carga
Máximo de ocorrências: 1") +public class RecepcoesDocumentoCarga { + + @XmlElement(name = "recepcaoDocumentoCarga", required = true) + @ApiModelProperty(required = true, value = "Lista de recepções por Documento de Carga") + @Valid + /** + * Lista de recepções por Documento de Carga + **/ + private List
Tamanho: 2
Formato: NN") + /** + * Tipo de embalagem conforme a tabela Tipo de Embalagem.
Tamanho: 2
Formato: NN + **/ + private Integer tipoEmbalagem = null; + + @XmlElement(name = "quantidade") + @ApiModelProperty(example = "9999", value = "Quantidade de embalagens deste tipo.
Tamanho: 4
Formato: NNNNN") + /** + * Quantidade de embalagens deste tipo.
Tamanho: 4
Formato: NNNNN + **/ + private Integer quantidade = null; + + /** + * Tipo de embalagem conforme a tabela Tipo de Embalagem.<br>Tamanho: 2<br>Formato: NN + * + * @return tipoEmbalagem + **/ + @JsonProperty("tipoEmbalagem") + @NotNull + public Integer getTipoEmbalagem() { + return tipoEmbalagem; + } + + public void setTipoEmbalagem(Integer tipoEmbalagem) { + this.tipoEmbalagem = tipoEmbalagem; + } + + public TCargaSolta tipoEmbalagem(Integer tipoEmbalagem) { + this.tipoEmbalagem = tipoEmbalagem; + return this; + } + + /** + * Quantidade de embalagens deste tipo.<br>Tamanho: 4<br>Formato: NNNNN + * + * @return quantidade + **/ + @JsonProperty("quantidade") + public Integer getQuantidade() { + return quantidade; + } + + public void setQuantidade(Integer quantidade) { + this.quantidade = quantidade; + } + + public TCargaSolta quantidade(Integer quantidade) { + this.quantidade = quantidade; + return this; + } + + + @Override + public String toString() { + + String sb = "class TCargaSolta {\n" + + " tipoEmbalagem: " + toIndentedString(tipoEmbalagem) + "\n" + + " quantidade: " + toIndentedString(quantidade) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TGranel.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TGranel.java new file mode 100644 index 0000000..74a2dda --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TGranel.java @@ -0,0 +1,177 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlEnum; +import javax.xml.bind.annotation.XmlEnumValue; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.math.BigDecimal; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "TGranel", propOrder = + {"tipoGranel", "unidademedida", "quantidade" + }) + +@XmlRootElement(name = "TGranel") +/** + * Dados informados para carga do tipo granel + **/ +@ApiModel(description = "Dados informados para carga do tipo granel") +public class TGranel { + + @XmlElement(name = "tipoGranel", required = true) + @ApiModelProperty(example = "19", required = true, value = "Tipo de granel conforme a tabela Tipo de Granel
Tamanho: 2
Formato: NN") + /** + * Tipo de granel conforme a tabela Tipo de Granel
Tamanho: 2
Formato: NN + **/ + private Integer tipoGranel = null; + + + @XmlType(name = "UnidademedidaEnum") + @XmlEnum(String.class) + public enum UnidademedidaEnum { + + @XmlEnumValue("KG") + @JsonProperty("KG") + KG("KG"), + + @XmlEnumValue("M_3") + @JsonProperty("M_3") + M_3("M_3"); + + + private final String value; + + UnidademedidaEnum(String v) { + value = v; + } + + public String value() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static UnidademedidaEnum fromValue(String v) { + for (UnidademedidaEnum b : UnidademedidaEnum.values()) { + if (String.valueOf(b.value).equals(v)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + v + "' to UnidademedidaEnum"); + } + } + + @XmlElement(name = "unidademedida", required = true) + @ApiModelProperty(example = "kg", required = true, value = "Unidade de medida estatística
Tamanho: 4
Formato: AAAA
Domínio: kg = quilo e m3 = metro cúbico.") + /** + * Unidade de medida estatística
Tamanho: 4
Formato: AAAA
Domínio: kg = quilo e m3 = metro cúbico. + **/ + private UnidademedidaEnum unidademedida = null; + + @XmlElement(name = "quantidade", required = true) + @ApiModelProperty(example = "123.456", required = true, value = "Peso bruto
Tamanho: 12.3
Formato: NNNNNNNNNNNN.NNN") + @Valid + /** + * Peso bruto
Tamanho: 12.3
Formato: NNNNNNNNNNNN.NNN + **/ + private BigDecimal quantidade = null; + + /** + * Tipo de granel conforme a tabela Tipo de Granel<br>Tamanho: 2<br>Formato: NN + * + * @return tipoGranel + **/ + @JsonProperty("tipoGranel") + @NotNull + public Integer getTipoGranel() { + return tipoGranel; + } + + public void setTipoGranel(Integer tipoGranel) { + this.tipoGranel = tipoGranel; + } + + public TGranel tipoGranel(Integer tipoGranel) { + this.tipoGranel = tipoGranel; + return this; + } + + /** + * Unidade de medida estatística<br>Tamanho: 4<br>Formato: AAAA<br>Domínio: kg = quilo e m3 = metro cúbico. + * + * @return unidademedida + **/ + @JsonProperty("unidademedida") + @NotNull + public String getUnidademedida() { + if (unidademedida == null) { + return null; + } + return unidademedida.value(); + } + + public void setUnidademedida(UnidademedidaEnum unidademedida) { + this.unidademedida = unidademedida; + } + + public TGranel unidademedida(UnidademedidaEnum unidademedida) { + this.unidademedida = unidademedida; + return this; + } + + /** + * Peso bruto<br>Tamanho: 12.3<br>Formato: NNNNNNNNNNNN.NNN + * + * @return quantidade + **/ + @JsonProperty("quantidade") + @NotNull + public BigDecimal getQuantidade() { + return quantidade; + } + + public void setQuantidade(BigDecimal quantidade) { + this.quantidade = quantidade; + } + + public TGranel quantidade(BigDecimal quantidade) { + this.quantidade = quantidade; + return this; + } + + + @Override + public String toString() { + + String sb = "class TGranel {\n" + + " tipoGranel: " + toIndentedString(tipoGranel) + "\n" + + " unidademedida: " + toIndentedString(unidademedida) + "\n" + + " quantidade: " + toIndentedString(quantidade) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TVeiculo.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TVeiculo.java new file mode 100644 index 0000000..1b9dfae --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TVeiculo.java @@ -0,0 +1,74 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "TVeiculo", propOrder = + {"chassi" + }) + +@XmlRootElement(name = "TVeiculo") +/** + * Dados informados para carga do tipo veículo + **/ +@ApiModel(description = "Dados informados para carga do tipo veículo") +public class TVeiculo { + + @XmlElement(name = "chassi", required = true) + @ApiModelProperty(example = "9BWZZZ377VT004251", required = true, value = "Chassi do veículo
Tamanho: 20") + /** + * Chassi do veículo
Tamanho: 20 + **/ + private String chassi = null; + + /** + * Chassi do veículo<br>Tamanho: 20 + * + * @return chassi + **/ + @JsonProperty("chassi") + @NotNull + public String getChassi() { + return chassi; + } + + public void setChassi(String chassi) { + this.chassi = chassi; + } + + public TVeiculo chassi(String chassi) { + this.chassi = chassi; + return this; + } + + + @Override + public String toString() { + + String sb = "class TVeiculo {\n" + + " chassi: " + toIndentedString(chassi) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TerceiroDTO.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TerceiroDTO.java new file mode 100644 index 0000000..2aa767f --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/TerceiroDTO.java @@ -0,0 +1,99 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "TerceiroDTO", propOrder = + {"identificacao", "nome" + }) + +@XmlRootElement(name = "TerceiroDTO") +/** + * Dados de terceiro declarado na Duimp + **/ +@ApiModel(description = "Dados de terceiro declarado na Duimp") +public class TerceiroDTO { + + @XmlElement(name = "identificacao") + @ApiModelProperty(example = "64854252000160", value = "Número de identificação") + /** + * Número de identificação + **/ + private String identificacao = null; + + @XmlElement(name = "nome") + @ApiModelProperty(example = "NOME DE EXEMPLO DO TERCEIRO", value = "Nome do terceiro") + /** + * Nome do terceiro + **/ + private String nome = null; + + /** + * Número de identificação + * + * @return identificacao + **/ + @JsonProperty("identificacao") + public String getIdentificacao() { + return identificacao; + } + + public void setIdentificacao(String identificacao) { + this.identificacao = identificacao; + } + + public TerceiroDTO identificacao(String identificacao) { + this.identificacao = identificacao; + return this; + } + + /** + * Nome do terceiro + * + * @return nome + **/ + @JsonProperty("nome") + public String getNome() { + return nome; + } + + public void setNome(String nome) { + this.nome = nome; + } + + public TerceiroDTO nome(String nome) { + this.nome = nome; + return this; + } + + + @Override + public String toString() { + + String sb = "class TerceiroDTO {\n" + + " identificacao: " + toIndentedString(identificacao) + "\n" + + " nome: " + toIndentedString(nome) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/UnexpectedExceptionCover.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/UnexpectedExceptionCover.java new file mode 100644 index 0000000..6e85fb1 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/UnexpectedExceptionCover.java @@ -0,0 +1,303 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlEnum; +import javax.xml.bind.annotation.XmlEnumValue; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "UnexpectedExceptionCover", propOrder = + {"message", "code", "field", "path", "tag", "date", "severity", "info" + }) + +@XmlRootElement(name = "UnexpectedExceptionCover") +public class UnexpectedExceptionCover { + + @XmlElement(name = "message") + @ApiModelProperty(example = "Ocorreu um erro inesperado. Por favor, tente novamente. Se o problema persistir, acione a Central Serpro de Atendimento anexando todo o conteúdo do response.", value = "Mensagem descritiva do erro") + /** + * Mensagem descritiva do erro + **/ + private String message = null; + + @XmlElement(name = "code") + @ApiModelProperty(example = "PUCX-ER0001", value = "Código do erro") + /** + * Código do erro + **/ + private String code = null; + + @XmlElement(name = "field") + @ApiModelProperty(value = "Não aplicável neste contexto de negócio") + /** + * Não aplicável neste contexto de negócio + **/ + private String field = null; + + @XmlElement(name = "path") + @ApiModelProperty(value = "Não aplicável neste contexto de negócio") + /** + * Não aplicável neste contexto de negócio + **/ + private String path = null; + + @XmlElement(name = "tag") + @ApiModelProperty(example = "[CCTR-AWCEGJ2248]", value = "Identificador único do erro") + /** + * Identificador único do erro + **/ + private String tag = null; + + @XmlElement(name = "date") + @ApiModelProperty(example = "2024-08-16T16:43:52", value = "Data e hora do erro") + /** + * Data e hora do erro + **/ + private String date = null; + + + @XmlType(name = "SeverityEnum") + @XmlEnum(String.class) + public enum SeverityEnum { + + @XmlEnumValue("ERROR") + @JsonProperty("ERROR") + ERROR("ERROR"), + + @XmlEnumValue("ALERT") + @JsonProperty("ALERT") + ALERT("ALERT"), + + @XmlEnumValue("INFO") + @JsonProperty("INFO") + INFO("INFO"); + + + private final String value; + + SeverityEnum(String v) { + value = v; + } + + public String value() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static SeverityEnum fromValue(String v) { + for (SeverityEnum b : SeverityEnum.values()) { + if (String.valueOf(b.value).equals(v)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + v + "' to SeverityEnum"); + } + } + + @XmlElement(name = "severity") + @ApiModelProperty(example = "ERROR", value = "Severidade da falha") + /** + * Severidade da falha + **/ + private SeverityEnum severity = null; + + @XmlElement(name = "info") + @ApiModelProperty(value = "") + @Valid + private DiagnosticInfo info = null; + + /** + * Mensagem descritiva do erro + * + * @return message + **/ + @JsonProperty("message") + public String getMessage() { + return message; + } + + public void setMessage(String message) { + this.message = message; + } + + public UnexpectedExceptionCover message(String message) { + this.message = message; + return this; + } + + /** + * Código do erro + * + * @return code + **/ + @JsonProperty("code") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public UnexpectedExceptionCover code(String code) { + this.code = code; + return this; + } + + /** + * Não aplicável neste contexto de negócio + * + * @return field + **/ + @JsonProperty("field") + public String getField() { + return field; + } + + public void setField(String field) { + this.field = field; + } + + public UnexpectedExceptionCover field(String field) { + this.field = field; + return this; + } + + /** + * Não aplicável neste contexto de negócio + * + * @return path + **/ + @JsonProperty("path") + public String getPath() { + return path; + } + + public void setPath(String path) { + this.path = path; + } + + public UnexpectedExceptionCover path(String path) { + this.path = path; + return this; + } + + /** + * Identificador único do erro + * + * @return tag + **/ + @JsonProperty("tag") + public String getTag() { + return tag; + } + + public void setTag(String tag) { + this.tag = tag; + } + + public UnexpectedExceptionCover tag(String tag) { + this.tag = tag; + return this; + } + + /** + * Data e hora do erro + * + * @return date + **/ + @JsonProperty("date") + public String getDate() { + return date; + } + + public void setDate(String date) { + this.date = date; + } + + public UnexpectedExceptionCover date(String date) { + this.date = date; + return this; + } + + /** + * Severidade da falha + * + * @return severity + **/ + @JsonProperty("severity") + public String getSeverity() { + if (severity == null) { + return null; + } + return severity.value(); + } + + public void setSeverity(SeverityEnum severity) { + this.severity = severity; + } + + public UnexpectedExceptionCover severity(SeverityEnum severity) { + this.severity = severity; + return this; + } + + /** + * Get info + * + * @return info + **/ + @JsonProperty("info") + public DiagnosticInfo getInfo() { + return info; + } + + public void setInfo(DiagnosticInfo info) { + this.info = info; + } + + public UnexpectedExceptionCover info(DiagnosticInfo info) { + this.info = info; + return this; + } + + + @Override + public String toString() { + + String sb = "class UnexpectedExceptionCover {\n" + + " message: " + toIndentedString(message) + "\n" + + " code: " + toIndentedString(code) + "\n" + + " field: " + toIndentedString(field) + "\n" + + " path: " + toIndentedString(path) + "\n" + + " tag: " + toIndentedString(tag) + "\n" + + " date: " + toIndentedString(date) + "\n" + + " severity: " + toIndentedString(severity) + "\n" + + " info: " + toIndentedString(info) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/UrfDTO.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/UrfDTO.java new file mode 100644 index 0000000..b754e41 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/UrfDTO.java @@ -0,0 +1,94 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "UrfDTO", propOrder = + {"codigo", "descricao" + }) + +@XmlRootElement(name = "UrfDTO") +public class UrfDTO { + + @XmlElement(name = "codigo") + @ApiModelProperty(example = "0717600", value = "Código da Unidade da Receita Federal") + /** + * Código da Unidade da Receita Federal + **/ + private String codigo = null; + + @XmlElement(name = "descricao") + @ApiModelProperty(example = "PORTO DO RIO DE JANEIRO", value = "Descrição da Unidade da Receita Federal") + /** + * Descrição da Unidade da Receita Federal + **/ + private String descricao = null; + + /** + * Código da Unidade da Receita Federal + * + * @return codigo + **/ + @JsonProperty("codigo") + public String getCodigo() { + return codigo; + } + + public void setCodigo(String codigo) { + this.codigo = codigo; + } + + public UrfDTO codigo(String codigo) { + this.codigo = codigo; + return this; + } + + /** + * Descrição da Unidade da Receita Federal + * + * @return descricao + **/ + @JsonProperty("descricao") + public String getDescricao() { + return descricao; + } + + public void setDescricao(String descricao) { + this.descricao = descricao; + } + + public UrfDTO descricao(String descricao) { + this.descricao = descricao; + return this; + } + + + @Override + public String toString() { + + String sb = "class UrfDTO {\n" + + " codigo: " + toIndentedString(codigo) + "\n" + + " descricao: " + toIndentedString(descricao) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/VeiculoDetails.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/VeiculoDetails.java new file mode 100644 index 0000000..d5241db --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/VeiculoDetails.java @@ -0,0 +1,99 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "VeiculoDetails", propOrder = + {"chassi", "situacao" + }) + +@XmlRootElement(name = "VeiculoDetails") +/** + * Lista de veículos + **/ +@ApiModel(description = "Lista de veículos") +public class VeiculoDetails { + + @XmlElement(name = "chassi") + @ApiModelProperty(example = "CONT000001", value = "Número do chassi") + /** + * Número do chassi + **/ + private String chassi = null; + + @XmlElement(name = "situacao") + @ApiModelProperty(example = "Disponível", value = "Descrição da situação") + /** + * Descrição da situação + **/ + private String situacao = null; + + /** + * Número do chassi + * + * @return chassi + **/ + @JsonProperty("chassi") + public String getChassi() { + return chassi; + } + + public void setChassi(String chassi) { + this.chassi = chassi; + } + + public VeiculoDetails chassi(String chassi) { + this.chassi = chassi; + return this; + } + + /** + * Descrição da situação + * + * @return situacao + **/ + @JsonProperty("situacao") + public String getSituacao() { + return situacao; + } + + public void setSituacao(String situacao) { + this.situacao = situacao; + } + + public VeiculoDetails situacao(String situacao) { + this.situacao = situacao; + return this; + } + + + @Override + public String toString() { + + String sb = "class VeiculoDetails {\n" + + " chassi: " + toIndentedString(chassi) + "\n" + + " situacao: " + toIndentedString(situacao) + "\n" + + "}"; + return sb; + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} + diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Veiculos.java b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Veiculos.java new file mode 100644 index 0000000..055eb81 --- /dev/null +++ b/src/main/java/br/gov/siscomex/portalunico/cct_imp/model/Veiculos.java @@ -0,0 +1,83 @@ +package br.gov.siscomex.portalunico.cct_imp.model; + +import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlType; +import java.util.ArrayList; +import java.util.List; + +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "Veiculos", propOrder = + {"carga" + }) + +@XmlRootElement(name = "Veiculos") +/** + * Veículos envolvidos na operação + **/ +@ApiModel(description = "Veículos envolvidos na operação") +public class Veiculos { + + @XmlElement(name = "carga", required = true) + @ApiModelProperty(required = true, value = "Dados de veículo") + @Valid + /** + * Dados de veículo + **/ + private List
Introdução
Bem-vindo à Application Programming Interface (API) do sistema Pucomex - Controle de Cargas e Transito Exportação.
Sistema desenvolvido para simplificar o controle de carga e trânsito no processo de Exportação, dando uma única solução e um único fluxo para qualquer tipo de carga e qualquer modal de transporte. Facilita a organização e realização da recepção, consolidação, trânsito, entrega, carregamento e manifestação de cargas.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/cct/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Recepção Assíncrona de NFe\" a URI é \"api/ext/recepcao\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/cct/api/ext/recepcao
+ * */ @Path("/") @Api(value = "/", description = "") @@ -30,6 +31,7 @@ public interface RecepoAssncronaDeNfeApi { /** * Cria novo protocolo de recepção de NFe + * */ @POST @Path("/api/ext/recepcao") @@ -39,12 +41,13 @@ public interface RecepoAssncronaDeNfeApi { @ApiResponses(value = { @ApiResponse(code = 422, message = "Erro(s) de validação da camada de negócio", response = ErroValidacao.class), @ApiResponse(code = 400, message = "JSON não atende as especificações definidas na API", response = ErroValidacao.class), - @ApiResponse(code = 200, message = "Operação realizada com sucesso", response = String.class), - @ApiResponse(code = 500, message = "Erro interno no servidor", response = ExceptionCover.class)}) + @ApiResponse(code = 500, message = "Erro interno no servidor", response = ExceptionCover.class), + @ApiResponse(code = 200, message = "Operação realizada com sucesso", response = String.class)}) Response criarProtocolo(@ApiParam(value = "", required = true) @Valid RecepcaoNFECover body); /** * Consulta o extrato do protocolo de recepção NFe + * */ @GET @Path("/api/ext/recepcao/{numero}/extrato") @@ -58,6 +61,7 @@ public interface RecepoAssncronaDeNfeApi { /** * Consulta a situação atual do protocolo de recepção NFe + * */ @GET @Path("/api/ext/recepcao/{numero}/situacao") diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/DiagnosticInfo.java b/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/DiagnosticInfo.java index a1c998a..c5b1d81 100644 --- a/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/DiagnosticInfo.java +++ b/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/DiagnosticInfo.java @@ -165,7 +165,6 @@ public DiagnosticInfo url(String url) { /** * Get fluxo - * * @return fluxo **/ @JsonProperty("fluxo") diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/ExceptionCover.java b/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/ExceptionCover.java index b0f5b4c..700bb81 100644 --- a/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/ExceptionCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/ExceptionCover.java @@ -264,7 +264,6 @@ public ExceptionCover severity(SeverityEnum severity) { /** * Get info - * * @return info **/ @JsonProperty("info") diff --git a/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/IExceptionCover.java b/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/IExceptionCover.java index 39f692d..92472ee 100644 --- a/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/IExceptionCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/cct_rcar/model/IExceptionCover.java @@ -15,15 +15,24 @@ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "IExceptionCover", propOrder = - {"path", "severity", "info", "tag", "status", "date", "field", "message", "code", "detail" + {"info", "status", "date", "severity", "path", "tag", "code", "field", "message", "detail" }) @XmlRootElement(name = "IExceptionCover") public class IExceptionCover { - @XmlElement(name = "path") + @XmlElement(name = "info") @ApiModelProperty(value = "") - private String path = null; + @Valid + private DiagnosticInfo info = null; + + @XmlElement(name = "status") + @ApiModelProperty(value = "") + private Integer status = null; + + @XmlElement(name = "date") + @ApiModelProperty(value = "") + private String date = null; @XmlType(name = "SeverityEnum") @@ -72,22 +81,17 @@ public static SeverityEnum fromValue(String v) { @ApiModelProperty(value = "") private SeverityEnum severity = null; - @XmlElement(name = "info") + @XmlElement(name = "path") @ApiModelProperty(value = "") - @Valid - private DiagnosticInfo info = null; + private String path = null; @XmlElement(name = "tag") @ApiModelProperty(value = "") private String tag = null; - @XmlElement(name = "status") - @ApiModelProperty(value = "") - private Integer status = null; - - @XmlElement(name = "date") + @XmlElement(name = "code") @ApiModelProperty(value = "") - private String date = null; + private String code = null; @XmlElement(name = "field") @ApiModelProperty(value = "") @@ -97,31 +101,65 @@ public static SeverityEnum fromValue(String v) { @ApiModelProperty(value = "") private String message = null; - @XmlElement(name = "code") - @ApiModelProperty(value = "") - private String code = null; - @XmlElement(name = "detail") @ApiModelProperty(value = "") @Valid private ListManual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -28,8 +29,9 @@ public interface ServiosDeConsultaDeArquivosRecebidosApi { /** * Consultar Situação de Arquivos por Número de Protocolo - *+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Consulta, para um determinado número de protocolo, a situação atual do processamento do arquivo enviado. O número de protocolo é aquele gerado pelo sistema após o recebimento do arquivo, quando o mesmo passa pela validação do XSD da IATA.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">As situações podem ser:</p><ul><li><em>Received</em> – Aguardando processamento.</li><li><em>Processed</em> – Processamento realizado com sucesso, com gravação dos dados na base de dados.</li><li><em>Rejected</em> – Arquivo rejeitado por erro no processamento. Neste caso, a lista de erros encontrados é exibida.</li></ul> + * */ @GET @Path("/api/ext/check/received-files/{protocolNumber}") @@ -47,8 +49,9 @@ public interface ServiosDeConsultaDeArquivosRecebidosApi { /** * Consultar Situação de Arquivos por Data - *
+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Consulta, para uma determinada data, a lista de arquivos enviados que passaram pela validação do XSD da IATA, tendo número de protocolo gerado. O retorno traz a situação atual do processamento de cada arquivo.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">As situações podem ser:</p><ul><li><em>Received</em> – Aguardando processamento.</li><li><em>Processed</em> – Processamento realizado com sucesso, com gravação dos dados na base.</li><li><em>Rejected</em> – Arquivo rejeitado por erro no processamento. Neste caso, a lista de erros encontrados é exibida.</li></ul> + * */ @GET @Path("/api/ext/check/received-files") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeConhecimentoDeCargaApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeConhecimentoDeCargaApi.java index cddcb72..6581d4f 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeConhecimentoDeCargaApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeConhecimentoDeCargaApi.java @@ -20,6 +20,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -27,8 +28,9 @@ public interface ServiosDeConsultaDeConhecimentoDeCargaApi { /** * Retorna o detalhamento de um ou mais conhecimentos de carga. - *+ * * Retorna o detalhamento de um ou mais conhecimentos de carga. + * */ @GET @Path("/api/ext/conhecimentos") @@ -47,8 +49,9 @@ public interface ServiosDeConsultaDeConhecimentoDeCargaApi { /** * Retorna o resumo de um ou mais conhecimentos de carga ativos. - *
+ * * Retorna o resumo de um ou mais conhecimentos de carga ativos. + * */ @GET @Path("/api/ext/conhecimentos/resumo") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeDsicApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeDsicApi.java index dccb4d0..3611e01 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeDsicApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeDsicApi.java @@ -18,6 +18,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -25,8 +26,9 @@ public interface ServiosDeConsultaDeDsicApi { /** * Retorna o detalhamento de um DSIC. - *+ * * Retorna o detalhamento de um DSIC. + * */ @GET @Path("/api/ext/dsic/{numeroDsic}") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeProtocoloApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeProtocoloApi.java index 9453a99..dad7f46 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeProtocoloApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeProtocoloApi.java @@ -18,6 +18,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -25,8 +26,9 @@ public interface ServiosDeConsultaDeProtocoloApi { /** * Consultar a situação do processamento do protocolo. - *+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">A identificação da consulta é o número do protocolo gerado pelo sistema.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">As situações retornadas podem ser:</p><ul><li><em>EM_PROCESSAMENTO</em> – Aguardando processamento.</li><li><em>PROCESSADO</em> – Processamento realizado com sucesso.</li><li><em>REJEITADO</em> – Processamento rejeitado. Neste caso, a lista de erros encontrados é retornada no resultado.</li></ul> + * */ @GET @Path("/api/ext/protocolos/{numeroProtocolo}") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeViagemApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeViagemApi.java index d6abeac..97b0257 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeViagemApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeConsultaDeViagemApi.java @@ -21,6 +21,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -28,8 +29,9 @@ public interface ServiosDeConsultaDeViagemApi { /** * Retorna lista de viagens - *+ * * Lista de viagens + * */ @GET @Path("/api/ext/viagens/chegadas") @@ -48,8 +50,9 @@ public interface ServiosDeConsultaDeViagemApi { /** * Retorna lista de viagens - *
+ * * Lista de viagens + * */ @GET @Path("/api/ext/viagens/partidas") @@ -68,8 +71,9 @@ public interface ServiosDeConsultaDeViagemApi { /** * Retorna o detalhamento de uma viagem. - *
+ * * Retorna o detalhamento de uma viagem. + * */ @GET @Path("/api/ext/viagens/{numeroManifesto}") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaDaCargaApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaDaCargaApi.java index 7d6176a..9f66b93 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaDaCargaApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaDaCargaApi.java @@ -24,6 +24,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -31,8 +32,9 @@ public interface ServiosDeEntregaDaCargaApi { /** * Possibilitar a entrega da carga - *+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Esse serviço tem por objetivo possibilitar a entrega da carga para o destinatário final, através do conhecimento de carga/DSIC e do documento de saída vinculado ao mesmo. A entrega poderá ser realizada de forma total ou parcial.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">O processamento dessa entrega é realizado de forma assíncrona, sendo retornado apenas o número de protocolo para consulta posterior.</p> + * */ @POST @Path("/api/ext/entregas-carga") @@ -52,8 +54,9 @@ public interface ServiosDeEntregaDaCargaApi { /** * Consultar a lista de impedimentos e condições para realização da entrega da carga - *
+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Esse serviço tem por objetivo retornar a lista de impedimentos e condições para a realização da entrega da carga.</p> + * */ @GET @Path("/api/ext/entregas-carga/impedimentos") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaIntermediriaDaCargaApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaIntermediriaDaCargaApi.java index 4c9a2b5..b96b7ea 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaIntermediriaDaCargaApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/api/ServiosDeEntregaIntermediriaDaCargaApi.java @@ -20,6 +20,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
Serviços de Envio de Arquivos
API Envio de Arquivos
+ * */ @Path("/") @Api(value = "/", description = "") @@ -27,8 +28,9 @@ public interface ServiosDeEntregaIntermediriaDaCargaApi { /** * Possibilitar a entrega intermediária da carga - *+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Esse serviço tem por objetivo possibilitar a entrega intermediária da carga, através do conhecimento de carga/DSIC e do interveniente destinatário que pode ser:</p><ul><li>Cia. Aérea</li><li>Depositário</li><li>Transportador Terrestre</li><li>Operador Remessa Postal</li></ul> + * */ @POST @Path("/api/ext/entregas-intermediaria") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/CargaDetalheChegadaTerrestre.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/CargaDetalheChegadaTerrestre.java index ab9ca4c..68ed2a3 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/CargaDetalheChegadaTerrestre.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/CargaDetalheChegadaTerrestre.java @@ -409,7 +409,6 @@ public CargaDetalheChegadaTerrestre numeroDta(String numeroDta) { /** * Placa do veículo terrestre.<br/>Tamanho: 7<br/>Formato: AAANNNN ou AAANANN - * * @return placa **/ @JsonProperty("placa") @@ -428,7 +427,6 @@ public CargaDetalheChegadaTerrestre placa(String placa) { /** * Número do termo gerado no sistema Mantra<br/>Tamanho: 9<br/>Formato: NNNNNNNNN - * * @return termo **/ @JsonProperty("termo") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaDetalhada.java index 4067452..c6122c0 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaDetalhada.java @@ -906,7 +906,6 @@ public ConhecimentoConsultaDetalhada cidadeEmbarcadorEstrangeiro(String cidadeEm /** * CNPJ do Transportador (Cia Aérea) ou do Agente de Carga responsável pelo envio do arquivo Tamanho mínimo: 8 Tamanho máximo: 14 Formato: NNNNNNNNNNNNNN - * * @return cnpjResponsavelArquivo **/ @JsonProperty("cnpjResponsavelArquivo") @@ -1011,7 +1010,6 @@ public ConhecimentoConsultaDetalhada addContatosConsignatarioConhecimentoItem(Co /** * Lista de contatos do embarcador estrangeiro. - * * @return contatosEmbarcadorEstrangeiro **/ @JsonProperty("contatosEmbarcadorEstrangeiro") @@ -1035,7 +1033,6 @@ public ConhecimentoConsultaDetalhada addContatosEmbarcadorEstrangeiroItem(Contat /** * Data/Hora de emissão.<br/> Formato: yyyy-MM-dd'T'HH:mm:ssZ - * * @return dataEmissao **/ @JsonProperty("dataEmissao") @@ -1054,7 +1051,6 @@ public ConhecimentoConsultaDetalhada dataEmissao(String dataEmissao) { /** * Data/Hora de emissao do XFWB pelo transportador.<br/> Formato: yyyy-MM-dd'T'HH:mm:ssZ - * * @return dataHoraAssinaturaTransportador **/ @JsonProperty("dataHoraAssinaturaTransportador") @@ -1073,7 +1069,6 @@ public ConhecimentoConsultaDetalhada dataHoraAssinaturaTransportador(String data /** * Descrição resumida das mercadorias que estão sendo transportadas<br>Tamanho: 600<br/> - * * @return descricaoResumida **/ @JsonProperty("descricaoResumida") @@ -1092,7 +1087,6 @@ public ConhecimentoConsultaDetalhada descricaoResumida(String descricaoResumida) /** * Lista as divergências ativos da carga<br/> - * * @return divergencias **/ @JsonProperty("divergencias") @@ -1116,7 +1110,6 @@ public ConhecimentoConsultaDetalhada addDivergenciasItem(DivergenciaConsultaDeta /** * Lista contendo os documentos de saída associados a carga / Dsic<br/> - * * @return documentosSaida **/ @JsonProperty("documentosSaida") @@ -1140,7 +1133,6 @@ public ConhecimentoConsultaDetalhada addDocumentosSaidaItem(DocumentoSaidaConsul /** * Lista contendo os Dsics apropriados a carga<br/> - * * @return dsicsApropriados **/ @JsonProperty("dsicsApropriados") @@ -1164,7 +1156,6 @@ public ConhecimentoConsultaDetalhada addDsicsApropriadosItem(ChaveDsic dsicsApro /** * Endereco do agente de carga consolidador estrangeiro no conhecimento de carga<br/>Tamanho máximo: 70 - * * @return enderecoAgenteDeCargaConsolidadorEstrang **/ @JsonProperty("enderecoAgenteDeCargaConsolidadorEstrang") @@ -1183,7 +1174,6 @@ public ConhecimentoConsultaDetalhada enderecoAgenteDeCargaConsolidadorEstrang(St /** * Endereco do consignatário no conhecimento de carga<br/>Tamanho máximo: 70 - * * @return enderecoConsignatarioConhecimento **/ @JsonProperty("enderecoConsignatarioConhecimento") @@ -1202,7 +1192,6 @@ public ConhecimentoConsultaDetalhada enderecoConsignatarioConhecimento(String en /** * Endereco do embarcador estrangeiro no conhecimento de carga<br/>Tamanho máximo: 70 - * * @return enderecoEmbarcadorEstrangeiro **/ @JsonProperty("enderecoEmbarcadorEstrangeiro") @@ -1221,7 +1210,6 @@ public ConhecimentoConsultaDetalhada enderecoEmbarcadorEstrangeiro(String endere /** * Get frete - * * @return frete **/ @JsonProperty("frete") @@ -1240,7 +1228,6 @@ public ConhecimentoConsultaDetalhada frete(CargaDetalheFrete frete) { /** * Lista contendo as cargas HAWB<br/> - * * @return hawbAssociados **/ @JsonProperty("hawbAssociados") @@ -1264,7 +1251,6 @@ public ConhecimentoConsultaDetalhada addHawbAssociadosItem(HawbMawbAssociadoCons /** * Número do conhecimento<br/>Tamanho mínimo: 1<br/>Tamanho máximo: 35 - * * @return identificacao **/ @JsonProperty("identificacao") @@ -1283,7 +1269,6 @@ public ConhecimentoConsultaDetalhada identificacao(String identificacao) { /** * CNPJ do consignatário<br/>Tamanho: 14<br/> - * * @return identificacaoDocumentoConsignatario **/ @JsonProperty("identificacaoDocumentoConsignatario") @@ -1324,7 +1309,6 @@ public ConhecimentoConsultaDetalhada indicadorNaoRecepcaoHawbAssociados(Indicado /** * Indica a presença de partes de madeira<br/> S - Sim <br/>N - Não<br/> - * * @return indicadorPartesMadeira **/ @JsonProperty("indicadorPartesMadeira") @@ -1346,7 +1330,6 @@ public ConhecimentoConsultaDetalhada indicadorPartesMadeira(IndicadorPartesMadei /** * Lista contendo os itens de carga contidos na carga / Dsic<br/> - * * @return itensCarga **/ @JsonProperty("itensCarga") @@ -1370,7 +1353,6 @@ public ConhecimentoConsultaDetalhada addItensCargaItem(ItemCargaConhecimentoCons /** * Local de emissao do XFWB pelo transportador<br/>Tamanho: 35<br/> - * * @return localAssinaturaTransportador **/ @JsonProperty("localAssinaturaTransportador") @@ -1389,7 +1371,6 @@ public ConhecimentoConsultaDetalhada localAssinaturaTransportador(String localAs /** * Lista contendo os manuseios especiais para a carga / Dsic<br/> - * * @return manuseiosEspeciais **/ @JsonProperty("manuseiosEspeciais") @@ -1413,7 +1394,6 @@ public ConhecimentoConsultaDetalhada addManuseiosEspeciaisItem(InfoManuseioConsu /** * Lista contendo as cargas MAWB<br/> - * * @return mawbAwbAssociados **/ @JsonProperty("mawbAwbAssociados") @@ -1437,7 +1417,6 @@ public ConhecimentoConsultaDetalhada addMawbAwbAssociadosItem(MawbAssociadoConsu /** * Nome do agente de carga consolidador estrangeiro<br>Tamanho: 70<br/> - * * @return nomeAgenteDeCargaConsolidadorEstrang **/ @JsonProperty("nomeAgenteDeCargaConsolidadorEstrang") @@ -1456,7 +1435,6 @@ public ConhecimentoConsultaDetalhada nomeAgenteDeCargaConsolidadorEstrang(String /** * Nome do responsável pelo embarque<br>Tamanho: 70<br/> - * * @return nomeAssinaturaEmbarcadorEstrangeiro **/ @JsonProperty("nomeAssinaturaEmbarcadorEstrangeiro") @@ -1475,7 +1453,6 @@ public ConhecimentoConsultaDetalhada nomeAssinaturaEmbarcadorEstrangeiro(String /** * Assinatura transportador<br/>Tamanho: 35<br/> - * * @return nomeAssinaturaTransportador **/ @JsonProperty("nomeAssinaturaTransportador") @@ -1494,7 +1471,6 @@ public ConhecimentoConsultaDetalhada nomeAssinaturaTransportador(String nomeAssi /** * Nome do consignatário no conhecimento de carga<br/>Tamanho máximo: 70 - * * @return nomeConsignatarioConhecimento **/ @JsonProperty("nomeConsignatarioConhecimento") @@ -1513,7 +1489,6 @@ public ConhecimentoConsultaDetalhada nomeConsignatarioConhecimento(String nomeCo /** * Nome do consignatário no documento<br/>Tamanho máximo: 70 - * * @return nomeDocumentoConsignatario **/ @JsonProperty("nomeDocumentoConsignatario") @@ -1532,7 +1507,6 @@ public ConhecimentoConsultaDetalhada nomeDocumentoConsignatario(String nomeDocum /** * Nome do embarcador estrangeiro<br>Tamanho: 70<br/> - * * @return nomeEmbarcadorEstrangeiro **/ @JsonProperty("nomeEmbarcadorEstrangeiro") @@ -1551,7 +1525,6 @@ public ConhecimentoConsultaDetalhada nomeEmbarcadorEstrangeiro(String nomeEmbarc /** * Lista contendo as outras informações de serviço para a carga / Dsic<br/> - * * @return outrasInfosServico **/ @JsonProperty("outrasInfosServico") @@ -1575,7 +1548,6 @@ public ConhecimentoConsultaDetalhada addOutrasInfosServicoItem(InfoManuseioConsu /** * Lista das partes interessadas. - * * @return outrasPartesInteressadas **/ @JsonProperty("outrasPartesInteressadas") @@ -1599,7 +1571,6 @@ public ConhecimentoConsultaDetalhada addOutrasPartesInteressadasItem(ParteIntere /** * País do agente de carga consolidador estrangeiro no conhecimento de carga<br/>Tamanho máximo: 2<br/>Formato: AA - * * @return paisAgenteDeCargaConsolidadorEstrang **/ @JsonProperty("paisAgenteDeCargaConsolidadorEstrang") @@ -1618,7 +1589,6 @@ public ConhecimentoConsultaDetalhada paisAgenteDeCargaConsolidadorEstrang(String /** * País do consignatário no conhecimento de carga<br/>Tamanho máximo: 2<br/>Formato: AA - * * @return paisConsignatarioConhecimento **/ @JsonProperty("paisConsignatarioConhecimento") @@ -1637,7 +1607,6 @@ public ConhecimentoConsultaDetalhada paisConsignatarioConhecimento(String paisCo /** * País do embarcador estrangeiro no conhecimento de carga<br/>Tamanho máximo: 2<br/>Formato: AA - * * @return paisEmbarcadorEstrangeiro **/ @JsonProperty("paisEmbarcadorEstrangeiro") @@ -1656,7 +1625,6 @@ public ConhecimentoConsultaDetalhada paisEmbarcadorEstrangeiro(String paisEmbarc /** * Lista contendo as partes da carga<br/> - * * @return partesEstoque **/ @JsonProperty("partesEstoque") @@ -1680,7 +1648,6 @@ public ConhecimentoConsultaDetalhada addPartesEstoqueItem(EstoqueConsultaDetalha /** * Peso em Kg<br/>Tamanho: 7,3<br/>Formato: Decimal, com até 3 casas decimais separadas por ponto. - * * @return pesoBrutoConhecimento **/ @JsonProperty("pesoBrutoConhecimento") @@ -1699,7 +1666,6 @@ public ConhecimentoConsultaDetalhada pesoBrutoConhecimento(BigDecimal pesoBrutoC /** * Quantidade de volumes<br/>Tamanho: 4<br/>Formato: Inteiro, com até 4 digitos - * * @return quantidadeVolumesConhecimento **/ @JsonProperty("quantidadeVolumesConhecimento") @@ -1718,7 +1684,6 @@ public ConhecimentoConsultaDetalhada quantidadeVolumesConhecimento(Integer quant /** * Razão social do consignatário<br/>Tamanho máximo: 70 - * * @return razaoSocialDocumentoConsignatario **/ @JsonProperty("razaoSocialDocumentoConsignatario") @@ -1737,7 +1702,6 @@ public ConhecimentoConsultaDetalhada razaoSocialDocumentoConsignatario(String ra /** * Lista de recepções com avarias agrupadas por recinto aduaneiro<br/> - * * @return recepcoesComAvarias **/ @JsonProperty("recepcoesComAvarias") @@ -1761,7 +1725,6 @@ public ConhecimentoConsultaDetalhada addRecepcoesComAvariasItem(RecepcaoComAvari /** * Código do Recinto Aduaneiro.<br/>Tamanho: 7<br/> Formato: inteiro com até 7 dígitos - * * @return recintoAduaneiroDestino **/ @JsonProperty("recintoAduaneiroDestino") @@ -1780,7 +1743,6 @@ public ConhecimentoConsultaDetalhada recintoAduaneiroDestino(String recintoAduan /** * Número único de referencia da carga que atende à recomendação da Organização Mundial de Aduanas (OMA) para a Unique Consignment Reference (UCR). Utilizado para o rastreamento de uma carga, servindo para o controle da armazenagem e movimentação da carga<br>Tamanho: 32 - * * @return ruc **/ @JsonProperty("ruc") @@ -1799,7 +1761,6 @@ public ConhecimentoConsultaDetalhada ruc(String ruc) { /** * Código da situação do Conhecimento<br>Tamanho: 1<br/>A - Ativo <br/>E - Excluído<br/> - * * @return situacao **/ @JsonProperty("situacao") @@ -1821,7 +1782,6 @@ public ConhecimentoConsultaDetalhada situacao(SituacaoEnum situacao) { /** * Lista contendo as solicitações de serviços especiaos para a carga / Dsic<br/> - * * @return solicitacoesServicosEspeciais **/ @JsonProperty("solicitacoesServicosEspeciais") @@ -1845,7 +1805,6 @@ public ConhecimentoConsultaDetalhada addSolicitacoesServicosEspeciaisItem(InfoMa /** * Tipo de carga. - * * @return tipo **/ @JsonProperty("tipo") @@ -1889,7 +1848,6 @@ public ConhecimentoConsultaDetalhada tipoDocumentoConsignatario(TipoDocumentoCon /** * Lista contendo as viagens as quais a carga / Dsic está associada<br/> - * * @return viagensAssociadas **/ @JsonProperty("viagensAssociadas") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaResumida.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaResumida.java index eb27a79..8aab662 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaResumida.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ConhecimentoConsultaResumida.java @@ -412,7 +412,6 @@ public ConhecimentoConsultaResumida quantidadeVolumesConhecimento(Integer quanti /** * Lista de recepções com avarias agrupadas por recinto aduaneiro<br/> - * * @return recepcoesComAvarias **/ @JsonProperty("recepcoesComAvarias") @@ -436,7 +435,6 @@ public ConhecimentoConsultaResumida addRecepcoesComAvariasItem(RecepcaoComAvaria /** * Número único de referencia da carga que atende à recomendação da Organização Mundial de Aduanas (OMA) para a Unique Consignment Reference (UCR). Utilizado para o rastreamento de uma carga, servindo para o controle da armazenagem e movimentação da carga<br>Tamanho: 32 - * * @return ruc **/ @JsonProperty("ruc") @@ -455,7 +453,6 @@ public ConhecimentoConsultaResumida ruc(String ruc) { /** * Tipo de carga. - * * @return tipo **/ @JsonProperty("tipo") @@ -477,7 +474,6 @@ public ConhecimentoConsultaResumida tipo(TipoEnum tipo) { /** * Lista contendo as viagens às quais a carga está associada<br/> - * * @return viagensAssociadas **/ @JsonProperty("viagensAssociadas") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/DesbloqueioConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/DesbloqueioConsultaDetalhada.java index 543fd2f..4e867ed 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/DesbloqueioConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/DesbloqueioConsultaDetalhada.java @@ -278,7 +278,6 @@ public DesbloqueioConsultaDetalhada responsavelDesbloqueio(String responsavelDes /** * Tipo do bloqueio aplicado<br>Tamanho: 100<br/> - * * @return tipoBloqueio **/ @JsonProperty("tipoBloqueio") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/DocumentoSaidaConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/DocumentoSaidaConsultaDetalhada.java index f03d3da..dfa78bb 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/DocumentoSaidaConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/DocumentoSaidaConsultaDetalhada.java @@ -354,7 +354,6 @@ public DocumentoSaidaConsultaDetalhada uaDestinoDta(String uaDestinoDta) { /** * Versão da Duimp - * * @return versaoDuimp **/ @JsonProperty("versaoDuimp") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/DsicConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/DsicConsultaDetalhada.java index bab7f8a..cb4d653 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/DsicConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/DsicConsultaDetalhada.java @@ -798,7 +798,6 @@ public DsicConsultaDetalhada addDocumentosSaidaItem(DocumentoSaidaConsultaDetalh /** * Número do conhecimento<br/>Tamanho mínimo: 1<br/>Tamanho máximo: 35 - * * @return identificacaoConhecimento **/ @JsonProperty("identificacaoConhecimento") @@ -817,7 +816,6 @@ public DsicConsultaDetalhada identificacaoConhecimento(String identificacaoConhe /** * Número de identificação do DSIC<br/>Tamanho: 11<br/> Formato: ANNNNNNNNNN - * * @return identificacaoDSIC **/ @JsonProperty("identificacaoDSIC") @@ -855,7 +853,6 @@ public DsicConsultaDetalhada identificacaoDocumentoConsignatario(String identifi /** * Lista contendo os manuseios especiais para a carga / Dsic<br/> - * * @return manuseiosEspeciais **/ @JsonProperty("manuseiosEspeciais") @@ -879,7 +876,6 @@ public DsicConsultaDetalhada addManuseiosEspeciaisItem(InfoManuseioConsultaDetal /** * Motivo de geração do DSIC<br/>1 - Meios Próprios<br/>2 - Apreensão<br/>3 - Retenção<br/>4 - Descaracterização de Bagagem<br/>5 - Outros<br/> - * * @return motivo **/ @JsonProperty("motivo") @@ -901,7 +897,6 @@ public DsicConsultaDetalhada motivo(MotivoEnum motivo) { /** * Nome do consignatário<br/>Tamanho mínimo: 1<br/>Tamanho máximo: 40 - * * @return nomeConsignatario **/ @JsonProperty("nomeConsignatario") @@ -939,7 +934,6 @@ public DsicConsultaDetalhada nomeResponsavelGeracaoDsicDepositario(String nomeRe /** * Nome do passageiro<br/>Tamanho máximo: 40 - * * @return nomeViajante **/ @JsonProperty("nomeViajante") @@ -958,7 +952,6 @@ public DsicConsultaDetalhada nomeViajante(String nomeViajante) { /** * Número de autorização de sobrevoo DAC<br/>Tamanho: 15<br/>Formato: NNNNNNNNNNNNNNN - * * @return numeroAutorizacaoSobrevooDac **/ @JsonProperty("numeroAutorizacaoSobrevooDac") @@ -977,7 +970,6 @@ public DsicConsultaDetalhada numeroAutorizacaoSobrevooDac(String numeroAutorizac /** * Número do documento para retenção e apreensão<br/>Tamanho:15<br/>Formato: NNNNNNNNNNNNNNNN - * * @return numeroDocumentoRetencaoApreensao **/ @JsonProperty("numeroDocumentoRetencaoApreensao") @@ -996,7 +988,6 @@ public DsicConsultaDetalhada numeroDocumentoRetencaoApreensao(String numeroDocum /** * Número do documento do passageiro<br/>Tamanho máximo: 20 - * * @return numeroDocumentoViajante **/ @JsonProperty("numeroDocumentoViajante") @@ -1015,7 +1006,6 @@ public DsicConsultaDetalhada numeroDocumentoViajante(String numeroDocumentoViaja /** * Observação<br/>Tamanho máximo: 50 - * * @return observacoes **/ @JsonProperty("observacoes") @@ -1034,7 +1024,6 @@ public DsicConsultaDetalhada observacoes(String observacoes) { /** * Número do documento do passageiro<br/>Tamanho máximo: 30 - * * @return orgaoEmissorDocumentoViajante **/ @JsonProperty("orgaoEmissorDocumentoViajante") @@ -1053,7 +1042,6 @@ public DsicConsultaDetalhada orgaoEmissorDocumentoViajante(String orgaoEmissorDo /** * Lista contendo as outras informações de serviço para a carga / Dsic<br/> - * * @return outrasInfosServico **/ @JsonProperty("outrasInfosServico") @@ -1077,7 +1065,6 @@ public DsicConsultaDetalhada addOutrasInfosServicoItem(InfoManuseioConsultaDetal /** * Lista contendo as partes da carga<br/> - * * @return partesEstoque **/ @JsonProperty("partesEstoque") @@ -1101,7 +1088,6 @@ public DsicConsultaDetalhada addPartesEstoqueItem(EstoqueConsultaDetalhada parte /** * Peso em Kg<br/>Tamanho: 7,3<br/>Formato: Decimal, com até 3 casas decimais separadas por ponto. - * * @return pesoBruto **/ @JsonProperty("pesoBruto") @@ -1120,7 +1106,6 @@ public DsicConsultaDetalhada pesoBruto(BigDecimal pesoBruto) { /** * Quantidade de volumes<br/>Tamanho: 4<br/>Formato: Inteiro, com até 4 digitos - * * @return quantidadeVolumes **/ @JsonProperty("quantidadeVolumes") @@ -1139,7 +1124,6 @@ public DsicConsultaDetalhada quantidadeVolumes(Integer quantidadeVolumes) { /** * Lista de recepções com avarias agrupadas por recinto aduaneiro<br/> - * * @return recepcoesComAvarias **/ @JsonProperty("recepcoesComAvarias") @@ -1163,7 +1147,6 @@ public DsicConsultaDetalhada addRecepcoesComAvariasItem(RecepcaoComAvaria recepc /** * Código do Recinto Aduaneiro.<br/>Tamanho: 7<br/> Formato: inteiro com até 7 dígitos - * * @return recintoAduaneiroGeracaoDsic **/ @JsonProperty("recintoAduaneiroGeracaoDsic") @@ -1182,7 +1165,6 @@ public DsicConsultaDetalhada recintoAduaneiroGeracaoDsic(String recintoAduaneiro /** * Número único de referencia da carga que atende à recomendação da Organização Mundial de Aduanas (OMA) para a Unique Consignment Reference (UCR). Utilizado para o rastreamento de uma carga, servindo para o controle da armazenagem e movimentação da carga<br>Tamanho: 32 - * * @return ruc **/ @JsonProperty("ruc") @@ -1201,7 +1183,6 @@ public DsicConsultaDetalhada ruc(String ruc) { /** * Setor de lotação do fiscal responsável pela geração do DSIC<br/>Tamanho: 35 - * * @return setorResponsavelGeracaoDsicRfb **/ @JsonProperty("setorResponsavelGeracaoDsicRfb") @@ -1220,7 +1201,6 @@ public DsicConsultaDetalhada setorResponsavelGeracaoDsicRfb(String setorResponsa /** * Código da situação do DSIC<br>Tamanho: 1<br/>A - Ativo <br/>E - Excludído<br/>P - Apropriado<br/> - * * @return situacao **/ @JsonProperty("situacao") @@ -1266,7 +1246,6 @@ public DsicConsultaDetalhada addSolicitacoesServicosEspeciaisItem(InfoManuseioCo /** * Tipo de carga. - * * @return tipoConhecimento **/ @JsonProperty("tipoConhecimento") @@ -1332,7 +1311,6 @@ public DsicConsultaDetalhada tipoDocumentoRetencaoApreensao(TipoDocumentoRetenca /** * Tipo de documento do passageiro<br/>P – Passaporte<br/>I – Carteira de identidade<br/>F – CPF<br/>O – Outros<br/>N – Nenhum<br/> - * * @return tipoDocumentoViajante **/ @JsonProperty("tipoDocumentoViajante") @@ -1354,7 +1332,6 @@ public DsicConsultaDetalhada tipoDocumentoViajante(TipoDocumentoViajanteEnum tip /** * Unidade de lotação do fiscal responsável pela geração do DSIC<br/>Tamanho: 8 - * * @return unidadeResponsavelGeracaoDsicRfb **/ @JsonProperty("unidadeResponsavelGeracaoDsicRfb") @@ -1373,7 +1350,6 @@ public DsicConsultaDetalhada unidadeResponsavelGeracaoDsicRfb(String unidadeResp /** * Código da UL de destino<br/> Tamanho: 7<br/> Formato: AAAAAAA - * * @return unidadeRfbGeracaoDsic **/ @JsonProperty("unidadeRfbGeracaoDsic") @@ -1392,7 +1368,6 @@ public DsicConsultaDetalhada unidadeRfbGeracaoDsic(String unidadeRfbGeracaoDsic) /** * Valor arbitrado pela RFB.<br/>Tamanho: 9,2<br/>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorArbitrado **/ @JsonProperty("valorArbitrado") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaCarga.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaCarga.java index d9b4110..bf2c162 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaCarga.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaCarga.java @@ -453,7 +453,6 @@ public EntregaCarga numeroDocumentoSaida(String numeroDocumentoSaida) { /** * Observações sobre a entrega<br/>Tamanho máximo: 300 - * * @return observacoes **/ @JsonProperty("observacoes") @@ -472,7 +471,6 @@ public EntregaCarga observacoes(String observacoes) { /** * Peso em Kg<br/>Tamanho: 7,3<br/>Formato: Decimal, com até 3 casas decimais separadas por ponto. - * * @return pesoEntrega **/ @JsonProperty("pesoEntrega") @@ -511,7 +509,6 @@ public EntregaCarga recebedor(RecebedorEntregaCarga recebedor) { /** * Recinto Aduaneiro do Depositário responsável pela entrega.<br/>Este campo é obrigatório para o Depositário e não deve ser informado para outros intervenientes. - * * @return recintoAduaneiro **/ @JsonProperty("recintoAduaneiro") @@ -599,7 +596,6 @@ public EntregaCarga tipoEntrega(TipoEntregaEnum tipoEntrega) { /** * Unidade da RFB da Cia. Aérea ou Depositário responsável pela entrega<br/>Este campo é obrigatório para Cia. Aérea e opcional para o Depositário. - * * @return unidadeRFB **/ @JsonProperty("unidadeRFB") @@ -618,7 +614,6 @@ public EntregaCarga unidadeRFB(String unidadeRFB) { /** * Quantidade de volumes<br/>Tamanho: 4<br/>Formato: Inteiro, com até 4 digitos - * * @return volumeEntrega **/ @JsonProperty("volumeEntrega") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaIntermediaria.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaIntermediaria.java index 8cd48b0..2b18be2 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaIntermediaria.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/EntregaIntermediaria.java @@ -525,7 +525,6 @@ public EntregaIntermediaria motivoEntregaIntermediaria(MotivoEntregaIntermediari /** * Número do DTA<br/>Este campo é obrigatório na entrega intermediária entre depositário e transportador terrestre e opcional para as demais entregas intermediárias que escolham os motivos TRANSITO_INTERNACIONAL ou TRANSITO_NACIONAL.</br>Para os demais motivos não deve ser informado.<br/><br/>Tamanho mínimo: 8<br/>Tamanho máximo: 15<br/> Formato: AAAAAAAAAAAAAAA<br/><br/> - * * @return numeroDTA **/ @JsonProperty("numeroDTA") @@ -544,7 +543,6 @@ public EntregaIntermediaria numeroDTA(String numeroDTA) { /** * Observações sobre a entrega intermediária<br/>Tamanho máximo: 1000 - * * @return observacoes **/ @JsonProperty("observacoes") @@ -563,7 +561,6 @@ public EntregaIntermediaria observacoes(String observacoes) { /** * Peso em Kg<br/>Tamanho: 7,3<br/>Formato: Decimal, com até 3 casas decimais separadas por ponto. - * * @return pesoEntrega **/ @JsonProperty("pesoEntrega") @@ -583,7 +580,6 @@ public EntregaIntermediaria pesoEntrega(BigDecimal pesoEntrega) { /** * Recinto Aduaneiro do Depositário responsável pela entrega intermediária.<br/>Este campo é obrigatório para o Depositário e não deve ser informado pelos demais intervenientes. - * * @return recintoAduaneiro **/ @JsonProperty("recintoAduaneiro") @@ -670,7 +666,6 @@ public EntregaIntermediaria tipoRecebedor(TipoRecebedorEnum tipoRecebedor) { /** * Unidade da RFB da Cia. Aérea ou Depositário responsável pela entrega intermediária<br/> - * * @return unidadeRFB **/ @JsonProperty("unidadeRFB") @@ -690,7 +685,6 @@ public EntregaIntermediaria unidadeRFB(String unidadeRFB) { /** * Quantidade de volumes<br/>Tamanho: 4<br/>Formato: Inteiro, com até 4 digitos - * * @return volumeEntrega **/ @JsonProperty("volumeEntrega") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/EstoqueConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/EstoqueConsultaDetalhada.java index 3a93e5d..e5a144f 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/EstoqueConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/EstoqueConsultaDetalhada.java @@ -384,7 +384,6 @@ public EstoqueConsultaDetalhada tipoDocumentoSaida(TipoDocumentoSaidaEnum tipoDo /** * Código da UL<br/> Tamanho: 7<br/> Formato: AAAAAAA - * * @return unidadeRfb **/ @JsonProperty("unidadeRfb") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ParteInteressadaConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ParteInteressadaConsultaDetalhada.java index 7c734fb..416f571 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ParteInteressadaConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ParteInteressadaConsultaDetalhada.java @@ -190,7 +190,6 @@ public ParteInteressadaConsultaDetalhada pais(String pais) { /** * Tipo da parte interessada<br/> Tamanho: 1<br/>1 - Consignatário<br/>2 - Embarcador<br/>3 - Agente de carga<br/>4 - Outras partes interessadas<br/> - * * @return tipo **/ @JsonProperty("tipo") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ViagemConsultaDetalhada.java b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ViagemConsultaDetalhada.java index 6495769..07f9d44 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta/model/ViagemConsultaDetalhada.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta/model/ViagemConsultaDetalhada.java @@ -295,7 +295,6 @@ public ViagemConsultaDetalhada addDsicsAssociadosItem(ChaveDsic dsicsAssociadosI /** * Número de identificação do manifesto<br/>Tamanho: 17 - * * @return identificacaoViagem **/ @JsonProperty("identificacaoViagem") @@ -352,7 +351,6 @@ public ViagemConsultaDetalhada prefixoAeronaveManifestoVoo(String prefixoAeronav /** * Código da situação da viagem<br>Tamanho: 1<br/>A - Ativa <br/>C - Cancelada<br/> - * * @return situacaoViagem **/ @JsonProperty("situacaoViagem") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ext_xml/api/ServiosDeEnvioDeArquivosApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ext_xml/api/ServiosDeEnvioDeArquivosApi.java index bb3f039..48abc48 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ext_xml/api/ServiosDeEnvioDeArquivosApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ext_xml/api/ServiosDeEnvioDeArquivosApi.java @@ -21,6 +21,7 @@ * Controle de Carga e Trânsito Importação - Modal Aéreo * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Aéreo). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
A documentação a seguir descreve os serviços da versão atual do sistema, disponível no ambiente de validação do setor privado. Não há, até o momento, versão disponível para uso em produção. O intuito da API é permitir que as empresas possam realizar testes, preparando as adaptações necessárias em seus sistemas. As informações encaminhadas para os endpoints, neste momento, não terão valor legal, nem serão reaproveitadas em produção.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Os Operadores de Remessa Postal/Expressa podem atuar como transportador, agente de carga, depositário ou importador, desde que devidamente cadastrados nestes perfis de atuação. As ESATA (Empresas de Serviços Auxiliares ao Transporte Aéreo) podem interagir com os serviços desde que possuam representação para atuar como transportador ou agente de carga. Para executar as ações relacionadas à recepção de carga e à chegada de veículo terrestre (trânsito aduaneiro), os recintos aduaneiros (depositários) devem utilizar os serviços disponibilizados pela API Recintos Aduaneiros.
Para a utilização dos serviços do CCT Importação – Modal Aéreo, a autenticação via certificação digital por e-CPF é obrigatória. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
Manifestação de Viagens e Cargas (arquivos Cargo XML)
Os arquivos referentes à manifestação de viagens e cargas devem seguir o padrão Cargo XML da IATA (Associação Internacional de Transportes Aéreos). Para conhecimento dos elementos de dados, estrutura e formato do padrão XSD, deve-se buscar a informação no site da IATA (www.iata.org). Nesta API, serão detalhadas somente as informações solicitadas de forma diferente do padrão IATA.
Serão solicitados aos transportadores aéreos os arquivos XFFM/XFWB, e aos agentes de carga os arquivos XFZB/XFHL, a serem enviados pelos serviços abaixo, descritos em maiores detalhes nas suas respectivas seções desta API:
- Informar Viagem - XFFM (Flight Manifest)
- Informar Conhecimento de Carga - XFWB (Freight Waybill)
- Informar Conhecimento de Carga House - XFZB (House Air Waybill)
- Informar Associação Master e House - XFHL (House Manifest)
Os arquivos somente serão recebidos caso o XML esteja de acordo com o XSD da IATA. Os arquivos corretamente validados passarão à situação "Received" e receberão um número de protocolo associado ao recebimento desse arquivo, sendo encaminhados para processamento. Os arquivos que não forem validados pelo XSD da IATA terão situação "Rejected" e não receberão número de protocolo.
Após a validação do XSD, será realizado o processamento do conteúdo dos campos dos arquivos. Este processamento inclui verificações, tais como: se o campo foi informado vazio ou acima do tamanho permitido, se as informações constam no cadastro da Receita Federal (CPF, CNPJ), etc., com vistas à gravação do dado na base. Os arquivos corretamente processados passarão à situação "Processed", e os que apresentarem algum tipo de erro passarão para "Rejected".
A qualquer momento, a situação dos arquivos enviados pode ser consultada pelos seguintes serviços descritos nesta API:
- Consultar Situação de Arquivos por Data
- Consultar Situação de Arquivos por Número de Protocolo
Durante o processamento, haverá batimento do conteúdo dos dados com tabelas de domínio. Os domínios que estão sendo validados e que podem causar rejeição de arquivo referem-se a:
- Aeroportos (código com três posições) - IATA Airport Code
- Companhia Aérea (número com três posições e código com duas posições) - IATA Airline Codes
- Indicador de Parcialidade de carga numa viagem - IATA Code List 1.15
- Moeda (código alfanumérico com três posições) - ISO 4217
- Países (sigla com duas posições) – ISO 3166
- Recinto Aduaneiro (código com sete posições) – site da Receita Federal do Brasil
- Unidade de Medida (Peso) - rec20_Rev10e_2014.xls do site http://www.unece.org/uncefact/codelistrecs.html
- Unidade de Medida (Volume) - IATA Code List 1.20
- Voos - Código de voo com duas posições alfanuméricas referentes à Companhia Aérea e quatro posições numéricas referentes ao número do voo.
A lista de campos a serem informados e a definição de se eles são obrigatórios ou opcionais seguirão, via de regra, os padrões estabelecidos pela IATA, passando pela validação do XSD. As exceções serão mencionadas explicitamente na descrição dos serviços na API, fazendo parte do processamento dos arquivos. Os tipos e tamanhos de campos também seguirão, via de regra, os padrões estabelecidos pela IATA e, quando não validados pelo XSD, serão verificados no processamento.
Serão processados os seguintes tipos de operação para os arquivos:
- XFFM – Creation
- XFWB, XFZB, XFHL – Creation, Update e Deletion
Os arquivos XFFM, XFWB, XFZB e XFHL podem ser enviados em qualquer ordem, desde que cumpram com os prazos estabelecidos pela Receita Federal do Brasil.
O escopo atual do projeto se encontra restrito a voos regulares. Voos não regulares serão objeto de versões futuras.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Informar Viagem - XFFM (Flight Manifest)\" a URL é \"/api/ext/incoming/xffm\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/incoming/xffm
+ * */ @Path("/") @Api(value = "/", description = "") @@ -28,8 +29,9 @@ public interface ServiosDeEnvioDeArquivosApi { /** * Informar Viagem - XFFM (Flight Manifest) - *+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Encaminhamento de arquivo XML para processamento de viagens áereas com suas respectivas cargas. Uma viagem consiste em um voo específico, aeroporto de partida, aeroporto(s) de chegada(s) e data/hora de partida. Será permitida apenas uma mensagem <strong>(XFFM)</strong> por arquivo, contendo a operação Creation, na versão 2.00, conforme o padrão estabelecido pela IATA. Não há operação Update ou Deletion para este arquivo.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Inicialmente, somente serão aceitos arquivos de viagem <strong>XFFM</strong> com aeroporto de partida no exterior e o primeiro aeroporto de chegada no Brasil. Desta forma, o aeroporto de partida constante no <strong>XFFM</strong> deve ser referente à última partida antes de chegar ao Brasil. Todas as cargas que se encontram na aeronave, independentemente do destino final das cargas, devem constar do <strong>XFFM</strong>.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A data/hora de partida efetiva da viagem deve ser anterior à data/hora da chegada da viagem, caso haja informação de chegada para a mesma.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos <strong>XFFM</strong> devem ser enviados uma única vez por viagem. Caso seja necessária alteração dos dados após o envio, pode ser enviado novo arquivo com a operação Creation, que deve conter a mesma identificação de viagem e data de criação posterior à anterior (FlightManifest/MessageHeaderDocument/IssueDateTime). Arquivos com mesma identificação de viagem e data de criação igual ou anterior serão rejeitados (situação "Rejected").</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A identificação da viagem (FlightManifest/BusinessHeaderDocument/ID) deve ser informada conforme o padrão IATA, contendo exatamente 17 posições, no formato XX9999AAAAMMDDYYY, sendo:</p><ul> <li>XX9999: Código do voo, formado por 2 caracteres da sigla IATA da CIA aérea e 4 caracteres do número de voo. Quando o número do voo contiver menos de 4 caracteres numéricos, devem ser informados zeros à esquerda.</li> <li>AAAAMMDD: Data de partida prevista do último aeroporto estrangeiro antes de vir ao Brasil.</li> <li>YYY: Aeroporto de partida do último aeroporto estrangeiro antes de vir ao Brasil.</li></ul><p style=\"margin-bottom: 1em; margin-top: 1em;\">Um arquivo <strong>XFFM</strong> que está sendo enviado pela primeira vez pode ser encaminhado a qualquer momento, inclusive após a chegada da aeronave. Já um arquivo que esteja substituindo o arquivo anterior poderá ser enviado após a primeira chegada da aeronave daquela viagem no Brasil, contanto que a retificação não seja para exclusão de conhecimentos de carga associados à viagem. Vale ressaltar que a troca do aeroporto de chegada de um conhecimento de carga não é considerada exclusão. Somente será considerada exclusão quando o conhecimento era mencionado no <strong>XFFM</strong> original e deixou de ser mencionado após a retificação, independentemente do aeroporto de chegada.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Após 48 horas da chegada da viagem, não é mais permitido alterar informações sobre os conhecimentos de carga (ex: indicador de parcialidade, peso, volumes, etc) previstos para este aeroporto, sendo permitida apenas a inclusão de novos conhecimentos de carga. Para os demais aeroportos, pode haver alterações normalmente até que ocorra a informação de chegada da viagem.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A retificação de uma viagem poderá ser realizada igualmente via tela, sendo permitido a cada Companhia Aérea retificar somente as suas viagens, considerando a representação do usuário que está utilizando o sistema.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para viagens com partida no exterior, devem ser enviados apenas arquivos <strong>XFFM</strong> com data da partida efetiva (A – Actual, após a partida do veículo) na tag FlightManifest/LogisticsTransportMovement/DepartureEvent/DepartureDateTimeTypeCode. Caso a data de partida seja prevista (S – Scheduled, antes da partida do veículo), o arquivo será rejeitado.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os conhecimentos de carga informados na viagem deverão ter código de classificação de mercadoria com 2, 4, 6 ou 8 posições em FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedMasterConsignmentItem/TypeCode. Esta tag poderá ser repetida caso seja desejado informar mais de um código.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todos os códigos de aeroporto devem ser informados com 3 caracteres, não sendo permitidos códigos UNLOCODE de 5 caracteres.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os indicadores de parcialidade, informados na tag FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/TransportSplitDescription, são divididos em dois grupos:</p><ul> <li>Total - valores T ou S</li> <li>Parcial - valores P, D ou M</li></ul><p style=\"margin-bottom: 1em; margin-top: 1em;\">Em um mesmo XFFM, um conhecimento de carga só pode ser informado dentro do mesmo grupo de parcialidade.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todas as informações de data no arquivo devem ser encaminhadas com o fuso horário no padrão YYYY-MM-DD'T'HH:mm:ss:SSS(‘+’/’-’)ZZ:ZZ.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A informação do fuso horário de partida ou chegada da aeronave refere-se ao fuso horário local. A data de criação do arquivo deverá ser informada com o fuso do local onde foi criado.</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">De acordo com a necessidade da Receita Federal do Brasil, algumas informações poderão ser registradas no bloco de dados "OtherCustomsInformations", conforme apresentado a seguir:</p></br><h3 id=\"indicador-conhecimento\">Indicador de conhecimento de carga não IATA</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>OBS:</strong> Caso seja informado um conhecimento de carga cuja identificação não esteja no padrão IATA, será obrigatório informar este indicador, caso contrário o arquivo será rejeitado.</p><table aria-describedby=\"indicador-conhecimento\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/ContendCode </td> <td>Informar "DI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/Content </td> <td>Informar "NON-IATA"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/SubjectCode </td> <td>Informar "WBI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/CountryID </td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"codigo-recinto\">Código do Recinto Aduaneiro da Chegada da Viagem</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>OBS:</strong>Este indicador deverá ser utilizado para sinalizar que a carga não será recepcionada no recinto aduaneiro principal do aeroporto de chegada, não sendo portanto uma tag obrigatória. O recinto aduaneiro informado neste indicador terá visibilidade de todas as cargas com chegada neste aeroporto. Este indicador poderá ser informado para cada aeroporto de chegada informado no <strong>XFFM</strong>.</p><table aria-describedby=\"codigo-recinto\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>FlightManifest/LogisticsTransportMovement/IncludedCustomsNote/ContendCode</td> <td>Informar "M"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>FlightManifest/LogisticsTransportMovement/IncludedCustomsNote/Content</td> <td> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Informar "CUSTOMSWAREHOUSEXXX9999999"</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Contém 26 caracteres, sendo:</p> <ul> <li>- 1º ao 16º caractere: texto fixo escrito CUSTOMSWAREHOUSE</li> <li>- 17º ao 19º caractere (XXX): sigla IATA do aeroporto de chegada da viagem com 3 posições</li> <li>- 20º ao 26º caractere (9999999): código do recinto aduaneiro que irá recepcionar as cargas</li> </ul> </td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>FlightManifest/LogisticsTransportMovement/IncludedCustomsNote/SubjectCode</td> <td>Informar "CCL"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>FlightManifest/LogisticsTransportMovement/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"data-emissao\">Data de emissão de conhecimento de carga</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>OBS:</strong>Este indicador deve ser informado quando a viagem estiver vinculada a conhecimento de carga que foi emitido há mais de um ano da data efetiva de partida da viagem (conhecimento não vigente). Caso este indicador não seja informado, o sistema vinculará a viagem aos conhecimentos de cargas vigentes no sistema.</p><table aria-describedby=\"data-emissao\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/ContendCode </td> <td>Informar a tag com conteúdo vazio: ""</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/Content </td> <td> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Informar "CARRIERDECLARATIONDATEAAAAMMDD":</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Contém 30 caracteres, sendo:</p> <ul> <li>- 1º ao 22º caractere: CARRIERDECLARATIONDATE (texto fixo)</li> <li>- 23º ao 30º caractere (AAAAMMDD): data de emissão do conhecimento que será associado</li> </ul> </td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/SubjectCode </td> <td>Informar "WBI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>FlightManifest/ArrivalEvent/AssociatedTransportCargo/IncludedMasterConsignment/IncludedCustomsNote/CountryID </td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"par-metros-de-entrada-\">Parâmetros de Entrada:</h3><table aria-describedby=\"par-metros-de-entrada-\"> <thead> <tr> <th>Nome</th> <th>Descrição</th> <th>Tipo</th> <th>Local</th> <th>Detalhes</th> </tr> </thead> <tbody> <tr> <td>Arquivo de viagem aérea (XFFM)</td> <td>Viagem com sua lista de conhecimentos</td> <td>Arquivo XML <strong>obrigatório</strong></td> <td>Body</td> <td>Versão 2.00 da IATA - informado pelas Companhias Aéreas</td> <td></td> </tr> <tr> <td>CNPJ</td> <td>CNPJ da Companhia Aérea</td> <td>Numérico(14) <strong>obrigatório</strong></td> <td>Query Param</td> <td>CNPJ (formato 99999999999999)</td> <td></td> </tr> </tbody></table></br><h3 id=\"resposta\">Resposta :</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os serviços de recebimento de arquivos terão o retorno de processamento por arquivo XFNM na versão 3.00, com as seguintes informações:</p><table aria-describedby=\"resposta\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Message Reference ID</td> <td>MessageHeaderDocument / ID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Message Name</td> <td>MessageHeaderDocument / Name</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Type</td> <td>MessageHeaderDocument / TypeCode</td> <td>Fixo "294"</td> </tr> <tr> <td>Message Date / Time Stamp</td> <td>MessageHeaderDocument / IssueDateTime</td> <td>Data / hora de processamento do arquivo - UTC time</td> </tr> <tr> <td>Message Function</td> <td>MessageHeaderDocument / PurposeCode</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Version</td> <td>MessageHeaderDocument / VersionID</td> <td>Fixo "3.0"</td> </tr> <tr> <td>Sender Qualifier</td> <td>MessageHeaderDocument / SenderParty / schemeID</td> <td>Fixo "C"</td> </tr> <tr> <td>Sender Identification</td> <td>MessageHeaderDocument / SenderParty / PrimaryID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Recipient Qualifier</td> <td>MessageHeaderDocument / RecipientParty / schemeID</td> <td>Valor do campo Sender Qualifier (tag MessageHeaderDocument / SenderParty / schemeID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com “O’ (letra O)</td> </tr> <tr> <td>Recipient Identification</td> <td>MessageHeaderDocument / RecipientParty / PrimaryID</td> <td>Valor do campo Sender Identification (tag MessageHeaderDocument / SenderParty / PrimaryID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED"</td> </tr> <tr> <td>Message Type</td> <td>BusinessHeaderDocument / TypeCode</td> <td>Valor do campo Message Type (tag MessageHeaderDocument / TypeCode) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com 999.</td> </tr> <tr> <td>Message Name</td> <td>BusinessHeaderDocument / Name</td> <td>Valor do campo Message Name (tag MessageHeaderDocument / Name) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED".</td> </tr> <tr> <td>Original Document Identification</td> <td>BusinessHeaderDocument / ID</td> <td>Valor do campo Message Reference ID (tag MessageHeaderDocument / ID) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED".</td> </tr> <tr> <td>Response Type</td> <td>BusinessHeaderDocument / StatusCode</td> <td>“<em>Received</em>” , “<em>Rejected</em>” ou “<em>Processed</em>” – conforme processamento do arquivo. Na versão atual, haverá resposta apenas nas situações “<em>Received</em>” (arquivo recebido e será processado) ou “<em>Rejected</em>”(arquivo foi rejeitado)</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos que passarem pela validação do XSD (formato estabelecido pela IATA), receberão status “<em>Received</em>”, acompanhado do número de protocolo gerado para este arquivo. Este número de protocolo pode ser utilizado para verificar a situação de processamento do arquivo por meio dos serviços <em>“Consultar Situação de Arquivos por Período”</em> ou <em>“Consultar Situação de Arquivos por número de Protocolo”</em>.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Já os arquivos que não passarem pela validação do XSD (formato estabelecido pela IATA) receberão status “<em>Rejected</em>”, acompanhado da lista de erros encontrados.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Received</em>\", haverá somente um registro do bloco de dados Response Status, conforme abaixo. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip1\"> </span><table aria-describedby=\"ip1\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Acknowledgement</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Número do protocolo de recebimento</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Rejected</em>”, cada ocorrência de erro conterá as seguintes informações no bloco de dados Response Status. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip2\"> </span><table aria-describedby=\"ip2\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Error</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Texto contendo a linha e coluna com erro, (informando Row:<número da linha> | Column:<número da coluna>) e a descrição do erro verificada.Tamanho do campo: 5000 posições. Ex: "Row:7|Column:20|Error: cvc-complex-type.2.4.a: Invalid content was found starting with element '{"iata:datamodel:3":PurposeCode}'. One of '{"iata:datamodel:3":IssueDateTime}' is expected.</td> </tr> </tbody></table> + * */ @POST @Path("/api/ext/incoming/xffm") @@ -49,8 +51,9 @@ public interface ServiosDeEnvioDeArquivosApi { /** * Informar Associação Master e House - XFHL (House Manifest) - *
+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Encaminhamento de arquivo XML para processamento da associação entre um conhecimento de carga AWB (Air Waybill) ou MAWB (Master Air Waybill) e conhecimento(s) de carga HAWB (House Air Waybill).Será permitida apenas uma mensagem XFHL por arquivo, contendo a operação Creation, Update ou Deletion, na versão 2.00, conforme o padrão estabelecido pela IATA.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos com operação Update ou Deletion serão processados caso exista um arquivo com a operação Creation recebido anteriormente com sucesso no sistema, contendo a mesma identificação do conhecimento de carga do MAWB/AWB e vigente.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para que um MAWB/AWB seja considerado associado aos seus HAWB, deve haver arquivo de associação MAWB/HAWB (XFHL) que referencie o MAWB (XFWB) e a respectiva lista de HAWB (XFZB) associados.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Um arquivo XFHL que está sendo enviado com a operação Creation pode ser encaminhado a qualquer momento, inclusive após a chegada da aeronave. Já um arquivo que tenha a operação Update (contanto que contenha a exclusão de alguma das associações) ou a operação Deletion somente será aceito até a primeira chegada da viagem no Brasil e caso a carga não esteja vinculada a um documento de saída. Nessas situações, as operações de retificação ou exclusão somente poderão ser realizadas por funcionalidade de tela (web) e pela RFB. Retificações somente para inclusão de associações são permitidas.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todas as informações de data no arquivo devem ser encaminhadas contendo o fuso horário no padrão YYYY-MM-DD'T'HH:mm:ss:SSS(‘+’/’-’)ZZ:ZZ.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A informação do fuso horário de partida ou chegada da aeronave refere-se ao fuso horário local. A data de criação do arquivo deverá ser informada com o fuso do local onde foi criado.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">De acordo com a necessidade da Receita Federal do Brasil, algumas informações poderão ser registradas no bloco de dados \"OtherCustomsInformations\", conforme apresentado a seguir:</p></br><h3 id=\"indicador-conhecimento\">Indicador de conhecimento de carga não IATA</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>OBS:</strong> Caso seja informado um conhecimento de carga cuja identificação não esteja no padrão IATA, será obrigatório informar este indicador, caso contrário o arquivo será rejeitado.</p><table aria-describedby=\"indicador-conhecimento\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/ContendCode</td> <td>Informar "DI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/Content</td> <td>Informar "NON-IATA"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "WBI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"indicador-agente-carga\">Identificação do Agente de Carga em cada HAWB (IncludedHouseConsignment) do XFHL</h3><table aria-describedby=\"indicador-agente-carga\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/ContendCode</td> <td>Informar "T"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/Content</td> <td>Informar "CNPJ<número do CNPJ com 8 dígitos>":</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "AGT"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"data-emissao-awb\">Data de emissão de conhecimento de carga ocorrência para o AWB/MAWB (MasterConsignment)</h3><table aria-describedby=\"data-emissao-awb\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/ContendCode</td> <td>Informar a tag com conteúdo vazio: ""</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/Content</td> <td> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Informar "CARRIERDECLARATIONDATEAAAAMMDD":</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Contém 30 caracteres, sendo:</p> <ul> <li>- 1º ao 22º caractere: CARRIERDECLARATIONDATE (texto fixo)</li> <li>- 23º ao 30º caractere (AAAAMMDD): data de emissão do conhecimento que será associado</li> </ul> </td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "WBI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseManifest/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"data-emissao-hawb\">Data de emissão de conhecimento de carga ocorrência em cada HAWB (IncludedHouseConsignment)</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>OBS:</strong> Este indicador deve ser informado quando o conhecimento de carga, seja o MAWB/AWB ou algum dos HAWB, foi emitido há mais de um ano da data efetiva de partida da viagem (conhecimento não vigente). Caso este indicador não seja informado, o sistema vinculará o MAWB/AWB vigente aos HAWB vigentes no sistema.</p><table aria-describedby=\"data-emissao-hawb\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/ContendCode</td> <td>Informar a tag com conteúdo vazio: ""</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/Content</td> <td> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Informar "CARRIERDECLARATIONDATEAAAAMMDD":</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">Contém 30 caracteres, sendo:</p> <ul> <li>- 1º ao 22º caractere: CARRIERDECLARATIONDATE (texto fixo)</li> <li>- 23º ao 30º caractere (AAAAMMDD): data de emissão do conhecimento que será associado</li> </ul> </td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "WBI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseManifest/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"par-metros-de-entrada-\">Parâmetros de Entrada:</h3><table aria-describedby=\"par-metros-de-entrada-\"> <thead> <tr> <th>Nome</th> <th>Descrição</th> <th>Tipo</th> <th>Local</th> <th>Detalhes</th> </tr> </thead> <tbody> <tr> <td>Arquivo de associação (XFHL)</td> <td>Associação entre <em>master</em>(MAWB) e <em>house</em>(HAWB)</td> <td>Arquivo XML <strong>obrigatório</strong></td> <td>Body</td> <td>Versão 2.00 da IATA - informado pelos Agentes de Carga ou pelo Operador de Remessa Postal / Expressa </td> <td></td> </tr> <tr> <td>CNPJ</td> <td>CNPJ do Agente de Carga ou do Operador de Remessa Postal / Expressa</td> <td>Numérico(14) <strong>obrigatório</strong></td> <td>Query Param</td> <td>CNPJ (formato 99999999999999)</td> <td></td> </tr> </tbody></table></br><h3 id=\"resposta-\">Resposta :</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os serviços de recebimento de arquivos terão o retorno de processamento por arquivo XFNM na versão 3.00, com as seguintes informações:</p><table aria-describedby=\"resposta\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Message Reference ID</td> <td>MessageHeaderDocument / ID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Message Name</td> <td>MessageHeaderDocument / Name</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Type</td> <td>MessageHeaderDocument / TypeCode</td> <td>Fixo "294"</td> </tr> <tr> <td>Message Date / Time Stamp</td> <td>MessageHeaderDocument / IssueDateTime</td> <td>Data / hora de processamento do arquivo - UTC time</td> </tr> <tr> <td>Message Function</td> <td>MessageHeaderDocument / PurposeCode</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Version</td> <td>MessageHeaderDocument / VersionID</td> <td>Fixo "3.0"</td> </tr> <tr> <td>Sender Qualifier</td> <td>MessageHeaderDocument / SenderParty / schemeID</td> <td>Fixo "C"</td> </tr> <tr> <td>Sender Identification</td> <td>MessageHeaderDocument / SenderParty / PrimaryID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Recipient Qualifier</td> <td>MessageHeaderDocument / RecipientParty / schemeID</td> <td>Valor do campo Sender Qualifier (tag MessageHeaderDocument / SenderParty / schemeID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com “O” (letra O)</td> </tr> <tr> <td>Recipient Identification</td> <td>MessageHeaderDocument / RecipientParty / PrimaryID</td> <td>Valor do campo Sender Identification (tag MessageHeaderDocument / SenderParty / PrimaryID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com \"NOT IDENTIFIED\".</td> </tr> <tr> <td>Message Type</td> <td>BusinessHeaderDocument / TypeCode</td> <td>Valor do campo Message Type (tag MessageHeaderDocument / TypeCode) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com 999.</td> </tr> <tr> <td>Message Name</td> <td>BusinessHeaderDocument / Name</td> <td>Valor do campo Message Name (tag MessageHeaderDocument / Name) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com \"NOT IDENTIFIED\".</td> </tr> <tr> <td>Original Document Identification</td> <td>BusinessHeaderDocument / ID</td> <td>Valor do campo Message Reference ID (tag MessageHeaderDocument / ID) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com \"NOT IDENTIFIED\".</td> </tr> <tr> <td>Response Type</td> <td>BusinessHeaderDocument / StatusCode</td> <td>“<em>Received</em>” , “<em>Rejected</em>” ou “<em>Processed</em>” – conforme processamento do arquivo. Na versão atual, haverá resposta apenas nas situações “<em>Received</em>” (arquivo recebido e será processado) ou “<em>Rejected</em>”(arquivo foi rejeitado)</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos que passarem pela validação do XSD (formato estabelecido pela IATA), receberão status \"Received\", acompanhado do número de protocolo gerado para este arquivo. Este número de protocolo pode ser utilizado para verificar a situação de processamento do arquivo por meio por meio dos serviços \"Consultar Situação de Arquivos por Data\" ou \"Consultar Situação de Arquivos por número de Protocolo\".</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Já os arquivos que não passarem pela validação do XSD (formato estabelecido pela IATA) receberão status “<em>Rejected</em>”, acompanhado da lista de erros encontrados.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Received</em>”, haverá somente um registro do bloco de dados Response Status, conforme abaixo. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip1\"> </span><table aria-describedby=\"ip1\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Acknowledgement</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Número do protocolo de recebimento</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Rejected</em>”, cada ocorrência de erro conterá as seguintes informações no bloco de dados Response Status. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip2\"> </span><table aria-describedby=\"ip2\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Error</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Texto contendo a linha e coluna com erro, (informando Row:<número da linha> | Column:<número da coluna>) e a descrição do erro verificado.Tamanho do campo: 5000 posições. Ex: "Row:7|Column:20|Error: cvc-complex-type.2.4.a: Invalid content was found starting with element '{"iata:datamodel:3":PurposeCode}'. One of '{"iata:datamodel:3":IssueDateTime}' is expected.</td> </tr> </tbody></table> + * */ @POST @Path("/api/ext/incoming/xfhl") @@ -70,8 +73,9 @@ public interface ServiosDeEnvioDeArquivosApi { /** * Informar Conhecimento de Carga - XFWB (Freight Waybill) - *
+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Encaminhamento de arquivo XML para processamento de conhecimentos de cargas do tipo <strong>AWB (Air Waybill)</strong> ou <strong>MAWB (Master Air Waybill)</strong>. Será permitida apenas uma mensagem <strong>XFWB</strong> por arquivo, contendo a operação <em>Creation</em>, <em>Update</em> ou <em>Deletion</em>, na versão 3.00, conforme o padrão estabelecido pela IATA..<p style=\"margin-bottom: 1em; margin-top: 1em;\">Um conhecimento de carga poderá ser informado de forma repetida contanto que não existam dois conhecimentos de carga vigentes ao mesmo tempo. Desta forma não pode haver repetição de um conhecimento de carga num período de 365 dias a partir da sua emissão.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos de operação <em>Update</em> ou <em>Deletion</em> serão processados caso exista um arquivo com a operação <em>Creation</em> recebido anteriormente com sucesso no sistema, tendo a mesma identificação do <strong>AWB/MAWB (Waybill/BusinessHeaderDocument/ID)</strong> e data de emissão.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A alteração de um <strong>AWB/MAWB</strong> poderá ocorrer por serviço caso não tenha ocorrido entrega final ao importador, seja esta parcial ou total. Já a exclusão do <strong>AWB/MAWB</strong> só poderá ocorrer até o momento da chegada da primeira parte ou do total da carga em um aeroporto brasileiro.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para que um <strong>AWB/MAWB</strong> seja considerado como manifestado em uma viagem, o conhecimento de carga <strong>(XFWB)</strong> deve ser referenciado no arquivo da viagem <strong>(XFFM)</strong>. Para tal, a identificação do <strong>AWB/MAWB</strong> deve ser igual em ambos os arquivos. Além disso, tanto o arquivo <strong>XFFM</strong> quanto o arquivo <strong>XFWB</strong> devem se encontrar na situação <em>Processed</em>.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">O conhecimento de carga será vinculado à viagem de acordo com sua data de emissão, que deve ser menor ou igual à data de partida efetiva da viagem.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">O agrupamento de informações de mercadoria (Waybill/MasterConsignment/ApplicableRating) obrigatório é o agrupamento do tipo "F" (Waybill/MasterConsignment/ApplicableRating/TypeCode), que se refere ao valor de face.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">O agrupamento de informações de forma de pagamento do frete (Waybill/MasterConsignment/ApplicableTotalRating/ApplicablePrepaidCollectMonetarySummation/PrepaidIndicator) poderá ter no máximo duas ocorrências, sendo uma prepaid e a outra collect.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os conhecimentos de carga informados deverão ter código de classificação de mercadoria <strong>(NCM)</strong> com 2, 4, 6 ou 8 posições em Waybill/MasterConsignment/ApplicableRating/IncludedMasterConsignmentItem/TypeCode. Esta tag poderá ser repetida caso seja desejado informar mais de um código NCM.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todas as unidades de medida de peso deverão ser informadas como unidades de medida de massa.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todos os códigos de aeroportos informados no sistema devem ser informados com 3 caracteres, não sendo aceito código UNLOCODE de 5 caracteres.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">De acordo com a necessidade da Receita Federal do Brasil, os campos abaixo são de informação obrigatória. Caso o arquivo não apresente as informações a seguir, ele será rejeitado em tempo de processamento.</p></br><h3 id=\"ip1\"><strong>Número Total de Volumes</strong></h3><table aria-describedby=\"ip1\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>WAYBILL SUMMARY/Total number of pieces</td> <td>Waybill/MasterConsignment/TotalPieceQuantity</td> </tr> </tbody></table></br><h3 id=\"ip2\"><strong>Peso Bruto Total</strong></h3><table aria-describedby=\"ip2\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>WAYBILL SUMMARY/Total Gross Weight</td> <td>Waybill/MasterConsignment/IncludedTareGrossWeightMeasure</td> </tr> </tbody></table></br><h3 id=\"ip3\"><strong>Peso Bruto Total - Unidade de Medida</strong></h3><table aria-describedby=\"ip3\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>WAYBILL SUMMARY/Total Gross Weight Unit of Measurement</td> <td>Waybill/MasterConsignment/IncludedTareGrossWeightMeasure (unit code)</td> </tr> </tbody></table></br><h3 id=\"ip4\" ><strong>Descrição das Mercadorias</strong> - Deve ser informado ao menos uma vez por arquivo</h3><table aria-describedby=\"ip4\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>WAYBILL BODY / Rating Type / Rating Type Indicator / Item Details / Item Description</td> <td>Waybill / MasterConsignment / ApplicableRating / IncludedMasterConsignmentItem / NatureIdentificationTransportCargo / Identification</td> </tr> </tbody></table></br><h3 id=\"ip5\"><strong>Valor Total do Frete</strong></h3><table aria-describedby=\"ip5\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>WAYBILL SUMMARY / Waybill Totals / Rating Type Indicator / Prepaid / Collect Indicator / Total Charge Summary</td> <td>Waybill / MasterConsignment / ApplicableTotalRating / ApplicablePrepaidCollectMonetarySummation / GrandTotalAmount</td> </tr> </tbody></table></br><h3 id=\"ip6\" ><strong>Forma de Pagamento do Frete (Prepaid, Collect)</strong></h3><table aria-describedby=\"ip6\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>WAYBILL SUMMARY / Waybill Totals / Rating Type Indicator / Prepaid / Collect Indicator</td> <td>Waybill / MasterConsignment / ApplicableTotalRating / ApplicablePrepaidCollectMonetarySummation / PrepaidIndicator</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Caso o tipo de conhecimento de carga seja <strong>MAWB</strong>, as informações de pagamento do frete e valor do frete não serão obrigatórias. Desta forma, o valor do frete para o MAWB pode ser zero.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A informação de identificação do consignatário não é obrigatória. Porém, caso a mesma não tenha sido informada no, <strong>AWB</strong> até o momento da chegada da viagem, o sistema realizará um bloqueio automático na carga. Para <strong>MAWB</strong>, não haverá bloqueio pela falta de informação da identificação do consignatário.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">De acordo com a necessidade da Receita Federal do Brasil, existem informações que poderão ser registradas no bloco de dados "Other Customs Informations", não sendo obrigatórias nas versões iniciais.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">São elas:</p></br><h3 id=\"indicador-conhecimento\">Indicador de conhecimento de carga não IATA</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>OBS:</strong>Caso seja informado um AWB ou MAWB cuja identificação não siga o padrão IATA, é obrigatório informar este indicador. Caso contrário, o arquivo será rejeitado.</p><table aria-describedby=\"indicador-conhecimento\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/ContendCode</td> <td>Informar "DI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/Content</td> <td>Informar "NON-IATA"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "WBI"</td> <td></td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> <td></td> </tr> </tbody></table></br><h3 id=\"ip7\"><strong>Indicador de Presença de Partes e Peças de Madeira Maciça</strong></h3><table aria-describedby=\"ip7\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "DI"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/Content</td> <td>Informar "WOOD PARTS"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "OCI"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip8\" ><strong>Indicador de Não Recepção dos HAWB Associados no Aeroporto de Destino</strong></h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Obs:</strong>Quando este campo OCI for informado, o indicador será preenchido com "sim". Quando esse campo OCI não for informado, o indicador será preenchido com "não".<br> Quando o indicador for "sim", a orientação é de que a recepção no aeroporto de destino do conhecimento seja realizada pelo MAWB, e não por seus HAWB associados.<br> Quando for "não", a orientação é de que a recepção no aeroporto de destino do conhecimento seja realizada diretamente pelos HAWB.<br> Este indicador não deve ser levado em consideração nas recepções realizadas em unidades que não sejam o aeroporto de destino do conhecimento. Nestes casos, indica-se como padrão a recepção pelo MAWB.</p><table aria-describedby=\"ip8\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "DI"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/Content</td> <td>Informar "DO NOT BREAK DOWN"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "HDL"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip9\" ><strong>Identificação do Consignatário</strong></h3><table aria-describedby=\"ip9\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "T"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/Content</td> <td> <p style=\"margin-bottom: 1em; margin-top: 1em;\">- Se for um CPF informar "CPF<número do CPF com 11 dígitos>" . Ex: CPF12345678901</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">- Se for um CNPJ informar "CNPJ<número do CNPJ com 8 ou 14 dígitos>". Ex:CNPJ12345678901234</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">- Se for um Passaporte informar "PASSPORT<número do passaporte com até 25 posições>. Ex:PASSPORTC12345678.</p> </td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "CNE"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information /Country code</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip10\" ><strong>RUC (Referência Única da Carga) / UCR (Unique Consignment Reference)</strong></h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Obs:</strong>Caso a informação da RUC não seja encaminhada no arquivo, o sistema gerará automaticamente um número RUC para a carga. Se a RUC for informada, deverá atender à recomendação da Organização Mundial de Aduanas (OMA) para a Unique Consignment Reference (UCR).</p><table aria-describedby=\"ip10\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "U"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/Content</td> <td>Informar UCR<número da RUC com até 32 posições>. Ex: UCR8BR167017161001713D0000000000004021</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "IMP"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip11\" ><strong>Código do Recinto Aduaneiro de Destino da Carga</strong></h3><table aria-describedby=\"ip11\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "M"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/Content</td> <td>Informar "CUSTOMSWAREHOUSE<número do Código do Recinto Aduaneiro de Destino da Carga com 7 dígitos>". Ex:CUSTOMSWAREHOUSE1234567</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "CCL"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>Waybill/MasterConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todas as informações de data no arquivo devem ser encaminhadas com o fuso horário no padrão <strong>“YYYY-MM-DD'T'HH:mm:ss:SSS(‘+’/’-’)ZZ:ZZ”</strong>.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A informação do fuso horário de partida ou chegada da aeronave refere-se ao fuso horário local. A data de criação do arquivo deverá ser informada com o fuso do local onde foi criado.</p></br><h3 id=\"par-metros-de-entrada-\">Parâmetros de Entrada:</h3><table aria-describedby=\"par-metros-de-entrada-\"> <thead> <tr> <th>Nome</th> <th>Descrição</th> <th>Tipo</th> <th>Local</th> <th>Detalhes</th> </tr> </thead> <tbody> <tr> <td>Arquivo de conhecimento de carga (XFWB)</td> <td>Conhecimentos de carga(AWB e MAWB)</td> <td>Arquivo XML <strong>obrigatório</strong></td> <td>Body</td> <td>Versão 3.00 da IATA - informado pelas Companhias Aéreas</td> <td></td> </tr> <tr> <td>CNPJ</td> <td>CNPJ da Companhia Aérea</td> <td>Numérico(14) <strong>obrigatório</strong></td> <td>Query Param</td> <td>CNPJ (formato 99999999999999)</td> <td></td> </tr> </tbody></table></br><h3 id=\"resposta-\">Resposta :</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os serviços de recebimento de arquivos terão o retorno de processamento por arquivo XFNM na versão 3.00, com as seguintes informações:</p><table aria-describedby=\"resposta\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Message Reference ID</td> <td>MessageHeaderDocument / ID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Message Name</td> <td>MessageHeaderDocument / Name</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Type</td> <td>MessageHeaderDocument / TypeCode</td> <td>Fixo "294"</td> </tr> <tr> <td>Message Date / Time Stamp</td> <td>MessageHeaderDocument / IssueDateTime</td> <td>Data / hora de processamento do arquivo - UTC time</td> </tr> <tr> <td>Message Function</td> <td>MessageHeaderDocument / PurposeCode</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Version</td> <td>MessageHeaderDocument / VersionID</td> <td>Fixo "3.0"</td> </tr> <tr> <td>Sender Qualifier</td> <td>MessageHeaderDocument / SenderParty / schemeID</td> <td>Fixo "C"</td> </tr> <tr> <td>Sender Identification</td> <td>MessageHeaderDocument / SenderParty / PrimaryID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Recipient Qualifier</td> <td>MessageHeaderDocument / RecipientParty / schemeID</td> <td>Valor do campo Sender Qualifier (tag MessageHeaderDocument / SenderParty / schemeID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com “O’ (letra O)</td> </tr> <tr> <td>Recipient Identification</td> <td>MessageHeaderDocument / RecipientParty / PrimaryID</td> <td>Valor do campo Sender Identification (tag MessageHeaderDocument / SenderParty / PrimaryID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED"</td> </tr> <tr> <td>Message Type</td> <td>BusinessHeaderDocument / TypeCode</td> <td>Valor do campo Message Type (tag MessageHeaderDocument / TypeCode) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com 999.</td> </tr> <tr> <td>Message Name</td> <td>BusinessHeaderDocument / Name</td> <td>Valor do campo Message Name (tag MessageHeaderDocument / Name) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED".</td> </tr> <tr> <td>Original Document Identification</td> <td>BusinessHeaderDocument / ID</td> <td>Valor do campo Message Reference ID (tag MessageHeaderDocument / ID) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED".</td> </tr> <tr> <td>Response Type</td> <td>BusinessHeaderDocument / StatusCode</td> <td>“<em>Received</em>” , “<em>Rejected</em>” ou “<em>Processed</em>” – conforme processamento do arquivo. Na versão atual, haverá resposta apenas nas situações “<em>Received</em>” (arquivo recebido e será processado) ou “<em>Rejected</em>”(arquivo foi rejeitado)</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos que passarem pela validação do XSD (formato estabelecido pela IATA), receberão status "<em>Received</em>", acompanhado do número de protocolo gerado para este arquivo. Este número de protocolo pode ser utilizado para verificar a situação de processamento do arquivo por meio dos serviços "Consultar Situação de Arquivos por Data" ou "Consultar Situação de Arquivos por número de Protocolo".</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Já os arquivos que não passarem pela validação do XSD (formato estabelecido pela IATA) receberão status "<em>Rejected</em>", acompanhado da lista de erros encontrados.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a "<em>Received</em>", haverá somente um registro do bloco de dados Response Status, conforme abaixo. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip12\"> </span><table aria-describedby=\"ip12\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category ResponseStatus / ConditionCode</td> <td>Acknowledgement</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Número do protocolo de recebimento</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Rejected</em>”, cada ocorrência de erro conterá as seguintes informações no bloco de dados Response Status. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip13\"> </span><table aria-describedby=\"ip13\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Error</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Texto contendo a linha e coluna com erro, (informando Row:<número da linha> | Column:<número da coluna>) e a descrição do erro verificado.Tamanho do campo: 5000 posições. Ex: "Row:7|Column:20|Error: cvc-complex-type.2.4.a: Invalid content was found starting with element '{"iata:datamodel:3":PurposeCode}'. One of '{"iata:datamodel:3":IssueDateTime}' is expected.</td> </tr> </tbody></table> + * */ @POST @Path("/api/ext/incoming/xfwb") @@ -91,8 +95,9 @@ public interface ServiosDeEnvioDeArquivosApi { /** * Informar Conhecimento de Carga House - XFZB (House Air Waybill) - *
+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\">Encaminhamento de arquivo XML para processamento de conhecimentos de cargas house (HAWB - <em>House Air Waybill</em>). Será permitida apenas uma mensagem XFZB por arquivo, contendo a operação de <em>Creation</em>, <em>Update</em> ou <em>Deletion</em>, conforme o padrão IATA.<p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos de operação Update ou Deletion serão processados, caso exista um arquivo de Creation recebido anteriormente com sucesso no sistema, tendo a mesma identificação do conhecimento de carga do HAWB. A identificação do conhecimento de carga HAWB é feita pelo conjunto da informação de número do HAWB (HouseWaybill/BusinessHeaderDocument/ID) e aeroporto de origem da carga do HAWB (HouseWaybill/MasterConsignment/IncludedHouseConsignment/OriginLocation/ID).</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para que um HAWB seja considerado associado a um MAWB(XFWB), deve haver arquivo de associação MAWB/HAWB(XFHL), que referencie o HAWB (XFZB), por meio de suas respectivas identificações do MAWB/HAWB e aeroporto de origem da carga. Além disso, todos os arquivos (XFHL, XFWB e XFZB) devem se encontrar na situação "<em>Processed</em>".</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Um arquivo XFZB que está sendo enviado com a operação Creation pode ser encaminhado por este serviço a qualquer momento, inclusive após a chegada da aeronave. Já um arquivo que tenha a operação Update ou Deletion, somente será aceito pelo serviço até a informação da chegada da aeronave e caso a carga não esteja vinculada a um documento de saída. No caso da exclusão, esta operação também não será permitida caso o HAWB já esteja vinculado a seu MAWB, conforme a regra de associação acima mencionada. Nessas situações, as operações de retificação ou exclusão somente poderão ser realizadas por funcionalidades de tela (web) a serem disponibilizadas futuramente, e não mais por arquivo XML. A funcionalidade de exclusão será restrita para uso da RFB.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os conhecimentos de carga informados deverão ter código de classificação de mercadoria <strong>(NCM)</strong> com 2, 4, 6 ou 8 posições em HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedHouseConsignmentItem/TypeCode. Esta tag poderá ser repetida caso seja desejado informar mais de um código NCM.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os valores totais de HAWB a serem informados, serão obrigatórios somente com relação ao valor de face (<strong>"F"</strong>).</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">De acordo com a necessidade da Receita Federal do Brasil, os campos abaixo são de informação obrigatória. Caso o arquivo não apresente as informações a seguir, ele será rejeitado em tempo de processamento.</p></br><h3 id=\"ip1\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Número Total de Volumes</strong></h3><table aria-describedby=\"ip1\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>HOUSE WAYBILL SUMMARY /Total number of pieces</td> <td>HouseWaybill / MasterConsignment / IncludedHouseConsignment / TotalPieceQuantity</td> </tr> </tbody></table></br><h3 id=\"ip2\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Peso Bruto Total</strong></h3><table aria-describedby=\"ip2\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>HOUSE WAYBILL SUMMARY / Total Gross Weight</td> <td>HouseWaybill / MasterConsignment / IncludedHouseConsignment / IncludedTareGrossWeightMeasure</td> </tr> </tbody></table></br><h3 id=\"ip3\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Peso Bruto Total - Unidade de Medida</strong></h3><table aria-describedby=\"ip3\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>HOUSE WAYBILL SUMMARY / Total Gross Weight</td> <td>HouseWaybill / MasterConsignment / IncludedHouseConsignment / IncludedTareGrossWeightMeasure (unit code) </td> </tr> </tbody></table></br><h3 id=\"ip4\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Descrição das Mercadorias</strong></h3><table aria-describedby=\"ip4\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>HOUSE WAYBILL SUMMARY / Description of Goods</td> <td>HouseWaybill / MasterConsignment / IncludedHouseConsignment / SummaryDescription</td> </tr> </tbody></table></br><h3 id=\"ip5\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Valor Total do Frete PREPAID</strong></h3><table aria-describedby=\"ip5\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>HOUSE WAYBILL SUMMARY / House Waybill Totals / Total Prepaid Charge Summary Amount</td> <td>HouseWaybill / MasterConsignment / IncludedHouseConsignment / TotalPrepaidChargeAmount</td> </tr> </tbody></table></br><h3 id=\"ip6\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Valor Total do Frete COLLECT</strong></h3><table aria-describedby=\"ip6\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> </tr> </thead> <tbody> <tr> <td>HOUSE WAYBILL SUMMARY / House Waybill Totals / Total Collect Charge Summary Amount</td> <td>HouseWaybill / MasterConsignment / IncludedHouseConsignment / TotalCollectChargeAmount</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">A informação de identificação do consignatário não é obrigatória, porém, caso a mesma não conste do HAWB no momento da chegada da viagem, o sistema realizará um bloqueio automático na carga.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">De acordo com a necessidade da Receita Federal do Brasil, existem informações que poderão ser registradas no bloco de dados \"Other Customs Informations\", não sendo obrigatórias nas versões iniciais.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">São elas:</p></br><h3 id=\"ip7\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Indicador de Presença de Partes e Peças de Madeira Maciça</strong></h3><table aria-describedby=\"ip7\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "DI"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/Content</td> <td>Informar "WOOD PARTS"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "OCI"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information /Country code</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip8\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Identificação do Consignatário</strong></h3><table aria-describedby=\"ip8\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "T"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information /Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/Content</td> <td> <p style=\"margin-bottom: 1em; margin-top: 1em;\">- Se for um CPF informar "CPF<número do CPF com 11 dígitos>" . Ex: CPF12345678901</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">- Se for um CNPJ informar "CNPJ<número do CNPJ com 8 ou 14 dígitos>". Ex:CNPJ12345678901234</p> <p style=\"margin-bottom: 1em; margin-top: 1em;\">- Se for um Passaporte informar "PASSPORT<número do passaporte com até 25 posições>. Ex:PASSPORTC12345678.</p> </td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "CNE" consignatário</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip9\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>RUC (Referência Única da Carga) / UCR (Unique Consignment Reference)</strong></h3><p style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Obs</strong>: Caso a informação da RUC não seja encaminhada no arquivo, o sistema gera automaticamente um número para a carga. Se a RUC for informada, deverá atender a recomendação da Organização Mundial de Aduanas (OMA) para a Unique Consignment Reference (UCR).</p><table aria-describedby=\"ip9\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "U"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/Content</td> <td>Informar UCR<número da RUC com até 32 posições>. Ex: UCR8BR167017161001713D0000000000004021</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "IMP"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table></br><h3 id=\"ip10\" style=\"margin-bottom: 1em; margin-top: 1em;\"><strong>Código do Recinto Aduaneiro de Destino da Carga</strong></h3><table aria-describedby=\"ip10\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Other Customs, Security and Regulatory Control Information / Customs, Security and Regulatory Control Information Identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/ContentCode</td> <td>Informar "M"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Supplementary Customs, Security and Regulatory Control Information</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/Content</td> <td>Informar "CUSTOMSWAREHOUSE<número do Código do Recinto Aduaneiro de Destino da Carga com 7 dígitos>". Ex:CUSTOMSWAREHOUSE1234567</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Information identifier</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/SubjectCode</td> <td>Informar "CCL"</td> </tr> <tr> <td>Other Customs, Security and Regulatory Control Information / Country code</td> <td>HouseWaybill/MasterConsignment/IncludedHouseConsignment/IncludedCustomsNote/CountryID</td> <td>Informar "BR"</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Todas as informações de data no arquivo devem ser encaminhadas com o fuso horário no padrão <strong>"YYYY-MM-DD'T'HH:mm:ss:SSS(‘+’/’-’)ZZ:ZZ"</strong>.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">A informação do fuso horário de partida ou chegada da aeronave refere-se ao fuso horário local. A data de criação do arquivo deverá ser informada com o fuso do local onde foi criado.</p></br><h3 id=\"par-metros-de-entrada-\">Parâmetros de Entrada:</h3><table aria-describedby=\"par-metros-de-entrada-\"> <thead> <tr> <th>Nome</th> <th>Descrição</th> <th>Tipo</th> <th>Local</th> <th>Detalhes</th> </tr> </thead> <tbody> <tr> <td>Arquivo de conhecimento de carga (XFZB)</td> <td>Conhecimentos de carga <em>House</em>(HAWB)</td> <td>Arquivo XML <strong>obrigatório</strong></td> <td>Body</td> <td>Versão 3.00 da IATA - informado pelos Agentes de Carga ou pelo Operador de Remessa Postal / Expressa </td> <td></td> </tr> <tr> <td>CNPJ</td> <td>CNPJ do Agente de Carga ou do Operador de Remessa Postal / Expressa</td> <td>Numérico(14) <strong>obrigatório</strong></td> <td>Query Param</td> <td>CNPJ (formato 99999999999999)</td> <td></td> </tr> </tbody></table></br><h3 id=\"resposta-\">Resposta :</h3><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os serviços de recebimento de arquivos terão o retorno de processamento por arquivo XFNM na versão 3.00, com as seguintes informações:</p><table aria-describedby=\"resposta-\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Message Reference ID</td> <td>MessageHeaderDocument / ID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Message Name</td> <td>MessageHeaderDocument / Name</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Type</td> <td>MessageHeaderDocument / TypeCode</td> <td>Fixo "294"</td> </tr> <tr> <td>Message Date / Time Stamp</td> <td>MessageHeaderDocument / IssueDateTime</td> <td>Data / hora de processamento do arquivo - UTC time</td> </tr> <tr> <td>Message Function</td> <td>MessageHeaderDocument / PurposeCode</td> <td>Fixo "Response"</td> </tr> <tr> <td>Message Version</td> <td>MessageHeaderDocument / VersionID</td> <td>Fixo "3.0"</td> </tr> <tr> <td>Sender Qualifier</td> <td>MessageHeaderDocument / SenderParty / schemeID</td> <td>Fixo "C"</td> </tr> <tr> <td>Sender Identification</td> <td>MessageHeaderDocument / SenderParty / PrimaryID</td> <td>Fixo "BRCUSTOMS"</td> </tr> <tr> <td>Recipient Qualifier</td> <td>MessageHeaderDocument / RecipientParty / schemeID</td> <td>Valor do campo Sender Qualifier (tag MessageHeaderDocument / SenderParty / schemeID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com “O’ (letra O)</td> </tr> <tr> <td>Recipient Identification</td> <td>MessageHeaderDocument / RecipientParty / PrimaryID</td> <td>Valor do campo Sender Identification (tag MessageHeaderDocument / SenderParty / PrimaryID) do arquivo recebido. Caso não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED"</td> </tr> <tr> <td>Message Type</td> <td>BusinessHeaderDocument / TypeCode</td> <td>Valor do campo Message Type (tag MessageHeaderDocument / TypeCode) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com 999.</td> </tr> <tr> <td>Message Name</td> <td>BusinessHeaderDocument / Name</td> <td>Valor do campo Message Name (tag MessageHeaderDocument / Name) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED".</td> </tr> <tr> <td>Original Document Identification</td> <td>BusinessHeaderDocument / ID</td> <td>Valor do campo Message Reference ID (tag MessageHeaderDocument / ID) do arquivo original. Caso este campo não seja passível de identificação ou for inválido ou não vier preenchido, será preenchido com "NOT IDENTIFIED".</td> </tr> <tr> <td>Response Type</td> <td>BusinessHeaderDocument / StatusCode</td> <td>“<em>Received</em>” , “<em>Rejected</em>” ou “<em>Processed</em>” – conforme processamento do arquivo. Na versão atual, haverá resposta apenas nas situações “<em>Received</em>” (arquivo recebido e será processado) ou “<em>Rejected</em>”(arquivo foi rejeitado)</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Os arquivos que passarem pela validação do XSD (formato estabelecido pela IATA), receberão status “Received”, acompanhado do número de protocolo gerado para este arquivo. Este número de protocolo pode ser utilizado para verificar a situação de processamento do arquivo por meio dos serviços “Consultar Situação de Arquivos por Data” ou “Consultar Situação de Arquivos por número de Protocolo”.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Já os arquivos que não passarem pela validação do XSD (formato estabelecido pela IATA) receberão status “Rejected”, acompanhado da lista de erros encontrados.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Received</em>”, haverá somente um registro do bloco de dados Response Status, conforme abaixo. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip11\"> </span><table aria-describedby=\"ip11\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Acknowledgement</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Número do protocolo de recebimento</td> </tr> </tbody></table><p style=\"margin-bottom: 1em; margin-top: 1em;\">Para arquivos com o campo Response Type igual a “<em>Rejected</em>”, cada ocorrência de erro conterá as seguintes informações no bloco de dados Response Status. O campo "Text" terá tamanho de 5000 caracteres, diferentemente do padrão estabelecido pela IATA.</p><span id=\"ip12\"> </span><table aria-describedby=\"ip12\"> <thead> <tr> <th>Campo</th> <th>Tag XML</th> <th>Valor</th> </tr> </thead> <tbody> <tr> <td>Category</td> <td>ResponseStatus / ConditionCode</td> <td>Error</td> </tr> <tr> <td>Text</td> <td>ResponseStatus / Reason</td> <td>Texto contendo a linha e coluna com erro, (informando Row:<número da linha> | Column:<número da coluna>) e a descrição do erro verificada.Tamanho do campo: 5000 posições. Ex: "Row:7|Column:20|Error: cvc-complex-type.2.4.a: Invalid content was found starting with element '{"iata:datamodel:3":PurposeCode}'. One of '{"iata:datamodel:3":IssueDateTime}' is expected.</td> </tr> </tbody></table> + * */ @POST @Path("/api/ext/incoming/xfzb") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/api/ServiosDeEnvioDeArquivosApi.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/api/ServiosDeEnvioDeArquivosApi.java index 6f26b6f..568875b 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/api/ServiosDeEnvioDeArquivosApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/api/ServiosDeEnvioDeArquivosApi.java @@ -22,6 +22,7 @@ * Controle de Carga e Trânsito Importação - Modal Rodoviário * *
Manual do Usuário
Informações detalhadas sobre serviços e funcionalidades em tela, assim como a lista de funcionalidades disponíveis para cada perfil de acesso, podem ser consultados no manual do usuário do CCT Importação.
Introdução
Bem-vindo à Application Programming Interface (API) de interação com o novo Sistema de Controle de Carga e Trânsito (CCT Importação - Modal Rodoviário). Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a manifestação e gestão do fluxo logístico de viagens e cargas dentro do Portal Único de Comércio Exterior.
Os perfis de acesso que podem utilizar cada serviço encontram-se listados no manual do usuário. Na seção Introdução da API do Portal Único de Comércio Exterior, podem ser encontradas as orientações gerais sobre os padrões de comunicação dos serviços, os procedimentos para autenticação e os códigos de resposta das requisições.
Os serviços, a princípio, não estarão disponíveis no horário de 1:00h às 3:00h, em virtude de parada programada dos sistemas de comércio exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/ccta/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar Situação de Arquivos por Número de Protocolo\" a URL é \"/api/ext/check/received-files/{protocolNumber}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/ccta/api/ext/check/received-files/{protocolNumber}
+ * */ @Path("/") @Api(value = "/", description = "") @@ -29,8 +30,9 @@ public interface ServiosDeEnvioDeArquivosApi { /** * Informar Manifesto do CRT - *+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\"> Esse serviço tem por objetivo possibilitar a manifestação do CRT pelo transportador nacional ou estrangeiro (este através de um representante CNPJ ou CPF)</p><p style=\"margin-bottom: 1em; margin-top: 1em;\"> O processamento dessa manifestação é realizado de forma assíncrona, sendo retornado apenas o número de protocolo para consulta posterior.</p> + * */ @POST @Path("/api/ext/rodoviario/manifestacao/conhecimento") @@ -50,8 +52,9 @@ public interface ServiosDeEnvioDeArquivosApi { /** * Informar Manifesto do Viagem - *
+ * * <p style=\"margin-bottom: 1em; margin-top: 1em;\"> Esse serviço tem por objetivo possibilitar a entrega da carga para o destinatário final, através do conhecimento de carga/DSIC e do documento de saída vinculado ao mesmo. A entrega poderá ser realizada de forma total ou parcial.</p><p style=\"margin-bottom: 1em; margin-top: 1em;\"> O processamento dessa entrega é realizado de forma assíncrona, sendo retornado apenas o número de protocolo para consulta posterior.</p> + * */ @POST @Path("/api/ext/rodoviario/manifestacao/viagem") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/CrtViagem.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/CrtViagem.java index d3e4d59..1657f81 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/CrtViagem.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/CrtViagem.java @@ -336,7 +336,6 @@ public CrtViagem indicadorParcialidade(Boolean indicadorParcialidade) { /** * Get itensCarga - * * @return itensCarga **/ @JsonProperty("itensCarga") @@ -360,7 +359,6 @@ public CrtViagem addItensCargaItem(ItemCargaViagem itensCargaItem) { /** * Get mercadorias - * * @return mercadorias **/ @JsonProperty("mercadorias") @@ -384,7 +382,6 @@ public CrtViagem addMercadoriasItem(Mercadoria mercadoriasItem) { /** * Número do CRT<br/> Tamanho Máximo: 15 - * * @return numeroCrt **/ @JsonProperty("numeroCrt") @@ -427,7 +424,6 @@ public CrtViagem tipoCarga(TipoCargaEnum tipoCarga) { /** * Valor do frete FCA.<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorFCA **/ @JsonProperty("valorFCA") @@ -447,7 +443,6 @@ public CrtViagem valorFCA(BigDecimal valorFCA) { /** * Valor do frete cobrado na parte da carga que está sendo transportada em uma viagem.<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorFrete **/ @JsonProperty("valorFrete") @@ -467,7 +462,6 @@ public CrtViagem valorFrete(BigDecimal valorFrete) { /** * Valor do seguro cobrado na parte da carga que está sendo transportada em uma viagem.<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorSeguro **/ @JsonProperty("valorSeguro") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCargaViagem.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCargaViagem.java index 14d2fa7..bef1188 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCargaViagem.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCargaViagem.java @@ -219,7 +219,6 @@ public ItemCargaViagem tipoEmbalagem(String tipoEmbalagem) { /** * Tipo de granel do item de carga transportado na viagempara tipocarga = 3 preenchimento obrigatório conforme Tabela de tipos de granel(TabX)<br/>Tamanho Máximo: 2 - * * @return tipoGranel **/ @JsonProperty("tipoGranel") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCrt.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCrt.java index 8e3637d..574bdd1 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCrt.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemCrt.java @@ -286,7 +286,6 @@ public ItemCrt numeroConteiner(String numeroConteiner) { /** * Peso bruto do item de carga em Kg<br/>Formato: Número Racional com 9 casas inteiras e 3 casas decimais - * * @return pesoBrutoKg **/ @JsonProperty("pesoBrutoKg") @@ -306,7 +305,6 @@ public ItemCrt pesoBrutoKg(BigDecimal pesoBrutoKg) { /** * Peso líquido do item de carga em Kg<br/>Formato: Número Racional com 9 casas inteiras e 3 casas decimais - * * @return pesoLiquido **/ @JsonProperty("pesoLiquido") @@ -344,7 +342,6 @@ public ItemCrt qtdeVolumesTotalManifestada(BigDecimal qtdeVolumesTotalManifestad /** * Número sequencial do item de carga<br/> Tamanho Máximo: 4 - * * @return sequencial **/ @JsonProperty("sequencial") @@ -364,7 +361,6 @@ public ItemCrt sequencial(BigDecimal sequencial) { /** * Tara do conteiner em Kg<br/>para \"tipoItemCRT\" = 1 preenchimento obrigatório<br/>Formato: Número Racional com 6 casas inteiras e 3 casas decimais - * * @return taraConteiner **/ @JsonProperty("taraConteiner") @@ -383,7 +379,6 @@ public ItemCrt taraConteiner(BigDecimal taraConteiner) { /** * Tipo de embalagem de carga solta</br>Para item Carga Solta (2), campo obrigatório, recuperar de tabela<br/> Tamanho Máximo: 2 - * * @return tipoEmbalagem **/ @JsonProperty("tipoEmbalagem") @@ -402,7 +397,6 @@ public ItemCrt tipoEmbalagem(String tipoEmbalagem) { /** * Código do tipo de granel</br>para \"tipoItemCRT\" = 3 preenchimento obrigatório conforme Tabela de tipos de granel(TabX)<br/>Tamanho Máximo: 2 - * * @return tipoGranel **/ @JsonProperty("tipoGranel") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemEnLastre.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemEnLastre.java index 24f89fe..c1a06f7 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemEnLastre.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ItemEnLastre.java @@ -318,7 +318,6 @@ public ItemEnLastre tipo(TipoEnum tipo) { /** * Tipo de embalagem da carga solta transportada na viagem (en lastre)<br/> para tipo = 2 preenchimento obrigatório<br/> Tamanho Máximo: 2 - * * @return tipoEmbalagem **/ @JsonProperty("tipoEmbalagem") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoCrt.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoCrt.java index 558b264..4fc01ce 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoCrt.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoCrt.java @@ -1049,7 +1049,6 @@ public ManifestoCrt cidadeParteNotificarEstrangeiro(String cidadeParteNotificarE /** * Código Locode da cidade do remetente da carga<br/> Formato: AAAAA - * * @return cidadeRemetente **/ @JsonProperty("cidadeRemetente") @@ -1089,7 +1088,6 @@ public ManifestoCrt cidadeTranspResponsMercadoria(String cidadeTranspResponsMerc /** * Código postal do endereço do consignatário estrangeiro<br/> Tamanho Máximo: 8 - * * @return codigoPostalConsignatario **/ @JsonProperty("codigoPostalConsignatario") @@ -1108,7 +1106,6 @@ public ManifestoCrt codigoPostalConsignatario(String codigoPostalConsignatario) /** * Código postal do endereço do destinatário da cargaObrigatorio para destinatário brasileiro (\"destinatarioNacBrasileira\" = true)<br/> Tamanho Máximo: 8 - * * @return codigoPostalDestinatario **/ @JsonProperty("codigoPostalDestinatario") @@ -1146,7 +1143,6 @@ public ManifestoCrt codigoPostalParteNotificarEstrangeiro(String codigoPostalPar /** * Código postal do endereço do remetente da carga<br/> Tamanho Máximo: 8 - * * @return codigoPostalRemetente **/ @JsonProperty("codigoPostalRemetente") @@ -1166,7 +1162,6 @@ public ManifestoCrt codigoPostalRemetente(String codigoPostalRemetente) { /** * Data de emissão do conhecimento<br/>A data de emissão não pode ser anterior à Data de Implantação do sistema CCT rodoviário menos um mês. <br/>A data de emissão não pode ser posterior à data atual<br/>(utilizar como chave junto com numero do CRT apenas a a data AAAAMMDD<br/>Formato: yyyyMMddHHmmssZ - * * @return dataEmissao **/ @JsonProperty("dataEmissao") @@ -1206,7 +1201,6 @@ public ManifestoCrt dataHoraTranspResponsMercadoria(String dataHoraTranspRespons /** * Qualquer declaração, observação ou instrução relativo ao transporte<br/> Tamanho Máximo: 500 - * * @return declaracaoObservacao **/ @JsonProperty("declaracaoObservacao") @@ -1226,7 +1220,6 @@ public ManifestoCrt declaracaoObservacao(String declaracaoObservacao) { /** * Indicador se o destinatário da carga é brasileiro - * * @return destinatarioNacBrasileira **/ @JsonProperty("destinatarioNacBrasileira") @@ -1246,7 +1239,6 @@ public ManifestoCrt destinatarioNacBrasileira(Boolean destinatarioNacBrasileira) /** * Get documentosApresentados - * * @return documentosApresentados **/ @JsonProperty("documentosApresentados") @@ -1270,7 +1262,6 @@ public ManifestoCrt addDocumentosApresentadosItem(DocumentoApresentado documento /** * E-mail da parte a notificar<br/>Precisar ter formato de email valido<br/> Tamanho Máximo: 100 - * * @return emailParteNotificar **/ @JsonProperty("emailParteNotificar") @@ -1289,7 +1280,6 @@ public ManifestoCrt emailParteNotificar(String emailParteNotificar) { /** * Nome do estado do endereço do consignatário estrangeiro<br/> Tamanho Máximo: 50 - * * @return estadoConsignatario **/ @JsonProperty("estadoConsignatario") @@ -1308,7 +1298,6 @@ public ManifestoCrt estadoConsignatario(String estadoConsignatario) { /** * Nome do estado do endereço do destinatário da carga</br>Obrigatorio para destinatário estrangeiro (\"destinatarioNacBrasileira\" = false)<br/> Tamanho Máximo: 50 - * * @return estadoDestinatario **/ @JsonProperty("estadoDestinatario") @@ -1327,7 +1316,6 @@ public ManifestoCrt estadoDestinatario(String estadoDestinatario) { /** * Estado da parte a notificar, quando estrangeiro<br/> Tamanho Máximo: 50 - * * @return estadoParteNotificarEstrangeiro **/ @JsonProperty("estadoParteNotificarEstrangeiro") @@ -1346,7 +1334,6 @@ public ManifestoCrt estadoParteNotificarEstrangeiro(String estadoParteNotificarE /** * Nome do estado ou província do remetente<br/> Tamanho Máximo: 50 - * * @return estadoRemetente **/ @JsonProperty("estadoRemetente") @@ -1366,7 +1353,6 @@ public ManifestoCrt estadoRemetente(String estadoRemetente) { /** * Identificação fiscal do consignatário da carga<br/>quando \"idTipoDocumentoConsignatario\" for \"F\" ou \"J\" deverá estar ativo no cadastro de CPF/CNPJ<br/> Tamanho Máximo: 35 - * * @return idFiscalConsignatario **/ @JsonProperty("idFiscalConsignatario") @@ -1386,7 +1372,6 @@ public ManifestoCrt idFiscalConsignatario(String idFiscalConsignatario) { /** * Identificação do destinatário da carga<br/> Tamanho Máximo: 20 - * * @return idFiscalDestinatario **/ @JsonProperty("idFiscalDestinatario") @@ -1406,7 +1391,6 @@ public ManifestoCrt idFiscalDestinatario(String idFiscalDestinatario) { /** * Identificação fiscal da parte a notificar<br/> Tamanho Máximo: 20 - * * @return idFiscalParteNotificar **/ @JsonProperty("idFiscalParteNotificar") @@ -1425,7 +1409,6 @@ public ManifestoCrt idFiscalParteNotificar(String idFiscalParteNotificar) { /** * Identificação fiscal do remetente da carga<br/> Tamanho Máximo: 20 - * * @return idFiscalRemetente **/ @JsonProperty("idFiscalRemetente") @@ -1445,7 +1428,6 @@ public ManifestoCrt idFiscalRemetente(String idFiscalRemetente) { /** * Identificação da carga<br/>Se \"paisRemetente\" for ATIT (*1) , o formato é AAXXXXXXXXX, em que AA = \"paisRemetente\"<br/>Se \"paisRemetente\" não for ATIT, campo de texto livre.<br/>Não pode haver outra carga com a mesma chave \"identificacaoCrt\"+\"dataEmissao\"<br/> Tamanho Máximo: 15 - * * @return identificacaoCrt **/ @JsonProperty("identificacaoCrt") @@ -1484,7 +1466,6 @@ public ManifestoCrt identificacaoRepresentanteTransportadorEstrangeiro(String id /** * Identificação do transportador Nacional<br/>Se campo transportadorNacBrasileira igual a \"true\" ( Transportador Nacional) é obrigatório o preenchimento do CNPJ. Este CNPJ deve estar ativo no cadastro de CNPJ e ser validado no Cadastro de Transportadores.<br/> Tamanho: 14 - * * @return identificacaoTransportadorNacional **/ @JsonProperty("identificacaoTransportadorNacional") @@ -1503,7 +1484,6 @@ public ManifestoCrt identificacaoTransportadorNacional(String identificacaoTrans /** * Indicador do consignatário é brasileiro - * * @return inConsignatarioNacBrasileira **/ @JsonProperty("inConsignatarioNacBrasileira") @@ -1522,7 +1502,6 @@ public ManifestoCrt inConsignatarioNacBrasileira(Boolean inConsignatarioNacBrasi /** * Indicador se a parte a notificar da carga é brasileiro - * * @return inParteNotificarNacBrasileira **/ @JsonProperty("inParteNotificarNacBrasileira") @@ -1564,7 +1543,6 @@ public ManifestoCrt incotermLocalEmbarque(IncotermLocalEmbarqueEnum incotermLoca /** * Instruções sobre formalidades de alfândega<br/> Tamanho Máximo: 500 - * * @return instrucaoFormalidadeAlfandega **/ @JsonProperty("instrucaoFormalidadeAlfandega") @@ -1584,7 +1562,6 @@ public ManifestoCrt instrucaoFormalidadeAlfandega(String instrucaoFormalidadeAlf /** * Get itensCRT - * * @return itensCRT **/ @JsonProperty("itensCRT") @@ -1608,7 +1585,6 @@ public ManifestoCrt addItensCRTItem(ItemCrt itensCRTItem) { /** * Licença Complementar do Transportador Estrangeiro<br/>Se tipoTransporteTransportador = \"REG\" e campo transportadorNacBrasileira igual a \"false\" ( Transportador estrangeiro) é obrigatório o preenchimento desse campo. <br/> Tamanho Máximo: 6 - * * @return licencaComplementarTransportador **/ @JsonProperty("licencaComplementarTransportador") @@ -1627,7 +1603,6 @@ public ManifestoCrt licencaComplementarTransportador(BigDecimal licencaComplemen /** * Licença Originária do Transportador Nacional<br/>Se tipoTransporteTransportador = \"REG\" e campo transportadorNacBrasileira igual a \"true\" ( Transportador Nacional) é obrigatório o preenchimento desse campo<br/> Tamanho Máximo: 6 - * * @return licencaOriginariaTransportador **/ @JsonProperty("licencaOriginariaTransportador") @@ -1646,7 +1621,6 @@ public ManifestoCrt licencaOriginariaTransportador(BigDecimal licencaOriginariaT /** * Get manuseiosEspeciaisCarga - * * @return manuseiosEspeciaisCarga **/ @JsonProperty("manuseiosEspeciaisCarga") @@ -1694,7 +1668,6 @@ public ManifestoCrt addMercadoriasItem(Mercadoria mercadoriasItem) { /** * Código da moeda do frete da mercadoria do destinatário<br/>Formato: AAA - * * @return moedaFreteDestinatario **/ @JsonProperty("moedaFreteDestinatario") @@ -1713,7 +1686,6 @@ public ManifestoCrt moedaFreteDestinatario(String moedaFreteDestinatario) { /** * Código da moeda do frete externo da mercadoria<br/>Formato: AAA - * * @return moedaFreteExterno **/ @JsonProperty("moedaFreteExterno") @@ -1733,7 +1705,6 @@ public ManifestoCrt moedaFreteExterno(String moedaFreteExterno) { /** * Código da moeda do frete da mercadoria do remetente<br/>Formato: AAA - * * @return moedaFreteRemetente **/ @JsonProperty("moedaFreteRemetente") @@ -1752,7 +1723,6 @@ public ManifestoCrt moedaFreteRemetente(String moedaFreteRemetente) { /** * Código da moeda do valor das mercadorias declarado pelo remetente<br/>Formato: AAA - * * @return moedaMercadoriaDeclaradoRemetente **/ @JsonProperty("moedaMercadoriaDeclaradoRemetente") @@ -1771,7 +1741,6 @@ public ManifestoCrt moedaMercadoriaDeclaradoRemetente(String moedaMercadoriaDecl /** * Código da moeda do valor da mercadoria no local de embarque no momento em que o transportador se responsabiliza pela carga<br/>Formato: AAA - * * @return moedaMercadoriaLocalEmbarque **/ @JsonProperty("moedaMercadoriaLocalEmbarque") @@ -1791,7 +1760,6 @@ public ManifestoCrt moedaMercadoriaLocalEmbarque(String moedaMercadoriaLocalEmba /** * Código da moeda de outros custos do destinatario<br/>Formato: AAA - * * @return moedaOutrosCustosDestinatario **/ @JsonProperty("moedaOutrosCustosDestinatario") @@ -1810,7 +1778,6 @@ public ManifestoCrt moedaOutrosCustosDestinatario(String moedaOutrosCustosDestin /** * Código da moeda de outros custos do remetente<br/>Formato: AAA - * * @return moedaOutrosCustosRemetente **/ @JsonProperty("moedaOutrosCustosRemetente") @@ -1829,7 +1796,6 @@ public ManifestoCrt moedaOutrosCustosRemetente(String moedaOutrosCustosRemetente /** * Código da moeda do reembolso da mercadoria - contra entrega<br/>Formato: AAA - * * @return moedaReembolso **/ @JsonProperty("moedaReembolso") @@ -1848,7 +1814,6 @@ public ManifestoCrt moedaReembolso(String moedaReembolso) { /** * Código da moeda do seguro da mercadoria do destinatário<br/>Formato: AAA - * * @return moedaSeguroDestinatario **/ @JsonProperty("moedaSeguroDestinatario") @@ -1867,7 +1832,6 @@ public ManifestoCrt moedaSeguroDestinatario(String moedaSeguroDestinatario) { /** * Código da moeda do seguro da mercadoria do remetente<br/>Formato: AAA - * * @return moedaSeguroRemetente **/ @JsonProperty("moedaSeguroRemetente") @@ -1886,7 +1850,6 @@ public ManifestoCrt moedaSeguroRemetente(String moedaSeguroRemetente) { /** * Nome do consignatário estrangeiro <br/> Tamanho Máximo: 60 - * * @return nomeConsignatario **/ @JsonProperty("nomeConsignatario") @@ -1905,7 +1868,6 @@ public ManifestoCrt nomeConsignatario(String nomeConsignatario) { /** * Nome do destinatário da carga</br>Obrigatorio para destinatário estrangeiro (\"destinatarioNacBrasileira\" = false)<br/> Tamanho Máximo: 60 - * * @return nomeDestinatario **/ @JsonProperty("nomeDestinatario") @@ -1924,7 +1886,6 @@ public ManifestoCrt nomeDestinatario(String nomeDestinatario) { /** * Nome da parte a notificar, quando estrangeiro<br/> Tamanho Máximo: 60 - * * @return nomeParteNotificarEstrangeiro **/ @JsonProperty("nomeParteNotificarEstrangeiro") @@ -1943,7 +1904,6 @@ public ManifestoCrt nomeParteNotificarEstrangeiro(String nomeParteNotificarEstra /** * Nome do remetente da carga<br/> Tamanho Máximo: 60 - * * @return nomeRemetente **/ @JsonProperty("nomeRemetente") @@ -1963,7 +1923,6 @@ public ManifestoCrt nomeRemetente(String nomeRemetente) { /** * Nome do transportador estrangeiro<br/>Se campo transportadorNacBrasileira igual a \"false\" ( Transportador estrangeiro) é obrigatório o preenchimento.<br/> Tamanho Máximo: 60 - * * @return nomeTransportadorEstrangeiro **/ @JsonProperty("nomeTransportadorEstrangeiro") @@ -1982,7 +1941,6 @@ public ManifestoCrt nomeTransportadorEstrangeiro(String nomeTransportadorEstrang /** * Sigla do país do consignatário estrangeiro<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisConsignatario **/ @JsonProperty("paisConsignatario") @@ -2001,7 +1959,6 @@ public ManifestoCrt paisConsignatario(String paisConsignatario) { /** * Sigla do país do destinatário da carga</br>Obrigatorio para destinatário estrangeiro (\"destinatarioNacBrasileira\" = false)<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisDestinatario **/ @JsonProperty("paisDestinatario") @@ -2020,7 +1977,6 @@ public ManifestoCrt paisDestinatario(String paisDestinatario) { /** * Código do país de emissão do CRT<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisEmissao **/ @JsonProperty("paisEmissao") @@ -2040,7 +1996,6 @@ public ManifestoCrt paisEmissao(String paisEmissao) { /** * sigla do país de entrega da carga<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisEntrega **/ @JsonProperty("paisEntrega") @@ -2060,7 +2015,6 @@ public ManifestoCrt paisEntrega(String paisEntrega) { /** * País onde a mercadoria foi fabricada<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisOrigemMercadoria **/ @JsonProperty("paisOrigemMercadoria") @@ -2080,7 +2034,6 @@ public ManifestoCrt paisOrigemMercadoria(String paisOrigemMercadoria) { /** * País da parte a notificar, quando estrangeiro<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisParteNotificarEstrangeiro **/ @JsonProperty("paisParteNotificarEstrangeiro") @@ -2099,7 +2052,6 @@ public ManifestoCrt paisParteNotificarEstrangeiro(String paisParteNotificarEstra /** * Sigla do país do remetente da carga<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisRemetente **/ @JsonProperty("paisRemetente") @@ -2119,7 +2071,6 @@ public ManifestoCrt paisRemetente(String paisRemetente) { /** * Código do país em que o transportador se responsabiliza pela mercadoria<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisTranspResponsMercadoria **/ @JsonProperty("paisTranspResponsMercadoria") @@ -2139,7 +2090,6 @@ public ManifestoCrt paisTranspResponsMercadoria(String paisTranspResponsMercador /** * Peso bruto da carga em KG<br/>Formato: Número Racional com 9 casas inteiras e 3 casas decimais - * * @return pesoBrutoKg **/ @JsonProperty("pesoBrutoKg") @@ -2159,7 +2109,6 @@ public ManifestoCrt pesoBrutoKg(BigDecimal pesoBrutoKg) { /** * Data em que o transportador se compromete com a entrega da carga<br/>Formato: yyyyMMddHHmmss - * * @return prazoEntrega **/ @JsonProperty("prazoEntrega") @@ -2178,7 +2127,6 @@ public ManifestoCrt prazoEntrega(String prazoEntrega) { /** * Rua do endereço do consignatário estrangeiro <br/> Tamanho Máximo: 150 - * * @return ruaConsignatario **/ @JsonProperty("ruaConsignatario") @@ -2197,7 +2145,6 @@ public ManifestoCrt ruaConsignatario(String ruaConsignatario) { /** * Rua do endereço do destinatário da carga</br>Obrigatorio para destinatário estrangeiro (\"destinatarioNacBrasileira\" = false)<br/> Tamanho Máximo: 150 - * * @return ruaDestinatario **/ @JsonProperty("ruaDestinatario") @@ -2216,7 +2163,6 @@ public ManifestoCrt ruaDestinatario(String ruaDestinatario) { /** * rua da parte a notificar, quando estrangeiro<br/> Tamanho Máximo: 150 - * * @return ruaParteNotificarEstrangeiro **/ @JsonProperty("ruaParteNotificarEstrangeiro") @@ -2235,7 +2181,6 @@ public ManifestoCrt ruaParteNotificarEstrangeiro(String ruaParteNotificarEstrang /** * Nome da Rua do remetente da carga<br/> Tamanho Máximo: 150 - * * @return ruaRemetente **/ @JsonProperty("ruaRemetente") @@ -2255,7 +2200,6 @@ public ManifestoCrt ruaRemetente(String ruaRemetente) { /** * ruc<br/>Não pode existir outro RUC na tabela de conhecimento com o mesmo número (levando em consideração conhecimentos ativos , ou seja, não excluídos logicamente ).<br/>Quando não informado, será gerado pelo sistema.<br/>Caso transportador seja estrangeiro e a licença complementar não for informado o campo RUC é obrigatório<br/> Tamanho Máximo: 35 - * * @return ruc **/ @JsonProperty("ruc") @@ -2274,7 +2218,6 @@ public ManifestoCrt ruc(String ruc) { /** * Telefone da parte a notificar<br/>Precisar ter no mínimo 12 números, podendo começar com +<br/> Tamanho Máximo: 16 - * * @return telefoneParteNotificar **/ @JsonProperty("telefoneParteNotificar") @@ -2338,7 +2281,6 @@ public ManifestoCrt tipoDocIdFiscalParteNotificar(TipoDocIdFiscalParteNotificarE /** * Identifica qual o tipo de Carga<br/>Granel (3), Veículo (4), Carga Solta (2), Conteiner (1) - * * @return tipoItemCRT **/ @JsonProperty("tipoItemCRT") @@ -2361,7 +2303,6 @@ public ManifestoCrt tipoItemCRT(TipoItemCRTEnum tipoItemCRT) { /** * Tipo de transporte do transportador<br/>REG = Regular PRO=próprio OCA=Ocasional<br/> Tamanho Máximo: 3 - * * @return tipoTransporteTransportador **/ @JsonProperty("tipoTransporteTransportador") @@ -2384,7 +2325,6 @@ public ManifestoCrt tipoTransporteTransportador(TipoTransporteTransportadorEnum /** * Indica que o transportador da carga é brasileiro - * * @return transportadorNacBrasileira **/ @JsonProperty("transportadorNacBrasileira") @@ -2404,7 +2344,6 @@ public ManifestoCrt transportadorNacBrasileira(Boolean transportadorNacBrasileir /** * Get transportadoresSucessivos - * * @return transportadoresSucessivos **/ @JsonProperty("transportadoresSucessivos") @@ -2428,7 +2367,6 @@ public ManifestoCrt addTransportadoresSucessivosItem(TransportadorSucessivo tran /** * Valor do frete da mercadoria do destinatário<br/>Deverá ser preenchido e diferente de zero caso o valor do frete do remetente for informado zerado<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorFreteDestinatario **/ @JsonProperty("valorFreteDestinatario") @@ -2447,7 +2385,6 @@ public ManifestoCrt valorFreteDestinatario(BigDecimal valorFreteDestinatario) { /** * Valor do frete externo da mercadoria<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorFreteExterno **/ @JsonProperty("valorFreteExterno") @@ -2467,7 +2404,6 @@ public ManifestoCrt valorFreteExterno(BigDecimal valorFreteExterno) { /** * Valor do frete da mercadoria do remetente<br/>Deverá ser preenchido e diferente de zero caso o frete do destinatário for informado zerado<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorFreteRemetente **/ @JsonProperty("valorFreteRemetente") @@ -2486,7 +2422,6 @@ public ManifestoCrt valorFreteRemetente(BigDecimal valorFreteRemetente) { /** * Valor das mercadorias declarado pelo remetente<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorMercadoriaDeclaradoRemetente **/ @JsonProperty("valorMercadoriaDeclaradoRemetente") @@ -2505,7 +2440,6 @@ public ManifestoCrt valorMercadoriaDeclaradoRemetente(BigDecimal valorMercadoria /** * Valor da mercadoria no local de embarque no momento em que o transportador se responsabiliza pela carga<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorMercadoriaLocalEmbarque **/ @JsonProperty("valorMercadoriaLocalEmbarque") @@ -2525,7 +2459,6 @@ public ManifestoCrt valorMercadoriaLocalEmbarque(BigDecimal valorMercadoriaLocal /** * Valor de outros custos do destinatario<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorOutrosCustosDestinatario **/ @JsonProperty("valorOutrosCustosDestinatario") @@ -2544,7 +2477,6 @@ public ManifestoCrt valorOutrosCustosDestinatario(BigDecimal valorOutrosCustosDe /** * Valor de outros custos do remetente<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorOutrosCustosRemetente **/ @JsonProperty("valorOutrosCustosRemetente") @@ -2563,7 +2495,6 @@ public ManifestoCrt valorOutrosCustosRemetente(BigDecimal valorOutrosCustosRemet /** * Valor do reembolso da mercadoria - contra entrega<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorReembolso **/ @JsonProperty("valorReembolso") @@ -2582,7 +2513,6 @@ public ManifestoCrt valorReembolso(BigDecimal valorReembolso) { /** * Valor do seguro da mercadoria do destinatário<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorSeguroDestinatario **/ @JsonProperty("valorSeguroDestinatario") @@ -2601,7 +2531,6 @@ public ManifestoCrt valorSeguroDestinatario(BigDecimal valorSeguroDestinatario) /** * Valor do seguro da mercadoria do remetente<br/>Moeda informada deverá ser um código na tabela de moedas (TABX)<br/>Formato: Número Racional com 12 casas inteiras e 2 casas decimais - * * @return valorSeguroRemetente **/ @JsonProperty("valorSeguroRemetente") @@ -2620,7 +2549,6 @@ public ManifestoCrt valorSeguroRemetente(BigDecimal valorSeguroRemetente) { /** * Volume da carga em metros cúbicos<br/>Formato: Número Racional com 9 casas inteiras e 3 casas decimais - * * @return volumeM3 **/ @JsonProperty("volumeM3") diff --git a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoViagem.java b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoViagem.java index c8df24f..586a9fa 100644 --- a/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoViagem.java +++ b/src/main/java/br/gov/siscomex/portalunico/ccta_ter_ext_xml/model/ManifestoViagem.java @@ -865,7 +865,6 @@ public ManifestoViagem cavaloPropriaMercadoria(Boolean cavaloPropriaMercadoria) /** * Chassi do veículo da viagem<br/> Tamanho Máximo: 20 - * * @return chassiVeiculo **/ @JsonProperty("chassiVeiculo") @@ -905,7 +904,6 @@ public ManifestoViagem cidadeDestinoFinal(String cidadeDestinoFinal) { /** * Cidade de partida da viagem<br/> Formato: AAAAA - * * @return cidadePartida **/ @JsonProperty("cidadePartida") @@ -944,7 +942,6 @@ public ManifestoViagem cidadeProprietarioVeiculoEstrangeiro(String cidadeProprie /** * Cidade do endereço do transportador estrangeiro</br>Obrigatorio se transportador for estrangeiro (\"transportadorNacBrasileira\" = false)<br/> Tamanho Máximo: 50 - * * @return cidadeTransportadorEstrangeiro **/ @JsonProperty("cidadeTransportadorEstrangeiro") @@ -1001,7 +998,6 @@ public ManifestoViagem codigoPostalTransportadorEstrangeiro(String codigoPostalT /** * Indicador que informa se o condutor do veículo da viagem é de nacionalidade brasileira - * * @return condutorBrasileiro **/ @JsonProperty("condutorBrasileiro") @@ -1021,7 +1017,6 @@ public ManifestoViagem condutorBrasileiro(Boolean condutorBrasileiro) { /** * Get crts - * * @return crts **/ @JsonProperty("crts") @@ -1045,7 +1040,6 @@ public ManifestoViagem addCrtsItem(CrtViagem crtsItem) { /** * Data de emissão do documento de transporte<br/>Formato: yyyy-MM-dd - * * @return dataEmissao **/ @JsonProperty("dataEmissao") @@ -1065,7 +1059,6 @@ public ManifestoViagem dataEmissao(String dataEmissao) { /** * data prevista de chegada do veículo na cidade de destino final viagem<br/>Formato: yyyy-MM-dd - * * @return dataPrevistaDestinoFinal **/ @JsonProperty("dataPrevistaDestinoFinal") @@ -1084,7 +1077,6 @@ public ManifestoViagem dataPrevistaDestinoFinal(String dataPrevistaDestinoFinal) /** * Data prevista de chegada do veículo na Aduana de entrada no Brasil<br/>Formato: yyyy-MM-dd - * * @return dataPrevistaEntrada **/ @JsonProperty("dataPrevistaEntrada") @@ -1103,7 +1095,6 @@ public ManifestoViagem dataPrevistaEntrada(String dataPrevistaEntrada) { /** * Data de vencimento do seguro<br/>Formato: yyyy-MM-dd - * * @return dataVencimentoSeguro **/ @JsonProperty("dataVencimentoSeguro") @@ -1123,7 +1114,6 @@ public ManifestoViagem dataVencimentoSeguro(String dataVencimentoSeguro) { /** * Descrição da rota internacional desde local de partida até a cidade de destino final<br/> Tamanho Máximo: 500 - * * @return descricaoRotaInternacional **/ @JsonProperty("descricaoRotaInternacional") @@ -1143,7 +1133,6 @@ public ManifestoViagem descricaoRotaInternacional(String descricaoRotaInternacio /** * Estado ou província do endereço do proprietário estrangeiro do veículo</br>Obrigatorio se proprietário do veículo for estrangeiro (\"proprietárioVeiculoBrasileiro\" = false)<br/> Tamanho Máximo: 50 - * * @return estadoProprietarioVeiculoEstrangeiro **/ @JsonProperty("estadoProprietarioVeiculoEstrangeiro") @@ -1162,7 +1151,6 @@ public ManifestoViagem estadoProprietarioVeiculoEstrangeiro(String estadoProprie /** * Estado ou província do endereço do transportador estrangeiro</br>Obrigatorio se transportador for estrangeiro (\"transportadorNacBrasileira\" = false)<br/> Tamanho Máximo: 50 - * * @return estadoTransportadorEstrangeiro **/ @JsonProperty("estadoTransportadorEstrangeiro") @@ -1181,7 +1169,6 @@ public ManifestoViagem estadoTransportadorEstrangeiro(String estadoTransportador /** * Identificação fiscal do proprietário do veículo da viagem<br/>Se proprietarioVeiculoBrasileiro é S, o CPF ou CNPJ preenchido neste campo será validado na tabela de CPF ou CNPJ.<br/> Tamanho: 14 - * * @return identificacaoProprietarioVeiculo **/ @JsonProperty("identificacaoProprietarioVeiculo") @@ -1220,7 +1207,6 @@ public ManifestoViagem identificacaoRepresentanteTransportadorEstrangeiro(String /** * Número de identificação do transportador estrangeiro</br>Obrigatorio se transportador for estrangeiro (\"transportadorNacBrasileira\" = false)<br/> Tamanho: 14 - * * @return identificacaoTransportadorEstrangeiro **/ @JsonProperty("identificacaoTransportadorEstrangeiro") @@ -1239,7 +1225,6 @@ public ManifestoViagem identificacaoTransportadorEstrangeiro(String identificaca /** * CNPJ do transportador nacional<br/> Se transportadorNacBrasileira é true, este campo é de preenchimento obrigatório e válido no cadastro de CNPJ<br/> Tamanho: 14 - * * @return identificacaoTransportadorNacional **/ @JsonProperty("identificacaoTransportadorNacional") @@ -1306,7 +1291,6 @@ public ManifestoViagem addLacresVeiculoItem(Lacre lacresVeiculoItem) { /** * Licença complementar<br/>campo obrigatório se tipoTransporte é REG e transportadorNacBrasileira é false.<br/> Tamanho Máximo: 6 - * * @return licencaComplementar **/ @JsonProperty("licencaComplementar") @@ -1325,7 +1309,6 @@ public ManifestoViagem licencaComplementar(String licencaComplementar) { /** * Licença originária<br/>campo obrigatório se tipoTransporte é REG e transportadorNacBrasileira é true.<br/> Tamanho Máximo: 6 - * * @return licencaOriginaria **/ @JsonProperty("licencaOriginaria") @@ -1344,7 +1327,6 @@ public ManifestoViagem licencaOriginaria(String licencaOriginaria) { /** * Marca do veículo da viagem<br/> Tamanho Máximo: 20 - * * @return marcaVeiculo **/ @JsonProperty("marcaVeiculo") @@ -1364,7 +1346,6 @@ public ManifestoViagem marcaVeiculo(String marcaVeiculo) { /** * Nome do condutor estrangeiro do veículo</br>Obrigatorio se condutor do veículo for estrangeiro (\"condutorBrasileiro\" = false)<br/> Tamanho Máximo: 50 - * * @return nomeCondutorVeiculoEstrangeiro **/ @JsonProperty("nomeCondutorVeiculoEstrangeiro") @@ -1383,7 +1364,6 @@ public ManifestoViagem nomeCondutorVeiculoEstrangeiro(String nomeCondutorVeiculo /** * Nome do proprietário estrangeiro do veículo </br>Obrigatorio se proprietário do veículo for estrangeiro (\"proprietárioVeiculoBrasileiro\" = false)<br/> Tamanho Máximo: 60 - * * @return nomeProprietarioVeiculoEstrangeiro **/ @JsonProperty("nomeProprietarioVeiculoEstrangeiro") @@ -1402,7 +1382,6 @@ public ManifestoViagem nomeProprietarioVeiculoEstrangeiro(String nomeProprietari /** * Nome do transportador estrangeiro</br>Obrigatorio se transportador for estrangeiro (\"transportadorNacBrasileira\" = false)<br/> Tamanho Máximo: 150 - * * @return nomeTransportadorEstrangeiro **/ @JsonProperty("nomeTransportadorEstrangeiro") @@ -1421,7 +1400,6 @@ public ManifestoViagem nomeTransportadorEstrangeiro(String nomeTransportadorEstr /** * Numero da declaração de trânsito no exterior, quando ocorrer<br/> Tamanho Máximo: 20 - * * @return numeroDTAExterior **/ @JsonProperty("numeroDTAExterior") @@ -1440,7 +1418,6 @@ public ManifestoViagem numeroDTAExterior(String numeroDTAExterior) { /** * Número do documento do condutor do veículo (relacionado ao Tipo do documento informado no campo anterior)<br/> Tamanho Máximo: 20 - * * @return numeroDocumentoCondutorVeiculo **/ @JsonProperty("numeroDocumentoCondutorVeiculo") @@ -1460,7 +1437,6 @@ public ManifestoViagem numeroDocumentoCondutorVeiculo(String numeroDocumentoCond /** * Número do documento de transporte.<br/>Não pode haver outro documento de transporte com a mesma chave tipoDocumentoTransporte, numeroDocumentoTransporte, e dataEmissao.<br/> Tamanho Máximo: 15 - * * @return numeroDocumentoTransporte **/ @JsonProperty("numeroDocumentoTransporte") @@ -1499,7 +1475,6 @@ public ManifestoViagem observacoesGerais(String observacoesGerais) { /** * Observações adicionais a serem reportadas sobre o veículo<br/> Tamanho Máximo: 200 - * * @return observacoesVeiculo **/ @JsonProperty("observacoesVeiculo") @@ -1518,7 +1493,6 @@ public ManifestoViagem observacoesVeiculo(String observacoesVeiculo) { /** * País de destino final da viagem<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisDestinoFinal **/ @JsonProperty("paisDestinoFinal") @@ -1538,7 +1512,6 @@ public ManifestoViagem paisDestinoFinal(String paisDestinoFinal) { /** * País de partida da viagem<br/> Se tipoDocumentoTransporte é DTAI, o país preenchido deverá ser Venezuela.<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisPartida **/ @JsonProperty("paisPartida") @@ -1558,7 +1531,6 @@ public ManifestoViagem paisPartida(String paisPartida) { /** * País do endereço do proprietário estrangeiro do veículo</br>Obrigatorio se proprietário do veículo for estrangeiro (\"proprietárioVeiculoBrasileiro\" = false)<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisProprietarioVeiculoEstrangeiro **/ @JsonProperty("paisProprietarioVeiculoEstrangeiro") @@ -1577,7 +1549,6 @@ public ManifestoViagem paisProprietarioVeiculoEstrangeiro(String paisProprietari /** * Pais do endereço do transportador estrangeiro</br>Obrigatorio se transportador for estrangeiro (\"transportadorNacBrasileira\" = false)<br/>Pais informado deve existir na tabela de países ISO3166 - ALFA2<br/> Formato: AA - * * @return paisTransportadorEstrangeiro **/ @JsonProperty("paisTransportadorEstrangeiro") @@ -1596,7 +1567,6 @@ public ManifestoViagem paisTransportadorEstrangeiro(String paisTransportadorEstr /** * Placa do cavalo <br/>Obrigatória apenas se o cavalo não for a própria mercadoria.<br/> Tamanho Máximo: 20 - * * @return placaCavalo **/ @JsonProperty("placaCavalo") @@ -1616,7 +1586,6 @@ public ManifestoViagem placaCavalo(String placaCavalo) { /** * Indicador que informa se o proprietário do veículo da viagem é de nacionalidade brasileira (true/false) - * * @return proprietarioVeiculoBrasileiro **/ @JsonProperty("proprietarioVeiculoBrasileiro") @@ -1660,7 +1629,6 @@ public ManifestoViagem addReboquesItem(Reboque reboquesItem) { /** * Local de entrada na fronteira (Recinto alfandegado)<br/> Tamanho Máximo: 7 - * * @return recintoEntrada **/ @JsonProperty("recintoEntrada") @@ -1680,7 +1648,6 @@ public ManifestoViagem recintoEntrada(String recintoEntrada) { /** * Rua do endereço do proprietário estrangeiro do veículo</br>Obrigatorio se proprietário do veículo for estrangeiro (\"proprietárioVeiculoBrasileiro\" = false)<br/> Tamanho Máximo: 150 - * * @return ruaProprietarioVeiculoEstrangeiro **/ @JsonProperty("ruaProprietarioVeiculoEstrangeiro") @@ -1699,7 +1666,6 @@ public ManifestoViagem ruaProprietarioVeiculoEstrangeiro(String ruaProprietarioV /** * Rua do endereço do transportador estrangeiro</br>Obrigatorio se transportador for estrangeiro (\"transportadorNacBrasileira\" = false)<br/> Tamanho Máximo: 150 - * * @return ruaTransportadorEstrangeiro **/ @JsonProperty("ruaTransportadorEstrangeiro") @@ -1718,7 +1684,6 @@ public ManifestoViagem ruaTransportadorEstrangeiro(String ruaTransportadorEstran /** * Tara do cavalo<br/>Formato: Número Racional com 9 casas inteiras e 3 casas decimais - * * @return taraCavalo **/ @JsonProperty("taraCavalo") @@ -1737,7 +1702,6 @@ public ManifestoViagem taraCavalo(BigDecimal taraCavalo) { /** * indicador se o veículo está transportando cargas com partes ou peças de madeira - * * @return temPecasMadeira **/ @JsonProperty("temPecasMadeira") @@ -1757,7 +1721,6 @@ public ManifestoViagem temPecasMadeira(Boolean temPecasMadeira) { /** * Tipo do documento do condutor do veículo.<br/> \"F\" (CPF), \"J\" (CNPJ),\"P\" (passaporte), \"O\" (outros)<br/>Se condutorBrasileiro é true (condutor brasieliro), é obrigatório o preenchimento do valor \"F\" ou \"H\".<br/>Se condutorBrasileiro é false (condutor estrangeiro), o tipo pode ser 'P' ou 'O' - * * @return tipoDocumentoCondutorVeiculo **/ @JsonProperty("tipoDocumentoCondutorVeiculo") @@ -1780,7 +1743,6 @@ public ManifestoViagem tipoDocumentoCondutorVeiculo(TipoDocumentoCondutorVeiculo /** * Tipo de documento de transporte<br/>Deve ser MIC/DTA (1) se paisPartida for ATIT, DTAI(3) se paisPartida for Venezuela <br/>ou \"Outros\"(4) se paisPartida for qualquer outro país. - * * @return tipoDocumentoTransporte **/ @JsonProperty("tipoDocumentoTransporte") @@ -1803,7 +1765,6 @@ public ManifestoViagem tipoDocumentoTransporte(TipoDocumentoTransporteEnum tipoD /** * Indicador do tipo de transporte que pode ser regular(REG), próprio(PRO) ou ocasional(OCA) - * * @return tipoTransporte **/ @JsonProperty("tipoTransporte") @@ -1826,7 +1787,6 @@ public ManifestoViagem tipoTransporte(TipoTransporteEnum tipoTransporte) { /** * Tipo do veículo, ou seja, se é Truck (TRU) ou Cavalo com 1 (C1R), 2 (C2R) ou 3 (C3R) reboques. - * * @return tipoVeiculo **/ @JsonProperty("tipoVeiculo") @@ -1849,7 +1809,6 @@ public ManifestoViagem tipoVeiculo(TipoVeiculoEnum tipoVeiculo) { /** * Indicador que informe se é trânsito aduaneiro internacional, ou seja, se haverá desembaraço na fronteira (false) ou seguirá por trânsito (true) - * * @return transitoInternacional **/ @JsonProperty("transitoInternacional") @@ -1889,7 +1848,6 @@ public ManifestoViagem transportadorImportador(Boolean transportadorImportador) /** * Indicador que informa se o transportador é nacional (true) ou estrangeiro (false) - * * @return transportadorNacBrasileira **/ @JsonProperty("transportadorNacBrasileira") @@ -1909,7 +1867,6 @@ public ManifestoViagem transportadorNacBrasileira(Boolean transportadorNacBrasil /** * Indicador que informa se o transportador é o proprietário do veículo - * * @return transportadorProprietarioVeiculo **/ @JsonProperty("transportadorProprietarioVeiculo") @@ -1929,7 +1886,6 @@ public ManifestoViagem transportadorProprietarioVeiculo(Boolean transportadorPro /** * Local de entrada na fronteira (Unidade da Receita Federal)<br/> Tamanho Máximo: 7 - * * @return ulEntrada **/ @JsonProperty("ulEntrada") diff --git a/src/main/java/br/gov/siscomex/portalunico/classif/api/ServioPblicoNomenclaturaApi.java b/src/main/java/br/gov/siscomex/portalunico/classif/api/ServioPblicoNomenclaturaApi.java index 0d14629..624e5ec 100644 --- a/src/main/java/br/gov/siscomex/portalunico/classif/api/ServioPblicoNomenclaturaApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/classif/api/ServioPblicoNomenclaturaApi.java @@ -13,14 +13,16 @@ /** * Classificação Fiscal de Mercadoria * - *
CLSF - Classificação Fiscal de Mercadorias
Introdução
Bem-vindo à API do sistema Classificação Fiscal de Mercadorias (Classif).
O Classificação Fiscal de Mercadorias fornece a relação dos atributos configurados pelos órgãos de governo para os códigos de mercadoria (NCM). A relação é atualizada diariamente, durante a madrugada, e pode ser consultada para a data atual.
O serviço disponibilizado nesta API é \"nomenclatura\", cuja especificação será descrita abaixo.
URLs de Acesso
Para utilizar o serviço, deve-se acessar uma das URLs que seguem, de acordo com o ambiente utilizado:
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | https://val.portalunico.siscomex.gov.br/classif/api/publico/nomenclatura/download/json |
| Ambiente de Produção | https://portalunico.siscomex.gov.br/classif/api/publico/nomenclatura/download/json |
+ *
CLSF - Classificação Fiscal de Mercadorias
Introdução
Bem-vindo à API do sistema Classificação Fiscal de Mercadorias (Classif).
O Classificação Fiscal de Mercadorias fornece a relação dos atributos configurados pelos órgãos de governo para os códigos de mercadoria (NCM). A relação é atualizada diariamente, durante a madrugada, e pode ser consultada para a data atual.
O serviço disponibilizado nesta API é \"nomenclatura\", cuja especificação será descrita abaixo.
URLs de Acesso
Para utilizar o serviço, deve-se acessar uma das URLs que seguem, de acordo com o ambiente utilizado:
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | https://val.portalunico.siscomex.gov.br/classif/api/publico/nomenclatura/download/json |
| Ambiente de Produção | https://portalunico.siscomex.gov.br/classif/api/publico/nomenclatura/download/json |
+ * */ @Path("/") @Api(value = "/", description = "") public interface ServioPblicoNomenclaturaApi { /** - * Download do Arquivo + * Download do Arquivo + * */ @GET @Path("/publico/nomenclatura/download/json") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/api/DueApi.java b/src/main/java/br/gov/siscomex/portalunico/due/api/DueApi.java index ebd96a1..df59e27 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/api/DueApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/api/DueApi.java @@ -31,6 +31,7 @@ * Declaração Única de Exportação * *
Bem-vindo à API do sistema Pucomex - Declaração Única de Exportação.
A Declaração Única de Exportação (DU-E) reúne as informações comercias, tributárias e aduaneiras necessárias para a realização de todos os tipos de exportação. As informações prestadas pelo exportador permitem que sejam realizadas autorizações e fiscalizações por parte dos diversos órgãos competentes da administração pública brasileira na execução de suas atribuições legais.
A DU-E é elaborada a partir das informações prestadas nas notas fiscais de exportação eliminando com isso a redundância de informações a serem prestadas pelos exportadores. As informações relativas à carga, LPCO, e tributação podem ser prestadas nos momentos mais oportunos permitindo uma maior flexibilidade e agilidade no processo de exportação.
A DU-E permite que com uma consulta todo o fluxo seguido pela declaração seja visualizado tanto por parte dos operadores privados quando pelos órgãos diversos governamentais.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/due/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Retorna Declaração Única de Exportação - DUE, por número\" a URI é \"due/api/ext/due/{numero}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/due/api/ext/due/17BR0055562808
+ * */ @Path("/") @Api(value = "/", description = "") @@ -38,8 +39,9 @@ public interface DueApi { /** * Altera Declaração de Documento Único de Exportação - DUE. - *+ * * <p><a rel=\"noopener noreferrer\" href=\"../pages/exemplos/duex/registro-retificacao/\">Exemplos adicionais da DUE</a><br><br><a rel=\"noopener noreferrer\" href=\"../pages/exemplos/duex/oma-xsd.zip\">XSD para download</a></p> + * */ @PUT @Path("/ext/due/{numero}") @@ -57,6 +59,7 @@ public interface DueApi { /** * Consulta que retorna uma lista de Links para as DUEs encontradas. + * */ @GET @Path("/ext/due") @@ -73,6 +76,7 @@ public interface DueApi { /** * Consulta DUE com dados resumidos. + * */ @GET @Path("/ext/due/consultarDadosResumidosDUE") @@ -88,8 +92,9 @@ public interface DueApi { /** * Serviço para criação do documento único de exportação - DUE. - *
+ * * <p><a rel=\"noopener noreferrer\" href=\"../pages/exemplos/duex/registro-retificacao/\">Exemplos adicionais da DUE</a><br><br><a rel=\"noopener noreferrer\" href=\"../pages/exemplos/duex/oma-xsd.zip\">XSD para download</a></p> + * */ @POST @Path("/ext/due") @@ -107,6 +112,7 @@ public interface DueApi { /** * Retorna lista de atos concessórios do tipo isenção + * */ @GET @Path("/ext/due/{numero-da-due}/drawback/isencao/atos-concessorios") @@ -125,6 +131,7 @@ public interface DueApi { /** * Retorna lista de exigências fiscais de uma DUE. + * */ @GET @Path("/ext/due/{numero-da-due}/exigencias-fiscais") @@ -142,6 +149,7 @@ public interface DueApi { /** * Retorna Declaração Única de Exportação - DUE, por número. + * */ @GET @Path("/ext/due/numero-da-due/{numero}") @@ -158,6 +166,7 @@ public interface DueApi { /** * Retorna Declaração Única de Exportação - DUE, por número da RUC. + * */ @GET @Path("/ext/due/numero-da-ruc/{numero}") @@ -174,8 +183,9 @@ public interface DueApi { /** * Serviço para vinculação de atos concessórios de Drawback Isenção ao documento único de exportação - DUE. - *
+ * * <p><a rel=\"noopener noreferrer\" href=\"../pages/exemplos/duex/vinculo-drawback-isencao/\">Exemplos adicionais da DUE</a><br><br><a rel=\"noopener noreferrer\" href=\"../pages/exemplos/duex/oma-xsd.zip\">XSD para download</a></p> + * */ @PUT @Path("/ext/due/{numero}/ato-concessorio-isencao") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/AtoConcessorio.java b/src/main/java/br/gov/siscomex/portalunico/due/model/AtoConcessorio.java index 67c8a8e..487c596 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/AtoConcessorio.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/AtoConcessorio.java @@ -213,7 +213,6 @@ public AtoConcessorio situacao(Situacao situacao) { /** * Get tipo - * * @return tipo **/ @JsonProperty("tipo") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/DUE.java b/src/main/java/br/gov/siscomex/portalunico/due/model/DUE.java index f591f7e..a2744cc 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/DUE.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/DUE.java @@ -825,7 +825,6 @@ public DUE dataDeRegistro(OffsetDateTime dataDeRegistro) { /** * Data em que a carga foi completamente exportada<br />Formato:'yyyy-MM-dd'T'HH:mm:ss.SSSZ' - * * @return dataDoCCE **/ @JsonProperty("dataDoCCE") @@ -863,7 +862,6 @@ public DUE declaracaoTributaria(DeclaracaoTributaria declaracaoTributaria) { /** * Get declarante - * * @return declarante **/ @JsonProperty("declarante") @@ -920,7 +918,6 @@ public DUE despachoEmRecintoDomiciliar(Boolean despachoEmRecintoDomiciliar) { /** * Get embarqueEmRecintoAlfandegado - * * @return embarqueEmRecintoAlfandegado **/ @JsonProperty("embarqueEmRecintoAlfandegado") @@ -977,7 +974,6 @@ public DUE enderecoDoEstabelecimentoDoLocalDeEmbarque(String enderecoDoEstabelec /** * Get estabelecimentoDoLocalDeDespacho - * * @return estabelecimentoDoLocalDeDespacho **/ @JsonProperty("estabelecimentoDoLocalDeDespacho") @@ -996,7 +992,6 @@ public DUE estabelecimentoDoLocalDeDespacho(CNPJ estabelecimentoDoLocalDeDespach /** * Get eventosDoHistorico - * * @return eventosDoHistorico **/ @JsonProperty("eventosDoHistorico") @@ -1039,7 +1034,6 @@ public DUE exigenciaAtiva(Boolean exigenciaAtiva) { /** * *Campo descontinuado, utilize o atributo exigenciasFiscaisEstruturadas - * * @return exigenciasFiscais **/ @JsonProperty("exigenciasFiscais") @@ -1063,7 +1057,6 @@ public DUE addExigenciasFiscaisItem(ExigenciaFiscalDTO exigenciasFiscaisItem) { /** * Get exigenciasFiscaisEstruturadas - * * @return exigenciasFiscaisEstruturadas **/ @JsonProperty("exigenciasFiscaisEstruturadas") @@ -1082,7 +1075,6 @@ public DUE exigenciasFiscaisEstruturadas(Link exigenciasFiscaisEstruturadas) { /** * Get formaDeExportacao - * * @return formaDeExportacao **/ @JsonProperty("formaDeExportacao") @@ -1142,7 +1134,6 @@ public DUE inclusaoNotaFiscal(Boolean inclusaoNotaFiscal) { /** * Informações complementares<br />Tamanho mínimo: 0<br />Tamanho máximo: 2000 - * * @return informacoesComplementares **/ @JsonProperty("informacoesComplementares") @@ -1185,7 +1176,6 @@ public DUE addItensItem(ItemDUERemoteDTO itensItem) { /** * Justificativa de dispensa da Nota Fiscal<br />Tamanho mínimo: 0<br />Tamanho máximo: 1000 - * * @return justificativaDeDispensaDaNotaFiscal **/ @JsonProperty("justificativaDeDispensaDaNotaFiscal") @@ -1204,7 +1194,6 @@ public DUE justificativaDeDispensaDaNotaFiscal(String justificativaDeDispensaDaN /** * Latitude do Local de Despacho<br />Regex: \"^((-)?90(\\\\.[0]{6}))|((-)?([0-9]|[1-8][0-9])(\\\\.[0-9]{6}))$\" - * * @return latitudeDoLocalDeDespacho **/ @JsonProperty("latitudeDoLocalDeDespacho") @@ -1223,7 +1212,6 @@ public DUE latitudeDoLocalDeDespacho(String latitudeDoLocalDeDespacho) { /** * Longitude do Local de Despacho<br />Regex: \"^((-)?90(\\\\.[0]{6}))|((-)?([0-9]|[1-8][0-9])(\\\\.[0-9]{6}))$\" - * * @return longitudeDoLocalDeDespacho **/ @JsonProperty("longitudeDoLocalDeDespacho") @@ -1242,7 +1230,6 @@ public DUE longitudeDoLocalDeDespacho(String longitudeDoLocalDeDespacho) { /** * Get moeda - * * @return moeda **/ @JsonProperty("moeda") @@ -1261,7 +1248,6 @@ public DUE moeda(MoedaDto moeda) { /** * Get motivoDeDispensaDaNotaFiscal - * * @return motivoDeDispensaDaNotaFiscal **/ @JsonProperty("motivoDeDispensaDaNotaFiscal") @@ -1280,7 +1266,6 @@ public DUE motivoDeDispensaDaNotaFiscal(MotivoDispensaNotaFiscalDTO motivoDeDisp /** * Número da DUE<br />Tamanho: 14<br />Formato: 'NNAANNNNNNNNNN' - * * @return numero **/ @JsonProperty("numero") @@ -1299,7 +1284,6 @@ public DUE numero(String numero) { /** * Get oea - * * @return oea **/ @JsonProperty("oea") @@ -1318,7 +1302,6 @@ public DUE oea(Boolean oea) { /** * Get paisImportador - * * @return paisImportador **/ @JsonProperty("paisImportador") @@ -1337,7 +1320,6 @@ public DUE paisImportador(PaisDto paisImportador) { /** * Get recintoAduaneiroDeDespacho - * * @return recintoAduaneiroDeDespacho **/ @JsonProperty("recintoAduaneiroDeDespacho") @@ -1356,7 +1338,6 @@ public DUE recintoAduaneiroDeDespacho(RecintoAduaneiroDto recintoAduaneiroDeDesp /** * Get recintoAduaneiroDeEmbarque - * * @return recintoAduaneiroDeEmbarque **/ @JsonProperty("recintoAduaneiroDeEmbarque") @@ -1375,7 +1356,6 @@ public DUE recintoAduaneiroDeEmbarque(RecintoAduaneiroDto recintoAduaneiroDeEmba /** * Referência do endereço do local de despacho<br />Tamanho mínimo: 0<br />Tamanho máximo: 240 - * * @return referenciaDoEnderecoDoLocalDeDespacho **/ @JsonProperty("referenciaDoEnderecoDoLocalDeDespacho") @@ -1394,7 +1374,6 @@ public DUE referenciaDoEnderecoDoLocalDeDespacho(String referenciaDoEnderecoDoLo /** * Referência do endereço do local de embarque<br />Tamanho mínimo: 0<br />Tamanho máximo: 240 - * * @return referenciaDoEnderecoDoLocalDeEmbarque **/ @JsonProperty("referenciaDoEnderecoDoLocalDeEmbarque") @@ -1413,7 +1392,6 @@ public DUE referenciaDoEnderecoDoLocalDeEmbarque(String referenciaDoEnderecoDoLo /** * Get responsavelPeloACD - * * @return responsavelPeloACD **/ @JsonProperty("responsavelPeloACD") @@ -1435,7 +1413,6 @@ public DUE responsavelPeloACD(ResponsavelPeloACDEnum responsavelPeloACD) { /** * RUC - Número da referência única de carga<br />Tamanho: 35<br />Formato: 'NAANNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN' - * * @return ruc **/ @JsonProperty("ruc") @@ -1454,7 +1431,6 @@ public DUE ruc(String ruc) { /** * Get situacao - * * @return situacao **/ @JsonProperty("situacao") @@ -1520,7 +1496,6 @@ public DUE situacaoEspecial(SituacaoEspecialEnum situacaoEspecial) { /** * Get situacoesDaCarga - * * @return situacoesDaCarga **/ @JsonProperty("situacoesDaCarga") @@ -1544,7 +1519,6 @@ public DUE addSituacoesDaCargaItem(SituacaoDaCargaDTO situacoesDaCargaItem) { /** * Get solicitacoes - * * @return solicitacoes **/ @JsonProperty("solicitacoes") @@ -1590,7 +1564,6 @@ public DUE tipo(TipoEnum tipo) { /** * Get tratamentoPrioritario - * * @return tratamentoPrioritario **/ @JsonProperty("tratamentoPrioritario") @@ -1628,7 +1601,6 @@ public DUE unidadeLocalDeAnaliseFiscal(UnidadeLocalRFBDto unidadeLocalDeAnaliseF /** * Get unidadeLocalDeDespacho - * * @return unidadeLocalDeDespacho **/ @JsonProperty("unidadeLocalDeDespacho") @@ -1647,7 +1619,6 @@ public DUE unidadeLocalDeDespacho(UnidadeLocalRFBDto unidadeLocalDeDespacho) { /** * Get unidadeLocalDeEmbarque - * * @return unidadeLocalDeEmbarque **/ @JsonProperty("unidadeLocalDeEmbarque") @@ -1666,7 +1637,6 @@ public DUE unidadeLocalDeEmbarque(UnidadeLocalRFBDto unidadeLocalDeEmbarque) { /** * Valor total da mercadoria<br />Tamanho: 15,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorTotalMercadoria **/ @JsonProperty("valorTotalMercadoria") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/DUEResumida.java b/src/main/java/br/gov/siscomex/portalunico/due/model/DUEResumida.java index ca5ea92..b7d5287 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/DUEResumida.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/DUEResumida.java @@ -305,7 +305,6 @@ public DUEResumida longitudeDespacho(String longitudeDespacho) { /** * Número da DUE<br />Tamanho: 14<br />Formato: 'NNAANNNNNNNNNN' - * * @return numeroDUE **/ @JsonProperty("numeroDUE") @@ -324,7 +323,6 @@ public DUEResumida numeroDUE(String numeroDUE) { /** * RUC - Número da referência única de carga<br />Tamanho: 35<br />Formato: 'NAANNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN' - * * @return numeroRUC **/ @JsonProperty("numeroRUC") @@ -343,7 +341,6 @@ public DUEResumida numeroRUC(String numeroRUC) { /** * Responsável pela Unidade Aduaneira do Despacho<br />Tamanho mínimo: 1<br />Tamanho máximo: 14 - * * @return responsavelUADespacho **/ @JsonProperty("responsavelUADespacho") @@ -362,7 +359,6 @@ public DUEResumida responsavelUADespacho(String responsavelUADespacho) { /** * Situação da Carga<br />Domínio: <br />1 = Estocada<br />2 = Em Trânsito<br />3 = Carga Completamente Exportada - * * @return situacaoCarga **/ @JsonProperty("situacaoCarga") @@ -386,7 +382,6 @@ public DUEResumida addSituacaoCargaItem(Integer situacaoCargaItem) { /** * Situação<br />Domínio: <br />1 = Em elaboração<br /> 10 = Registrada<br />11 = Declaração apresentada para despacho<br /> 15 = ACD em processamento<br />20 = Liberada sem conferência aduaneira<br /> 21 = Selecionada para conferência aduaneira<br />24 = Embarque antecipado pendente de LPCO<br /> 25 = Embarque antecipado autorizado<br />26 = Embarque antecipado pendente de autorização<br /> 30 = Em análise fiscal<br />35 = Concluída análise fiscal<br /> 36 = Desembaraço pendente de LPCO<br /> 40 = Desembaraçada<br />70 = Averbada<br /> 80 = Cancelada pelo exportador<br /> 81 = Cancelada por expiração de prazo<br />82 = Cancelada pela RFB<br /> 83 = Cancelada pela RFB a pedido do exportador<br /> 86 = Interrompida - * * @return situacaoDUE **/ @JsonProperty("situacaoDUE") @@ -405,7 +400,6 @@ public DUEResumida situacaoDUE(Integer situacaoDUE) { /** * Unidade aduaneira de despacho<br />Tamanho: 7<br />Formato: 'NNNNNNN' - * * @return uaDespacho **/ @JsonProperty("uaDespacho") @@ -424,7 +418,6 @@ public DUEResumida uaDespacho(String uaDespacho) { /** * Unidade aduaneira de Embarque<br />Tamanho: 7<br />Formato: 'NNNNNNN' - * * @return uaEmbarque **/ @JsonProperty("uaEmbarque") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNFe.java b/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNFe.java index 02b58f3..f4912cc 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNFe.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNFe.java @@ -250,7 +250,6 @@ public DeclarationNFe addGoodsShipmentItem(GoodsShipment goodsShipmentItem) { /** * Get id - * * @return id **/ @JsonProperty("id") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNoNF.java b/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNoNF.java index f118d5e..763bae4 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNoNF.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/DeclarationNoNF.java @@ -211,7 +211,6 @@ public DeclarationNoNF id(DeclarationIdentificationIDType id) { /** * Get ucr - * * @return ucr **/ @JsonProperty("ucr") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/ExigenciaFiscalEstruturada.java b/src/main/java/br/gov/siscomex/portalunico/due/model/ExigenciaFiscalEstruturada.java index 1442cfa..a779ef9 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/ExigenciaFiscalEstruturada.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/ExigenciaFiscalEstruturada.java @@ -313,7 +313,6 @@ public ExigenciaFiscalEstruturada matriculaServidorRespLiberacao(String matricul /** * NCM sugerida<br />Tamanho: 8 - * * @return ncmSugerida **/ @JsonProperty("ncmSugerida") @@ -332,7 +331,6 @@ public ExigenciaFiscalEstruturada ncmSugerida(String ncmSugerida) { /** * Número da DU-E<br />Tamanho: 14<br />Formato: 'NNAANNNNNNNNNN' - * * @return numeroDocumento **/ @JsonProperty("numeroDocumento") @@ -351,7 +349,6 @@ public ExigenciaFiscalEstruturada numeroDocumento(String numeroDocumento) { /** * Número de ordem da exigência<br />Formato: Inteiro, com até 3 digitos - * * @return numeroExigencia **/ @JsonProperty("numeroExigencia") @@ -370,7 +367,6 @@ public ExigenciaFiscalEstruturada numeroExigencia(Integer numeroExigencia) { /** * Observação do servidor ao atender uma exigência<br />Tamanho mínimo: 0<br />Tamanho máximo: 4000 - * * @return observacaoAtendimento **/ @JsonProperty("observacaoAtendimento") @@ -389,7 +385,6 @@ public ExigenciaFiscalEstruturada observacaoAtendimento(String observacaoAtendim /** * Órgão responsável pela criação da exigência<br />Tamanho mínimo: 1<br />Tamanho máximo: 10 - * * @return orgao **/ @JsonProperty("orgao") @@ -408,7 +403,6 @@ public ExigenciaFiscalEstruturada orgao(String orgao) { /** * Get situacao - * * @return situacao **/ @JsonProperty("situacao") @@ -427,7 +421,6 @@ public ExigenciaFiscalEstruturada situacao(SituacaoExigenciaFiscalDTO situacao) /** * Valor a recolher de Multa<br />Tamanho: 15,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorRecolherMulta **/ @JsonProperty("valorRecolherMulta") @@ -446,7 +439,6 @@ public ExigenciaFiscalEstruturada valorRecolherMulta(BigDecimal valorRecolherMul /** * Número da versão da DU-E<br />Formato: Inteiro, com até 10 digitos - * * @return versaoDocumento **/ @JsonProperty("versaoDocumento") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDUERemoteDTO.java b/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDUERemoteDTO.java index ee782c2..1d9bf09 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDUERemoteDTO.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDUERemoteDTO.java @@ -419,7 +419,6 @@ public ItemDUERemoteDTO addDocumentosImportacaoItem(DocumentoImportacao document /** * Endereço do importador<br />Tamanho mínimo: 0<br />Tamanho máximo: 380 - * * @return enderecoImportador **/ @JsonProperty("enderecoImportador") @@ -457,7 +456,6 @@ public ItemDUERemoteDTO exportacaoTemporaria(ExportacaoTemporaria exportacaoTemp /** * Get exportador - * * @return exportador **/ @JsonProperty("exportador") @@ -495,7 +493,6 @@ public ItemDUERemoteDTO itemDaNotaFiscalDeExportacao(ItemDaNotaFiscalRemoteDTO i /** * Get itensDaNotaDeRemessa - * * @return itensDaNotaDeRemessa **/ @JsonProperty("itensDaNotaDeRemessa") @@ -543,7 +540,6 @@ public ItemDUERemoteDTO addItensDeNotaComplementarItem(ItemDaNotaFiscalRemoteDTO /** * Get listaDeEnquadramentos - * * @return listaDeEnquadramentos **/ @JsonProperty("listaDeEnquadramentos") @@ -567,7 +563,6 @@ public ItemDUERemoteDTO addListaDeEnquadramentosItem(Enquadramento listaDeEnquad /** * Get listaPaisDestino - * * @return listaPaisDestino **/ @JsonProperty("listaPaisDestino") @@ -591,7 +586,6 @@ public ItemDUERemoteDTO addListaPaisDestinoItem(PaisDto listaPaisDestinoItem) { /** * Motivo do Tratamento prioritário<br />Domínio: <br />1 = Carga viva<br />2 = Carga perecível<br />3 = Carga perigosa<br />4 = Urna funerária<br />5 = Órgãos humano<br />6 = Partes/peças de aeronave - * * @return motivoDoTratamentoPrioritario **/ @JsonProperty("motivoDoTratamentoPrioritario") @@ -610,7 +604,6 @@ public ItemDUERemoteDTO motivoDoTratamentoPrioritario(String motivoDoTratamentoP /** * Get ncm - * * @return ncm **/ @JsonProperty("ncm") @@ -629,7 +622,6 @@ public ItemDUERemoteDTO ncm(NcmDto ncm) { /** * Nome do importador<br />Tamanho mínimo: 0<br />Tamanho máximo: 60 - * * @return nomeImportador **/ @JsonProperty("nomeImportador") @@ -648,7 +640,6 @@ public ItemDUERemoteDTO nomeImportador(String nomeImportador) { /** * Número do item<br />Formato: Inteiro, com até 5 digitos - * * @return numero **/ @JsonProperty("numero") @@ -667,7 +658,6 @@ public ItemDUERemoteDTO numero(Integer numero) { /** * Percentual de comissão do Agente<br />Tamanho: 3,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return percentualDeComissaoDoAgente **/ @JsonProperty("percentualDeComissaoDoAgente") @@ -686,7 +676,6 @@ public ItemDUERemoteDTO percentualDeComissaoDoAgente(BigDecimal percentualDeComi /** * Peso líquido total<br />Tamanho: 14,5<br />Formato: Decimal, com até 5 casas decimais separadas por ponto. - * * @return pesoLiquidoTotal **/ @JsonProperty("pesoLiquidoTotal") @@ -705,7 +694,6 @@ public ItemDUERemoteDTO pesoLiquidoTotal(BigDecimal pesoLiquidoTotal) { /** * Quantidade na unidade comercializada<br />Tamanho: 14,5<br />Formato: Decimal, com até 5 casas decimais separadas por ponto. - * * @return quantidadeNaUnidadeComercializada **/ @JsonProperty("quantidadeNaUnidadeComercializada") @@ -724,7 +712,6 @@ public ItemDUERemoteDTO quantidadeNaUnidadeComercializada(BigDecimal quantidadeN /** * Quantidade na unidade comercializada<br />Tamanho: 14,5<br />Formato: Decimal, com até 5 casas decimais separadas por ponto. - * * @return quantidadeNaUnidadeEstatistica **/ @JsonProperty("quantidadeNaUnidadeEstatistica") @@ -743,7 +730,6 @@ public ItemDUERemoteDTO quantidadeNaUnidadeEstatistica(BigDecimal quantidadeNaUn /** * Get tratamentosAdministrativos - * * @return tratamentosAdministrativos **/ @JsonProperty("tratamentosAdministrativos") @@ -767,7 +753,6 @@ public ItemDUERemoteDTO addTratamentosAdministrativosItem(TratamentoAdministrati /** * Unidade comercializada<br />Tamanho mínimo: 0<br />Tamanho máximo: 20 - * * @return unidadeComercializada **/ @JsonProperty("unidadeComercializada") @@ -786,7 +771,6 @@ public ItemDUERemoteDTO unidadeComercializada(String unidadeComercializada) { /** * Valor da mercadoria na condição de venda<br />Tamanho: 15,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorDaMercadoriaNaCondicaoDeVenda **/ @JsonProperty("valorDaMercadoriaNaCondicaoDeVenda") @@ -824,7 +808,6 @@ public ItemDUERemoteDTO valorDaMercadoriaNaCondicaoDeVendaEmReais(BigDecimal val /** * Valor da Mercadoria no local de embarque<br />Tamanho: 15,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorDaMercadoriaNoLocalDeEmbarque **/ @JsonProperty("valorDaMercadoriaNoLocalDeEmbarque") @@ -862,7 +845,6 @@ public ItemDUERemoteDTO valorDaMercadoriaNoLocalDeEmbarqueEmReais(BigDecimal val /** * Valor Financiado<br />Tamanho: 15,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorFinanciado **/ @JsonProperty("valorFinanciado") @@ -881,7 +863,6 @@ public ItemDUERemoteDTO valorFinanciado(BigDecimal valorFinanciado) { /** * Valor total<br />Tamanho: 15,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorTotal **/ @JsonProperty("valorTotal") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDaNotaFiscalRemoteDTO.java b/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDaNotaFiscalRemoteDTO.java index 693379b..afa969d 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDaNotaFiscalRemoteDTO.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/ItemDaNotaFiscalRemoteDTO.java @@ -275,7 +275,6 @@ public ItemDaNotaFiscalRemoteDTO quantidadeEstatistica(BigDecimal quantidadeEsta /** * Unidade comercial<br />Tamanho mínimo: 1<br />Tamanho máximo: 6 - * * @return unidadeComercial **/ @JsonProperty("unidadeComercial") @@ -294,7 +293,6 @@ public ItemDaNotaFiscalRemoteDTO unidadeComercial(String unidadeComercial) { /** * Valor total bruto<br />Tamanho: 13,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorTotalBruto **/ @JsonProperty("valorTotalBruto") @@ -313,7 +311,6 @@ public ItemDaNotaFiscalRemoteDTO valorTotalBruto(BigDecimal valorTotalBruto) { /** * Valor total calculado<br />Tamanho: 13,2<br />Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorTotalCalculado **/ @JsonProperty("valorTotalCalculado") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/NotaFiscalRemoteDTO.java b/src/main/java/br/gov/siscomex/portalunico/due/model/NotaFiscalRemoteDTO.java index 85699f7..8e53faa 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/NotaFiscalRemoteDTO.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/NotaFiscalRemoteDTO.java @@ -238,7 +238,6 @@ public NotaFiscalRemoteDTO quantidadeDeItens(Integer quantidadeDeItens) { /** * Serie<br />Formato: Inteiro, com até 3 digitos - * * @return serie **/ @JsonProperty("serie") @@ -257,7 +256,6 @@ public NotaFiscalRemoteDTO serie(Integer serie) { /** * UF do emissor<br />Tamanho: 2<br />Formato: 'AAS' - * * @return ufDoEmissor **/ @JsonProperty("ufDoEmissor") diff --git a/src/main/java/br/gov/siscomex/portalunico/due/model/QuadroCalculoDto.java b/src/main/java/br/gov/siscomex/portalunico/due/model/QuadroCalculoDto.java index 10e40ae..73dcbdb 100644 --- a/src/main/java/br/gov/siscomex/portalunico/due/model/QuadroCalculoDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/due/model/QuadroCalculoDto.java @@ -248,7 +248,6 @@ public QuadroCalculoDto valorCalculado(BigDecimal valorCalculado) { /** * Valor devido<br />Tamanho: 16,7<br />Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorDevido **/ @JsonProperty("valorDevido") @@ -267,7 +266,6 @@ public QuadroCalculoDto valorDevido(BigDecimal valorDevido) { /** * Valor normal<br />Tamanho: 16,7<br />Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorNormal **/ @JsonProperty("valorNormal") @@ -286,7 +284,6 @@ public QuadroCalculoDto valorNormal(BigDecimal valorNormal) { /** * Valor suspenso<br />Tamanho: 16,7<br />Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorSuspenso **/ @JsonProperty("valorSuspenso") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp/api/ServiosExternosSefazApi.java b/src/main/java/br/gov/siscomex/portalunico/duimp/api/ServiosExternosSefazApi.java index 7463f59..399a802 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp/api/ServiosExternosSefazApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp/api/ServiosExternosSefazApi.java @@ -19,6 +19,7 @@ * Declaração Única de Importação - SEFAZ * *
Duimp - Declaração Única de Importação
Introdução
Bem-vindo à API do sistema Pucomex - Declaração Única de Importação .
A Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública brasileira na execução de suas atribuições legais.
O processo eliminará diversas redundâncias presentes no fluxo atual e permitirá a visualização da integralidade da operação tanto pelo operador privado como pelos órgãos governamentais.
Outro importante avanço é a flexibilização, em relação ao modelo atual, do momento de prestação das informações pelo importador. Respeitando determinados marcos temporais, o importador terá maior domínio sobre o fluxo de informações e dos procedimentos relacionados à sua operação, podendo optar pelo momento mais oportuno para prestá-las à Administração e determinando, assim, a movimentação de seu processo.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação da Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consulta dos dados da versão vigente de uma Duimp\" a URI é \"ext/sefaz/duimp/{numero}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp/api/ext/sefaz/duimp/20BR00001001899
+ * */ @Path("/") @Api(value = "/", description = "") @@ -26,8 +27,9 @@ public interface ServiosExternosSefazApi { /** * Consulta os dados de uma versão específica de uma DUIMP registrada. - *+ * * <p>Disponível apenas para as Secretarias de Fazenda (SEFAZ).</p> + * */ @GET @Path("/ext/sefaz/duimp/{numeroDuimp}/{versaoDuimp}") @@ -45,8 +47,9 @@ public interface ServiosExternosSefazApi { /** * Consulta os dados da versão vigente de uma DUIMP registrada. - *
+ * * <p> Disponível apenas para as Secretarias de Fazenda (SEFAZ).</p> + * */ @GET @Path("/ext/sefaz/duimp/{numeroDuimp}") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp/model/DadosDaCarga.java b/src/main/java/br/gov/siscomex/portalunico/duimp/model/DadosDaCarga.java index 488de30..e0c915f 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp/model/DadosDaCarga.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp/model/DadosDaCarga.java @@ -456,7 +456,6 @@ public DadosDaCarga viaTransporte(ViaTransporteEnum viaTransporte) { /** * Data de Chegada da Carga na URF de Localização da Carga.<br>Formato: 'yyyy-MM-dd' - * * @return dataChegada **/ @JsonProperty("dataChegada") @@ -494,7 +493,6 @@ public DadosDaCarga paisProcedencia(PasDoExportadorEstrangeiroObjetoCompostoPelo /** * Peso líquido em quilogramas correspondente ao quantitativo total das mercadorias do item.<br>Tamanho: 16,5<br>Formato: Decimal, com até 5 casas decimais separadas por ponto. - * * @return pesoLiquido **/ @JsonProperty("pesoLiquido") @@ -513,7 +511,6 @@ public DadosDaCarga pesoLiquido(BigDecimal pesoLiquido) { /** * Código da moeda do Valor total do Frete<br> Domínio: Tabela de Moedas do Siscomex.<br>Tamanho: 3<br>Formato: 'NNN' - * * @return moedaFreteTotal **/ @JsonProperty("moedaFreteTotal") @@ -551,7 +548,6 @@ public DadosDaCarga valorFreteTotalMoedaUtiliza(BigDecimal valorFreteTotalMoedaU /** * Valor total do frete em R$ (Reais)<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto.<br>Observação:<br>Para as Duimp registradas a partir de 08/06/2022, o valor do frete utilizado no cálculo do valor aduaneiro não inclui os gastos relativos à carga, à descarga e ao manuseio incorridos no território nacional e destacados do custo de transporte - * * @return valorFreteTotalEmReal **/ @JsonProperty("valorFreteTotalEmReal") @@ -570,7 +566,6 @@ public DadosDaCarga valorFreteTotalEmReal(BigDecimal valorFreteTotalEmReal) { /** * Valor total do frete em Dólares<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto.<br>Observação:<br>Para as Duimp registradas a partir de 08/06/2022, o valor do frete utilizado no cálculo do valor aduaneiro não inclui os gastos relativos à carga, à descarga e ao manuseio incorridos no território nacional e destacados do custo de transporte - * * @return valorFreteTotalDolar **/ @JsonProperty("valorFreteTotalDolar") @@ -589,7 +584,6 @@ public DadosDaCarga valorFreteTotalDolar(BigDecimal valorFreteTotalDolar) { /** * Valor total do frete não utilizado no cálculo do valor aduaneiro da Duimp, em R$ (Reais)<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto.<br>Observação:<br>Para as Duimp registradas a partir de 08/06/2022, o valor do frete utilizado no cálculo do valor aduaneiro não inclui os gastos relativos à carga, à descarga e ao manuseio incorridos no território nacional e destacados do custo de transporte - * * @return valorFreteTotalDestinoEmReal **/ @JsonProperty("valorFreteTotalDestinoEmReal") @@ -608,7 +602,6 @@ public DadosDaCarga valorFreteTotalDestinoEmReal(BigDecimal valorFreteTotalDesti /** * Valor total do frete não utilizado no cálculo do valor aduaneiro da Duimp, em Dólares<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto.<br>Observação:<br>Para as Duimp registradas a partir de 08/06/2022, o valor do frete utilizado no cálculo do valor aduaneiro não inclui os gastos relativos à carga, à descarga e ao manuseio incorridos no território nacional e destacados do custo de transporte - * * @return valorFreteTotalDestinoDolar **/ @JsonProperty("valorFreteTotalDestinoDolar") @@ -627,7 +620,6 @@ public DadosDaCarga valorFreteTotalDestinoDolar(BigDecimal valorFreteTotalDestin /** * Código da moeda negociada do seguro<br> Domínio: Tabela de Moedas do Siscomex.<br>Tamanho: 3<br>Formato: 'NNN' - * * @return moedaSeguro **/ @JsonProperty("moedaSeguro") @@ -646,7 +638,6 @@ public DadosDaCarga moedaSeguro(Integer moedaSeguro) { /** * Valor do seguro na moeda negociada<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorSeguroMoedaUtilizada **/ @JsonProperty("valorSeguroMoedaUtilizada") @@ -665,7 +656,6 @@ public DadosDaCarga valorSeguroMoedaUtilizada(BigDecimal valorSeguroMoedaUtiliza /** * Valor do seguro em R$ (Reais)<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorSeguroEmReal **/ @JsonProperty("valorSeguroEmReal") @@ -684,7 +674,6 @@ public DadosDaCarga valorSeguroEmReal(BigDecimal valorSeguroEmReal) { /** * Valor do seguro em Dólares<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorSeguroDolar **/ @JsonProperty("valorSeguroDolar") @@ -722,7 +711,6 @@ public DadosDaCarga dadosCargaAquaviaria(DadosExclusivosDeUmaCargaAquaviriaNoSis /** * Get dadosCargaAerea - * * @return dadosCargaAerea **/ @JsonProperty("dadosCargaAerea") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazCalculoTributoCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazCalculoTributoCover.java index 0ccdae9..6a5d823 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazCalculoTributoCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazCalculoTributoCover.java @@ -434,7 +434,6 @@ public SefazCalculoTributoCover percReducaoAliquotaReduzida(BigDecimal percReduc /** * Valor calculado em reais.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorCalculado **/ @JsonProperty("valorCalculado") @@ -453,7 +452,6 @@ public SefazCalculoTributoCover valorCalculado(BigDecimal valorCalculado) { /** * Valor a reduzir em reais.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorAReduzir **/ @JsonProperty("valorAReduzir") @@ -472,7 +470,6 @@ public SefazCalculoTributoCover valorAReduzir(BigDecimal valorAReduzir) { /** * Valor devido em reais.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorDevido **/ @JsonProperty("valorDevido") @@ -491,7 +488,6 @@ public SefazCalculoTributoCover valorDevido(BigDecimal valorDevido) { /** * Valor suspenso em reais.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorSuspenso **/ @JsonProperty("valorSuspenso") @@ -510,7 +506,6 @@ public SefazCalculoTributoCover valorSuspenso(BigDecimal valorSuspenso) { /** * Valor do imposto a recolher em reais.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return impostoARecolher **/ @JsonProperty("impostoARecolher") @@ -529,7 +524,6 @@ public SefazCalculoTributoCover impostoARecolher(BigDecimal impostoARecolher) { /** * Valor normal em reais.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorNormal **/ @JsonProperty("valorNormal") @@ -548,7 +542,6 @@ public SefazCalculoTributoCover valorNormal(BigDecimal valorNormal) { /** * Valor originalmente devido em Real. Valor aplicável para Duimp de situação especial de despacho cujo motivo de situação especial de despacho possua o 'Indicador de cobrança do tributo suspenso' = Sim<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorOriginalmenteDevido **/ @JsonProperty("valorOriginalmenteDevido") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDeclaracaoVinculada.java b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDeclaracaoVinculada.java index 5a77efd..9c97351 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDeclaracaoVinculada.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDeclaracaoVinculada.java @@ -397,7 +397,6 @@ public SefazDeclaracaoVinculada numeroItemDeclaracaoVinculada(String numeroItemD /** * Valor do frete (R$) do item.<br>O valor do frete (R$) do item é informado apenas quando a Duimp consultada for COM situação especial de despacho, o tipo da declaração vinculada for \"Duimp\" e quando o frete foi calculado durante a elaboração/registro da Duimp consultada, caso contrário, esse atributo será fornecido com o valor nulo. O conteúdo será preenchido da seguinte forma: o valor do frete (R$) do item da Duimp informada como vinculada, quando esta for SEM situação especial de despacho ou o valor do frete (R$) do item da Duimp original (Duimp de admissão em regime especial), quando a Duimp informada como vinculada for COM situação especial de despacho.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto.<br>Observação:<br>Apenas quando a declaração vinculada for uma Duimp. - * * @return valorFreteReal **/ @JsonProperty("valorFreteReal") @@ -416,7 +415,6 @@ public SefazDeclaracaoVinculada valorFreteReal(BigDecimal valorFreteReal) { /** * Valor do seguro (R$) do item.<br>O valor do seguro (R$) item é informado apenas quando a Duimp consultada for COM situação especial de despacho, o tipo da declaração vinculada for \"Duimp\" e quando o seguro foi calculado durante a elaboração/registro da Duimp consultada, caso contrário, esse atributo será fornecido com o valor nulo. O conteúdo será preenchido da seguinte forma: o valor do seguro (R$) do item da Duimp informada como vinculada, quando esta for SEM situação especial de despacho ou o valor do seguro (R$) do item da Duimp original (Duimp de admissão em regime especial), quando a Duimp informada como vinculada for COM situação especial de despacho.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valorSeguroReal **/ @JsonProperty("valorSeguroReal") @@ -473,7 +471,6 @@ public SefazDeclaracaoVinculada qtdMercadoriaUnidadeEstatistica(BigDecimal qtdMe /** * Regime Aplicado ao Item da Declaração Vinculada.<br>Dominio: Regimes tributários existentes no sistema Tratamento Tributário<br>Observação:<br>Apenas quando a declaração vinculada for uma Duimp. - * * @return itemCodigoRegime **/ @JsonProperty("itemCodigoRegime") @@ -492,7 +489,6 @@ public SefazDeclaracaoVinculada itemCodigoRegime(Integer itemCodigoRegime) { /** * Fundamento Aplicado ao Item da Declaração Vinculada<br>Dominio: Fundamentos legais existentes no sistema Tratamento Tributário<br>Observação:<br>Apenas quando a declaração vinculada for uma Duimp. - * * @return itemCodigoFundamento **/ @JsonProperty("itemCodigoFundamento") @@ -511,7 +507,6 @@ public SefazDeclaracaoVinculada itemCodigoFundamento(Integer itemCodigoFundament /** * Código da NCM associada ao item da Declaração Vinculada.<br>Tamanho: 8<br>Formato: 'NNNNNNNN'<br>Observação:<br>Apenas quando a declaração vinculada for uma Duimp. - * * @return itemNcmAssociada **/ @JsonProperty("itemNcmAssociada") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDuimpCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDuimpCover.java index 50f5c8a..8e0b41d 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDuimpCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazDuimpCover.java @@ -425,7 +425,6 @@ public SefazDuimpCover tipoImportador(TipoImportadorEnum tipoImportador) { /** * <br>Número de indentificação do Importador: <br>Caso seja CNPJ: <br>Tamanho: 14<br>Formato: 'NNNNNNNNNNNNNN'<br>Caso seja CPF: <br>Tamanho: 11<br>Formato: 'NNNNNNNNNNN' - * * @return niImportador **/ @JsonProperty("niImportador") @@ -465,7 +464,6 @@ public SefazDuimpCover nomeImportador(String nomeImportador) { /** * UF do importador<br>Dominio:<br>AC, AL, AP, AM, BA, CE, DF<br>ES, GO, MA, MT, MS, MG, PA<br>PB, PR, PE, PI, RJ, RN, RS<br>RO, RR, SC, SP, SE, TO - * * @return ufImportador **/ @JsonProperty("ufImportador") @@ -598,7 +596,6 @@ public SefazDuimpCover addDocumentosInstrutivoDespachoItem(DocumentoInstrutivoDo /** * Lista de processos vinculados - * * @return processosVinculados **/ @JsonProperty("processosVinculados") @@ -622,7 +619,6 @@ public SefazDuimpCover addProcessosVinculadosItem(DadosDoProcesso processosVincu /** * Lista de declarações estrangeiras - * * @return docDeclaracoesExportacaoEstrangeira **/ @JsonProperty("docDeclaracoesExportacaoEstrangeira") @@ -646,7 +642,6 @@ public SefazDuimpCover addDocDeclaracoesExportacaoEstrangeiraItem(DadosDaDeclara /** * Get sefazDadosResumo - * * @return sefazDadosResumo **/ @JsonProperty("sefazDadosResumo") @@ -666,7 +661,6 @@ public SefazDuimpCover sefazDadosResumo(SefazDadosResumo sefazDadosResumo) { /** * Lista de eventos no histórico de operações - * * @return itensHistorico **/ @JsonProperty("itensHistorico") @@ -690,7 +684,6 @@ public SefazDuimpCover addItensHistoricoItem(SefazDuimpHistEventoCover itensHist /** * Lista de itens de Duimp - * * @return itens **/ @JsonProperty("itens") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazItemCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazItemCover.java index c164a9b..f005993 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazItemCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp/model/SefazItemCover.java @@ -282,7 +282,6 @@ public SefazItemCover dadosCambiais(SefazDadosCambiaisCover dadosCambiais) { /** * Get itemTributo - * * @return itemTributo **/ @JsonProperty("itemTributo") @@ -302,7 +301,6 @@ public SefazItemCover itemTributo(SefazItemTributoCover itemTributo) { /** * Lista de LPCOs do item - * * @return lpcos **/ @JsonProperty("lpcos") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ChaveDeAcessoApi.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ChaveDeAcessoApi.java index f332a88..560d2d1 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ChaveDeAcessoApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ChaveDeAcessoApi.java @@ -23,7 +23,8 @@ /** * Declaração Única de Importação - Intervenientes Privados * - *
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
+ * * Use esta funcionalidade para recuperar os dados relativos a chave de acesso do importador em um determinado período. + * */ @GET @Path("/ext/duimp/chaves-acesso/importadores/{ni-importador}") @@ -49,8 +51,9 @@ public interface ChaveDeAcessoApi { /** * Recuperar as chaves de acesso de uma lista de Duimp. - *
+ * * Use esta funcionalidade para recuperar os dados relativos a chave de acesso para uma lista de Duimp. + * */ @GET @Path("/ext/duimp/chaves-acesso") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/DadosGeraisDaDuimpApi.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/DadosGeraisDaDuimpApi.java index 65e087b..e3248eb 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/DadosGeraisDaDuimpApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/DadosGeraisDaDuimpApi.java @@ -27,7 +27,8 @@ /** * Declaração Única de Importação - Intervenientes Privados * - *
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
+ * * Use esta funcionalidade para atualizar os dados gerais de uma Duimp que já foi salva tanto para registro quanto para retificação. + * */ @PUT @Path("/ext/duimp/{numero-duimp}/{versao-duimp}") @@ -54,8 +56,9 @@ public interface DadosGeraisDaDuimpApi { /** * Consultar valores calculados da Duimp. - *
+ * * Use esta funcionalidade para recuperar os valores calculados de uma Duimp em rascunho ou uma solicitação de retificação em rascunho, para pagamento. + * */ @GET @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/valores-calculados") @@ -72,8 +75,9 @@ public interface DadosGeraisDaDuimpApi { /** * Salvar dados gerais da Duimp para registro. - *
+ * * Use esta funcionalidade para salvar os dados gerais de uma Duimp que ainda não foi salva para registro. + * */ @POST @Path("/ext/duimp") @@ -91,8 +95,9 @@ public interface DadosGeraisDaDuimpApi { /** * Salvar dados gerais da Duimp para retificação. - *
+ * * Use esta funcionalidade para criar retificação para uma Duimp já registrada com os dados gerais informados e realizar a cópia dos itens da versão anterior da Duimp. + * */ @POST @Path("/ext/duimp/{numero-duimp}/{versao-duimp}") @@ -110,8 +115,9 @@ public interface DadosGeraisDaDuimpApi { /** * Excluir dados gerais e itens da Duimp para registro ou retificação. - *
+ * * Use esta funcionalidade para excluir uma Duimp em rascunho ou uma solicitação de retificação em rascunho. Nesta operação tanto os dados gerais quanto os dados dos itens serão excluídos. + * */ @DELETE @Path("/ext/duimp/{numero-duimp}/{versao-duimp}") @@ -128,8 +134,9 @@ public interface DadosGeraisDaDuimpApi { /** * Consultar os dados gerais da Duimp já registrada. - *
+ * * Use esta funcionalidade para recuperar os dados gerais de uma versão de Duimp que já foi registrada. + * */ @GET @Path("/ext/duimp/{numero-duimp}/{versao-duimp}") @@ -146,8 +153,9 @@ public interface DadosGeraisDaDuimpApi { /** * Consultar a versão vigente de uma Duimp. - *
+ * * Use esta funcionalidade para recuperar a versão registrada de uma Duimp que é considerada a versão vigente atualmente.<br> Versões que em elaboração não são consideradas vigentes e não são retornadas neste serviço + * */ @GET @Path("/ext/duimp/{numero-duimp}/versoes") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ItensDaDuimpApi.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ItensDaDuimpApi.java index 477d2bb..a6595c7 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ItensDaDuimpApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ItensDaDuimpApi.java @@ -30,7 +30,8 @@ /** * Declaração Única de Importação - Intervenientes Privados * - *
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
+ * * Use esta funcionalidade para atualizar os dados dos itens de uma Duimp que já teve seus dados gerais salvos tanto para registro quanto para retificação da declaração.<br> <b>Tamanho:</b> Podem ser enviados até <b>100</b> itens por requisição.<br>Para enviar mais de 100 itens, basta envir os itens restantes em novas requisições. + * */ @PUT @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/itens") @@ -58,8 +60,9 @@ public interface ItensDaDuimpApi { /** * Consultar valores calculados de um item da Duimp. - *
+ * * Use esta funcionalidade para recuperar os valores calculados de um item específico de uma Duimp em rascunho ou uma solicitação de retificação em rascunho, para pagamento. + * */ @GET @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/itens/{numero-item}/valores-calculados") @@ -76,8 +79,9 @@ public interface ItensDaDuimpApi { /** * Consultar os dados de um item da Duimp já registrada. - *
+ * * Use esta funcionalidade para recuperar os dados de um item específico de uma versão de Duimp que já foi registrada. + * */ @GET @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/itens/{numero-item}") @@ -94,8 +98,9 @@ public interface ItensDaDuimpApi { /** * Consultar os dados de uma faixa de itens da Duimp já registrada. - *
+ * * Use esta funcionalidade para recuperar os dados de uma faixa de itens de uma versão de Duimp que já foi registrada.<br>O parâmetro \"inicial\" é utilizado para informar o número do item inicial e o parâmetro \"tamanho\" para informar a quantidade máxima de itens que pode ser retornado. O valor máximo para este parâmetro é <b>100</b>. <br>Se os parâmetros \"inicial\" e \"tamanho\" não forem informados, os valores 1 e 100 serão utilizados respectivamente. + * */ @GET @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/itens") @@ -112,8 +117,9 @@ public interface ItensDaDuimpApi { /** * Excluir dados dos itens da Duimp para registro ou retificação. - *
+ * * Use esta funcionalidade para excluir um item específico de uma Duimp em rascunho ou de uma solicitação de retificação em rascunho. + * */ @DELETE @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/itens/{numero-item}") @@ -130,8 +136,9 @@ public interface ItensDaDuimpApi { /** * Salvar dados dos itens da Duimp para registro ou retificação. - *
+ * * Use esta funcionalidade para salvar os dados do item de uma Duimp que já teve seus dados gerais salvos para registro da declaração ou para salvar novos itens quando da retificação da declaração.<br> <b>Tamanho:</b> Podem ser enviados até <b>100</b> itens por requisição.<br>Para enviar mais de 100 itens, basta enviar os itens restantes em novas requisições. + * */ @POST @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/itens") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ModelosDaDuimpApi.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ModelosDaDuimpApi.java index 35031bf..a6c1067 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ModelosDaDuimpApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/ModelosDaDuimpApi.java @@ -22,7 +22,8 @@ /** * Declaração Única de Importação - Intervenientes Privados * - *
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
+ * * Use esta funcionalidade para gerar o JSON que servirá de modelo para a funcionalidade salvar dados gerais. + * */ @GET @Path("/ext/modelo/duimp/{numero-duimp}/{versao-duimp}") @@ -48,8 +50,9 @@ public interface ModelosDaDuimpApi { /** * Recuperar modelo dos dados dos itens da Duimp. - *
+ * * Use esta funcionalidade para gerar o JSON que servirá de modelo para a funcionalidade salvar os dados dos itens da Duimp. + * */ @GET @Path("/ext/modelo/duimp/{numero-duimp}/{versao-duimp}/itens") @@ -66,8 +69,9 @@ public interface ModelosDaDuimpApi { /** * Recuperar modelo da solicitação de registro da Duimp. - *
+ * * Use esta funcionalidade para gerar o JSON que servirá de modelo para a funcionalidade de registro da Duimp. + * */ @GET @Path("/ext/modelo/duimp/{numero-duimp}/{versao-duimp}/registros") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/RegistroEDiagnsticoApi.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/RegistroEDiagnsticoApi.java index f6c64a9..6b95424 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/RegistroEDiagnsticoApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/api/RegistroEDiagnsticoApi.java @@ -22,7 +22,8 @@ /** * Declaração Única de Importação - Intervenientes Privados * - *
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
Duimp - Declaração Única de Importação
Introdução
A API da Declaração Única de Importação (Duimp) , reunirá todas as informações de natureza aduaneira, administrativa, comercial, financeira, tributária e fiscal pertinentes ao controle das importações pelos órgãos competentes da Administração Pública Brasileira na execução de suas atribuições legais.
A entrega das APIs de registro, retificação e consulta de Duimp contribui para o aumento da utilização da Duimp, bem como proporciona mais agilidade no processo de importação para as grandes empresas que já fazem uso de sistemas próprios ou terceirizados para o preenchimento e acompanhamento do fluxo das importações.
Outro importante avanço da API é a notificação do avanço do processo de registro/retificação e mudança de situação da Duimp até seu desembaraço, possibilitando maior domínio sobre o processo de despacho das declarações de importação.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/duimp-api/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço "Consulta dos dados gerais da versão vigente de uma Duimp" a URI é "ext/duimp/{numero}/{versao}".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Validação, consumindo este serviço
https://val.portalunico.siscomex.gov.br/duimp-api/api/ext/duimp/20BR00001001899/1
As operações que podem ser gerenciadas pela API do sistema são:
Operações para Registro:
- Salvar dados gerais da Duimp para registro
- Salvar dados gerais da Duimp retificação
- Atualizar dados gerais da Duimp para registro ou retificação
- Salvar dados dos itens da Duimp para registro ou retificação
- Atualizar dados dos itens da Duimp para registro ou retificação
- Excluir dados gerais e itens da Duimp para registro ou retificação
- Excluir dados dos itens da Duimp para registro ou retificação
- Consultar valores calculados da Duimp
- Consultar valores calculados dos itens da Duimp
- Solicitar o diagnóstico da Duimp para registro ou retificação
- Solicitar o registro da Duimp para registro ou retificação
- Recuperar modelo dos dados gerais da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo dos dados dos itens da Duimp para utilizar em novo registro ou retificação
- Recuperar modelo da solicitação de registro da Duimp para utilizar em novo registro ou retificação
Operações de Consulta:
- Consultar os dados gerais da Duimp já registrada
- Consultar os dados de um item específico da Duimp já registrada
- Consultar os dados de uma faixa de itens da Duimp já registrada
- Consultar a versão vigente de uma Duimp já registrada
- Consultar a chave de acesso por importador e período
- Consultar a chave de acesso por Duimp
Obs: Todas as operações contam com uma descrição geral da operação abaixo da url, além da descrição resumida exibida ao seu lado.
Integrações
A Duimp é um sistema integrador que interage com com diversos outros sistemas da família Pucomex, além de alguns sistemas da família Siscomex, relacionados abaixo:
-
Sistema Siscomex Carga
-
Sistemas do Portal Único de Comércio Exterior
- Sistema Anexação Eletrônica (https://docs.portalunico.siscomex.gov.br/swagger/edocex.html)
- Sistema Catálogo de Produtos (https://docs.portalunico.siscomex.gov.br/swagger/catp.html)
- Sistema Cadastro de Atributos (https://val.portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json ou https://portalunico.siscomex.gov.br/cadatributos/api/atributo-ncm/download/json)
- Sistema Tratamento Administrativo e LPCO (https://docs.portalunico.siscomex.gov.br/swagger/talpco.html)
- Sistema Tabelas Aduaneiras (https://docs.portalunico.siscomex.gov.br/pages/tabelas_dominio/)
- Sistema Tratamento Tributário (https://docs.portalunico.siscomex.gov.br/swagger/ttce.html)
Fluxos de utilização da API
Fluxo Mínimo
Fluxo Simplificado
Fluxo da Consulta
Fluxos Alternativos
+ * * Use esta funcionalidade para solicitar o diagnóstico de uma Duimp em rascunho ou uma solicitação de retificação em rascunho.<br> <p>No caso de solicitação recebida com sucesso, você receberá como retorno a informação de que a sua solicitação está em processamento. <strong>O resultado do diagnóstico solicitado será recebido via notificação push.</strong> </p><p>Os eventos de notificação push da API Duimp Intervenientes Privados podem ser consultados na documentação de API do Pucomex, no seguinte endereço: <a href=\"../pages/duimp_eventos_intervenientes_privados/\">Eventos da Duimp</a> </p><p>Para mais esclarecimentos sobre como realizar a assinatura dos eventos, verificar a ocorrência de falhas na notificação e outras operações envolvendo a notificação de eventos, acessar o seguinte endereço: <a href=\"../pages/webhooks/\">Documentação sobre Webhooks</a> </p> + * */ @POST @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/diagnosticos") @@ -49,8 +51,9 @@ public interface RegistroEDiagnsticoApi { /** * Solicitar o registro da Duimp para registro ou retificação. - *
+ * * Use esta funcionalidade para solicitar o registro de uma Duimp em rascunho ou uma solicitação de retificação em rascunho.<br> <p>No caso de solicitação recebida com sucesso, você receberá como retorno a informação de que a sua solicitação está em processamento. <strong>O andamento da solicitação de registro será recebido via notificação push.</strong> </p><p>Os eventos de notificação push da API Duimp Intervenientes Privados podem ser consultados na documentação de API do Pucomex, no seguinte endereço: <a href=\"../pages/duimp_eventos_intervenientes_privados/\">Eventos da Duimp</a> </p><p>Para mais esclarecimentos sobre como realizar a assinatura dos eventos, verificar a ocorrência de falhas na notificação e outras operações envolvendo a notificação de eventos, acessar o seguinte endereço: <a href=\"../pages/webhooks/\">Documentação sobre Webhooks</a> </p> + * */ @POST @Path("/ext/duimp/{numero-duimp}/{versao-duimp}/registros") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DadosPagamentoCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DadosPagamentoCover.java index 1191768..a91af13 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DadosPagamentoCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DadosPagamentoCover.java @@ -191,7 +191,6 @@ public DadosPagamentoCover tributo(TributoDuimpConsultaCover tributo) { /** * Valor pago.<br>Tamanho: 17,2<br>Formato: Decimal, com até 2 casas decimais separadas por ponto. - * * @return valor **/ @JsonProperty("valor") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DeclaracaoVinculadaCoverConsulta.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DeclaracaoVinculadaCoverConsulta.java index 95cf121..b19ecd0 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DeclaracaoVinculadaCoverConsulta.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DeclaracaoVinculadaCoverConsulta.java @@ -265,7 +265,6 @@ public DeclaracaoVinculadaCoverConsulta numeroItemDeclaracaoOriginal(Integer num /** * Get item - * * @return item **/ @JsonProperty("item") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DuimpConsultaCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DuimpConsultaCover.java index 3a8047d..a048ad6 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DuimpConsultaCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/DuimpConsultaCover.java @@ -291,7 +291,6 @@ public DuimpConsultaCover tratamentoAdministrativo(TratamentoAdministrativoCover /** * Quantidade total de Itens da Duimp.<br>Tamanho mínimo: 1<br>Tamanho máximo: 5 - * * @return quantidadeItens **/ @JsonProperty("quantidadeItens") @@ -310,7 +309,6 @@ public DuimpConsultaCover quantidadeItens(Integer quantidadeItens) { /** * Lista contendo os links para os itens da Duimp - * * @return itens **/ @JsonProperty("itens") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemConsultaCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemConsultaCover.java index 40c8287..3e03e25 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemConsultaCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemConsultaCover.java @@ -304,7 +304,6 @@ public ItemConsultaCover indicadorCompradorVendedor(IndicadorCompradorVendedorCo /** * Get mercadoria - * * @return mercadoria **/ @JsonProperty("mercadoria") @@ -342,7 +341,6 @@ public ItemConsultaCover condicaoVenda(CondicaoVendaConsultaItemCover condicaoVe /** * Get lpcos - * * @return lpcos **/ @JsonProperty("lpcos") @@ -414,7 +412,6 @@ public ItemConsultaCover addDeclaracoesVinculadasItem(DeclaracaoVinculadaCoverCo /** * Get dadosCambiais - * * @return dadosCambiais **/ @JsonProperty("dadosCambiais") @@ -433,7 +430,6 @@ public ItemConsultaCover dadosCambiais(DadosCambiaisCover dadosCambiais) { /** * Get atributosDuimp - * * @return atributosDuimp **/ @JsonProperty("atributosDuimp") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemCover.java index bc2d1ad..e435eac 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ItemCover.java @@ -285,7 +285,6 @@ public ItemCover condicaoVenda(CondicaoVendaCover condicaoVenda) { /** * Get lpcos - * * @return lpcos **/ @JsonProperty("lpcos") @@ -357,7 +356,6 @@ public ItemCover addDeclaracoesVinculadasItem(DeclaracaoVinculadaCover declaraco /** * Get dadosCambiais - * * @return dadosCambiais **/ @JsonProperty("dadosCambiais") @@ -377,7 +375,6 @@ public ItemCover dadosCambiais(DadosCambiaisCover dadosCambiais) { /** * Get atributosDuimp - * * @return atributosDuimp **/ @JsonProperty("atributosDuimp") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MemoriaCalculoItemCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MemoriaCalculoItemCover.java index ca82a4e..ed6e73d 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MemoriaCalculoItemCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MemoriaCalculoItemCover.java @@ -330,7 +330,6 @@ public MemoriaCalculoItemCover valorAliquotaEspecifica(Double valorAliquotaEspec /** * Valor da alíquota reduzida (%).<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return valorAliquotaReduzida **/ @JsonProperty("valorAliquotaReduzida") @@ -349,7 +348,6 @@ public MemoriaCalculoItemCover valorAliquotaReduzida(Double valorAliquotaReduzid /** * Valor normal em R$ (Reais).<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return normal **/ @JsonProperty("normal") @@ -368,7 +366,6 @@ public MemoriaCalculoItemCover normal(Double normal) { /** * Indicador de tributação. - * * @return tributado **/ @JsonProperty("tributado") @@ -387,7 +384,6 @@ public MemoriaCalculoItemCover tributado(Boolean tributado) { /** * Percentual de pagamento, preenchido no caso de item com fundamento legal correspondente à admissão temporária com pagamento proporcional (ATUE). Para as demais Duimp será retornado nulo.<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return percentualPagamento **/ @JsonProperty("percentualPagamento") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MercadoriaCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MercadoriaCover.java index 1544678..8f12f0d 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MercadoriaCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/MercadoriaCover.java @@ -289,7 +289,6 @@ public MercadoriaCover valorUnitarioMoedaNegociada(Double valorUnitarioMoedaNego /** * Descrição complementar da mercadoria.<br>Tamanho mínimo: 0<br>Tamanho máximo: 4000 - * * @return descricao **/ @JsonProperty("descricao") diff --git a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ValoresTributoDuimpCover.java b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ValoresTributoDuimpCover.java index 0f51e8e..59fc7ce 100644 --- a/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ValoresTributoDuimpCover.java +++ b/src/main/java/br/gov/siscomex/portalunico/duimp_api/model/ValoresTributoDuimpCover.java @@ -208,7 +208,6 @@ public ValoresTributoDuimpCover complementar(Double complementar) { /** * Valores de cálculo de juros.<br>Tamanho: 16,7<br>Formato: Decimal, com até 7 casas decimais separadas por ponto. - * * @return juros **/ @JsonProperty("juros") diff --git a/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosComunsParaTodasAsOperaesApi.java b/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosComunsParaTodasAsOperaesApi.java index 57d1839..d49df7b 100644 --- a/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosComunsParaTodasAsOperaesApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosComunsParaTodasAsOperaesApi.java @@ -26,6 +26,7 @@ * Anexação Eletrônica de Documentos * *
O sistema Anexação Eletrônica de Documentos do Comércio Exterior permite a recepção, armazenamento, anexação e consulta de documentos, relativos às operações de comércio exterior, pelos intervenientes e diversos órgãos de governo envolvidos no controle das importações e exportações.
A primeira etapa na integração com o sistema Anexação é obter os metadados (tipo de documento e palavras-chave) que podem ser utilizadas para anexar documentos.
Os tipos de documentos disponíveis podem ser obtidos de duas maneiras:
\\* pelo número do dossiê para os tipos de operações DI, LI, RE e DT.
\\* pelo tipo de operação.
\\* em seguida será necessário consultar as palavras-chave do tipo de documento que está sendo anexado.
Tendo obtido os metadados acima, será possível enviar o documento (arquivo) e a assinatura (arquivo p7s) do documento codificado em base64 utilizando um dos dois serviços disponíveis, lembrando que a palavra-chave obrigatória deve ser a primeira da lista de palavras-chave:
\\* anexar documento ao dossiê para os tipos de operações DI, LI, RE e DT.
\\* anexar documento à operação
Para gerar a assinatura do documento no formato PKCS#7 sem o conteúdo anexado (CAdES detached) podem ser utilizados:
\\* o Assinador Serpro de forma interativa
\\* o componente Java Demoiselle Signer item Assinatura Digital no Formato PKCS#7/CAdES sem o conteúdo anexado (detached) para implementação em sistemas próprios.
Para os tipos de operação DI, LI, RE e DT, caso não exista um dossiê vinculado, é possível criar e vincular o dossiê à respectiva operação. Ao criar dossiês (apenas operações do tipo DI, LI, RE e DT), será necessário indicar o id do tipo de dossiê que se deseja criar. Para consultar os ids e os tipos de dossiês disponíveis para o tipo de operação em questão, primeiro utilize o serviço Consultar tipos de documentos que podem ser utilizados no tipo de operação. Após a consulta, utilize os serviços abaixo:
\\* criar dossiê e
\\* vincular dossiê à operação
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/edocex/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar tipos de documentos que podem ser utilizados no tipo de operação\" a URL é \"ext/tipos-documentos-operacao/{tipoOperacao}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de produção, consumindo este serviço
https://portalunico.siscomex.gov.br/edocex/api/ext/tipos-documentos-operacao/DI
+ * */ @Path("/") @Api(value = "/", description = "") @@ -33,8 +34,9 @@ public interface ServiosComunsParaTodasAsOperaesApi { /** * Anexar documento à operação. - *+ * * Esse serviço somente poderá ser utilizado quando houver apenas um dossiê vinculado à operação e para os seguintes tipos de operações:<ul><li>DI - Declaração de Importação<br/></li><li>LI - Licença de Importação<br/></li><li>RE - Registro de Exportação<br/></li><li>DT - Declaração de Trânsito<br/></li><li>DIR - Declaração de Importação de Remessa<br/></li><li>DUE - Declaração Única de Exportação<br/></li><li>DUIMP - Declaração Única de Importação,<br/></li><li>CATP - Catálogo de Produtos<br/></li><li>LPCO - Tratamento Administrativo/LPCO<br/></li></ul> + * */ @POST @Path("/ext/documentos-operacao") @@ -53,8 +55,9 @@ public interface ServiosComunsParaTodasAsOperaesApi { /** * Consultar documentos de uma operação. - *
+ * * <a rel=\"noopener noreferrer\" href=\"../pages/exemplos/anex/anex-documentos-operacao-consultar/\">Exemplos adicionais do sistema Anexação</a> + * */ @GET @Path("/ext/documentos-operacao/{tipoOperacao}/{numeroOperacao}") @@ -72,6 +75,7 @@ public interface ServiosComunsParaTodasAsOperaesApi { /** * Consultar palavras-chaves que podem ser utilizadas no tipo de documento. + * */ @GET @Path("/ext/tipos-documentos/{idTipoDocumento}/palavras-chave") @@ -89,8 +93,9 @@ public interface ServiosComunsParaTodasAsOperaesApi { /** * Consultar tipos de documentos que podem ser utilizados no tipo de operação. - *
+ * * <a rel=\"noopener noreferrer\" href=\"../pages/exemplos/anex/anex-tipos-documento-operacao/\">Exemplos adicionais do sistema Anexação</a> + * */ @GET @Path("/ext/tipos-documentos-operacao/{tipoOperacao}") @@ -108,6 +113,7 @@ public interface ServiosComunsParaTodasAsOperaesApi { /** * Download do documento pelo seu id. + * */ @GET @Path("/ext/documentos/download/{idDocumento}") diff --git a/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosParaOperaesDiLiReDtEDirApi.java b/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosParaOperaesDiLiReDtEDirApi.java index 4e2c915..338503a 100644 --- a/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosParaOperaesDiLiReDtEDirApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/edocex/api/ServiosParaOperaesDiLiReDtEDirApi.java @@ -27,6 +27,7 @@ * Anexação Eletrônica de Documentos * *
O sistema Anexação Eletrônica de Documentos do Comércio Exterior permite a recepção, armazenamento, anexação e consulta de documentos, relativos às operações de comércio exterior, pelos intervenientes e diversos órgãos de governo envolvidos no controle das importações e exportações.
A primeira etapa na integração com o sistema Anexação é obter os metadados (tipo de documento e palavras-chave) que podem ser utilizadas para anexar documentos.
Os tipos de documentos disponíveis podem ser obtidos de duas maneiras:
\\* pelo número do dossiê para os tipos de operações DI, LI, RE e DT.
\\* pelo tipo de operação.
\\* em seguida será necessário consultar as palavras-chave do tipo de documento que está sendo anexado.
Tendo obtido os metadados acima, será possível enviar o documento (arquivo) e a assinatura (arquivo p7s) do documento codificado em base64 utilizando um dos dois serviços disponíveis, lembrando que a palavra-chave obrigatória deve ser a primeira da lista de palavras-chave:
\\* anexar documento ao dossiê para os tipos de operações DI, LI, RE e DT.
\\* anexar documento à operação
Para gerar a assinatura do documento no formato PKCS#7 sem o conteúdo anexado (CAdES detached) podem ser utilizados:
\\* o Assinador Serpro de forma interativa
\\* o componente Java Demoiselle Signer item Assinatura Digital no Formato PKCS#7/CAdES sem o conteúdo anexado (detached) para implementação em sistemas próprios.
Para os tipos de operação DI, LI, RE e DT, caso não exista um dossiê vinculado, é possível criar e vincular o dossiê à respectiva operação. Ao criar dossiês (apenas operações do tipo DI, LI, RE e DT), será necessário indicar o id do tipo de dossiê que se deseja criar. Para consultar os ids e os tipos de dossiês disponíveis para o tipo de operação em questão, primeiro utilize o serviço Consultar tipos de documentos que podem ser utilizados no tipo de operação. Após a consulta, utilize os serviços abaixo:
\\* criar dossiê e
\\* vincular dossiê à operação
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/edocex/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URL do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Consultar tipos de documentos que podem ser utilizados no tipo de operação\" a URL é \"ext/tipos-documentos-operacao/{tipoOperacao}\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de produção, consumindo este serviço
https://portalunico.siscomex.gov.br/edocex/api/ext/tipos-documentos-operacao/DI
+ * */ @Path("/") @Api(value = "/", description = "") @@ -34,8 +35,9 @@ public interface ServiosParaOperaesDiLiReDtEDirApi { /** * Anexar documento ao dossiê. - *+ * * Esse serviço somente poderá ser utilizado para dossiês dos seguintes tipos de operações:<ul><li>DI - Declaração de Importação<br/></li><li>LI - Licença de Importação<br/></li><li>RE - Registro de Exportação<br/></li><li>DT - Declaração de Trânsito<br/></li><li>DIR - Declaração de Importação de Remessa<br/></li></ul> + * */ @POST @Path("/ext/documentos-dossie") @@ -54,8 +56,9 @@ public interface ServiosParaOperaesDiLiReDtEDirApi { /** * Consultar documentos do dossiê. - *
+ * * Esse serviço somente poderá ser utilizado para dossiês dos seguintes tipos de operações:<ul><li>DI - Declaração de Importação<br/></li><li>LI - Licença de Importação<br/></li><li>RE - Registro de Exportação<br/></li><li>DT - Declaração de Trânsito<br/></li><li>DIR - Declaração de Importação de Remessa<br/></li></ul> + * */ @GET @Path("/ext/documentos-dossie/{numeroDossie}") @@ -73,6 +76,7 @@ public interface ServiosParaOperaesDiLiReDtEDirApi { /** * Consultar tipos de documentos que podem ser utilizados no dossiê. + * */ @GET @Path("/ext/tipos-documentos-dossie/{numeroDossie}") @@ -90,6 +94,7 @@ public interface ServiosParaOperaesDiLiReDtEDirApi { /** * Criar dossiê. + * */ @POST @Path("/ext/dossies") @@ -108,8 +113,9 @@ public interface ServiosParaOperaesDiLiReDtEDirApi { /** * Vincular dossiê à operação. - *
+ * * Esse serviço esta disponível apenas para os seguintes tipos de operações:<ul><li>DI - Declaraçãoo de Importação</li><li>LI - Licença de Importação</li><li>RE - Registro de Exportação</li><li>DT - Declaração de Trânsito</li></ul> + * */ @POST @Path("/ext/vinculos-dossies") diff --git a/src/main/java/br/gov/siscomex/portalunico/edocex/model/Documento.java b/src/main/java/br/gov/siscomex/portalunico/edocex/model/Documento.java index 67aabcf..efc7fb8 100644 --- a/src/main/java/br/gov/siscomex/portalunico/edocex/model/Documento.java +++ b/src/main/java/br/gov/siscomex/portalunico/edocex/model/Documento.java @@ -353,7 +353,6 @@ public Documento addDocumentoPalavrasChaveItem(DocumentoPalavraChave documentoPa /** * Id do documento.<br/>Valor mínimo: 1<br/>Valor máximo: 9223372036854775807 - * * @return id **/ @JsonProperty("id") @@ -393,7 +392,6 @@ public Documento idTipoDocumento(Integer idTipoDocumento) { /** * Nome do arquivo<br/>Tamanho máximo: 255 - * * @return nomeArquivo **/ @JsonProperty("nomeArquivo") @@ -433,7 +431,6 @@ public Documento nomeTipoDocumento(String nomeTipoDocumento) { /** * String em SHA256 representando o hash do arquivo.<br/>Tamanho: 64 - * * @return sha256 **/ @JsonProperty("sha256") diff --git a/src/main/java/br/gov/siscomex/portalunico/edocex/model/Dossie.java b/src/main/java/br/gov/siscomex/portalunico/edocex/model/Dossie.java index 8cc9f45..73b8dce 100644 --- a/src/main/java/br/gov/siscomex/portalunico/edocex/model/Dossie.java +++ b/src/main/java/br/gov/siscomex/portalunico/edocex/model/Dossie.java @@ -317,7 +317,6 @@ public Dossie idTipoDossie(Long idTipoDossie) { /** * Nome do tipo de dossiê.<br/>Tamanho máximo: 255 - * * @return nomeTipoDossie **/ @JsonProperty("nomeTipoDossie") @@ -336,7 +335,6 @@ public Dossie nomeTipoDossie(String nomeTipoDossie) { /** * Número do dossiê.<br/>Tamanho: 15<br/>Formato: NNNNNNNNNNNNNNN - * * @return numeroDossie **/ @JsonProperty("numeroDossie") @@ -356,7 +354,6 @@ public Dossie numeroDossie(String numeroDossie) { /** * Lista de vinculos do dossiê com operações. - * * @return vinculos **/ @JsonProperty("vinculos") diff --git a/src/main/java/br/gov/siscomex/portalunico/edocex/model/DossieOperacao.java b/src/main/java/br/gov/siscomex/portalunico/edocex/model/DossieOperacao.java index 15c3fc7..3773462 100644 --- a/src/main/java/br/gov/siscomex/portalunico/edocex/model/DossieOperacao.java +++ b/src/main/java/br/gov/siscomex/portalunico/edocex/model/DossieOperacao.java @@ -388,7 +388,6 @@ public DossieOperacao addDossiesVinculadosItem(DossieVinculado dossiesVinculados /** * Id do tipo de dossiê.<br/>Valor mínimo: 1<br/>Valor máximo: 2147483647 - * * @return idTipoDossie **/ @JsonProperty("idTipoDossie") @@ -408,7 +407,6 @@ public DossieOperacao idTipoDossie(Long idTipoDossie) { /** * Nome do tipo de dossiê.<br/>Tamanho máximo: 255 - * * @return nomeTipoDossie **/ @JsonProperty("nomeTipoDossie") @@ -427,7 +425,6 @@ public DossieOperacao nomeTipoDossie(String nomeTipoDossie) { /** * Número do dossiê.<br/>Tamanho: 15<br/>Formato: NNNNNNNNNNNNNNN - * * @return numeroDossie **/ @JsonProperty("numeroDossie") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDasSefazApi.java b/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDasSefazApi.java index cf24ad7..0a6cec1 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDasSefazApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDasSefazApi.java @@ -31,6 +31,7 @@ * Pagamento Centralizado do Comércio Exterior * *
Introdução
O PCCE visa facilitar a validação e o acompanhamento do cumprimento da obrigação do ICMS, via PUCOMEX, junto às Sefaz/UF e o pagamento de tributos federais relativos à Declaração Única de Importação. Futuramente também será responsável pelos pagamentos dos demais tributos e taxas vinculados ao Comércio Exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/pcce/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Confirmar crédito de pagamento de ICMS\" a URI é \"/ext/sefaz/icms/credito\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Produção, consumindo este serviço:
https://portalunico.siscomex.gov.br/pcce/api/ext/sefaz/icms/credito
+ * */ @Path("/") @Api(value = "/", description = "") @@ -38,8 +39,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Alterar opção de cálculo de ICMS - *+ * * Altera os dados e/ou inativa uma opção de cálculo de ICMS. + * */ @PUT @Path("/ext/sefaz/opcao/{id}") @@ -57,8 +59,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Cadastrar opções para cálculo de ICMS - *
+ * * Recebe da Sefaz os dados referentes às opções que serão disponibilizadas para o importador na solicitação de cálculo de ICMS. + * */ @POST @Path("/ext/sefaz/opcao") @@ -76,8 +79,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Cancelar declaração de ICMS - *
+ * * Recebe da Sefaz favorecida cancelamento de uma Declação de ICMS com criação automática pela própria Sefaz. + * */ @PUT @Path("/ext/sefaz/icms/cancelamento/{numDeclaracao}/{versaoDeclaracao}") @@ -94,8 +98,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Confirmar crédito de pagamento de ICMS - *
+ * * Recebe da Sefaz a confirmação de crédito de pagamento de ICMS. + * */ @POST @Path("/ext/sefaz/icms/credito") @@ -113,8 +118,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Consultar declarações de ICMS - *
+ * * Consulta dados das declarações de ICMS no PCCE. + * */ @GET @Path("/ext/sefaz/icms/consulta/{numDeclaracao}") @@ -132,8 +138,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Consultar opções de cálculo de ICMS - *
+ * * Retorna a lista de opções de cálculo de ICMS cadastradas para a Sefaz. + * */ @GET @Path("/ext/sefaz/opcao") @@ -151,8 +158,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Consultar solicitação de cálculo de ICMS pendente - *
+ * * Consulta de solicitação de cálculo de ICMS pendente. + * */ @GET @Path("/ext/sefaz/icms/consulta/calculo/{numDeclaracao}/{versaoDeclaracao}") @@ -170,8 +178,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Excluir opção de cálculo de ICMS - *
+ * * Exclui uma opção de cálculo de ICMS. + * */ @DELETE @Path("/ext/sefaz/opcao/{id}") @@ -188,8 +197,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Cancelar guia de pagamento de ICMS - *
+ * * Registra o cancelamento de uma guia de pagamento de ICMS. + * */ @PUT @Path("/ext/sefaz/icms/guia/{numDeclaracao}/{versaoDeclaracao}/{codigoBarras}") @@ -206,8 +216,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Receber dados de declaração de ICMS da Sefaz - *
+ * * Recebe da Sefaz os dados referentes ao cálculo de ICMS para criação automática da declaração de ICMS no Pucomex. + * */ @POST @Path("/ext/sefaz/icms") @@ -225,8 +236,9 @@ public interface ServiosDestinadosComunicaoComSistemasDasSefazApi { /** * Cadastrar guia de pagamento de ICMS - *
+ * * Cadastra uma guia de pagamento de ICMS recebida da Sefaz. + * */ @POST @Path("/ext/sefaz/icms/guia") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIcmsApi.java b/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIcmsApi.java index da45c21..c5acc51 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIcmsApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIcmsApi.java @@ -25,6 +25,7 @@ * Pagamento Centralizado do Comércio Exterior * *
Introdução
O PCCE visa facilitar a validação e o acompanhamento do cumprimento da obrigação do ICMS, via PUCOMEX, junto às Sefaz/UF e o pagamento de tributos federais relativos à Declaração Única de Importação. Futuramente também será responsável pelos pagamentos dos demais tributos e taxas vinculados ao Comércio Exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/pcce/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Confirmar crédito de pagamento de ICMS\" a URI é \"/ext/sefaz/icms/credito\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Produção, consumindo este serviço:
https://portalunico.siscomex.gov.br/pcce/api/ext/sefaz/icms/credito
+ * */ @Path("/") @Api(value = "/", description = "") @@ -32,8 +33,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIc /** * Cancelar declaração de ICMS de Duimp - *+ * * Serviço destinado a cancelar uma solicitação de pagamento/exoneração de ICMS de Duimp. + * */ @PUT @Path("/ext/priv/icms/{numeroDuimp}/{versaoDuimp}/cancelamento") @@ -50,8 +52,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIc /** * Consultar Declaração de Tributos Estaduais ativa de Duimp - *
+ * * Serviço destinado a consultar a Declaração de Tributos Estaduais ativa de uma Duimp. + * */ @GET @Path("/ext/priv/icms/{numeroDuimp}") @@ -69,8 +72,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIc /** * Consultar UFs candidatas à favorecida para o ICMS de Duimp - *
+ * * Serviço destinado a consultar as possíveis UFs Favorecidas, bem como os tipos de tratamento, tipos de declaração e opções de cálculo de ICMS disponíveis para a Duimp. + * */ @GET @Path("/ext/priv/icms/{numeroDuimp}/ufs-favorecidas") @@ -88,8 +92,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIc /** * Solicitar pagamento/exoneração de ICMS para Duimp - *
+ * * Serviço destinado a criar uma solicitação de pagamento/exoneração de ICMS para Duimp. + * */ @POST @Path("/ext/priv/icms") @@ -107,8 +112,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeIntervenientesPrivadosIc /** * Enviar solicitação de pagamento/exoneração de ICMS de Duimp para análise manual da Sefaz - *
+ * * Serviço destinado a enviar uma solicitação de pagamento/exoneração de ICMS de Duimp para análise manual da Sefaz. Utilizar apenas para solicitações com tratamento do tipo 'MANUAL'. + * */ @PUT @Path("/ext/priv/icms/{numeroDuimp}/{versaoDuimp}/analisesefaz") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi.java b/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi.java index 569af73..1315979 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/api/ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi.java @@ -20,6 +20,7 @@ * Pagamento Centralizado do Comércio Exterior * *
Introdução
O PCCE visa facilitar a validação e o acompanhamento do cumprimento da obrigação do ICMS, via PUCOMEX, junto às Sefaz/UF e o pagamento de tributos federais relativos à Declaração Única de Importação. Futuramente também será responsável pelos pagamentos dos demais tributos e taxas vinculados ao Comércio Exterior.
URLs de Acesso
Para utilizar os serviços disponíveis nessa API deve-se seguir o seguinte padrão de URL:
https://{ambiente}/pcce/api/{serviço}
Onde, em {ambiente} deve-se informar o ambiente desejado dentro os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
| Nome do Ambiente | URL de acesso |
|---|---|
| Ambiente de Validação das Empresas | val.portalunico.siscomex.gov.br |
| Ambiente de Produção | portalunico.siscomex.gov.br |
Exemplo: Para o serviço \"Confirmar crédito de pagamento de ICMS\" a URI é \"/ext/sefaz/icms/credito\".
Logo, abaixo temos um exemplo de URL completa considerando o ambiente de Produção, consumindo este serviço:
https://portalunico.siscomex.gov.br/pcce/api/ext/sefaz/icms/credito
+ * */ @Path("/") @Api(value = "/", description = "") @@ -27,8 +28,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi { /** * Confirmar pagamento de guia de tributos dos orgãos anuentes - *+ * * Recebe dos órgãos anuentes a confirmação de pagamento de uma guia. + * */ @POST @Path("/ext/anuentes/guia/pagamento") @@ -46,8 +48,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi { /** * Cadastrar guia de pagamento de tributos de órgãos anuentes - *
+ * * Recebe dos órgãos anuentes os dados referentes a uma guia de pagamento de tributos. + * */ @POST @Path("/ext/anuentes/guia") @@ -65,8 +68,9 @@ public interface ServiosDestinadosComunicaoComSistemasDeRgosAnuentesApi { /** * Solicitar pagamento de taxa de órgãos anuentes - *
+ * * Recebe dos órgãos anuentes os dados para realizar o pagamento de taxa. + * */ @POST @Path("/ext/anuentes/pagamento") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/DadosSolicitacaoIcmsDTO.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/DadosSolicitacaoIcmsDTO.java index 6b5e61b..a75db00 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/DadosSolicitacaoIcmsDTO.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/DadosSolicitacaoIcmsDTO.java @@ -557,7 +557,6 @@ public DadosSolicitacaoIcmsDTO ufFavorecida(UfFavorecidaEnum ufFavorecida) { /** * Valor do AFRMM<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório para Duimp de modal marítmo. - * * @return valorAfrmm **/ @JsonProperty("valorAfrmm") @@ -576,7 +575,6 @@ public DadosSolicitacaoIcmsDTO valorAfrmm(BigDecimal valorAfrmm) { /** * Valor CIF considerado para exoneração (abatido da base de cálculo de ICMS)<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = 'EXONERACAO_PAG_PARCIAL_DUIMP' ou 'EXONERACAO_INTEGRAL_DUIMP' e tipo de tratamento != 'CALCULO_SEFAZ'. - * * @return valorCIFExonerado **/ @JsonProperty("valorCIFExonerado") @@ -595,7 +593,6 @@ public DadosSolicitacaoIcmsDTO valorCIFExonerado(BigDecimal valorCIFExonerado) { /** * Valor considerado para a base de cálculo do ICMS quando a declaração for um pagamento parcial<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = 'PAGAMENTO_PARCIAL_DUIMP' ou 'EXONERACAO_PAG_PARCIAL_DUIMP' e tipo de tratamento != 'CALCULO_SEFAZ'. - * * @return valorCIFPagamento **/ @JsonProperty("valorCIFPagamento") @@ -633,7 +630,6 @@ public DadosSolicitacaoIcmsDTO valorDespesasAduaneiras(BigDecimal valorDespesasA /** * Valor do ICMS importação<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = 'PAGAMENTO_INTEGRAL_DUIMP' ou 'PAGAMENTO_PARCIAL_DUIMP' ou 'EXONERACAO_PAG_PARCIAL_DUIMP' e tipo de tratamento != 'CALCULO_SEFAZ'. - * * @return valorIcms **/ @JsonProperty("valorIcms") @@ -652,7 +648,6 @@ public DadosSolicitacaoIcmsDTO valorIcms(BigDecimal valorIcms) { /** * Versão da Duimp<br>Valor mínimo: 1<br>Valor máximo: 9999 - * * @return versaoDuimp **/ @JsonProperty("versaoDuimp") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/DeclaracaoIcmsDTO.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/DeclaracaoIcmsDTO.java index ccbda92..e43204e 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/DeclaracaoIcmsDTO.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/DeclaracaoIcmsDTO.java @@ -661,7 +661,6 @@ public DeclaracaoIcmsDTO situacaoSolicitacao(SituacaoSolicitacaoEnum situacaoSol /** * Observação, conforme o tipo de tratamento - * * @return status **/ @JsonProperty("status") @@ -749,7 +748,6 @@ public DeclaracaoIcmsDTO ufFavorecida(UfFavorecidaEnum ufFavorecida) { /** * Valor do AFRMM no momento da criação da solicitação<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório para Duimp de modal marítmo. - * * @return valorAfrmm **/ @JsonProperty("valorAfrmm") @@ -768,7 +766,6 @@ public DeclaracaoIcmsDTO valorAfrmm(BigDecimal valorAfrmm) { /** * Valor CIF considerado para exoneração (abatido da base de cálculo de ICMS)<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = 'EXONERACAO_PAG_PARCIAL_DUIMP' ou 'EXONERACAO_INTEGRAL_DUIMP' e tipo de tratamento != 'CALCULO_SEFAZ'. - * * @return valorCIFExonerado **/ @JsonProperty("valorCIFExonerado") @@ -787,7 +784,6 @@ public DeclaracaoIcmsDTO valorCIFExonerado(BigDecimal valorCIFExonerado) { /** * Valor considerado para a base de cálculo do ICMS quando a declaração for um pagamento parcial<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = 'PAGAMENTO_PARCIAL_DUIMP' ou 'EXONERACAO_PAG_PARCIAL_DUIMP' e tipo de tratamento != 'CALCULO_SEFAZ'. - * * @return valorCIFPagamento **/ @JsonProperty("valorCIFPagamento") @@ -806,7 +802,6 @@ public DeclaracaoIcmsDTO valorCIFPagamento(BigDecimal valorCIFPagamento) { /** * Valor das demais despesas aduaneiras<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorDespesasAduaneiras **/ @JsonProperty("valorDespesasAduaneiras") @@ -825,7 +820,6 @@ public DeclaracaoIcmsDTO valorDespesasAduaneiras(BigDecimal valorDespesasAduanei /** * Valor do ICMS importação<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = 'PAGAMENTO_INTEGRAL_DUIMP' ou 'PAGAMENTO_PARCIAL_DUIMP' ou 'EXONERACAO_PAG_PARCIAL_DUIMP' e tipo de tratamento != 'CALCULO_SEFAZ'. - * * @return valorIcms **/ @JsonProperty("valorIcms") @@ -844,7 +838,6 @@ public DeclaracaoIcmsDTO valorIcms(BigDecimal valorIcms) { /** * Valor a pagar do ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorPagarIcms **/ @JsonProperty("valorPagarIcms") @@ -864,7 +857,6 @@ public DeclaracaoIcmsDTO valorPagarIcms(BigDecimal valorPagarIcms) { /** * Valor total já pago do ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorPagoIcms **/ @JsonProperty("valorPagoIcms") @@ -884,7 +876,6 @@ public DeclaracaoIcmsDTO valorPagoIcms(BigDecimal valorPagoIcms) { /** * Versão da Duimp<br>Valor mínimo: 1<br>Valor máximo: 9999 - * * @return versaoDuimp **/ @JsonProperty("versaoDuimp") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsCreditoDto.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsCreditoDto.java index fd3572e..de3a002 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsCreditoDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsCreditoDto.java @@ -340,7 +340,6 @@ public GuiaIcmsCreditoDto linhaDigitavel(String linhaDigitavel) { /** * Número de Controle da Sefaz (Nosso Número)<br>Tamanho mínimo: 1<br>Tamanho máximo: 20 - * * @return numeroControle **/ @JsonProperty("numeroControle") @@ -378,7 +377,6 @@ public GuiaIcmsCreditoDto valorAtualizacaoMonetaria(BigDecimal valorAtualizacaoM /** * Valor calculado sem benefícios/onerações para o código de receita <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorCalculado **/ @JsonProperty("valorCalculado") @@ -398,7 +396,6 @@ public GuiaIcmsCreditoDto valorCalculado(BigDecimal valorCalculado) { /** * Valor devido efetivamente <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorDevido **/ @JsonProperty("valorDevido") @@ -418,7 +415,6 @@ public GuiaIcmsCreditoDto valorDevido(BigDecimal valorDevido) { /** * Valor dos juros <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorJuros **/ @JsonProperty("valorJuros") @@ -437,7 +433,6 @@ public GuiaIcmsCreditoDto valorJuros(BigDecimal valorJuros) { /** * Valor da multa <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorMulta **/ @JsonProperty("valorMulta") @@ -456,7 +451,6 @@ public GuiaIcmsCreditoDto valorMulta(BigDecimal valorMulta) { /** * Somatório dos valores devidos + juros + multa + atualização monetária <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotal **/ @JsonProperty("valorTotal") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsDto.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsDto.java index a09c43e..ec866cd 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaIcmsDto.java @@ -366,7 +366,6 @@ public GuiaIcmsDto linhaDigitavel(String linhaDigitavel) { /** * Número de Controle da Sefaz (Nosso Número)<br>Tamanho mínimo: 1<br>Tamanho máximo: 20 - * * @return numeroControle **/ @JsonProperty("numeroControle") @@ -404,7 +403,6 @@ public GuiaIcmsDto valorAtualizacaoMonetaria(BigDecimal valorAtualizacaoMonetari /** * Valor calculado sem benefícios/onerações para o código de receita <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorCalculado **/ @JsonProperty("valorCalculado") @@ -424,7 +422,6 @@ public GuiaIcmsDto valorCalculado(BigDecimal valorCalculado) { /** * Valor devido efetivamente <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorDevido **/ @JsonProperty("valorDevido") @@ -444,7 +441,6 @@ public GuiaIcmsDto valorDevido(BigDecimal valorDevido) { /** * Valor dos juros <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorJuros **/ @JsonProperty("valorJuros") @@ -463,7 +459,6 @@ public GuiaIcmsDto valorJuros(BigDecimal valorJuros) { /** * Valor da multa <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorMulta **/ @JsonProperty("valorMulta") @@ -482,7 +477,6 @@ public GuiaIcmsDto valorMulta(BigDecimal valorMulta) { /** * Somatório dos valores devidos + juros + multa + atualização monetária <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotal **/ @JsonProperty("valorTotal") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaPagamentoTributosDTO.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaPagamentoTributosDTO.java index 60a12b5..0b4e91b 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaPagamentoTributosDTO.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/GuiaPagamentoTributosDTO.java @@ -358,7 +358,6 @@ public GuiaPagamentoTributosDTO tpOperacaoOrigem(TpOperacaoOrigemEnum tpOperacao /** * Valor total da guia <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotal **/ @JsonProperty("valorTotal") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazDadosIcmsDto.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazDadosIcmsDto.java index 0adde94..cccbf4e 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazDadosIcmsDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazDadosIcmsDto.java @@ -694,7 +694,6 @@ public SefazDadosIcmsDto numeroDeclaracao(String numeroDeclaracao) { /** * Número da GLME <br>Tamanho mínimo: 1<br>Tamanho máximo: 100<br/>(*) Obrigatório numeroGlme ou autenticidadeGlme se tipoSolicitacao = EXONERACAO_PAG_PARCIAL_DUIMP ou EXONERACAO_INTEGRAL_DUIMP e tipoRetorno != INDEFERIDO - * * @return numeroGlme **/ @JsonProperty("numeroGlme") @@ -713,7 +712,6 @@ public SefazDadosIcmsDto numeroGlme(String numeroGlme) { /** * Número do Mandado Judicial <br>Tamanho mínimo: 1<br>Tamanho máximo: 30<br/>(*) Obrigatório se tipoSolicitacao = MANDADO_JUDICIAL_DUIMP e tipoRetorno != INDEFERIDO - * * @return numeroMandadoJudicial **/ @JsonProperty("numeroMandadoJudicial") @@ -732,7 +730,6 @@ public SefazDadosIcmsDto numeroMandadoJudicial(String numeroMandadoJudicial) { /** * Período de referência <br/>(*) Obrigatório se tipoRetorno != INDEFERIDO.<br>Formato: 'yyyy-MM' - * * @return periodoReferencia **/ @JsonProperty("periodoReferencia") @@ -843,7 +840,6 @@ public SefazDadosIcmsDto ufFavorecida(UfFavorecidaEnum ufFavorecida) { /** * Valor do AFRMM<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório para Duimp de modal marítmo e tipoRetorno != INDEFERIDO. - * * @return valorAfrmm **/ @JsonProperty("valorAfrmm") @@ -862,7 +858,6 @@ public SefazDadosIcmsDto valorAfrmm(BigDecimal valorAfrmm) { /** * Valor CIF Exonerado (abatido da base de cálculo de ICMS)<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = EXONERACAO_PAG_PARCIAL_DUIMP ou EXONERACAO_INTEGRAL_DUIMP e tipoRetorno != INDEFERIDO. - * * @return valorCIFExonerado **/ @JsonProperty("valorCIFExonerado") @@ -881,7 +876,6 @@ public SefazDadosIcmsDto valorCIFExonerado(BigDecimal valorCIFExonerado) { /** * Valor calculado sem benefícios <br/>(*) Obrigatório se tipoRetorno != INDEFERIDO.<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorCalculado **/ @JsonProperty("valorCalculado") @@ -900,7 +894,6 @@ public SefazDadosIcmsDto valorCalculado(BigDecimal valorCalculado) { /** * Valor considerado para a base de cálculo do ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou EXONERACAO_PAG_PARCIAL_DUIMP e tipoRetorno != INDEFERIDO. - * * @return valorCifPagamento **/ @JsonProperty("valorCifPagamento") @@ -919,7 +912,6 @@ public SefazDadosIcmsDto valorCifPagamento(BigDecimal valorCifPagamento) { /** * Valor total do crédito de ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/> (*) Obrigatório se tipoRetorno = SEM_VALOR_A_PAGAR e tipoSolicitacao != EXONERACAO_INTEGRAL_DUIMP - * * @return valorTotalCredito **/ @JsonProperty("valorTotalCredito") @@ -938,7 +930,6 @@ public SefazDadosIcmsDto valorTotalCredito(BigDecimal valorTotalCredito) { /** * Valor total devido (a pagar ou pago) <br/>(*) Obrigatório se tipoRetorno != INDEFERIDO.<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotalDevido **/ @JsonProperty("valorTotalDevido") @@ -957,7 +948,6 @@ public SefazDadosIcmsDto valorTotalDevido(BigDecimal valorTotalDevido) { /** * Somatório dos valores devidos + juros + multa + atualização monetária<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou EXONERACAO_PAG_PARCIAL_DUIMP ou PAGAMENTO_INTEGRAL_DUIMP e tipoRetorno != INDEFERIDO. - * * @return valorTotalaRecolher **/ @JsonProperty("valorTotalaRecolher") @@ -976,7 +966,6 @@ public SefazDadosIcmsDto valorTotalaRecolher(BigDecimal valorTotalaRecolher) { /** * Versão da declaração<br>Valor mínimo: 1<br>Valor máximo: 9999 - * * @return versaoDeclaracao **/ @JsonProperty("versaoDeclaracao") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazInclusaoGuiaIcmsDto.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazInclusaoGuiaIcmsDto.java index 39cd306..8f6a344 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazInclusaoGuiaIcmsDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SefazInclusaoGuiaIcmsDto.java @@ -386,7 +386,6 @@ public SefazInclusaoGuiaIcmsDto valorAtualizacaoMonetaria(BigDecimal valorAtuali /** * Valor calculado sem benefícios/onerações para o código de receita <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorCalculado **/ @JsonProperty("valorCalculado") @@ -406,7 +405,6 @@ public SefazInclusaoGuiaIcmsDto valorCalculado(BigDecimal valorCalculado) { /** * Valor devido efetivamente <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorDevido **/ @JsonProperty("valorDevido") @@ -426,7 +424,6 @@ public SefazInclusaoGuiaIcmsDto valorDevido(BigDecimal valorDevido) { /** * Valor dos juros <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorJuros **/ @JsonProperty("valorJuros") @@ -445,7 +442,6 @@ public SefazInclusaoGuiaIcmsDto valorJuros(BigDecimal valorJuros) { /** * Valor da multa <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorMulta **/ @JsonProperty("valorMulta") @@ -464,7 +460,6 @@ public SefazInclusaoGuiaIcmsDto valorMulta(BigDecimal valorMulta) { /** * Somatório dos valores devidos + juros + multa + atualização monetária <br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotal **/ @JsonProperty("valorTotal") @@ -484,7 +479,6 @@ public SefazInclusaoGuiaIcmsDto valorTotal(BigDecimal valorTotal) { /** * Versão da declaração<br>Valor mínimo: 1<br>Valor máximo: 9999 - * * @return versaoDeclaracao **/ @JsonProperty("versaoDeclaracao") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoCalculoIcmsDto.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoCalculoIcmsDto.java index 77b89de..3ecd1b4 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoCalculoIcmsDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoCalculoIcmsDto.java @@ -967,7 +967,6 @@ public SolicitacaoCalculoIcmsDto ufFavorecida(UfFavorecidaEnum ufFavorecida) { /** * UF importador - * * @return ufImportador **/ @JsonProperty("ufImportador") @@ -990,7 +989,6 @@ public SolicitacaoCalculoIcmsDto ufImportador(UfImportadorEnum ufImportador) { /** * Valor do AFRMM no momento da criação da solicitação<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorAfrmm **/ @JsonProperty("valorAfrmm") @@ -1010,7 +1008,6 @@ public SolicitacaoCalculoIcmsDto valorAfrmm(BigDecimal valorAfrmm) { /** * Valor das demais despesas aduaneiras<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorDespesasAduaneiras **/ @JsonProperty("valorDespesasAduaneiras") @@ -1029,7 +1026,6 @@ public SolicitacaoCalculoIcmsDto valorDespesasAduaneiras(BigDecimal valorDespesa /** * Versão da declaração<br>Valor mínimo: 1<br>Valor máximo: 9999 - * * @return versaoDeclaracao **/ @JsonProperty("versaoDeclaracao") diff --git a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoIcmsDto.java b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoIcmsDto.java index ffc16ae..c444b68 100644 --- a/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoIcmsDto.java +++ b/src/main/java/br/gov/siscomex/portalunico/pcce/model/SolicitacaoIcmsDto.java @@ -1025,7 +1025,6 @@ public SolicitacaoIcmsDto descricaoDespesasAduaneiras(String descricaoDespesasAd /** * Lista de guias de pagamento de ICMS (não canceladas) - * * @return guias **/ @JsonProperty("guias") @@ -1092,7 +1091,6 @@ public SolicitacaoIcmsDto informacoesComplementares(String informacoesComplement /** * Número do Mandado Judicial <br>Tamanho mínimo: 1<br>Tamanho máximo: 30<br/>(*) Obrigatório se tipoSolicitacao = MANDADO_JUDICIAL_DUIMP - * * @return numMandadoJudicial **/ @JsonProperty("numMandadoJudicial") @@ -1111,7 +1109,6 @@ public SolicitacaoIcmsDto numMandadoJudicial(String numMandadoJudicial) { /** * Número da declaração<br>Formato: 'NNAANNNNNNNNNNN'<br>Tamanho: 15 - * * @return numeroDeclaracao **/ @JsonProperty("numeroDeclaracao") @@ -1131,7 +1128,6 @@ public SolicitacaoIcmsDto numeroDeclaracao(String numeroDeclaracao) { /** * Get opcaoIcms - * * @return opcaoIcms **/ @JsonProperty("opcaoIcms") @@ -1150,7 +1146,6 @@ public SolicitacaoIcmsDto opcaoIcms(OpcaoIcmsConsultaDto opcaoIcms) { /** * Período de referência<br>Formato: 'yyyy-MM' - * * @return periodoReferencia **/ @JsonProperty("periodoReferencia") @@ -1193,7 +1188,6 @@ public SolicitacaoIcmsDto situacaoSolicitacao(SituacaoSolicitacaoEnum situacaoSo /** * Observação, conforme o tipo de tratamento - * * @return status **/ @JsonProperty("status") @@ -1281,7 +1275,6 @@ public SolicitacaoIcmsDto tipoTratamento(TipoTratamentoEnum tipoTratamento) { /** * UF favorecida - * * @return ufAdquirente **/ @JsonProperty("ufAdquirente") @@ -1303,7 +1296,6 @@ public SolicitacaoIcmsDto ufAdquirente(UfAdquirenteEnum ufAdquirente) { /** * UF favorecida - * * @return ufFavorecida **/ @JsonProperty("ufFavorecida") @@ -1326,7 +1318,6 @@ public SolicitacaoIcmsDto ufFavorecida(UfFavorecidaEnum ufFavorecida) { /** * UF importador - * * @return ufImportador **/ @JsonProperty("ufImportador") @@ -1349,7 +1340,6 @@ public SolicitacaoIcmsDto ufImportador(UfImportadorEnum ufImportador) { /** * Valor do AFRMM no momento da criação da solicitação<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório para Duimp de modal marítmo. - * * @return valorAfrmm **/ @JsonProperty("valorAfrmm") @@ -1368,7 +1358,6 @@ public SolicitacaoIcmsDto valorAfrmm(BigDecimal valorAfrmm) { /** * Valor CIF Exonerado (abatido da base de cálculo de ICMS)<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = EXONERACAO_PAG_PARCIAL_DUIMP ou EXONERACAO_INTEGRAL_DUIMP. - * * @return valorCIFExonerado **/ @JsonProperty("valorCIFExonerado") @@ -1387,7 +1376,6 @@ public SolicitacaoIcmsDto valorCIFExonerado(BigDecimal valorCIFExonerado) { /** * Valor considerado para a base de cálculo do ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2<br/>(*) Obrigatório se tipoSolicitacao = PAGAMENTO_PARCIAL_DUIMP ou EXONERACAO_PAG_PARCIAL_DUIMP. - * * @return valorCIFPagamento **/ @JsonProperty("valorCIFPagamento") @@ -1406,7 +1394,6 @@ public SolicitacaoIcmsDto valorCIFPagamento(BigDecimal valorCIFPagamento) { /** * Valor das demais despesas aduaneiras<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorDespesasAduaneiras **/ @JsonProperty("valorDespesasAduaneiras") @@ -1425,7 +1412,6 @@ public SolicitacaoIcmsDto valorDespesasAduaneiras(BigDecimal valorDespesasAduane /** * Valor total a recolher de ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotalARecolher **/ @JsonProperty("valorTotalARecolher") @@ -1445,7 +1431,6 @@ public SolicitacaoIcmsDto valorTotalARecolher(BigDecimal valorTotalARecolher) { /** * Valor total do crédito de ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotalCredito **/ @JsonProperty("valorTotalCredito") @@ -1465,7 +1450,6 @@ public SolicitacaoIcmsDto valorTotalCredito(BigDecimal valorTotalCredito) { /** * Valor total devido de ICMS<br>Formato: Decimal, com 2 casas decimais separadas por ponto.<br>Tamanho: 15,2 - * * @return valorTotalDevido **/ @JsonProperty("valorTotalDevido") @@ -1485,7 +1469,6 @@ public SolicitacaoIcmsDto valorTotalDevido(BigDecimal valorTotalDevido) { /** * Versão da declaração<br>Valor mínimo: 1<br>Valor máximo: 9999 - * * @return versaoDeclaracao **/ @JsonProperty("versaoDeclaracao") diff --git a/src/main/java/br/gov/siscomex/portalunico/rcnt/api/ServiosDestinadosRecepoDeEventosAduaneiros_Api.java b/src/main/java/br/gov/siscomex/portalunico/rcnt/api/ServiosDestinadosRecepoDeEventosAduaneiros_Api.java index 4ee232d..9b66599 100644 --- a/src/main/java/br/gov/siscomex/portalunico/rcnt/api/ServiosDestinadosRecepoDeEventosAduaneiros_Api.java +++ b/src/main/java/br/gov/siscomex/portalunico/rcnt/api/ServiosDestinadosRecepoDeEventosAduaneiros_Api.java @@ -42,6 +42,7 @@ * Recintos Aduaneiros * *
Aviso
Esta documentação refere-se à API Recintos disponível em ambiente de Produção (Release Apa). A documentação da API Recintos referente às evoluções da API Recintos disponíveis em ambiente de Validação de Empresas (Release Volga) está disponível em: https://docs-proxima.portalunico.siscomex.gov.br/swagger/rcnt.html.
Introdução
Bem-vindo à Application Programming Interface (API) de interação entre os recintos e o Portal Único de Comércio Exterior no Sistema Integrado de Comércio Exterior (Portal Siscomex), aqui chamada de API-Recintos. Trata-se de um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software baseado nos padrões Web, que permitirá a recepção de eventos dentro do Portal Siscomex.
Disponibilizamos os endpoints de 22 eventos.
Para a utilização dos serviços desta API, a autenticação via certificação digital, do tipo e-CNPJ, é obrigatória. Caso seja verificado erro na autenticação ao serviço, o sistema irá retornar o erro referente à autenticação conforme especificado na seção Status Codes da API.
O processo de autenticação deve ser executado conforme descrito em Autenticação.
Definições importantes, conforme a Portaria Coana no 72, de 12 de abril de 2022:
I - Sistema Informatizado de Controle Aduaneiro (SICA): o conjunto de sistemas informatizados de controle que operem em locais ou recintos alfandegados ou autorizados a operar com mercadorias sob controle aduaneiro;
II - interveniente: a administradora de local ou recinto alfandegado ou autorizado a operar com mercadorias sob controle aduaneiro, o depositário e o operador portuário habilitado ou autorizado a operar nestes locais ou recintos;
III - informações: aquelas relativas às operações de entrada e saída de pessoas e veículos, movimentação de carga e armazenamento de mercadorias, inclusive imagens;
IV - registro: a inserção e a retificação de informações no SICA;
V - eventos: o conjunto de informações previstas no Anexo III desta Portaria que devem ser enviadas à API-Recintos simultaneamente ao seu registro no SICA; e
VI - envio de eventos à API-Recintos: transmissão eletrônica de conjunto de informações, inclusive imagens, registradas no SICA à API-Recintos, por meio da integração entre estes.