Você está na página 1de 16

PREFEITURA DO MUNICPIO DE OSASCO

MANUAL PARA EMISSO DE NFS-E EM


TEMPO REAL VIA WEBSERVICE

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 2 de 16

Sumrio
Objetivo ......................................................................................................................................3
Pblico Alvo ..............................................................................................................................3
Pr-requisitos .........................................................................................................................3
Solicitao da Chave de Autenticao ......................................................................4
Estrutura e definio do WebService........................................................................7
Definio das operaes ........................................................................................................................... 7
1.

Emitir ............................................................................................................................................ 7

1.1.

Parmetros de entrada ........................................................................................... 7

1.2.

Objeto de retorno..................................................................................................... 10

Cancelar .................................................................................................................................... 10

2.

2.1.

Parmetros de entrada ......................................................................................... 10

2.2.

Objeto de retorno..................................................................................................... 11

Como utilizar o WebService..........................................................................................12


Emitir nova NF-e ..................................................................................................................................... 12
1.

Sem tomador ...................................................................................................................... 12

2.

Com tomador ...................................................................................................................... 12

3.

Com tomador estrangeiro................................................................................................... 12

4.

Homologao ...................................................................................................................... 12

Cancelar NF-e existente .......................................................................................................................... 13


Notificando o tomador por e-mail .......................................................................................................... 13

Acesso ao WebService .....................................................................................................14


Ajuda Tcnica ................................................................................................................................15
Exemplo Java........................................................................................................................................... 15
Exemplo .Net........................................................................................................................................... 16

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 3 de 16

Objetivo
Este documento tem por objetivo identificar os principais aspectos para a integrao
direta e em tempo real entre contribuinte e Prefeitura no envio de Notas Fiscais
Eletrnicas utilizando o mecanismo de WebService disponibilizado.
Pblico Alvo
Este documento destinado s reas de negcio e tecnologia dos contribuintes que
desejam fazer a integrao utilizando-se do mecanismo de WebService.
Pr-requisitos
Para o funcionamento adequado do mecanismo de integrao, os requisitos abaixo
devem ser atendidos:

O contribuinte dever possuir permisso de emisso de Notas Fiscais


Eletrnicas.

O contribuinte dever obter uma chave de autenticao para comunicao


com o WebService.

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 4 de 16

Solicitao da Chave de Autenticao


A Chave de Autenticao exclusiva para o contribuinte e cada Inscrio Municipal,
obrigatoriamente, dever possuir sua prpria chave pois ela quem identifica a empresa, o
usurio e suas permisses.
Para solicitar a Chave de Autenticao, utilize os passos abaixo:

Acesse o sistema utilizando o usurio principal da NF -E. O usurio


principal o usurio criado no momento em que a requisio de
autorizao foi preenchida.

No menu Notas Fiscais clique em Web Service Gerar Chave


Autenticao.

Clique em Gerar Chave.

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 5 de 16

Aguarde a confirmao da gerao.

A Chave gerada deve ser utilizada para enviar as Notas Fiscais, guarde -a
com segurana, caso necessrio, refaa o procedimento para gerar uma
nova chave.

Obs.: quando for gerada uma nova chave, a anterior automaticamente ser
desativada e a nova chave dever passar a constar nos procedimentos de integrao
atravs do web service.

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 6 de 16

Processo de Homologao
Durante o processo de ajustes da aplicao do contribuinte ser possvel a gerao
das notas em Homologao para fins de verificao e validao do processo de
gerao de NF-E atravs do WebService. Para isso, basta indicar o valor True no
campo referente Homologao. Quando geradas em homologao as notas no
tero valor fiscal e apresentaro uma tarja indicativa de Homologao. Quando no
houver a indicao True no campo referente homologao, a nota ser
considerada como Oficial.

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Estrutura e definio do WebService


O WebService de integrao trabalha com objetos de Request para entrada e
Response para a sada dos dados.
Definio das operaes
1. Emitir
Emite uma nova nota fiscal eletrnica.
1.1. Parmetros de entrada
Estrutura do XML

Pg. 7 de 16

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

<?xml version="1.0"?>
<EmissaoNotaFiscalRequest
xmlns:xsi="_http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="_http://www.w3.org/2001/XMLSchema">
<NotaFiscal>
<ChaveAutenticacao />
<Tomador>
<CNPJ />
<CPF />
<InscricaoMunicipal />*
<Nome />
<Email />
<Endereco>
<TipoLogradouro />
<Logradouro />
<Numero />
<Complemento />
<Bairro />
<Cidade />
<CEP />
<Estado />
<Pais />
</Endereco>
<DDD />
<Telefone />
</Tomador>
<TomadorEstrangeiro>false</TomadorEstrangeiro>
<InformacoesAdicionais />
<Atividade />
<Valor>0</Valor>
<ValorDeducao>0</ValorDeducao>
<Aliquota>0</Aliquota>
<ValorIR />
<ValorINSS />
<ValorCofins />
<ValorPisPasep />
<ValorCSLL />
<ValorOutrosImpostos />
<SubstituicaoTributaria>false</SubstituicaoTributaria>
<Homologacao>false</Homologacao>
<NotificarTomadorPorEmail>false</NotificarTomadorPorEmail>
</NotaFiscal>
</EmissaoNotaFiscalRequest>
* A tag <InscricaoMunicipal /> somente dever ser utilizada quando o
Tomador do Servio for uma empresa inscrita no Municpio de Osasco.
Certifique-se de que o nmero informado a inscrio correta pois o sistema
utilizar essa informao para localizar os dados do tomador do servio.

