Habilitar emissor.
Permite habilitar um novo emissor para uso na aplicação. Para realização de consultas da tributação dos produtos e emissão de notas fiscais é fundamental o credenciamento do emissor.
⚠️ ATENÇÃO: É necessário que os dados cadastrais do emissor estejam corretos e atualizados para retorno assertivo da tributação dos produtos nas consultas e emissão de notas fiscais.
post
Body
Body
Dados necessários para habilitar o emissor.
HabilitarEmissorInputModel
Dados de entrada para habilitar o emissor.
* Additional properties are NOT allowed.
documentostring | null
Documento (CPF/CNPJ) do emissor.
tipoDocumentostringrequired
Tipo de documento do emissor.
Allowed values:CpfCnpj
nomestringrequired
Nome ou Razão Social do emissor.
>= 3 characters<= 60 characters
nomeFantasiastring | null
Nome fantasia do emissor.
regimeTributariostringrequired
Regime tributário do emissor.
Allowed values:MeiSimplesNacionalSimplesNacionalExcessoReceitaLucroPresumidoLucroReal
aliquotaCreditoSimplesnumber | null(double)
Alíquota do crédito de icms do simples nacional consedido em operações de revenda do regime Simples Nacional.
tipoIcmsStstringrequired
Tipo de ICMS ST do emissor.
Allowed values:SubstitutaSubstituida
tipoEstabelecimentostringrequired
Tipo de estabelecimento do emissor quanto ao IPI.
Allowed values:OutrosIndustriaOuEquiparado
telefonestring | null
Telefone de contato.
>= 6 characters<= 14 characters
inscricaoMunicipalstring | null
Inscrição municipal do emissor.
<= 15 characters
cnaestring | null
Código CNAE principal.
<= 7 characters
cnaeSecundariostring | null
Código CNAE secundário.
<= 7 characters
enderecoobjectrequired
Dados do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
inscricoesEstaduaisarray | null[object]
Dados da inscrição estadual e identificação do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
Response
Response
No Content
post/api/v1/Emissor/Habilitar
Authentication
Body
{
"tipoDocumento": "Cpf",
"nome": "nome",
"regimeTributario": "Mei",
"tipoIcmsSt": "Substituta",
"tipoEstabelecimento": "Outros",
"endereco": {
"logradouro": "logradouro",
"numero": "numero",
"bairro": "bairro",
"codigoMunicipio": "codigoMunicipio",
"municipio": "municipio",
"cep": "cep"
}
}
Atualização de dados cadastrais.
Permite atualizar os dados cadastrais do emissor.
⚠️ ATENÇÃO: É necessário que os dados cadastrais do emissor estejam corretos e atualizados para retorno assertivo da tributação dos produtos nas consultas e emissão de notas fiscais.
put
Path Parameters
documentoEmissorstringrequired
Documento do emissor a ser atualizado.
Body
Body
Dados atualizados do emissor.
AtualizarDadosEmissorInputModel
Informações para atualizar os dados do emissor.
* Additional properties are NOT allowed.
nomestringrequired
Nome ou Razão Social do emissor.
>= 3 characters<= 60 characters
nomeFantasiastring | null
Nome fantasia do emissor.
regimeTributariostringrequired
Regime tributário do emissor.
Allowed values:MeiSimplesNacionalSimplesNacionalExcessoReceitaLucroPresumidoLucroReal
aliquotaCreditoSimplesnumber | null(double)
Alíquota do crédito de icms do simples nacional consedido em operações de revenda do regime Simples Nacional.
tipoIcmsStstringrequired
Tipo de ICMS ST do emissor.
Allowed values:SubstitutaSubstituida
tipoEstabelecimentostringrequired
Tipo de estabelecimento do emissor quanto ao IPI.
Allowed values:OutrosIndustriaOuEquiparado
telefonestring | null
Telefone de contato.
>= 6 characters<= 14 characters
inscricaoMunicipalstring | null
Inscrição municipal do emissor.
<= 15 characters
cnaestring | null
Código CNAE principal.
<= 7 characters
cnaeSecundariostring | null
Código CNAE secundário.
<= 7 characters
enderecoobjectrequired
Dados do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
inscricoesEstaduaisarray | null[object]
Dados da inscrição estadual e identificação do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
Response
Response
No Content
put/api/v1/Emissor/{documentoEmissor}/Atualizar
Authentication
Path Parameters
Body
{
"nome": "nome",
"regimeTributario": "Mei",
"tipoIcmsSt": "Substituta",
"tipoEstabelecimento": "Outros",
"endereco": {
"logradouro": "logradouro",
"numero": "numero",
"bairro": "bairro",
"codigoMunicipio": "codigoMunicipio",
"municipio": "municipio",
"cep": "cep"
}
}
Desabilitar emissor.
Permite desabilitar o emissor da aplicação, impedindo o uso dos recursos pelo mesmo.
⚠️ ATENÇÃO: Após desabilitar o emissor, o mesmo ficará inativo no sistema, não permitindo mais realizar operações para o mesmo.
delete
Path Parameters
documentoEmissorstringrequired
Documento do emissor.
Response
Response
No Content
delete/api/v1/Emissor/{documentoEmissor}/Desabilitar
Authentication
Path Parameters
Adicionar certificado digital.
Permite adicionar o certificado digital para o emissor. O certificado digital é fundamental para emissão de documentos fiscais.
⚠️ ATENÇÃO: O sistema só permite o uso de certificado digital modelo A1 com extensão de arquivo .PFX ou .P12.
🚨 IMPORTANTE: Após o vencimento do certificado digital atual, o mesmo deve ser removido para adição de um novo.
post
Path Parameters
documentoEmissorstringrequired
Documento do emissor associado ao certificado.
Body
multipart/form-data
Body
multipart/form-data
CertificadoDigitalstringrequired
Arquivo PFX contendo o certificado digital do emissor.
>= 1 characters
Senhastringrequired
Senha do certificado digital.
>= 1 characters
Response
Response
OK
CertificadoDigitalViewModel
Informações do certificado digital.
* Additional properties are NOT allowed.
numeroSeriestring | null
Número de série do certificado.
dataValidadestring(date)
Data de validade do certificado.
Example:2025-03-31
post/api/v1/Emissor/{documentoEmissor}/CertificadoDigital/Adicionar
Authentication
Path Parameters
Body
No file selected
Error initializing code snippet
Remover certificado digital.
Permite remover o certificado digital do emissor.
🚨 IMPORTANTE: Após o vencimento do certificado digital atual, o mesmo deve ser removido para adição de um novo.
delete
Path Parameters
documentoEmissorstringrequired
Documento do emissor.
Response
Response
No Content
delete/api/v1/Emissor/{documentoEmissor}/CertificadoDigital/Remover