Manual Webservice RPS

Fazer download em pdf ou txt
Fazer download em pdf ou txt
Você está na página 1de 10

Nota Fiscal

Eletrônica de
Serviços
Webservice de Envio de RPS em Lote
- Instruções e Layout -

Versão 1.00
1. Modelo Conceitual

• Fluxo de comunicação

É iniciado pelo aplicativo cliente através do envio de uma mensagem ao webservice com a solicitação do
serviço desejado. O webservice sempre deverá devolver uma mensagem de resposta confirmando o
recebimento da solicitação na mesma conexão.

• Meio Acesso

O meio acesso de comunicação utilizado será a Internet, com um mecanismo de segurança "accessKeyId",
"secretAccessKey" e "accessToken" sobre o protocolo HTTPS (Hypertext Transfer Protocol Secure).

• Padrão troca de mensagem

A troca de mensagens entre o webservice e o aplicativo do Contribuinte será realizada no padrão REST,
com troca de mensagens JSON.

2. Recibo Provisório de Serviços – RPS

O RPS é o documento que tem validade temporária e é emitido previamente pelo prestador, e deverá ser
usado nas seguintes situações:

• No eventual impedimento da emissão “on-line” da NFS-e;

• Emissão de grande quantidade de NFS-e (Exe.: hotéis, pousadas, cinemas, cartórios,


estacionamentos e etc.). Neste caso o prestador emitirá o RPS para cada transação e providenciará
sua conversão em NFS-e mediante o envio em lote.

3. Solicitação

O Recibo Provisório de Serviços deverá ser solicitado através do webservice conforme seção Métodos.

4. Autorização

Após a solicitação o webservice irá autorizar e criará um lote contendo as numerações dos RPS e seus
respectivos códigos de verificação.

5. Emissão

O RPS deve ser emitido conforme a data de execução do serviço e em 2 (duas) vias:

• A 1ª (primeira) via deverá ser entregue ao tomador do serviço;

• A 2ª (segunda) via deverá ser arquivada pelo emitente.


6. Prazos

O RPS deverá ser convertido por NFS-e até o 10º (décimo) dia subseqüente ao de sua emissão. O prazo
inicia-se no dia seguinte ao da emissão do RPS.

7. Cancelamento

O RPS somente poderá ser cancelado pelo emitente nos seguintes casos:

• quando o serviço não for aceito pelo tomador ou intermediário do serviço, no ato da entrega do
mesmo;
• quando o documento fiscal tiver sido emitido com erro ou rasura relativos à prestação do serviço.

O emitente do documento cancelado deverá observar os seguintes procedimentos:

• todas as vias deverão ser conservadas em poder do emitente para apresentação ao Fisco quando
solicitado;
• anotar na primeira via a expressão “CANCELADA” e o motivo pelo qual houve o cancelamento.

É obrigatória a informação de cancelamento de RPS.

8. Substituição

O RPS poderá substituir uma NFS-e quando o documento fiscal tiver sido emitido com erro ou rasura
relativos à prestação do serviço e necessite ser emitido corretamente.

O RPS que substituir a NFS-e terá obrigatoriamente o número e série da NFS-e a ser substituída. Essa
informação deverá constar no campo “Outras Informações” no RPS.

9. Requisitos para emissão do RPS

• Modelo de RPS: O RPS poderá ser confeccionado ou impresso em sistema próprio do contribuinte,
mediante Autorização de Impressão de Recibo Provisório de Serviço - AIRPS. Não existe modelo
padrão de RPS, mas o mesmo deverá ser confeccionado ou impresso contendo todos os dados que
permitam a sua conversão por NFS-e, em especial o CPF ou CNPJ do tomador de serviços.

• Numeração do RPS: O RPS será numerado obrigatoriamente em ordem crescente seqüencial a


partir do número 1 (um) com seu devido Código de Verificação.

• Quantidade de vias de um RPS: O RPS deve ser emitido em 2 vias, sendo a 1ª entregue ao
tomador de serviços, ficando a 2ª em poder do emitente.

10. Penalidades pela não conversão do RPS em NFS-e

A não conversão do RPS pela NFS-e equipara-se a não emissão de documento fiscal e sujeitará o
prestador de serviços a penalidade de 50 (cinqüenta) UFIRCA´s, por cada RPS não convertido.

11. Conversão de RPS em NFS-e (em lote)

