API Reference
  1. API Nibo Obrigações
  2. Documentos Recebidos

Baixar arquivo de solicitação de documento

get
https://api.nibo.com.br/accountant/api/v1/accountingfirms//documentrequests/files//download

Permite baixar um arquivo recebido em uma solicitação de documento de um cliente vinculado ao escritório, redirecionando para um link temporário do arquivo.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades enviadas

fileId

Id do arquivo, informado no detalhe da solicitação de documento:

  • documentTypes[].files[].fileId - arquivos recebidos
  • documentTypes[].bankAccounts[].ofx.fileId - extrato OFX
  • documentTypes[].bankAccounts[].otherFiles[].fileId - extratos em outros formatos

forceDownload

  • false - o arquivo é exibido no navegador quando o formato permite (padrão)
  • true - o arquivo é baixado

Comportamento

  • A rota responde 302 com o header Location apontando para um link temporário do arquivo. Para um novo link, chame a rota de novo.
  • Envie a mesma autenticação das demais rotas.
  • Só é liberado arquivo de cliente que o usuário enxerga.
Path Params
string
required

Id do escritório.

string
required

Id do arquivo, informado no detalhe da solicitação de documento.

Query Params
boolean
Defaults to false

Quando true, o arquivo é baixado em vez de exibido no navegador. Padrão: false.

Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Updated about 4 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated about 4 hours ago

Did this page help you?