Pg. 8 de 16

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 9 de 16

No dever ser informado qualquer dgito verificador que houver na inscrio


municipal. Por exemplo, para inscrio 107815 -9 deve-se informar apenas
107815.
Sugere-se que, preferencialmente, seja informado o CNPJ ou o CPF para
identificao do tomador.
Definio dos campos
NOME

TIPO

DEFINIO

EmissaoNotaFiscalRequest

Objeto

Objetivo principal da entrada

NotaFiscal
ChaveAutenticacao

Objeto
String

Tomador

Objeto

CNPJ
CPF
InscricaoMunicipal
Nome

String
String
String
String

Endereco

String

TipoLogradouro
Logradouro
Numero
Complemento
Bairro
Cidade
CEP
Estado

String
String
String
String
String
String
String
String

Pais

String

Contm os dados da nota fiscal a ser emitida


Chave de autenticao do prestador
Contm as informaes do tomador da nota
fiscal
CNPJ do tomador. Mximo de 14 caracteres
CPF do tomador. Mximo de 11 caracteres
Inscrio Municipal do tomador
Nome do tomador
Contm as informaes de endereo do
tomador
Tipo do logradouro (Rua, Av, etc)
Logradouro do endereo do tomador
Numero do endereo do tomador
Complemento do endereo do tomador
Bairro do endereo do tomador
Cidade do endereo do tomador
CEP do endereo do tomador
Estado do endereo do tomador
Pas do endereo do tomador dever ser
informado para tomador estrangeiro
DDD do tomador com dois dgitos
Telefone do tomador
Indicativo se tomador estrangeiro
Informaes adicionais da nota fiscal
contendo no mximo 2300 caracteres.
Cdigo da atividade da nota fiscal
Valor da nota fiscal
Valor da deduo da nota fiscal
Alquota especial do simples nacional a ser
utilizada na nota fiscal. Deve ser indicada
apenas quando o prestador estiver
enquadrado no Simples Nacional e tratar-se
de Substituio Tributria.
Valor do IR (No obrigatrio)
Valor do INSS (No obrigatrio)
Valor do Cofins (No obrigatrio)
Valor do Pis/Pasep (No obrigatrio)
Valor do CSLL (No obrigatrio)
Valor de outros impostos
(No obrigatrio)
Indicativo de substituio tributria

DDD
Telefone
TomadorEstrangeiro
InformacoesAdicionais

String
String
Boolean
String

Atividade
Valor
ValorDeducao

String
Decimal
Decimal

Aliquota

Decimal

ValorIR
ValorINSS
ValorCofins
ValorPisPasep
ValorCSLL

Decimal
Decimal
Decimal
Decimal
Decimal

ValorOutrosImpostos

Decimal

SubstituicaoTributaria

Boolean

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Homologacao

Boolean

NotificarTomadorPorEmail

Boolean

Pg. 10 de 16

Indicativo para emisso da nota fiscal em


homologao
Indicativo para notificar o tomador por e-mail

1.2. Objeto de retorno


Estrutura do XML
<?xml version="1.0"?>
<EmissaoNotaFiscalResponse>
<Erro></Erro>
<MensagemErro></MensagemErro>
<NotaFiscalGerada>
<Numero></Numero>
<Autenticador></Autenticador>
<Link></Link>
</NotaFiscalGerada>
</EmissaoNotaFiscalResponse>
Definio dos campos
NOME
EmissaoNotaFiscalResponse
Erro

TIPO DE
DADO
Objeto
Boolean

DEFINIO
Objeto principal do retorno
Indicativo se ocorreu algum erro durante a
requisio

MensagemErro

String

Mensagem de erro ocorrida durante a


requisio

NotaFiscalGerada

Objeto

Objeto que contm as informaes da nota


gerada

Numero
Autenticador
Link

String
String
String

Nmero da nota fiscal gerada


Cdigo autenticador da nota fiscal gerada
Link para visualizao da nota fiscal gerada