Visando facilitar a substituição do RPS por NFS-e (conversão em lote), o Sistema de Nota Fiscal de Serviço
Eletrônica (NFS-e), permite que sejam enviados informações dos contribuintes para a Prefeitura em lotes
via webservice. Tais lotes devem atender a um layout pré-definido. O webservice de NFS-e permite ao
prestador de serviço enviar, validar e processar os lotes contendo os RPS emitidos em determinado
período. Após o envio, o lote é validado. Se a validação for bem sucedida, o lote será processado
automaticamente, substituindo os RPS enviados por NFS-e. O lote enviado deverá conter no máximo 50
unidades.

12. Cancelando um RPS antes de sua conversão em NFS-e

No caso de ser necessário cancelar um RPS antes de sua conversão em NFS-e, o prestador de serviços
deverá manter arquivo de todas as vias do RPS com a tarja de “cancelado”, caso contrário, seu
cancelamento não será permitido. O sistema da NFS-e controlará a seqüência numérica dos RPS
convertidos.

13. Consulta de RPS

O sistema da NFS-e permite que o tomador de serviços que recebeu um RPS consulte a sua conversão em
NFS-e. A consulta de RPS será disponibilizada no site da SEFIN.

Para a consulta deverão ser informados os seguintes dados:

• CNPJ do Prestador de Serviços: (quem emitiu o RPS);


• Número do RPS;
• Código de Verificação do RPS.

14. Descrição dos Métodos

O webservice deve manter disponível os seguintes os métodos:

• token – permite gerar token de acesso, que será utilizado nas requisições.

• solicitarAirps – permite solicita um lote de números de RPS com seus respectivos Códigos de
Validação para ser utilizado pelo Contribuinte.

• gerarRps – permite enviar lote de RPS para ser validado e convertido em NFS-e.

15. Fluxo de Acesso

O contribuinte através do seu aplicativo deverá enviar requisição para o método token passando
accessKeyId e secretAccessKey, via verbo POST. O webservice retornará o accessToken, onde o mesmo
será utilizado no cabeçalho das futuras requisições.

16. URL webservice

O webservice está publicado em https://api.nfse.sefin.caucaia.ce.gov.br.


17. Fluxo Operacional

• Método: token
• Verbo: POST

Tipo: Requisição
Campo Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo
accessKeyId 14 String S Deve ser preenchido com CPF/CNPJ
do Prestador de Serviço de acesso ao
Sistema de NFS-e.
secretAccessKey - String S Deve ser preenchido com a senha de
acesso ao Sistema de NFS-e.

versao 3 String S Versão do webservice. Informar 100.

Tipo: Resposta
Campo Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo

accessToken - String S Retorna token de acesso que será


utilizado nas futuras requisições.
mensagem - String S Retorna mensagem contendo os erros
conforme tabela de Erros e
Procedimento caso erro durante o
processamento.

Se houver sucesso durante o


processamento, retornará ocorrência
“Usuario autorizado”.

• Método: solicitarAirps
• Verbo: POST

Tipo: Requisição
Campo Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo
acessToken - String S Deve ser informado no header da
requisição.
inscricaoMunicipalPrestador 7 String S Inscrição municipal do prestador a
que se refere ao lote.

dataSolicitação 8 String S Informe neste campo a Data da


Solicitação.

Formato: AAAAMMDD

Tipo: Resposta
Campo Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo
numeroSolicitacao - Numérico S Retorna o número da solicitação
gerada no Sistema de NFS-e
dataSolicitacao 8 String S Retorna a data da solicitação
informada na requisição.

Formato: AAAAMMDD
dataAutorizaçãoSolicitacao 8 String S Retorna a data da autorização
gerada no Sistema de NFS-e.

Formato: AAAAMMDD
numerosRps - listaNumeroRps S Retorna lista de números de RPS e
seus respectivos códigos de
validação gerada no Sistema de
NFS-e.

Caso ocorra erro(s) durante o


processamento a lista retornará será
vazia.
mensagem - String S Retorna mensagem contendo os
erros conforme tabela de Erros e
Procedimento caso erro durante o
processamento.
Se houver sucesso durante o
processamento, retornará
ocorrência “Lote Gerado”.
Tipo de Dado: listaNumeroRps
Campo Tamanho Tipo Campo Obrigatório (S/N) Conteúdo
numero - Numérico S Retorna o número do RPS gerada
no Sistema de NFS-e
codigoValidacao 9 String S Retorna o Código de Validação
gerado no Sistema de NFS-e.

