logo

NfseRecebida

0/0

NfseRecebida

Nota Fiscal de Serviço Recebida: Documentação completa de campos (api_version: 2023-03-01)

Orientações de integração disponíveis na Documentação da API.

Notações de tipos conforme padrão NF-e:

  • String[2] : String com 2 caracteres
  • Decimal[13.2] : Tipo Decimal com 15 dígitos, sendo 13 de corpo e 2 decimais

Campos não fornecidos pelas prefeituras são retornados como null.

chave

String

Chave do documento fiscal recebido, identificador único em nossa API

versao

Integer

Versão do documento fiscal recebido, numero sequencial único em nossa API

status

Status do documento fiscal

  • 1: autorizado
  • 2: cancelado
  • 3: substituido

numero

String

Número da NFSe

serie

String

Série da NFSe

codigo_verificacao

String

Codigo de verificação da NFSe

data_emissao

String[25] Padrão ISO

Data e Hora de emissão da NFSe

numero_rps

String

Número do RPS

serie_rps

String

Série do RPS

tipo_rps

String

Tipo do RPS

data_emissao_rps

String[25] Padrão ISO

Data e Hora de emissão do RPS

natureza_operacao

String

Natureza da operação (conforme definição da prefeitura)

regime_especial_tributacao

String

Código de identificação do regime especial de tributação (conforme definição da prefeitura)

optante_simples_nacional

Boolean

Empresa prestadora é optante pelo Simples Nacional

incentivador_cultural

Boolean

Empresa prestadora possui incentivo fiscal (ex: incentivador cultural)

competencia

String[10] Padrão ISO (YYYY-MM-DD)

Data da prestação de serviço

numero_nfse_substituida

String

Número da NFSe substituída

outras_informacoes

String

Outras informações fornecidas pela prefeitura

informacoes_adicionais_contribuinte

String

Informações adicionais fornecidas pelo prestador

prestador

Dados do prestador (emitente) do documento fiscal

cpf

String[11]

Número do CPF, se Pessoa Física (apenas dígitos)

cnpj

String[14]

Número do CNPJ, se Empresa (apenas dígitos)

inscricao_municipal

String

Número de Inscrição Municipal

razao_social

String

Razão Social da Empresa ou Nome da Pessoa Física

nome_fantasia

String

Nome fantasia da Empresa (apenas para Prestador)

telefone

String

Número de telefone de contato

email

String

Endereço eletrônico (e-mail) de contato

endereco

Endereço

logradouro

String

Tipo e nome do logradouro

numero

String

Número do imóvel

complemento

String

Complemento do endereço

bairro

String

Bairro

codigo_municipio

String[7]

Código do município (conforme tabela do IBGE)

nome_municipio

String

Nome do município

uf

String[2]

Sigla da Unidade de Federação

codigo_pais

String[4]

Código do país (conforme tabela do IBGE)

cep

String[8]

Número do CEP (apenas dígitos)

tomador

Dados do tomador (remetente) do documento fiscal

cpf

String[11]

Número do CPF, se Pessoa Física (apenas dígitos)

cnpj

String[14]

Número do CNPJ, se Empresa (apenas dígitos)

inscricao_municipal

String

Número de Inscrição Municipal

razao_social

String

Razão Social da Empresa ou Nome da Pessoa Física

nome_fantasia

String

Nome fantasia da Empresa (apenas para Prestador)

telefone

String

Número de telefone de contato

email

String

Endereço eletrônico (e-mail) de contato

endereco

Endereço

logradouro

String

Tipo e nome do logradouro

numero

String

Número do imóvel

complemento

String

Complemento do endereço

bairro

String

Bairro

codigo_municipio

String[7]

Código do município (conforme tabela do IBGE)

nome_municipio

String

Nome do município

uf

String[2]

Sigla da Unidade de Federação

codigo_pais

String[4]

Código do país (conforme tabela do IBGE)

cep

String[8]

Número do CEP (apenas dígitos)

servicos

Array de Servico

Dados dos serviços prestados

valor_servicos

Decimal[13.2]

Valor do serviço

valor_deducoes

Decimal[13.2]

Valor total das deduções

valor_pis

Decimal[13.2]

Valor do PIS

valor_cofins

Decimal[13.2]

Valor do COFINS

valor_inss

Decimal[13.2]

Valor do INSS

valor_ir

Decimal[13.2]

Valor do imposto de renda

valor_csll

Decimal[13.2]

Valor do CSLL

iss_retido

Boolean

O ISS foi retido na fonte

valor_iss

Decimal[13.2]

Valor do ISS devido, informado pelo prestador ou município

valor_iss_retido

Decimal[13.2]

Valor do ISS quando retido

outras_retencoes

Decimal[13.2]

Valor total de outras retenções na Fonte

base_calculo

Decimal[13.2]

Base de cálculo da NFSe

aliquota

Decimal[3.4]

Alíquota do serviço prestado (valor percentual, entre 0% e 100%)

valor_liquido

Decimal[13.2]

Valor líquido da NFSe

valor_credito

Decimal[13.2]

Valor do crédito gerado pela NFSe

desconto_incondicionado

Decimal[13.2]

Valor desconto incondicionado (deduzido no cômputo da base de cálculo)

desconto_condicionado

Decimal[13.2]

Valor desconto condicionado (não deduzido no cômputo da base de cálculo)

item_lista_servico

String[5] Padrão NF-e (0#.0#)

Código do subitem do serviço prestado (conforme Lei Complementar 116/2003)

codigo_cnae

String[7]

Código CNAE do serviço prestado

codigo_tributario_municipio

String

Código do serviço prestado próprio do município

discriminacao

String

Discriminação dos serviços

codigo_municipio

String[7]

Código do município (conforme tabela do IBGE) da prestação do serviço

codigo_pais

String[4]

Código do país (conforme tabela do IBGE) da prestação do serviço

codigo_municipio_incidencia

String[7]

Código do município (conforme tabela do IBGE) da incidência do ISS

quantidade

Decimal[13.2]

Quantidade do item de serviço prestado

valor_unitario

Decimal[13.2]

Valor de cada unidade do item de serviço prestado

url

String

URL para acesso ao espelho da NFSe

url_xml

String

URL para acesso ao XML da NFSe

erros

Array de Mensagem

Eventuais erros e mensagens adicionais de processamento da API Focus NFe