NInibo

Listar obrigações vinculadas a um cliente

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

get/v1/accountingfirms/{accountingFirmId}/customers/{customerId}/obligations

Request

  • Base URL
    https://api.nibo.com.br/accountant/api
  • URL
    https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/customers/{customerId}/obligations
  • Auth
    none required

Path parameters

accountingFirmIdstring required

Id do escritório.

customerIdstring required

Id do cliente.

Query parameters

$filterstring

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

$skipstring

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

$topstring

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

$orderbystring

Ordena os resultados. Exemplo: orderby=name asc.

Headers

X-API-Keystring

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

X-User-Idstring

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

Response

200

Example response

{
  "items": [
    {
      "obligationId": "string",
      "obligationName": "string",
      "obligationType": 1,
      "obligationFrequency": 3,
      "inChargeUser": {
        "id": "id",
        "name": "string"
      },
      "startControlDate": "2025-05-14T18:06:22.538Z"
    }
  ],
  "metadata": {
    "totalAllItems": "int",
    "total": "int"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.