• Método: gerarRps
• Verbo: POST

Tipo: Requisição
Campo Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo
acessToken - String S Deve ser informado no header da
requisição.
inscricaoMunicipalPrestador 7 String S Inscrição municipal do prestador a
que se refere ao lote.

dataSolicitação 8 String S Informe neste campo a Data da


Solicitação.

Formato: AAAAMMDD
ambiente 1 String S Deve ser informado:
H – Homologação
P – Produção

Após a opção P ser informada, não


será, mas possível utilizar opção H.
rps - listaRps S Informe lista de RPS gerada pelo
Sistema do Contribuinte.

Deverá conter no máximo 50


unidades.

Tipo de Dado: listaRps


Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo
Campo

numeroRPS Numérico S Informe o Número do RPS


codigoVerificacaoRPS 9 String S Informe o Código de verificação
do RPS com 09 posições.
dataEmissãoRPS 8 AAAAMMDD S Informe a Data de emissão do
RPS no formato AAAAMMDD.
situaçãoRPS 1 Caractere S Informe a Situação do RPS com
01 posição, de acordo com o tipo
do RPS.
N - Operação normal (tributação
conforme documento emitido) ;
I - Operação isenta ou não
tributável, executadas;
C – Cancelado;
E – Extraviado.
valorTotal 15 Numérico S Informe o Valor Total da NF.
Campo obrigatório caso a situação
do RPS seja diferente de “C”
(Cancelado) e “E” (Extraviado).
Exemplo:
500,85
500,00
valorServiço 15 Numérico S Informe o Valor dos Serviços.
Campo obrigatório caso a situação
do RPS seja diferente de “C”
(Cancelado) e “E” (Extraviado).
Exemplo:
500,85
500,00
valorDeduçãoServiço 15 Numérico S Informe o Valor das Deduções
Serviço. Campo obrigatório caso a
situação do RPS seja diferente de
“C” (Cancelado) e “E”
(Extraviado).
Exemplo:
500,85
500,00

valorBaseCalculServiço 15 Numérico S Informe o Valor da Base de


Calculo dos Serviços. Campo
obrigatório caso a situação do
RPS seja diferente de “C”
(Cancelado) e “E” (Extraviado).
Exemplo:
500,85
500,00
aliquota 4 Numérico S Informe o Valor da Alíquota.
Campo obrigatório caso a situação
do RPS seja diferente de “C”
(Cancelado) e “E” (Extraviado).
Exemplo:
5,00
2,75
ValorISS 15 Numérico S Informe o Valor do ISS. Campo
obrigatório caso a situação do
RPS seja diferente de “C”
(Cancelado) e “E” (Extraviado).
Exemplo:
500,85
500,00
issRetido 1 Numérico S S para ISS Retido.
N para ISS não Retido.
valorDescontoIncondicional 15 Numérico S Informe o Valor do Desconto
Incondicional. Campo obrigatório
caso a situação do RPS seja
diferente de “C” (Cancelado) e “E”
(Extraviado).
Exemplo:
500,85
500,00
valorTotalLiquido 15 Numérico S Informe o Valor Total Liquido.
Exemplo:
500,85
500,00
codigoServiço 5 Texto S Código da lista de serviço da
tabela anexa a Lei nº
Complementar 02/2009.
codigoCNAE 10 Texto S Código CNAE cadastrado no
CPBS (Cadastro de Produtores de
Bens e Serviços).
indicadorCpfCnpjTomador 1 Caractere S Este campo indica o tipo de dados
que será fornecido no campo
CPF/CNPJ do Tomador
1 para CPF;
2 para CNPJ;
3 para Não-informado.
cpfCnpjTomador 14 Numérico S Informe o CNPJ do tomador com
14 posições ou CPF do tomador
com 11 posições.

O conteúdo deste campo será


ignorado caso o campo 17 esteja
preenchido com a opção 3.
InscriçãoMunicipalTomador 7 Numérico N Informe a Inscrição Municipal do
Tomador, com 7 posições.
ATENÇÃO!!! Este campo só
deverá ser preenchido para
tomadores estabelecidos no
município de CAUCAIA (CPBS).
nomeRazaoSociaTTomador 80 Texto S (*)Este campo é obrigatório
apenas para tomadores Pessoa
Física e Pessoa Jurídica
(CPF/CNPJ).
enderecoTomador 50 Texto N (*) Este campo é obrigatório
apenas para tomadores Pessoa
numeroEnderecoTomador 10 Texto N Física e Pessoa Jurídica
(CPF/CNPJ).
complementoEnderecoTomador 30 Texto N
Note que apenas tomadores cuja
Cidade / UF seja igual a CAUCAIA
/ CE, irão receber créditos.
bairroTomador 50 Texto (*)

