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

Listar o status das solicitações de documentos recebidos

get
https://api.nibo.com.br/accountant/api/v1/accountingfirms//customers//documentrequests/statuses/year//month/

Permite obter o status das solicitações de documentos recebidos de um cliente específico na competência informada, vinculado a um escritório contábil, com suporte a OData.

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

Dicionário para propriedades retornadas

status

Essa propriedade representa o status da solicitação de documento na competência:

  • 1- Pendente
  • 2- Parcial
  • 3- Completo

Response body

  • id - Id da solicitação de documento
  • name - Nome da solicitação de documento
  • status - Status da solicitação de documento na competência
  • totalUnverifiedFiles - Quantidade de arquivos recebidos que ainda não foram conferidos
Path Params
string
required

Id do escritório.

string
required

Id do cliente.

int32
required

Ano da competência. Exemplo: 2026.

int32
required

Mês da competência, de 1 a 12. Exemplo: 8.

Query Params
string

Filtra os resultados com base em critérios específicos. Exemplo: filter=status eq 1.

string

Define o número de resultados a serem ignorados. Exemplo: skip=10.

string

Limita o número de resultados retornados. Exemplo: top=5.

string

Ordena os resultados. Exemplo: orderby=name asc.

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 7 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 7 hours ago

Did this page help you?