API Reference

Listar obrigações

get
https://api.nibo.com.br/accountant/api/v1/accountingfirms//obligations

Permite obter uma lista paginada de até 100 obrigações vinculadas a um escritório contábil, com suporte a OData.

Dicionário para propriedades retornadas

frequency

Essa propriedade representa o status do documento:

  • 0- Diário
  • 1- Decendial
  • 2- Quinzenal
  • 3- Mensal
  • 4- Bimestral
  • 5- Trimestral
  • 6 - Quadrimestral
  • 7- Semestral
  • 8- Anual
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

Updated about 2 hours ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 hours ago