Sistema SIC-EU



Sistema SIC-EU SUBJECT \* MERGEFORMAT Especifica??o de Web ServicesSIC-EUVers?o 1.5Sistema SIC-EU SUBJECT \* MERGEFORMAT Especifica??o de Web ServicesTítulo:Sistema SIC-EU - SUBJECT \* MERGEFORMAT Especifica??o de Web ServicesVers?o:Vers?o 1.5Projecto:SIC-EUData Cria??o: CREATEDATE \@ "yyyy-MM-dd H:mm" \* MERGEFORMAT 2010-05-31 17:27Data Revis?o: SAVEDATE \@ "yyyy-MM-dd H:mm" \* MERGEFORMAT 2016-07-01 10:56Nome Ficheiro:Sistema SIC-EU - Especifica??o de Web Services.docTipo de DocumentoFinal Vers?oDataDescri??oCapítulo1.02010-05-26Primeira vers?o do documento-1.12010-09-23Atualiza??o dos endere?os de submiss?o4.1 e 4.21.22010-10-22Atualiza??o da interface – nova opera??o: EntregarDocumento3.41.32011-01-19Atualiza??o da interface – nova opera??o: ObterDocumentosComPedidoCertificacao3.51.42014-01-12Altera??o de formata??o-1.52016-02-18Atualiza??o dos endere?os de submiss?o REF _Ref443586582 \r \h 4.1, REF _Ref443586585 \r \h 4.2?ndice TOC \o "2-4" \t "Heading 1;1;Heading 5;4" 1. Introdu??o PAGEREF _Toc283221984 \h 52. Pré-requisitos para utiliza??o do servi?o PAGEREF _Toc283221985 \h 63. Descri??o da interface PAGEREF _Toc283221986 \h 73.1. Opera??o: ObterDocumentos PAGEREF _Toc283221987 \h 73.2. Opera??o: ObterDocumento PAGEREF _Toc283221988 \h 83.3. Opera??o: ApurarDocumento PAGEREF _Toc283221989 \h 93.4. Opera??o: EntregarDocumento PAGEREF _Toc283221990 \h 103.5. Opera??o: ObterDocumentosComPedidoCertificacao PAGEREF _Toc283221991 \h 114. Endere?os de submiss?o PAGEREF _Toc283221992 \h 134.1. Ambiente de testes PAGEREF _Toc283221993 \h 134.2. Ambiente de produ??o PAGEREF _Toc283221994 \h 135. Referências PAGEREF _Toc283221995 \h 146. Defini??es, Acrónimos e Abreviaturas PAGEREF _Toc283221996 \h 15Introdu??oO objetivo principal deste documento é descrever a interface dos Web Services disponibilizados pelo sistema SIC-EU [1].Este documento destina-se a empresas que pretendam desenvolver uma solu??o que possibilite aos Operadores Económicos efetuar opera??es sobre Documentos de Acompanhamento eletrónicos (e-DA) através da interface de Web Services disponibilizada no sítio do Portal Aduaneiro da AT REF _Ref443655266 \r \h [3].Pré-requisitos para utiliza??o do servi?oA utiliza??o deste servi?o pressup?e que foram cumpridos os procedimentos e requisitos descritos na documenta??o referente à utiliza??o dos Web Services disponibilizados pelo sítio do Portal Aduaneiro da AT REF _Ref262633518 \r \h [2].Descri??o da interfaceO Web Service descrito neste documento segue o formato SOAP e disponibiliza um conjunto de opera??es cujas interfaces ser?o descritas ao longo do presente capítulo.De referir que todas as opera??es incluem, nos dados devolvidos, o estado de execu??o do pedido:Em caso de sucesso: um código de resposta igual a 0 (zero). Para cada situa??o anómala, devidamente tratada: um código de erro diferente de 0 (zero) e a respetiva mensagem de erro.Opera??o: ObterDocumentosEsta opera??o permite obter uma listagem de documentos (e-DAs) por apurar.O pedido deve conter a identifica??o do Operador Económico, destinatário dos documentos pretendidos, em conjunto com as datas inicial e final do período de pesquisa pretendido.Em caso de sucesso, retorna uma lista de documentos, cada documento contendo um resumo da informa??o presente no e-DA.Dados do Pedido:Par?metroDescri??oInd. Obrig.NIFOperadorNIF do Operador destinatário dos e-DAs pretendidos.ObrigatórioDataInicioData de início do período de pesquisa.ObrigatórioDataFimData de fim do período de pesquisa.ObrigatórioDados da Resposta:Par?metroDescri??oInd. Obrig.EstadoExecucaoEstado de execu??o do pedido. Em caso de erro, contém a descri??o do erro.ObrigatórioListaDocumentosLista de documentos. Cada documento contém a seguinte informa??o:Código de referência do e-DA (ARC)Número de Referência LocalSitua??o do e-DAData Rece??o do e-DAIdentifica??o IEC do Operador Expedidor do e-DANome do Operador Expedidor do e-DAIdentifica??o IEC do Operador Destinatário do e-DANome do Operador Destinatário do e-DA.Condicional [1][1] Presente apenas no caso de sucessoOpera??o: ObterDocumentoO pedido deve conter a identifica??o do documento (e-DA) pretendido, ou seja, o número de referência conhecido por: ARC.Em caso de sucesso, devolve um documento contendo a última vers?o conhecida do e-DA e a situa??o em que este se encontra (Aceite, Recusado, Parcialmente Recusado, etc.).Dados do Pedido:Par?metroDescri??oInd. Obrig.ARCNúmero de referência do e-DA.ObrigatórioDados da Resposta:Par?metroDescri??oInd. Obrig.EstadoExecucaoEstado de execu??o do pedido. Em caso de erro, contém a descri??o do erro.ObrigatórioDocumentoDocumento contendo a seguinte informa??o:?ltima vers?o do e-DA correspondente ao ARC indicadoSitua??o do e-DA.Condicional [1][1] Presente apenas no caso de sucessoOpera??o: ApurarDocumentoO pedido deve incluir o e-DA a apurar.Em caso de sucesso, devolve apenas o estado de execu??o do pedido.Em caso de insucesso, e quando detetados erros na valida??o do apuramento, devolve uma lista de erros de negócio. Cada erro de negócio contém um código de erro, respetiva descri??o e localiza??o do erro relativamente ao e-DA apurado.Dados do Pedido:Par?metroDescri??oInd. Obrig.eDAAe-DA a apurar.ObrigatórioDados da Resposta:Par?metroDescri??oInd. Obrig.EstadoExecucaoEstado de execu??o do pedido. Em caso de erro, contém a descri??o do erro.ObrigatórioListaErrosLista de erros de negócio encontrados durante a valida??o do apuramento.Condicional [1][1] Presente apenas em caso de insucesso (existência de erros de valida??o)Opera??o: EntregarDocumentoO pedido deve incluir um novo e-DA, a registar no sistema.Em caso de sucesso, devolve apenas o estado de execu??o do pedido.Em caso de insucesso, e quando forem detetados erros na valida??o do e-DA submetido, devolve uma lista de erros de negócio. Cada erro de negócio contém um código de erro, respetiva descri??o e localiza??o do erro relativamente ao e-DA submetido.Dados do Pedido:Par?metroDescri??oInd. Obrig.eDAANovo e-DA, a registar no sistemaObrigatórioDados da Resposta:Par?metroDescri??oInd. Obrig.EstadoExecucaoEstado de execu??o do pedido. Em caso de erro, contém a descri??o do erro.ObrigatórioDocumentoDocumento contendo a seguinte informa??o:e-DA entregue, acrescido de informa??o preenchida automaticamente no servidor, nomeadamente:Número de Referência atribuído ao e-DA (se aceite);Detalhes da expedi??o n?o preenchidos no e-DA submetido;Dados de cadastro de: operadores, responsável pelo transporte, primeiro transportador e entidades garante.Condicional [1]ListaErrosLista de erros de negócio encontrados durante a valida??o do e-DA submetido.Condicional [2][1] Presente apenas em caso de sucesso (e-DA entregue)[2] Presente apenas em caso de insucesso (existência de erros de valida??o)Opera??o: ObterDocumentosComPedidoCertificacaoEsta opera??o destina-se, exclusivamente, a entidades certificadoras e permite obter uma listagem de documentos (e-DAs) certificados ou por certificar, num dado intervalo de tempo.O pedido deve conter o indicador do estado de certifica??o e as datas inicial e final do período de pesquisa pretendido.Em caso de sucesso, retorna uma lista de documentos, cada documento contendo um resumo da informa??o presente no e-DA.Dados do Pedido:Par?metroDescri??oInd. Obrig.IndicadorEstadoCertificacaoIndicador do estado de certifica??o:PC – Por CertificarCE – Certificado.ObrigatórioDataInicioData de início do período de pesquisa.ObrigatórioDataFimData de fim do período de pesquisa.ObrigatórioDados da Resposta:Par?metroDescri??oInd. Obrig.EstadoExecucaoEstado de execu??o do pedido. Em caso de erro, contém a descri??o do erro.ObrigatórioListaDocumentosLista de documentos. Cada documento contém a seguinte informa??o:Código de referência do e-DA (ARC)Número de Referência LocalSitua??o do e-DAData Rece??o do e-DAIdentifica??o IEC do Operador Expedidor do e-DANome do Operador Expedidor do e-DAIdentifica??o IEC do Operador Destinatário do e-DANome do Operador Destinatário do e-DA.Condicional [1][2][1] Presente apenas no caso de sucesso[2] Nem todos os campos podem vir preenchidos na respostaEndere?os de submiss?oAmbiente de Qualidade de Produ??oênciasDescri??o campos e-DA.docxDefini??es, Acrónimos e AbreviaturasATAutoridade Tributária e AduaneiraEMCSExcise Movement and Control Systeme-DADocumento de Acompanhamento eletrónicoSIC-EUVertente nacional do sistema comunitário EMCSSOAPSimple Object Access ProtocolWeb ServiceServi?o disponibilizado através de uma rede (Internet, Intranet ou outras) usado para a troca de dados entre aplica??es e sistemas. ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download