...
A seguir são detalhadas as tabelas de cada tipo composto e seus campos.
A tabela está dividida da seguinte forma:
(1) | ||||
---|---|---|---|---|
(2) | ||||
Nome | Tipo | Ocorrência | Descrição | |
| (4) | (5) | (6) | (7) |
(4) | (5) | (6) | (7) |
...
notaFiscalServicoEletronica | |||
---|---|---|---|
Representa dados de identificação da Nfs-e. | |||
Nome | Tipo | Ocorrência | Descrição |
numeroNfse | numeroNfse | 1 - 1 | |
codigoVerificacao | codigoVerificacao | 1 - 1 | |
dataEmissao | date | 1 - 1 | |
numeroNfseSubstituta | numeroNfse | 0 - 1 | Não utilizado |
outrasinformacoes | outrasinformacoes | 0 - 1 | |
status | status | 1 - 1 | 1 ou 2 |
descStatus | string | 0 - 1 | 1 - Normal |
creditoGerado | creditoGerado | 0 - 1 | Tabela creditoGerado |
complementoPrestador | complementoPrestadorServico | 0 - 1 | |
valorNfse | valorNfse | 0 - 1 | |
identificacaoOrgaoGerador | identificacaoOrgaoGerador | 0 - 1 | Tabela identificacaoOrgaoGerador |
rps | reciboProvisorioDeServico | 0 - 1 | Tabela reciboProvisorioDeServico |
loteRPS | |||
---|---|---|---|
Representa dados de identificação do Lote. | |||
Nome | Tipo | Ocorrência | Descrição |
tipoLote | tipoLote | 1 - 1 | 1 - Recibo provisório de |
ildentLote | numeroLote | 1 - 1 | Não pode ser repetido |
recibosProvisoriosDeServico | recibosProvisoriosDeServico | 1 - N | Tabela |
resultado | int | 1 - 1 | Número do resultado |
status | int | 1 - 1 | Código do status |
descStatus | string | 1 - 1 | Descrição do status |
codErro | int | 1 - 1 | Código do erro |
informacoesErro | string | 0 - 1 | Informações sobre o |
reciboProvisorioDeServico | |||
---|---|---|---|
Representa dados do Recibo Provisório de Serviço (RPS). | |||
Nome | Tipo | Ocorrência | Descrição |
dataEmissaoRps | date | 1 - 1 | |
identificacao TomadorServico | recibosProvisoriosDeServico | 0 - 1 | Tabela |
itens | item | 0- N | Tabelaitem |
numeroRps | numeroRps | 1 - 1 | Não pode ser |
numeroRpsSubstituto | numeroRps | 0 - 1 | Não utilizado |
prestadorServico | prestadorServico | 0 - 1 | Tabela |
serieRps | serieRps | 1 - 1 | Não utilizado |
tipoRps | tipoRps | 1 - 1 | 1 - Recibo provisório de |
tipoRpsSubstítuto | tipoRpsSubstítuto | 0 - 1 | Não utilizado |
serieRpsSubstítuto | serieRpsSubstítuto | 0 - 1 | Não utilizado |
statusRps | status | 1 - 1 | 1 - Normal |
detaheContrucaoCivil | detaheContrucaoCivil | 0 - 1 | Tabela detalheContucaoCivil |
identificacaointermediarioServico | identificacaointermediarioServico | 0 - 1 | Tabela IdentficacaointermediarioServico |
identicficacaoPrestacaoServico | identicficacaoPrestacaoServico | 1 - 1 | Tabela identicficacaoPrestacaoServico |
creditoGerado | |||
---|---|---|---|
Valor do crédito gerado. | |||
Nome | Tipo | Ocorrência | Descrição |
valorCredito | valor | 0 - 1 | Não utilizado |
complementoPrestadorServico | |||
---|---|---|---|
Representa dados do complemento de endereço do prestador do serviço | |||
Nome | Tipo | Ocorrência | Descrição |
bairro | bairro | 0 - 1 | |
cep | cep | 1 - 1 | |
cidade | municipio | 1 - 1 | De acordo com a tabela do IBGE, utilizamos os 7 dígitos |
complementoEndereco | complementoEndereco | 0 - 1 | |
0 - 1 | |||
nomeFantasia | nomeFantasia | 0 - 1 | |
numeroEndereco | numeroEndereco | 1 - 1 | |
pais | pais | 0 - 1 | Tabela do BACEN |
razaoSocial | razaoSocial | 1 - 1 | |
telefone | telefone | 0 - 1 | |
uf | uf | 1 - 1 |
valorNfse | |||
---|---|---|---|
Representa dados do valor da Nota Fiscal de Serviço eletrônica. | |||
Nome | Tipo | Ocorrência | Descrição |
aliquotaServicos | aliquota | 0 - 1 | De acordo com o Código |
baseCalculo | valor | 0 - 1 | De acordo com o Código |
valorIss | valor | 0 - 1 | |
valorLiquidoNfse | valor | 0 - 1 |
identificacaoOrgaoGerador | |||
---|---|---|---|
Representa dados de identificações do órgão gerador. | |||
Nome | Tipo | Ocorrência | Descrição |
codigoMunicipioGerador | municipio | 1 - 1 | De acordo com a tabela do IBGE, utilizamos os 7 dígitos |
ufMunicipioGerador | uf | 1 - 1 |
identificacaoTomadorServico | |||
---|---|---|---|
Representa dados de identificações do tomador do serviço. | |||
Nome | Tipo | Ocorrência | Descrição |
bairro | bairro | 0 - 1 | |
cep | cep | 0 - 1 | |
cidade | municipio | 0 - 1 | De acordo com a tabela do IBGE, utilizando os 7 dígitos |
complementoEndereco | complementoEndereco | 0 - 1 | |
cpfCnpj | cpfCnpj | 0 - 1 | |
0 - 1 | |||
endereco | endereco | 0 - 1 | |
inscricaoMunicipal | inscricao | 0 - 1 | |
nifTomador | nif | 0 - 1 | |
numeroEndereco | numeroEndereco | 0 - 1 | |
pais | pais | 0 - 1 | |
razaoSocial | razaoSocial | 0 - 1 | |
telefone | telefone | 0 - 1 | |
uf | uf | 0 - 1 |
Item | |||
---|---|---|---|
Representa dados do item do RPS. | |||
Nome | Tipo | Ocorrência | Descrição |
descricao | discriminacao | 0 - 1 | |
quantidade | quantidade | 0 - 1 | |
total | quantidade | 0 - 1 | |
valorUnitario | quantidade | 0 - 1 |
prestadorServico | |||
---|---|---|---|
Representa dados do item do RPS. | |||
Nome | Tipo | Ocorrência | Descrição |
cpfCnpj | cpfCnpj | 1 - 1 | |
inscricaoMunicipal | inscricao | 0 - 1 |
detalheConstrucaoCivil | |||
---|---|---|---|
Representa dados do detalhe da construção civil. | |||
Nome | Tipo | Ocorrência | Descrição |
art | detalhe | 0 - 1 | |
codigoObra | 0 - 1 |
identificacaoIntermediarioServico | |||
---|---|---|---|
Representa dados de identificação do intermediário do serviço. | |||
Nome | Tipo | Ocorrência | Descrição |
cidadeIntermediario | municipio | 0 - 1 | De acordo com a tabela do IBGE, utilizando os 7 dígitos |
cpfCnpj | cpfCnpj | 0 - 1 | |
inscricaoMunicipal | inscricao | 0 - 1 | |
razaoSocial | razaoSocial | 0 - 1 |
identificacaoPrestadorServico | |||
---|---|---|---|
Representa dados de identificação da prestação do serviço. | |||
Nome | Tipo | Ocorrência | Descrição |
codigoCnae | cnae | 1 - 1 | |
aliquota | aliquota | 0 - 1 | De acordo com o Código |
codigoNbs | codigoNbs | 0 - 1 | |
codigoTributacaoMunicipio | codTrbutacao | 0 - 1 | De acordo com o Código |
competencia | date | 1 - 1 | |
descontoCondicionado | valor | 0 - 1 | Não utilizado |
descontoIncondicionado | valor | 0 - 1 | Não utilizado |
discriminacao | discriminacao | 1 - 1 | |
exigibilidadeIss | exigibilidade | 1 - 1 | 1 - Exigível |
incentivoFiscal | simnao | 1 - 1 | 1 - sim |
issRetido | simnao | 1 - 1 | 1 - sim |
itemListaServico | codigoServico | 1 - 1 | De acordo coma tabela da lista de serviços anexa à Lei Complementar nº 116,de 31 de julho de 2003 |
municipioIncidencia | municipio | 0 - 1 | De acordo com a tabela do IBGE, utilizando os 7 dígitos |
municipioPrestacaoServico | municipio | 1 - 1 | De acordo com a tabela do IBGE, utilizando os 7 dígitos |
numeroProcesso | numProcesso | 0 - 1 | |
optanteSimpesNacional | simnao | 1 - 1 | 1 - sim |
outrasRetencoes | valor | 0 - 1 | |
paisPrestacaoServico | pais | 0 - 1 | Tabela BACEN |
regimeEspecialTributacao | regime | 0 - 1 | Não utilizado |
responsavelRetencao | responsavelRetencao | 0 - 1 | Não utilizado |
valorConfins | valor | 0 - 1 | |
valorCsll | valor | 0 - 1 | |
valorDeducoes | valor | 0 - 1 | |
valorInss | valor | 0 - 1 | |
valorIr | valor | 0 - 1 | |
valorIss | valor | 0 - 1 | |
valorPis | valor | 0 - 1 | |
valorServico | valor | 1 - 1 | |
valorTotalributos | valor | 0 - 1 |
(1) | ||||
---|---|---|---|---|
(2) | ||||
Nome | Tipo | Ocorrência | Descrição | |
| (4) | (5) | (6) | (7) |
(4) | (5) | (6) | (7) |
8 SERVIÇOS
A seguir estão os serviços relacionados disponíveis, conforme descritos no item 3.1, no WebService e seus XML Schema. O XML Schema define a estrutura e formatação do arquivo XML que conterá os dados a serem trafegados. Esses documentos serão enviados de forma textual (como uma string) como
parâmetros do serviço oferecido pelo Web Service, como descrito em 4. As tabelas que detalham cada XML Schema estão divididas da seguinte forma:
(1) | ||||
---|---|---|---|---|
(2) | ||||
Nome | Tipo | Ocorrência | Descrição | |
| (4) | (5) | (6) | (7) |
(4) | (5) | (6) | (7) |
Legenda da tabela:
(1) Elemento
(2) Número identificador do campo, quando este contiver subitens;
(3) Nome do campo;
(4) Nome do tipo do campo que pode ser do tipo primitivo, simples ou complexo;
(5) Indica qual é o campo pai, para definição da hierarquia;
(6) Quantas vezes o campo se repete na estrutura de dados: a. Formato: “z-y”
onde “x” é a quantidade mínima e “y” a quantidade máxima. Se a quantidade
máxima for indefinida, será utilizado “N” no lugar do “y”;
(7) Descreve alguma observação pertinente;
(8) Formato de grupo, utilizado para definição de uma escolha (ver próximo item);
(9) Identifica os campos ou grupos que farão parte de uma escolha (choice).
8.1 Recepção e Processamento de Lote de RPS (Gerar NFS-e)
Esse serviço será executado, pelo o método gerarNfse, passando a mensagem XML como parâmetro com a estrutura definida na tabela que segue.
gerarNfse | ||||
---|---|---|---|---|
# | Nome | Tipo | Ocorrência | Observação |
1 | gerarNfse | 1 - 1 | ||
loteRPServico | loteRps | 1 - 1 |
Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a seguir.
gerarNfseReponse | ||||
---|---|---|---|---|
# | Nome | Tipo | Ocorrência | Observação |
1 | gerarNfseResponse | 1 - 1 | ||
protocolo | int | 1 - 1 |
| |
mensagemErro | string | 0 - 1 |
O lote será processado posteriormente, gerando a nota fiscal em caso de conformidade e sendo o seu resultado disponibilizado para consulta (tanto o lote quanto as notas).
8.2 Consulta de Lote de RPS
Esse serviço será executado pelo método buscarLote, passando a mensagem XML como parâmetro com a estrutura definida na tabela que segue.
buscarLote | ||||
---|---|---|---|---|
# | Nome | Tipo | Ocorrência | Observação |
1 | buscarLote | 1 - 1 | ||
tipoFiltroLote | tipoFiltroLote | 1 - 1 | ||
filtroLote | int | 1 - 1 |
Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a seguir.
buscarLoteResponse | ||||
---|---|---|---|---|
# | Nome | Tipo | Ocorrência | Observação |
1 | buscarLoteResponse | 1 - 1 | ||
lote | loteRps | 0 - 1 | choice | |
mensagemErro | string | 0 - 1 |
8.3 Consulta de NFS-e
buscarNfse | ||||
---|---|---|---|---|
# | Nome | Tipo | Ocorrência | Observação |
1 | buscarNfse | 1 - 1 | ||
tipoFiltroNota | tipoFiltroNota | 1 - 1 | ||
filtroNota | string | 1 - 1 | Filtro a utilizar |
Esse serviço será executado pelo método buscarNfse, passando a mensagem XML como parâmetro com a estrutura definida na tabela que segue. Em resposta.
buscarNfseResponse | ||||
---|---|---|---|---|
# | Nome | Tipo | Ocorrência | Observação |
1 | buscarNotaResponse | 1 - 1 | ||
nfs-e | notaFiscalServicoEletronica | 0 - N | choice | |
mensagemErro | string | 0 - 1 |
a chamada do serviço será devolvida a estrutura definida na tabela a seguir.