2. Cancelar
Cancela uma nota fiscal eletrnica.
2.1. Parmetros de entrada
Estrutura do XML
<?xml version="1.0"?>
<CancelamentoNotaFiscalRequest
xmlns:xsi="_http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="_http://www.w3.org/2001/XMLSchema">
<ChaveAutenticacao />
<NumeroNota />
<Homologacao>false</Homologacao>
</CancelamentoNotaFiscalRequest>

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 11 de 16

Definio dos campos


NOME
CancelamentoNotaFiscalRequest
ChaveAutenticacao
NumeroNota
Homologacao

TIPO DE
DADO
Objeto
String
String
Boolean

DEFINIO
Objeto principal da requisio
Contm as informaes do tomador da nota
fiscal
Nmero da nota fiscal a ser cancelada
Indicativo se a nota fiscal foi emitida em
homologao ou no

2.2. Objeto de retorno


Estrutura do XML
<?xml version="1.0"?>
<CancelamentoNotaFiscalResponse
xmlns:xsi="_http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="_http://www.w3.org/2001/XMLSchema">
<Erro>false</Erro>
<MensagemErro />
</CancelamentoNotaFiscalResponse>

Definio dos campos

CancelamentoNotaFiscalResponse
Erro

TIPO DE
DADO
Objeto
Boolean

MensagemErro

String

NOME

DEFINIO
Objeto principal do retorno
Indicativo se ocorreu algum erro durante a
requisio
Mensagem de erro ocorrida durante a
requisio

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 12 de 16

Como utilizar o WebService


Emitir nova NF-e
1. Sem tomador
Para emitir a nota fiscal sem tomador, o objeto Tomador dever ser Nulo, caso o
mesmo for informado o sistema r considerar que o tomador dever ser considerado
para a nota fiscal em questo.
2. Com tomador
Para emitir a nota fiscal com tomador o objeto do tomador dever ser informado.
3. Com tomador estrangeiro
Para emitir a nota fiscal para tomador estrangeiro, a indicao dever estar marcada
como True, bem como o tomador dever possuir endereo com indicao do pas
que dever ser diferente de Brasil.
4. Homologao
Visualizando as NF-e emitidas em homologao

No menu Notas Fiscais clique em Web Service NF-E em homologao.

Ao clicar sobre o nmero Identificador ou sobre a data de Gerao ser


exibida a imagem da nota em homologao.

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 13 de 16

Cancelar NF-e existente


Para cancelar uma nota fiscal informe a chave de autenticao e o numero da nota, para
notas fiscais em homologao no ser consideradas a tarja de cancelada.

Notificando o tomador por e-mail


Caso deseje notificar o tomador por e-mail, o indicativo de notificao dever estar
marcado como True nesse caso o campo e-mail do tomador deve ser informado.
O tomador s receber o e-mail quando a nota fiscal no for emitida com indicao de
homologao.

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Acesso ao WebService
Para acessar o WebService utilize o endereo abaixo:
https://www.nfeosasco.com.br/EissnfeWebServices/NotaFiscalEletronica.svc
Para gerar os tipos atravs do WSDL
https://www.nfeosasco.com.br/EissnfeWebServices/NotaFiscalEletronica.svc?wsdl

Pg. 14 de 16

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 15 de 16

Ajuda Tcnica
Exemplo Java
Aps gerar os tipos a partir do WSDL, segue exemplo abaixo para consumir WebService,
utilizando tecnologia Java.
public class TesteWebService {
public static void main (String []args)
throws RemoteException, ServiceException {
BigDecimal big1 = new BigDecimal(10.00);
NotaFiscalDTO dto = new NotaFiscalDTO();
dto.setChaveAutenticacao(
"0f961fa7-4cff-40f5-a096-c7c66dcefc29");
dto.setAtividade("1.01");
dto.setValor(big1);
EmissaoNotaFiscalRequest request =
new EmissaoNotaFiscalRequest();
request.setNotaFiscal(dto);
INotaFiscalEletronica servico =
new NotaFiscalEletronicaLocator()
.getBasicHttpBinding_INotaFiscalEletronica();
EmissaoNotaFiscalResponse response = servico.emitir(request);
if (!response.getErro()) {
System.out.println(
response.getNotaFiscalGerada().getAutenticador());
System.out.println(
response.getNotaFiscalGerada().getNumero());
} else {
System.out.println(response.getMensagemErro());
}
}
}

Prefeitura do Municpio de Osasco

Nota Fiscal Eletrnica

Pg. 16 de 16

Exemplo .Net.
Aps gerar os tipos a partir do WSDL, segue exemplo abaixo para consumir WebService,
utilizando tecnologia .NET.
using (var servico = new NotaFiscalEletronicaServicoClient())
{
var request = new EmissaoNotaFiscalRequest();
var response = servico.Emitir(request);
if (response.Erro)
{
MessageBox.Show(response.MensagemErro);
}
else
{
MessageBox.Show(
string.Format("O nmero da nota gerada : {0}",
response.NotaFiscalGerada.Numero));
}
}