Este artigo reúne as especificações do padrão NFS-e Coplan20 para integração via web service, incluindo portais, métodos disponíveis, tipo de impressão do documento, observações do padrão, novos campos da Reforma Tributária e campos customizados de impressão.
Tópicos deste artigo (Sumário)
- Manual do web service
- Portais disponíveis
- Métodos disponíveis
- Tipo de impressão
- Observações gerais do padrão
- Observações sobre a geração do XML / TX2
- Novos campos disponibilizados para adequação da Reforma Tributária
- Campos customizados para impressão
Manual de integração com o web service
- Download do manual - Manual de Integração
Portais disponíveis
- Produção
- Homologação
Métodos disponíveis
Envio
- Modo: (X) Síncrono / ( ) Assíncrono / ( ) Ambos
- Lote de RPS: (X) Aceita lote / ( ) Não aceita lote
Consulta
- (X) Consulta de Lote
- (X) Consulta por RPS
- (X) Consulta por NFS-e
- ( ) Consulta por protocolo
Cancelamento
- (X) Cancelamento de NFS-e via web service
- ( ) Cancelamento apenas administrativo (fora do web service)
Tipo de impressão
- ( ) Impressão via link da prefeitura
- Nossos produtos fazem download do PDF gerado pela prefeitura.
-
(X) Impressão via layout Tecnospeed
- Nossos produtos geram o PDF, aproximando ao máximo o layout da prefeitura.
Observações gerais do padrão
- Não é possível efetuar uma substituição de NFS-e.
- Não há limite de data para a consulta.
Observações sobre a geração do XML / TX2
- O código do serviço segue o padrão nacional descrito na LC-116.
- O layout segue o padrão da NFS-e Nacional, com os ajustes da NT007 (RTC007), contendo campos de IBS e CBS.
Novos campos disponibilizados para adequação da Reforma Tributária
| CodigoNbs | CodigoModoPrestacao | CodigoVinculoPrestacao | TipoMoedaEstrangeira |
| ValorServicosEstrangeiro | TipoFomentoPrestador | TipoFomentoTomador | TipoMovimentacaoBens |
| NumeroDeclaracaoImp | NumeroRegistroExp | TipoMDIC | TipoCST |
| ValorBCPisCofins | AliquotaPisProprio | AliquotaCofinsProprio | ValorPisProprio |
| ValorCofinsProprio | TipoRetPisCofins | ValorPisCofinsCsll | ValorPercTotalTribFed |
| ValorPercTotalTribEst | ValorPercTotalTribMun | ValorPercAliqSN | FinalidadeNFSe |
| OperacaoPessoal | CodigoOperacao | TipoOperacao | ChaveNFSe |
| TipoEnteGovernamental | IndicadorDestinatario | SituacaoTributariaIbsCbs | ClassificacaoTributariaIbsCbs |
| CodigoCreditoPresumidoIbsCbs | SituacaoTributariaRegularIbsCbs | ClassifTributariaRegularIbsCbs | ValorPercDiferimentoEstadual |
| ValorPercDiferimentoMunicipal | ValorPercDiferimentoCbs | CpfCnpjDestinatario | NifDestinatario |
| MotivoNaoNifDestinatario | RazaoSocialDestinatario | PaisDestinatario | CodigoCidadeDestinatario |
| CepDestinatario | DescricaoCidadeDestinatario | RegiaoDestinatario | EnderecoDestinatario |
| NumeroDestinatario | ComplementoDestinatario | BairroDestinatario | TelefoneDestinatario |
| EmailDestinatario | InscricaoFiscalImovel | CodigoCIB | CodigoCidadeImovel |
| CepImovel | DescricaoCidadeImovel | RegiaoImovel | EnderecoImovel |
| NumeroImovel | ComplementoImovel | BairroImovel | TipoChaveDF |
| DescricaoTipoChaveDFe | ChaveDFe | MunicipioDocumentoFiscal | NumeroDocumentoFiscal |
| DescricaoDocumentoFiscal | NumeroDocumentoNaoFiscal | DescricaoDocumentoNaoFiscal | CpfCnpjFornecedor |
| NifFornecedor | MotivoNaoNifFornecedor | RazaoSocialFornecedor | DataEmissaoDedutivel |
| DataCompetenciaDedutivel | TipoValorDedutivel | DescricaoValorDedutivel | ValorDedutivel |
Observações:
- Campos obrigatórios conforme o arquivo de esquema do padrão estão destacados em negrito. Eles são obrigatórios somente quando o grupo de IBS/CBS for gerado.
-
(Componente) O grupo de IBS/CBS só é gerado no XML quando informado
VersaoEsquema=RTC(ouRTC007) no TX2. - Para maiores informações sobre a forma de preenchimento destes campos novos, acesse nossa documentação do Padrão Unificado de TX2.
Exemplos de TX2 e XML
NT007 - PIS, COFINS e CSLL
O padrão está adequado às diretrizes da Nota Técnica 007 (NT007) da NFS-e Nacional, que separa os valores de apuração própria dos valores retidos na fonte. Para mais detalhes sobre a NT007, acesse o artigo NT007 - Alterações em PIS, COFINS e CSLL nos padrões municipais.
Apuração própria
- Gerada quando o campo TipoCST é informado com valor diferente de 00.
- A base de cálculo (
vBCPisCofins) é obtida do campo ValorBCPisCofins. Se ele não for informado, são utilizados, nesta ordem, BaseCalculoPIS, BaseCalculoCOFINS e BaseCalculo. A base não é gerada para os CST 08 (sem incidência) e 09 (suspensão). - Quando não houver retenção, o
tpRetPisCofinsé gerado automaticamente com o valor 0 (PIS/COFINS/CSLL não retidos).
| Tag XML | Campo TX2 com VersaoEsquema=RTC007 | Campo TX2 nas demais versões |
| pAliqPis | AliquotaPisProprio | AliquotaPisProprio; se não informado, AliquotaPis |
| pAliqCofins | AliquotaCofinsProprio | AliquotaCofinsProprio; se não informado, AliquotaCofins |
| vPis | ValorPisProprio | ValorPisProprio; se não informado, ValorPis |
| vCofins | ValorCofinsProprio | ValorCofinsProprio; se não informado, ValorCofins |
Retenção
- O tipo de retenção é informado no campo TipoRetPisCofins e enviado no
tpRetPisCofins, conforme a tabela abaixo. - Quando houver retenção sem apuração própria (TipoCST não informado ou igual a 00), o CST é gerado automaticamente com o valor 00.
- O valor retido (
vRetCSLL) corresponde à soma de PIS, COFINS e CSLL retidos e é obtido do campo ValorPisCofinsCsll. Se ele não for informado, é utilizado o campo ValorCSLL. - Para emissão via PlugNotas, utilize
versaoEsquema: RTC007. Nesse caso, a API calcula automaticamente o tipo de retenção.
| TipoRetPisCofins | Descrição |
| 0 | PIS/COFINS/CSLL não retidos |
| 1 | PIS/COFINS retidos (descontinuado) |
| 2 | PIS/COFINS não retidos (descontinuado) |
| 3 | PIS/COFINS/CSLL retidos |
| 4 | PIS/COFINS retidos, CSLL não retido |
| 5 | PIS retido, COFINS/CSLL não retidos |
| 6 | COFINS retido, PIS/CSLL não retidos |
| 7 | PIS não retido, COFINS/CSLL retidos |
| 8 | PIS/COFINS não retidos, CSLL retido |
| 9 | COFINS não retido, PIS/CSLL retidos |
Exemplo de TX2 (apuração própria com retenção)
formato=tx2 padrao=TecnoNFSe NomeCidade=SINOPMT VersaoEsquema=RTC007 INCLUIRRPS (...) TipoCST=01 ValorBCPisCofins=1000.00 AliquotaPisProprio=1.65 AliquotaCofinsProprio=7.60 ValorPisProprio=16.50 ValorCofinsProprio=76.00 TipoRetPisCofins=3 ValorPisCofinsCsll=46.50 (...) SALVARRPS
Campos customizados para impressão
Impressão do RPS
- RazaoSocialPrestadorCustom=String[80]
- EnderecoPrestadorCustom=String[80]
- CodigoMunicipioPrestador=String[10]
- NumeroPrestadorCustom=String[7]
- ComplementoPrestadorCustom=String[20]
- BairroPrestadorCustom=String[40]
- CepPrestadorCustom=String[8]
- TelefonePrestadorCustom=String[20]
- EmailPrestadorCustom=String[80]
- MunicipioIncidencia=String[7]
- ValorBaseCalculo=String[15]
- ValorDeducoesCustom=String[15]
- ValorIss=String[15]
- AliquotaIss=String[15]
- IssRetido=String[1]
- ExigibilidadeISS=String[2]
- CodigoTributacaoMunicipio=String[10]
Impressão da NFS-e
- CodigoVerificacao=String[25]
- ValorCofinsImportacao=String[20]
- ValorCIDE=String[20]
- ValorICMS=String[20]
- ValorIOF=String[20]
- ValorIPI=String[20]
- ValorPisImportacao=String[20]
- InscricaoEstadualTomador=String[80]
- InscricaoEstadualPrestador=String[80]
- IssRetido=String[2]
- ExigibilidadeISS=String[2]
- CodigoTributacaoMunicipio=String[10]
- CodigoCnae=String[10]
Comentários
0 comentário
Artigo fechado para comentários.