Consulta de nota fiscal de serviço

Consulte as informações de sua nota fiscal de serviço




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

  • Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
  • Nota Fiscal: para que a resposta da API seja preenchida, é recomendável que uma nota fiscal tenha sido emitida anteriormente.

Bora pro código?

383

Parâmetros da resposta

Parâmetro

Tipo

Descrição

id obrigatório

String

Identificador da nota fiscal na Cora.

status\ obrigatório

String

Possíveis estados que a nota fiscal pode assumir. Consulte a descrição do Enum de Estados da Nota

pdf\ obrigatório

String

URL com o local do arquivo em formato PDF para fazer o download.

xml\ obrigatório

String

URL com o local do arquivo em formato XML para fazer o download.

customer\ obrigatório

Objeto Customer

Objeto Customer. Representa o tomador de serviço da nota fiscal, ou seja, o cliente para quem o serviço é prestado.

trigger\ obrigatório

String

Possíveis tipos de gatilhos de emissão de nota fiscal. Consulte a descrição do Enum de Gatilhos de emissão

cnae\ obrigatório

String

Campo com a concatenação do código do CNAE com sua respectiva descrição. O CNAE apresentado é o que foi utilizado na configuração da nota fiscal de serviço.

service_code\ obrigatório

String

Campo com a concatenação do código de serviço com sua respectiva descrição. O Código de serviço apresentado é o que foi utilizado na configuração da nota fiscal de serviço.

description\ obrigatório

String

Descrição do serviço que foi inserido no momento da criação da nota fiscal. Essa descrição pode ser a mesma da cobrança atrelada, depende da escolha do cliente ao configurar.

municipal_tax_code\ opcional

String

Código de tributação Municipal. Cada município tem sua própria lei que define. Consulte a legislação municipal.

tax\ obrigatório

Objeto
Tax

Objeto Tax.

O objeto Tax, contém as informações dos impostos declarados na nota fiscal de serviço.

Tipos de Objetos

Objeto Customer

Parâmetro

Tipo

Descrição

email obrigatório

String

E-mail do tomador de serviço. É para esse e-mail que a nota fiscal (PDF e XML) será enviada após ser emitida.

address\ obrigatório

Objeto Address

Endereço do tomador de serviço. Essa informação é obrigatória para configurar a nota fiscal, portanto sempre será retornada na resposta dos detalhes da nota

Objeto Address

Parâmetro

Tipo

Descrição

street obrigatório

String

Rua do tomador de serviço.

number\ obrigatório

String

Número do tomador de serviço.

district\ obrigatório

String

Bairro do tomador de serviço.

city\ obrigatório

String

Cidade do tomador de serviço.

state\ obrigatório

String

Estado (formato: SP) do tomador de serviço.

complement\ opcional

String

Campo de complemento do endereço. Esse campo pode ser nulo.

zipcode\ obrigatório

String

CEP do tomador de serviço.

Objeto Tax

Parâmetro

Tipo

Descrição

iss obrigatório

Objeto ISS

Objeto ISS.

O objeto ISS, contém a alíquota do imposto ISSQN a ser paga e se o ISS é retido na fonte ou não. Para mais informações sobre ISS, consulte nossa central de ajuda e pesquise "Como configurar a nota fiscal na Cora"

Objeto ISS

Parâmetro

Tipo

Descrição

value obrigatório

String

Valor da alíquota de imposto ISSQN configurado na nota fiscal. O formato considera os campos decimais como inteiros. Exemplo: Se o valor da alíquota for de 5% sobre o valor da nota fiscal, o campo estará preenchido com "500". Caso o valor da alíquota seja 2,5% virá preenchido com "250".

withheld\ opcional

String

Campo para definir se o ISS será retido na fonte ou não.


Tipos de Enumeradores

Enum de Status da Nota Fiscal

ParâmetroDescrição
COMPLETEDNota fiscal de serviço já emitida com sucesso
WAITING_TRIGGERAguardando o pagamento da cobrança atrelada a nota fiscal.
WAITING_CERTIFICATEAguardando o envio do certificado digital A1 da empresa para ser emitida. Caso o certificado seja enviado, a Cora fará e emissão automaticamente de todas as notas fiscais nesse estado.
ERRORHouve uma tentativa de emissão que foi rejeitada pela prefeitura.

Enum de Gatilhos de emissão Nota Fiscal

ParâmetroDescrição
COMPLETEDNota fiscal de serviço já emitida com sucesso
WAITING_TRIGGERAguardando o pagamento da cobrança atrelada a nota fiscal.
WAITING_CERTIFICATEAguardando o envio do certificado digital A1 da empresa para ser emitida. Caso o certificado seja enviado, a Cora fará e emissão automaticamente de todas as notas fiscais nesse estado.
ERRORHouve uma tentativa de emissão que foi rejeitada pela prefeitura.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!