cidadeTomador 40 Texto (*)

ufTomador 2 Texto (*)

cepTomador 8 Numérico (*)

emailTomador 80 Texto N (*) Campo contendo o e-mail do


tomador
discriminacaoServicos - Texto N Informe a discriminação do
Serviço Prestado.

Tipo: Resposta
Campo Tamanho Tipo de Dado Campo Obrigatório (S/N) Conteúdo
mensagem - String S Retorna mensagem contendo os
erros conforme tabela de Erros e
Procedimento caso erro durante o
processamento.

Se houver sucesso durante o


processamento, retornará
ocorrência “Lote Convertido”.

18. Erros e Procedimentos

A tabela a seguir, relacionam os erros e procedimentos adotados pelo Sistema de Notas Fiscais Eletrônicas
na substituição do Recibo Provisório de Serviços - RPS por NFS-e.

Código Descrição Procedimento


001 Usuário inválido. Só será permitido o envio por usuário autorizado no
sistema NFS-e.
002 O código do serviço prestado não Verifique a tributação para a atividade informada no
permite retenção de ISS. RPS.
003 RPS em duplicidade no lote enviado. Não são permitidos RPS com numeração duplicado no
lote. A numeração de RPS deve ser seqüencial, em
ordem ascendente e sem duplicidade.
004 RPS já processado. O RPS não O RPS enviado no lote já foi convertido em nota em
poderá ser enviado novamente. outro lote enviado anteriormente.
005 O tomador de serviços informado é o O prestador e o tomador do serviço não pode ser os
próprio prestador. mesmos. Verifique esta informação no RPS.
006 CPF/CNPJ do Tomador de Serviços Informe um CPF/CNPJ do tomador válido.
inválido (dígitos verificadores não
conferem).
007 O Valor do serviços deverá ser O valor do RPS devem ser maior que zero.
superior a R$ 0,00 (zero).
008 O Valor da dedução de verá ser O valor da dedução do RPS deve ser menor que o valor
inferior ao valor dos serviços. do serviço.
009 O Valor da dedução deverá ser O valor da dedução do RPS deve ser maior ou igual a
superior ou igual a R$ 0,00 (zero). zero.
010 Alíquota ISS informada no RPS Verifique o valor correto da alíquota de ISS para esta
difere do valor da alíquota para a atividade de prestação junto a prefeitura.
atividade informada.
011 A data da emissão do RPS não foi Verifique a data de emissão do RPS.
preenchida corretamente.
012 A data da emissão do RPS não Não podem ser emitidos RPS com data futura.
poderá ser superior de envio.
013 A data da emissão do RPS não Verifique a data de emissão do RPS
poderá ser inferior a 01/11/2011.
014 Número do RPS não informado. Informe o número do RPS
015 Campo Endereço não preenchido Para tomador pessoa física e pessoa jurídica é
(obrigatório para tomador com obrigatório o preenchimento do endereço.
CPF/CNPJ).
016 Campo Cidade/UF não preenchido É obrigatório o preenchimento da cidade do tomador
(obrigatório para tomador com para pessoa física e pessoa jurídica.
CPF/CNPJ).
017 A tributação do RPS não confere Verifique a alíquota de ISS do RPS.
com a tributação do Prestador.
018 Motivo do cancelamento do RPS não A situação do RPS esta marcada como CANCELADA
informado. porém não foi informado o motivo do cancelamento.
019 A alíquota deve estar entre 2,00 a Verifique o correto preenchimento para o campo Alíquota
5,00 ou alíquota igual a zero. de ISS
020 O serviço e o CNAE não tem O código do serviço não está relacionado ao código do
relação. CNAE.
021 O status do campo ISS Retido não Verificar o campo ISS Retido no Manual de Orientação.
condiz com o Manual.
022 RPS cancelado. O RPS não poderá Verificar situação do RPS no ambiente da NFS-e.
ser enviado novamente.
023 RPS não localizado. Verificar Inscrição Municipal, Número do RPS e Código
de Verificação.
024 Serviço não é permitido dedução. O serviço informado não é permitido dedução, consulte
o CTM.

Você também pode gostar