Cadastro de cliente para emissão de NFS-e

Cadastre as informações iniciais obrigatórias para emissão de nota fiscal de serviço


154
Importante para Integração Direta Para você conseguir integrar é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"


Esta API realiza o registro de informações importantes à respeito do emissor prestador de serviços. No entanto, é importante observar que o registro das informações com sucesso não substitui a verificação de informações específicas, como a autenticidade da Inscrição Municipal, ou precisão do Regime Tributário.

Quais são os requisitos para a utilização desta API?

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
municipal_register
obrigatório
StringInscrição Municipal. Pode ser conhecida também como: Cadastro Mobiliário ou CCM (Cadastro do Contribuinte Mobiliário)
state_register
opcional
StringInscrição Estadual. Necessário para algumas cidades somente. Essa informação é necessária, por exemplo, para clientes de Brasília.
tax_regime
obrigatório
StringRegime tributário da empresa. O regime tributário de uma empresa refere-se ao conjunto de leis que determinam como os impostos devem ser calculados e pagos ao governo.

É possível consultar os tipos de regime tributário disponíveis em Regimes Tributários.
special_tax_regime
obrigatório
StringRegime tributário especial da empresa. Um regime tributário especial é um conjunto de normas e procedimentos fiscais diferenciados, estabelecidos por lei, que oferecem condições de tributação distintas das previstas nos regimes tributários tradicionais. Caso a empresa não tenha regime tributário especial, enviar como NONE.

É possível consultar os tipos de regime tributário especial disponíveis em Regimes Tributários Especiais.
rps
obrigatório
RPS Objeto RPS.

O objeto RPS, que inclui o último número utilizado e a série, é essencial para a emissão de Notas Fiscais de Serviço (NFS-e). Ele garante a continuidade e a unicidade na sequência de emissões, sendo crucial nas configurações iniciais para emissão.

Tipos de Objetos

Objeto RPS

ParâmetroTipoDescrição
last_number
obrigatório
StringÚltimo número de RPS utilizado: Esse número é específico para integrações via webservice. Caso a emissão de NFS-e tenha sido realizada exclusivamente pelo portal da prefeitura, o uso de RPS pode não ter sido necessário. Para novos usuários sem emissões anteriores de RPS, o valor inicial padrão é 1
serie
obrigatório
StringSérie do RPS: Representa um identificador que pode ser um número (como '1') ou uma letra (por exemplo, 'U' em Curitiba), utilizado para classificar e organizar os recibos provisórios de serviços. Essa classificação facilita a gestão e o controle fiscal, atuando em conjunto com o número do RPS para segmentar e rastrear as emissões de notas fiscais de serviço de maneira eficaz.

Tipos de Enumeradores

Enum de Regimes Tributários

ParâmetroDescrição
SIMPLES_NACIONALRegime tributário simples nacional
SIMPLES_NACIONAL_EXCESSORegime tributário simples nacional excesso de sublimite
REGIME_NORMAL_LUCRO_PRESUMIDOLucro Presumido
NORMAL_LUCRO_REALLucro Real

Enum de Regimes Tributários Especiais

ParâmetroDescrição
NONESem regime tributário especial
MICRO_EMPRESA_MUNICIPALMicro empresa municipal
ESTIMATIVAEstimativa
SOCIEDADE_DE_PROFISSIONAISSociedade de Profissionais
COOPERATIVACooperativa
MEIMEI (Micro empresário individual)
ME_EPPMicro Empresa ou Empresa de Pequeno Porte
LUCRO_REALLucro Real
LUCRO_PRESUMIDOLucro Presumido
TRIBUTACAO_NORMALTributação Normal
SIMPLES_NACIONAL_COM_EXCESSO_DO_SUBLIMITESimples Nacional com excesso de sublimite
EMPRESA_DE_RESPONSABILIDADE_LIMITADAEmpresa de Responsabilidade Limitada

Algumas cidades limitam os tipos de regime tributário especial.


Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!