Listar pedidos de documentos recebidos por cliente e competência

get

https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/customers/{customerId}/documentrequests/{documentRequestId}/year/{year}/month/{month}

Permite consultar os pedidos de documentos recebidos de um cliente por competência (mês e ano), incluindo os dados da solicitação e o download dos documentos anexados.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Dicionário para propriedades retornadas

`type`

Essa propriedade representa o tipo de documento da solicitação:

1- Arquivo
2- Extrato bancário

`status`

Essa propriedade representa o status do tipo de documento na competência:

1- Pendente
2- Completo

`Response body`

id - Id da solicitação de documento
documentTypes - Tipos de documento que compõem a solicitação
- id - Id do tipo de documento
- name - Nome do tipo de documento
- type - Tipo de documento (1 - Arquivo, 2 - Extrato bancário)
- status - Status do tipo de documento na competência
- files - Arquivos recebidos na competência (preenchido quando type = 1)
  - fileId - Id do arquivo
  - downloadUrl - URL para download do arquivo
  - name - Nome do arquivo
  - dueDate - Data informada na conferência do arquivo
  - supplierDocumentNumber - CNPJ/CPF do fornecedor ou cliente informado na conferência
  - supplier - Nome do fornecedor ou cliente informado na conferência
  - value - Valor informado na conferência
  - receivedAt - Data de recebimento do arquivo
  - verified - Indica se o arquivo já foi conferido
- bankAccounts - Contas bancárias com lembrete de extrato (preenchido quando type = 2)
  - accountId - Id da conta bancária
  - accountName - Nome da conta bancária
  - ofx - Extrato OFX recebido na competência, ou null
    - fileId - Id do arquivo
    - downloadUrl - URL para download do arquivo
    - name - Nome do arquivo
  - otherFiles - Extratos recebidos em outros formatos (.pdf, .xls, .csv, .jpeg etc.)
    - fileId - Id do arquivo
    - downloadUrl - URL para download do arquivo
    - name - Nome do arquivo

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json