Nota Fiscal Eletronica
Busca as informações de configuração da cidade, esses dados devem ser usados para preencher o JSON de envio/criação do documento fiscal.
Para buscar as especificações da Nota de Serviço Nacional deve ser utilizado o Código do IBGE 9999999, caso o Emitente vinculado ao token seja MEI ou caso o flag Nacional esteja marcado no Emitente vinculado ao token
Para buscar as especificações da Nota de Serviço Nacional deve ser utilizado o Código do IBGE 9999999, caso o Emitente vinculado ao token seja MEI ou caso o flag Nacional esteja marcado no Emitente vinculado ao token
Responses - HTTP Code 200
{
"sucesso": true,
"codigo": 1000,
"mensagem": "Provedor encontrado.",
"info": {
"nome": "El",
"sincrono": false,
"autenticacao": {
"login_prefeitura": "Login da prefeitura",
"senha_prefeitura": "Senha da prefeitura"
},
"cancela": 1,
"certificado": 0,
"homologacao": 0,
"itens": 1,
"campos": {
"regime_tributacao": {
"existe": true,
"obrigatorio": true,
"opcoes": [
{
"valor": "0",
"descricao": "Tributação Normal"
},
{
"valor": "1",
"descricao": "Microempresa Municipal"
},
{
"valor": "2",
"descricao": "Estimativa"
},
{
"valor": "3",
"descricao": "Sociedade de Profissionais"
},
{
"valor": "4",
"descricao": "Cooperativa"
},
{
"valor": "5",
"descricao": "Microempresário Individual (MEI)"
},
{
"valor": "6",
"descricao": "Microempresário e Empresa de Pequeno Porte (MEPP)"
},
{
"valor": "7",
"descricao": "Autônomo"
}
]
},
"natureza_operacao": {
"existe": true,
"obrigatorio": true,
"opcoes": [
{
"valor": "1",
"descricao": "Tributação no Município"
},
{
"valor": "2",
"descricao": "Tributação fora do Município"
},
{
"valor": "3",
"descricao": "Isenção"
},
{
"valor": "4",
"descricao": "Imune"
},
{
"valor": "5",
"descricao": "Exigibilidade suspensa por decisão judicial"
},
{
"valor": "6",
"descricao": "Exigibilidade suspensa por procedimento administrativo"
}
]
},
"responsavel_retencao": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"exigibilidade_iss": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"rps_tipo": {
"existe": true,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
},
{
"valor": "1",
"descricao": "Recibo Provisório de Serviços"
},
{
"valor": "2",
"descricao": "RPS Nota Fiscal Conjugada (Mista)"
},
{
"valor": "3",
"descricao": "Cupom"
}
]
},
"rps_status": {
"existe": true,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
},
{
"valor": "1",
"descricao": "Normal"
},
{
"valor": "2",
"descricao": "Cancelado"
}
]
},
"codigo_cancelamento": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"forma_recolhimento": {
"existe": false,
"obrigatorio": false,
"opcoes": [
{
"valor": "",
"descricao": "Nenhum"
}
]
},
"incentivo_fiscal": {
"existe": false,
"obrigatorio": false,
"opcoes": []
},
"incentivador_cultural": {
"existe": true,
"obrigatorio": true,
"opcoes": [
{
"valor": "true",
"descricao": "Sim"
},
{
"valor": "false",
"descricao": "Não"
}
]
},
"tomador": {
"required": true,
"type": "object",
"properties": {
"cnpj": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/cnpj",
"description": "CNPJ do Tomador do Serviço",
"options": "Apenas numeros sem simbolos. Com 14 digitos."
},
"cpf": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/cpf",
"description": "CPF do Tomador do Serviço",
"options": "Apenas numeros sem simbolos. Com 11 digitos."
},
"documento_estrangeiro": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,20}$",
"description": "Numero do documento do estrangeiro tomador do serviço.",
"options": "1 a 20 caracteres"
},
"im": {
"required": false,
"type": [
"string",
"null"
],
"maxLength": 15,
"description": "Inscrição Municipal do Tomador do Serviço",
"options": "Este elemento só deverá ser preenchido para tomadores cadastrados no município. Até 15 caracteres."
},
"razao_social": {
"required": true,
"type": "string",
"pattern": "^.{1,120}$",
"description": "Razão Social do Tomador do Serviço",
"options": "1 à 120 caracteres. Evite usar acentos e simbolos."
},
"nome_fantasia": {
"required": false,
"type": "string",
"pattern": "^.{1,100}$",
"description": "Nome fantasia do Tomador do Serviço",
"options": "1 a 100 caracteres"
},
"telefone": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,15}$",
"description": "Número do telefone do Tomador do Serviço",
"options": "1 à 15 digitos."
},
"email": {
"required": true,
"type": "string",
"$ref": "#/definitions/email",
"description": "Email do Tomador do Serviço",
"options": "1 a 60 caracteres"
},
"endereco": {
"required": true,
"type": "object",
"properties": {
"logradouro": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,130}$",
"description": "Rua (Logradouro) do Tomador do Serviço",
"options": "1 à 130 caracteres. Evite usar acentos e simbolos."
},
"numero": {
"required": false,
"type": [
"string",
"null"
],
"maxLength": 10,
"description": "Número do Endereço do Tomador do Serviço",
"options": "1 à 10 caracteres. Evite usar acentos e simbolos."
},
"complemento": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,60}$",
"description": "Complemento do Endereço do Tomador do Serviço",
"options": "1 à 60 caracteres. Evite usar acentos e simbolos."
},
"bairro": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^.{1,70}$",
"description": "Bairro do Endereço do Tomador do Serviço",
"options": "1 à 70 caracteres. Evite usar acentos e simbolos."
},
"codigo_municipio": {
"required": true,
"type": "string",
"$ref": "#/definitions/ibge",
"description": "Código IBGE do Municipio do Endereço do Tomador do Serviço",
"options": "numero com 7 digitos."
},
"nome_municipio": {
"required": true,
"type": "string",
"pattern": "^.{1,100}$",
"description": "Nome da Cidade do Tomador do serviço.",
"options": "Usar somente em caso de Exportação de serviços para indicar a cidade do contratante do serviço, 1 a 100 caracteres"
},
"uf": {
"required": true,
"type": "string",
"$ref": "#/definitions/siglauf",
"description": "Sigla do Estado do Endereço do Tomador do Serviço",
"options": "Se EXPORTAÇÃO indicar \"EX\" ou \"SP\""
},
"cep": {
"required": false,
"type": [
"string",
"null"
],
"$ref": "#/definitions/cep",
"description": "Codigo Postal do Tomador do Serviço",
"options": "Se exportação Não passar esse dado ou deixe null, numero com 8 digitos."
}
}
}
}
},
"servico": {
"required": true,
"type": "object",
"properties": {
"iss_retido": {
"required": false,
"type": [
"boolean",
"null"
],
"description": "ISS foi retido",
"options": "true - SIM; false - Não (ocorre apenas quando o serviço realizado fora do municipio, vide legislação)",
"default": "false"
},
"codigo": {
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9.-]{1,5}$",
"description": "Código do serviço prestado Item da LC 116/2003",
"options": "1 à 5 caracteres alfa-numericos ex. \"7.23\""
},
"descricao": {
"required": false,
"type": [
"string",
"null"
],
"maxLength": 200,
"description": "Descrição do serviço",
"options": "1 a 200 caracteres. Usado apenas para mostrar no PDF a descrição do código do serviço"
},
"codigo_cnae": {
"required": false,
"type": [
"string",
"null"
],
"pattern": "^[0-9]{8,10}$",
"description": "Código CNAE para o Serviço Prestado",
"options": "8 a 10 digitos."
},
"codigo_tributacao_municipio": {
"required": true,
"type": "string",
"maxLength": 20,
"description": "Código do serviço prestado próprio do município",
"options": "Consultar lista de códigos do seu municipio."
},
"discriminacao": {
"required": true,
"type": "string",
"maxLength": 255,
"description": "Discriminação dos serviços",
"options": "1 à 255 caracteres. Evite usar acentos e simbolos.;Para quebra de linha use \\n ou ponto e virgula"
},
"codigo_municipio": {
"required": true,
"type": "string",
"pattern": "^[0-9]{7}$",
"description": "Código IBGE do município onde o serviço foi prestado.",
"options": "Se o serviço foi feito em outro pais indicar 9999999. Numero com 7 digitos."
},
"unidade_quantidade": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Quantidade dos serviços prestados.",
"options": "ex. 2",
"default": "1"
},
"unidade_nome": {
"required": true,
"type": "string",
"pattern": "^.{1,20}$",
"description": "Nome da unidade do serviço",
"options": "ex. UN, 1 a 20 caracteres"
},
"valor_servicos": {
"required": true,
"type": "number",
"minimum": 0,
"description": "Valor dos serviços em R$",
"options": "Use o formato com ponto na separaçao de decimais e não use virgula ex. 100.00"
},
"valor_deducoes": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor das deduções para Redução da Base de Cálculo em R$",
"options": "ex. 100.00"
},
"valor_pis": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do PIS em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_cofins": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do COFINS em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_inss": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do INSS em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_ir": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do IR em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_csll": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor da retenção do CSLL em R$ Informação declaratória",
"options": "ex. 100.00"
},
"valor_outras": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Outras retenções na Fonte. Informação declaratória",
"options": "ex. 100.00"
},
"valor_iss": {
"required": true,
"type": "number",
"minimum": 0,
"description": "Valor do ISS devido em R$",
"options": "ex. 100.00"
},
"valor_iss_retido": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do ISS retido em R$",
"options": "ex. 100.00"
},
"valor_aliquota": {
"required": true,
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Alíquota do serviço prestado",
"options": "ex. 5.00;Deve ser sempre enviado esse valor em percentual, 5% seria enviado como 5.00 e nao 0.05"
},
"valor_liquido": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor liquido da NFS-e",
"options": "ex. 100.00"
},
"valor_desconto_condicionado": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do desconto condicionado",
"options": "ex. 100.00"
},
"valor_desconto_incondicionado": {
"required": false,
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Valor do desconto incondicionado",
"options": "ex. 100.00"
}
}
},
"cancelamento": {}
}
}
}
{
"sucesso": false,
"codigo": CODIGO,
"mensagem": MENSAGEM
}