Sistema SIC-EU inancas.gov.pt
[pic]
Sistema SIC-EX
Especificação de Web Services
SIC-EX
Versão 1.1
Sistema SIC-EX
Especificação de Web Services
Título: SIC-EX - Especificação de Web Services
Versão: 1.1
Projecto: SIC-EX
Data Criação: 2016-02-22 10:17
Data Revisão: 2016-05-16 11:04
Nome Ficheiro: Sistema SIC-EX - Especificação de Web Services.doc
Tipo de Documento Final
|Versão |Data |Descrição |Capítulo |
|1.0 |2016-02-22 |Primeira versão do documento |- |
|1.1 |2016-05-16 |Adicionado campo valor apurado à resposta da operação |3.1 |
| | |EntregarEdicRequest | |
Índice
1. Introdução 5
2. Pré-requisitos para utilização do serviço 5
3. Descrição da interface 5
3.1 Operação: EntregarEdicRequest 5
3.2 Operação: ObterEdicRequest 6
3.3 Operação: AlterarEdicRequest 7
3.4 Operação: AnularEdicRequest 8
4. Mensagens de Erro 9
5. Endereços de submissão 10
5.1 Ambiente de Qualidade 10
5.2 Ambiente de Produção 10
6. Referências 10
7. Definições, Acrónimos e Abreviaturas 11
Introdução
O objetivo principal deste documento é descrever a interface dos Web Services disponibilizados pelo sistema SIC-EX [1].
Este documento destina-se a empresas que pretendam desenvolver uma solução que possibilite aos Operadores Económicos efetuar operações sobre Declarações de Introdução no Consumo Eletrónica (e-DIC) e Pedidos de Autorização de Receção eletrónico (e-PAR) através da interface de Web Services disponibilizada no sítio do Portal das Finanças da AT [2].
Pré-requisitos para utilização do serviço
A 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 das Finanças da AT) [2].
Descrição da interface
O 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.
Como auxiliar, o documento e-DIC – Declaração de Introdução no Consumo Eletrónica contém a descrição dos campos relativos ao schema EDIC.
1 Operação: EntregarEdicRequest
Esta operação permite entregar uma e-DIC.
O pedido deve conter o tipo de e-DIC a entregar e a nova e-DIC a registar no sistema.
Em caso de sucesso, retorna o Nº de Ordem da nova e-DIC, a versão do documento, o seu valor apurado, o documento comprimido em Base64, o código da resposta e mensagem correspondente a esse código.
Dados do Pedido:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|edicType |Tipo da e-DIC. Tipos permitidos: |Obrigatório |
| |G – e-DIC Geral | |
| |P – e-PAR | |
|EDIC |Nova e-DIC a registar no sistema |Obrigatório |
Dados da Resposta:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|OrderNumber |Nº de Ordem da e-DIC registada no sistema |Condicional [1] |
|Version |Versão do documento registado no sistema |Condicional [1] |
|ValorApurado |Valor apurado da e-DIC registada no sistema |Condicional [1] |
|Base64ZippedEdic |Documento comprimido e codificado em Base64 |Condicional [1] |
|ExecutionState |Estado da execução do pedido. Em caso de erro, contém a descrição do erro. |Obrigatório |
|ErrorList |Lista de erros na declaração, caso existam. |Condicional [2] |
[1] Presente apenas no caso de sucesso
[2] Presente apenas em caso de insucesso (existência de erros de validação)
2 Operação: ObterEdicRequest
Esta operação permite obter uma e-DIC.
O pedido deve conter o Nº de Ordem da e-DIC que se pretende obter.
Em caso de sucesso, retorna o documento em ZIP e Base64.
Dados do Pedido:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|OrderNumber |Nº de Ordem da e-DIC registada no sistema |Obrigatório |
Dados da Resposta:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|Base64ZippedEdic |Documento comprimido e codificado em Base64 |Condicional [1] |
|ExecutionState |Estado da execução do pedido. Em caso de erro, contém a descrição do erro. |Obrigatório |
[1] Presente apenas no caso de sucesso
3 Operação: AlterarEdicRequest
Esta operação permite alterar uma e-DIC previamente registada no sistema.
O pedido deve conter o Nº de Ordem da e-DIC a alterar e a respetiva e-DIC alterada para registar no sistema.
Em caso de sucesso, retorna o Nº de Ordem da nova e-DIC, a nova versão do documento, o documento comprimido em Base64, o código da resposta e mensagem correspondente a esse código.
Dados do Pedido:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|OrderNumber |Nº de Ordem da e-DIC registada no sistema |Obrigatório |
|EDIC |e-DIC alterada a registar no sistema. |Obrigatório |
Dados da Reposta:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|OrderNumber |Nº de Ordem da e-DIC registada no sistema |Condicional [1] |
|Version |Versão do documento registado no sistema |Condicional [1] |
|Base64ZippedEdic |Documento comprimido e codificado em Base64 |Condicional [1] |
|ExecutionState |Estado da execução do pedido. Em caso de erro, contém a descrição do erro. |Obrigatório |
|ErrorList |Lista de erros na declaração, caso existam. |Condicional [2] |
[1] Presente apenas no caso de sucesso
[2] Presente apenas em caso de insucesso (existência de erros de validação)
4 Operação: AnularEdicRequest
Esta operação permite anular uma e-DIC previamente regista no sistema.
O pedido deve conter o Nº de Ordem da e-DIC que se pretende anular.
Em caso de sucesso, é retornado o Nº de Ordem da e-DIC anulada, a versão do documento, e o código da resposta e mensagem correspondente a esse código.
Dados do Pedido:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|OrderNumber |Nº de Ordem da e-DIC a ser anulada |Obrigatório |
Dados da Reposta:
|Parâmetro |Descrição |Indicação de Obrigatoriedade |
|OrderNumber |Nº de Ordem da e-DIC que foi anulada |Condicional [1] |
|Version |Versão da e-DIC que foi anulada |Condicional [1] |
|ExecutionState |Estado da execução do pedido. Em caso de erro, contém a descrição do erro. |Obrigatório |
|ErrorList |Lista de erros na declaração, caso existam. |Condicional [2] |
[1] Presente apenas no caso de sucesso
[2] Presente apenas em caso de insucesso (existência de erros de validação)
Mensagens de Erro
Os pedidos realizados retornam sempre uma mensagem com o estado de execução. A seguinte tabela apresenta os códigos e respetivas mensagens possíveis.
|Código |Mensagem |
|0 |Operação efetuada com sucesso. |
|1 |Existem erros na declaração. |
|2 |e-DIC não encontrada. |
|3 |Ocorreram erros na obtenção da Edic. |
|4 |A declaração não se encontra num estado que permita efetuar a operação requisitada. |
|5 |A declaração não se encontra num estado que permita efetuar a operação requisitada. |
|6 |Existem erros de validação de uma aplicação externa devido a erros na declaração. |
|7 |Utilizador sem permissões para entregar a declaração. |
|8 |Parâmetro user não presente no pedido. |
|9 |Tipo de declaração não permitida. |
|94 |A sua versão da aplicação está desactualizada. Por favor grave os seus dados e obtenha a última versão |
| |(nº da versão atual). |
|98 |Os dados de utilizador submetidos são inválidos ou não tem permissões para efetuar a operação |
| |pretendida. |
|99 |Ocorreu um erro durante o processamento central do pedido |
Endereços de submissão
1 Ambiente de Qualidade
2 Ambiente de Produção
Referências
1] Sistema SIC-EU:
2] Sítio do Portal das Finanças da AT:
Definições, Acrónimos e Abreviaturas
|AT |Autoridade Tributária e Aduaneira |
|Condicional |Representa que o campo pode ou não estar presente nos dados da resposta. |
|e-DIC |Declaração de Introdução no Consumo Eletrónica |
|e-PAR |Pedido de Autorização de Receção eletrónico (Certificado de Garantia) |
|Obrigatório |Indicador que campo deve ser preenchido no caso de pertencer aos dados do pedido. Nos dados da resposta, |
| |indica que o campo está sempre presente. |
|SIC-EX |Sistema de Impostos Especiais sobre o Consumo - Controlo de Existências em Entrepostos Fiscais |
|SOAP |Simple Object Access Protocol |
|Web Service |Serviç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.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.