Consulta de nota fiscal de serviço

Consulte as informações de sua 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"


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âmetroTipoDescrição
id
obrigatório
StringIdentificador da nota fiscal na Cora.
status
obrigatório
StringPossíveis estados que a nota fiscal pode assumir. Consulte a descrição do Enum de Estados da Nota
pdf
obrigatório
StringURL com o local do arquivo em formato PDF para fazer o download.
xml
obrigatório
StringURL 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
StringPossíveis tipos de gatilhos de emissão de nota fiscal. Consulte a descrição do Enum de Gatilhos de emissão
cnae
obrigatório
StringCampo 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
StringCampo 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
StringDescriçã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
StringCó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âmetroTipoDescrição
email
obrigatório
StringE-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âmetroTipoDescrição
street
obrigatório
StringRua do tomador de serviço.
number
obrigatório
StringNúmero do tomador de serviço.
district
obrigatório
StringBairro do tomador de serviço.
city
obrigatório
StringCidade do tomador de serviço.
state
obrigatório
StringEstado (formato: SP) do tomador de serviço.
complement
opcional
StringCampo de complemento do endereço. Esse campo pode ser nulo.
zipcode
obrigatório
StringCEP do tomador de serviço.

Objeto Tax

ParâmetroTipoDescriçã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âmetroTipoDescrição
value
obrigatório
StringValor 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
StringCampo 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.

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!