Listar relatórios do Nibo Obrigações

Permite obter uma lista paginada de até 100 relatórios vinculados ao escritório, com suporte a OData.

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

Para consultas nessa rota é levado em consideração as permissões do usuário responsável pelo token ou do usário passado como parâmetro do header.

Essa rota da API permite que os campos de clientes, obrigações e departamentos sejam utilizados diretamente nos filtros da URL. Isso significa que você pode realizar buscas específicas com base nessas informações, utilizando a sintaxe Entidade/NomeDoCampo.

Por exemplo, para buscar registros de arquivos vinculados a clientes com IDs específicos, a consulta OData pode ser feita da seguinte forma:

https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/fileds?$filter=Customer/Id in (1a85c9e2-f631-4c56-9a24-c8c5e7e7e4cb, 8e7b55ad-b39c-45d2-84d6-d34af6e3376b, 9fa10502-e981-4f9a-9b2e-3f998314c20f)

Outro exemplo seria filtrar arquivos com base nos departamentos associados:

https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/fileds?$filter=Department/Id in (a435f40f-5480-4ae3-a1db-f3628371ac9d, 6bd41df8-09c1-4dc3-9d62-1047505d378b)

Ou ainda, consultar por arquivos vinculados a obrigações específicas:

https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/fileds?$filter=Obligation/Id in ('234687', '525873')

Para aplicar filtros em outras propriedades dessas entidades, basta substituir Id por qualquer outro campo exposto no objeto, como Name e Type.

Dicionário para propriedades retornadas

destinationType

Essa propriedade representa o destino do protocolo:

  • 1 - Arquivos Online
  • 2 - Controle Interno
  • 3 - Cliente
  • 4 - Contador
  • 5 - Baixa Justificada

null quando a obrigação ainda não tem protocolo.


status

Essa propriedade representa o status do protocolo:

  • 1 - Excluído
  • 2 - Cancelado
  • 3 - Não Recebido
  • 4 - Recebido
  • 5 - Não ativo
  • 6 - Ativo
  • 7 - Baixa Justificada
  • 8 - Pago

null quando a obrigação ainda não tem protocolo.


obligation.type

Essa propriedade representa o tipo da obrigação:

  • 1 - Pagamento
  • 2 - Cadastral
  • 3 - Declaração
  • 4 - Diversos

Nas obrigações Diversos, o valor vem null, não 4.


obligation.frequency

Essa propriedade representa a frequência de vencimento da obrigação:

  • 0 - Diário
  • 1 - Decendial
  • 2 - Quinzenal
  • 3 - Mensal
  • 4 - Bimestral
  • 5 - Trimestral
  • 6 - Quadrimestral
  • 7 - Semestral
  • 8 - Anual

null quando a obrigação não tem frequência de vencimento definida.


documentUpdateType

Essa propriedade representa o tipo de atualização, quando o protocolo é uma nova versão de outro:

  • 1 - Correção
  • 2 - Complemento

null no protocolo original e quando a obrigação ainda não tem protocolo.


Response body

  • accrual - competência
  • dueDate - data de vencimento
  • filedDate - data do protocolo
  • internalDeadline - meta interna
  • department - departamento da obrigação
  • value - campo preenchido somente se o protocolo for realizado com valor
  • recalculationEnabled - indica se o protocolo foi realizado com o recálculo habilitado ou desabilitado
Path Params
string
required

Id do escritório.

Query Params
string

Filtra os resultados com base em critérios específicos. Exemplo: filter=Name eq 'Usuário X'.

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

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