Financeiro / Notas Fiscais / Listar Notas Fiscais

Listar todas Notas Fiscais (exeto pendentes)

Query strings

Query StringFinalidade
situationsituação NF:
issued: NF gerada
canceling: NF cancelado
FieldTypeField Name correspondingDescriptionReturn Type
checkNumberIntegerBoletoRetorna o ID do boleto na plataforma externainteger
cofinsIntegerID do boletoRetorna o ID do boleto no Operandinteger
companyBooleanCheckbox Empresatrue = é empresa,
false = não é empresa
boolean
companyNationalDocumentStringEmpresaCNPJ referente a empresa vinculadastring
companyIdIntegerID empresa OperandRetorna ID da entidade como empresainteger
csllIntegerContribuição Social sobre o Lucro Líquidointeger
descriptionStringdescrição faturaRetorna descrição faturastring
discountintegerdesconto faturaRetorna desconto relacionado a NFdecimal
federalServiceCodeIntegercod para retornar tipo de serviço prestadoInteger
latePaymentInterestDecimalJuros de moraRetorna o juros de moradecimal
inssIntegerRetorna encargosInteger
irIntegerRetorno que trata da retenção do Imposto de Renda na fonteInteger
issIntegerRetorna Imposto Sobre Serviçosineteger
issuedOnDateRetornar a data geração da NFDate
nationalDocumentStringRetorna CNPJString
nfeExternalIdStringIntegerRetorna id da NFe no sistema terceiro
nfeIdIntegerRetorna id da NFe na OperandInteger
numberStringIntegerRetorna número da NF na prefeitura
pisIntegerRetorna valor da contribuição PIS na transação comercialDecimal
rpsSerialNumberIntegerRetorna identificador numérico atribuído a cada Recibo Provisório
situationENUMRetorna situação da NFwaiting: aguardando geração nota fiscal prefeitura
issued: nota fiscal gerada
canceling: nota fiscal na fila de cancelamento
waitingCancellation: aguardando cancelamento da nota fiscal na prefeitura
waitingIntegration:
aguardando envio da nota fiscal para prefeitura
canceled: nota fiscal cancelada
urlPdfStringRetorna url da NF em formato PDFString
urlXmlStringRetorna url da NF em formato XMLString
valueIntegerRetorna valor da NFInteger
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Headers
string
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json