Nibo API

https://nibo.readme.io/reference
Admin
Nibo API is a financial management platform API that provides endpoints for managing accounts,...
Tokens:293,925
Snippets:652
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Combined OData Query for Open Receivables

Source: https://nibo.readme.io/reference/como-utilizar-a-api

A comprehensive example combining API token, sorting, pagination, and filtering for querying open receivables. This demonstrates a practical application of multiple OData parameters in a single request.

```HTTP
https://api.nibo.com.br/empresas/v1/schedules/debit?apitoken=58524AE25524003BB0E4CD0B84B46A56&$orderby=dueDate&$skip=0&$top=20&$filter=value le 200
```

--------------------------------

### OData Filtering Examples

Source: https://nibo.readme.io/reference/como-utilizar-a-api

Illustrates how to use the OData $filter parameter to refine API query results. Examples show filtering by value range and by multiple criteria like year, month, and partial string matching on stakeholder names.

```HTTP
https://api.nibo.com.br/empresas/v1/schedules/debit?$filter=value le 100

https://api.nibo.com.br/empresas/v1/schedules/debit?$filter=year(dueDate) eq 2023 AND month(dueDate) eq 10 AND startswith(stakeholder/name, 'Papelaria')
```

--------------------------------

### OData Pagination with $top, $skip, and $orderBy

Source: https://nibo.readme.io/reference/como-utilizar-a-api

Shows how to implement pagination for API GET requests using OData parameters. $top defines the number of items per page, $skip determines how many items to skip, and $orderBy is mandatory for sorting results.

```HTTP
https://api.nibo.com.br/empresas/v1/schedules/debit?$orderby=dueDate&$skip=20&$top=10
```

--------------------------------

### API Authentication with ApiToken

Source: https://nibo.readme.io/reference/como-utilizar-a-api

Demonstrates how to authenticate API requests using the ApiToken. The token can be provided either in the request header or as a URL parameter. Using 'ApiToken' in the header is recommended over 'Authorization'.

```HTTP
GET https://api.nibo.com.br/empresas/v1/schedules/debit?apitoken=58524AE25524003BB0E4CD0B84B46A56

# OR

GET https://api.nibo.com.br/empresas/v1/schedules/debit
# Header:
# ApiToken: 58524AE25524003BB0E4CD0B84B46A56
```

--------------------------------

### List Employees API Request Examples (Node.js, Ruby, PHP, Python)

Source: https://nibo.readme.io/reference/fornecedores-copy

Provides examples for making a GET request to the Nibo API to list employees in various programming languages. These snippets show how to construct the request, including the URL and headers, for integration into different application backends.

```javascript
// Node.js example (using fetch)
fetch('https://api.nibo.com.br/empresas/v1/employees', {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

```ruby
# Ruby example (using Net::HTTP)
require 'net/http'
require 'uri'

uri = URI.parse('https://api.nibo.com.br/empresas/v1/employees')
request = Net::HTTP::Get.new(uri)
request['accept'] = 'application/json'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body
```

```php
// PHP example (using cURL)
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.nibo.com.br/empresas/v1/employees');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'accept: application/json'
]);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
```

```python
# Python example (using requests)
import requests

url = 'https://api.nibo.com.br/empresas/v1/employees'
headers = {
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.json())
```

--------------------------------

### List Installment Schedules (Python)

Source: https://nibo.readme.io/reference/parcelamento

This Python snippet shows how to get installment schedules using the 'requests' library. It sends a GET request to the API, needing the installment ID as a parameter.

```python
import requests

url = "https://api.nibo.com.br/empresas/v1/installments/installmentId/schedules"

headers = {
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Financial Entry Request Example

Source: https://nibo.readme.io/reference/consulta-recebimentos-vencidos

This example demonstrates the structure of a JSON request body for creating a financial entry. It includes details such as categories, cost centers, scheduling, type, dates, values, stakeholder information, and custom attributes. This is useful for integrating financial data into Nibo.

```json
{
  "items": [
    {
      "categories": [
        {
          "id": "c292eeab-a490-4cfc-bb95-5f36dc049af2",
          "categoryId": "1ab2f6bc-4721-42e2-a2c0-1071f45aa0f6",
          "categoryName": "Receita com vendas",
          "value": 1,
          "type": "in",
          "parent": "Receitas operacionais",
          "parentId": "fe57d34d-9127-4f1e-bf52-f4d0789d9b59",
          "isDeleted": false
        }
      ],
      "costCenters": [],
      "scheduleId": "720c6448-7a4d-4ce8-80f3-de0ede037662",
      "type": "Debit",
      "isEntry": true,
      "isBill": false,
      "isDebitNote": false,
      "isFlagged": true,
      "isDued": true,
      "dueDate": "2022-05-27T00:00:00Z",
      "scheduleDate": "2022-05-27T00:00:00Z",
      "createDate": "2022-05-27T12:45:37.267Z",
      "createUser": "Italo leite222222",
      "updateDate": "2022-05-27T12:45:37.2666667Z",
      "updateUser": "Italo leite222222",
      "value": 1,
      "isPaid": true,
      "costCenterValueType": 0,
      "paidValue": -1,
      "openValue": 0,
      "stakeholderId": "00000000-0000-0000-0000-000000000000",
      "stakeholder": {
        "id": "1811d7e8-7b54-4dcc-b77b-f1babfdded77",
        "name": "teste fornecedor",
        "isDeleted": false,
        "type": "Supplier"
      },
      "description": "string",
      "reference": "string",
      "category": {
        "id": "1ab2f6bc-4721-42e2-a2c0-1071f45aa0f6",
        "name": "Receita com vendas",
        "isDeleted": false,
        "type": "in"
      },
      "hasInstallment": false,
      "hasRecurrence": false,
      "hasOpenEntryPromise": false,
      "hasEntryPromise": false,
      "autoGenerateEntryPromise": false,
      "hasInvoice": false,
      "hasPendingInvoice": false,
      "hasScheduleInvoice": false,
      "customAttributes": {},
      "autoGenerateNFSeType": 0,
      "isPaymentScheduled": false
    }
  ],
  "count": 1
}
```

--------------------------------

### List Installment Schedules (PHP)

Source: https://nibo.readme.io/reference/parcelamento

This PHP snippet demonstrates fetching installment schedules using cURL. It performs a GET request to the API endpoint, requiring the installment ID.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, "https://api.nibo.com.br/empresas/v1/installments/installmentId/schedules");
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'accept: application/json',
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #" . $err;
} else {
  echo $response;
}

?>
```

--------------------------------

### POST /websites/nibo_readme_io_reference

Source: https://nibo.readme.io/reference/criar-tarefa

Allows the creation of a task for a given office. This route returns a 202 Accepted status, indicating that the task has been received and will be created and validated asynchronously.

```APIDOC
## POST /websites/nibo_readme_io_reference

### Description
Allows the creation of a task for a given office. This route returns a 202 Accepted status, indicating that the task has been received and will be created and validated asynchronously. You can create either a blank task or a task from a template.

### Method
POST

### Endpoint
/websites/nibo_readme_io_reference

### Parameters
#### Request Body
- **taskTemplateId** (string) - Optional - The ID of the task template to use. If provided, the task will be created based on this template.
- **name** (string) - Optional - The name of the task. If creating from a template, this field cannot be modified and will remain as defined in the template.
- **other_fields** (object) - Optional - Custom properties to override default template settings.
```

--------------------------------

### List Installment Schedules (Ruby)

Source: https://nibo.readme.io/reference/parcelamento

This Ruby snippet illustrates how to retrieve installment schedules using the Net::HTTP library. It sends a GET request to the API endpoint, including the installment ID.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.nibo.com.br/empresas/v1/installments/installmentId/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"

response = http.request(request)
puts response.read_body
```

--------------------------------

### List Installment Schedules (Node.js)

Source: https://nibo.readme.io/reference/parcelamento

This Node.js snippet shows how to fetch installment schedules using the 'node-fetch' library. It makes a GET request to the specified API endpoint, requiring the installment ID.

```javascript
const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
};

fetch('https://api.nibo.com.br/empresas/v1/installments/installmentId/schedules', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
```

--------------------------------

### API Authentication

Source: https://nibo.readme.io/reference/como-utilizar-a-api

To use the Nibo API, you need an API key (api token). This token can be found in 'Your Company > More Options > Settings > API'. You must include this token in the header of your request or as a route parameter.

```APIDOC
## API Authentication

### Description
To use the Nibo API, you need an API key (api token). This token can be found in 'Your Company > More Options > Settings > API'. You must include this token in the header of your request or as a route parameter.

### Method
GET, POST, PUT, DELETE (all methods require authentication)

### Headers
- **ApiToken** (string) - Required - Your API token

### Query Parameters
- **apitoken** (string) - Required - Your API token

### Request Example (using Header)
```
GET /empresas/v1/schedules/debit HTTP/1.1
Host: api.nibo.com.br
ApiToken: 58524AE25524003BB0E4CD0B84B46A56
```

### Request Example (using Query Parameter)
```
https://api.nibo.com.br/empresas/v1/schedules/debit?apitoken=58524AE25524003BB0E4CD0B84B46A56
```

### Important Note
If you provide the ApiToken in the Header, use the `ApiToken` parameter. Do not use the `Authorization` parameter.
```

--------------------------------

### GET /empresas/v1/installments/{installmentId}/schedules

Source: https://nibo.readme.io/reference/parcelamento

Retrieves a list of schedules associated with the specified installment identifier (installmentId).

```APIDOC
## GET /empresas/v1/installments/{installmentId}/schedules

### Description
Retorna uma lista de agendamentos associados ao identificador de parcelamento especificado (installmentId).

### Method
GET

### Endpoint
https://api.nibo.com.br/empresas/v1/installments/{installmentId}/schedules

### Parameters
#### Path Parameters
- **installmentId** (string) - Required - Identificador da parcelamento

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl --request GET \
     --url https://api.nibo.com.br/empresas/v1/installments/installmentId/schedules \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **schedules** (array) - A list of schedules.
  - **id** (string) - The schedule ID.
  - **date** (string) - The date of the schedule.
  - **amount** (number) - The amount of the schedule.

#### Error Response (500)
- **error** (string) - An error message.
- **error_description** (string) - A more detailed description of the error.
- **exception** (object) - Detailed exception information.

#### Response Example (200)
```json
{
  "schedules": [
    {
      "id": "schedule-123",
      "date": "2023-10-27",
      "amount": 100.50
    }
  ]
}
```

#### Response Example (500)
```json
{
  "error": "Internal Server Error",
  "error_description": "An unexpected error occurred.",
  "exception": {
    "ClassName": "System.Exception",
    "Message": "Object reference not set to an instance of an object.",
    "Data": null,
    "InnerException": null,
    "HelpURL": null,
    "StackTraceString": " at Nibo.Api.Controllers.InstallmentsController.GetSchedules(String installmentId)\n   at lambda_method(Closure , Object , Object[] )\n   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, Dictionary`2 arguments, CancellationToken cancellationToken)",
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": -2147467261,
    "WatsonBuckets": null
  }
}
```
```

--------------------------------

### GET /v1/installments/{installmentId}

Source: https://nibo.readme.io/reference/buscar-parcelamento

Retrieves installment information using the installment's unique identifier. You can find the installment ID by checking the 'installmentId' property of your schedule, as detailed in the 'List Scheduling' documentation.

```APIDOC
## GET /v1/installments/{installmentId}

### Description
Retrieves installment information using the installment's unique identifier. You can find the installment ID by checking the 'installmentId' property of your schedule, as detailed in the 'List Scheduling' documentation.

### Method
GET

### Endpoint
/v1/installments/{installmentId}

### Parameters
#### Path Parameters
- **installmentId** (string) - Required - Identificador do parcelamento

### Request Example
```json
{
  "example": "No request body for this GET request."
}
```

### Response
#### Success Response (200)
- **installmentId** (string) - The unique identifier for the installment.
- **divideTotalValue** (boolean) - Indicates if the total value is divided.
- **totalOfInstallments** (number) - The total number of installments.
- **totalValue** (number) - The total value of the installment.

#### Response Example
```json
{
  "installmentId": "string",
  "divideTotalValue": true,
  "totalOfInstallments": 12,
  "totalValue": 1200.50
}
```

#### Error Response (500)
- **error** (string) - A general error message.
- **error_description** (string) - A more detailed description of the error.
- **exception** (object) - Contains detailed information about the exception that occurred.
  - **ClassName** (string) - The name of the exception class.
  - **Message** (string) - The error message.
  - **StackTraceString** (string) - The stack trace of the error.

#### Error Response Example
```json
{
  "error": "Internal Server Error",
  "error_description": "An unexpected error occurred on the server.",
  "exception": {
    "ClassName": "System.NullReferenceException",
    "Message": "Object reference not set to an instance of an object.",
    "Data": null,
    "InnerException": null,
    "HelpURL": null,
    "StackTraceString": "at Nibo.Api.Controllers.InstallmentsController.Get(String installmentId)\n   at lambda_method(Closure , Object )
   at Microsoft.Extensions.Internal.ObjectMethodExecutor.Execute(Object obj, Object[] parameters)\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.ExecuteAsync(IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.InvokeActionMethodAsync()\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.InvokeNextAsync()\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.InvokeInnerFilterAsync()\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.InvokeFilterPipelineAsync()\n   at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.HttpContext.Features.IHttpMaxRequestBodySizeFeature.MaxRequestBodySize\n   at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http.HttpProtocol.ProcessRequestAsync()",
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": "Void Get(String)",
    "HResult": -2147467261,
    "WatsonBuckets": null
  }
}
```
```

--------------------------------

### Adicionar CNAEs a um Cliente

Source: https://nibo.readme.io/reference/adicionar-cnae-a-um-cliente

Este endpoint permite adicionar um ou mais CNAEs ao registro de um cliente associado a um escritório específico. É útil para manter as informações de atividade econômica de um cliente atualizadas.

```APIDOC
## POST /websites/nibo_readme_io_reference/clientes/{cliente_id}/cnaes

### Description
Permite adicionar CNAEs ao cliente de um determinado escritório.

### Method
POST

### Endpoint
/websites/nibo_readme_io_reference/clientes/{cliente_id}/cnaes

### Parameters
#### Path Parameters
- **cliente_id** (string) - Required - O identificador único do cliente.

#### Query Parameters
Nenhum.

#### Request Body
- **cnaes** (array) - Required - Uma lista de objetos, onde cada objeto representa um CNAE a ser adicionado.
  - **codigo** (string) - Required - O código do CNAE.
  - **descricao** (string) - Optional - A descrição do CNAE.
  - **principal** (boolean) - Optional - Indica se este é o CNAE principal do cliente.

### Request Example
```json
{
  "cnaes": [
    {
      "codigo": "1234-5/67",
      "descricao": "Atividade Principal Exemplo",
      "principal": true
    },
    {
      "codigo": "9876-5/43",
      "principal": false
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Mensagem de sucesso indicando que os CNAEs foram adicionados.

#### Response Example
```json
{
  "message": "CNAEs adicionados com sucesso ao cliente."
}
```
```

--------------------------------

### Listar Transferências Bancárias (GET /websites/nibo_readme_io_reference)

Source: https://nibo.readme.io/reference/listar-transferencias

Lista todas as transferências bancárias entre contas, com suporte para filtros e paginação utilizando OData.

```APIDOC
## GET /websites/nibo_readme_io_reference

### Description
Lista todas as transferências bancárias entre contas, com suporte para filtros e paginação utilizando OData.

### Method
GET

### Endpoint
/websites/nibo_readme_io_reference

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Permite aplicar filtros avançados nos resultados.
- **$orderby** (string) - Optional - Define a ordem dos resultados.
- **$select** (string) - Optional - Seleciona campos específicos a serem retornados.
- **$top** (integer) - Optional - Define o número máximo de itens a serem retornados (paginação).
- **$skip** (integer) - Optional - Define o número de itens a serem pulados (paginação).

### Request Example
```
GET /websites/nibo_readme_io_reference?$filter=status eq 'completed'&$orderby=date desc&$select=id,amount,date
```

### Response
#### Success Response (200)
- **id** (string) - Identificador único da transferência.
- **amount** (number) - Valor da transferência.
- **date** (string) - Data da transferência.
- **status** (string) - Status da transferência.

#### Response Example
```json
{
  "value": [
    {
      "id": "transfer-123",
      "amount": 100.50,
      "date": "2023-10-27T10:00:00Z",
      "status": "completed"
    },
    {
      "id": "transfer-456",
      "amount": 250.00,
      "date": "2023-10-26T15:30:00Z",
      "status": "pending"
    }
  ]
}
```
```

--------------------------------

### GET /v1/installments/{installmentId}/schedules

Source: https://nibo.readme.io/reference/listar-agendamento-de-parcelamento

Retrieves a list of schedules associated with a specific installment ID. You can find the installment ID by checking if the schedule has this property populated.

```APIDOC
## GET /v1/installments/{installmentId}/schedules

### Description
Retorna uma lista de agendamentos associados ao identificador de parcelamento especificado (installmentId).

### Method
GET

### Endpoint
/v1/installments/{installmentId}/schedules

### Parameters
#### Path Parameters
- **installmentId** (string) - Required - Identificador da parcelamento

### Request Example
```json
{
  "example": "No request body for this GET request."
}
```

### Response
#### Success Response (200)
- **scheduleId** (string) - Description of the schedule identifier.
- **dueDate** (string) - Description of the due date.
- **scheduleDate** (string) - Description of the schedule date.
- **accrualDate** (string) - Description of the accrual date.
- **value** (number) - Description of the value.
- **installmentNumber** (number) - Description of the installment number.

#### Response Example
```json
[
  {
    "scheduleId": "string",
    "dueDate": "string",
    "scheduleDate": "string",
    "accrualDate": "string",
    "value": 100.50,
    "installmentNumber": 1
  },
  {
    "scheduleId": "string",
    "dueDate": "string",
    "scheduleDate": "string",
    "accrualDate": "string",
    "value": 200.75,
    "installmentNumber": 2
  }
]
```

#### Error Response (500)
- **error** (string) - Description of the error.
- **error_description** (string) - Description of the error details.
- **exception** (object) - Detailed exception information.

#### Error Response Example
```json
{
  "error": "Internal Server Error",
  "error_description": "An unexpected error occurred.",
  "exception": {
    "ClassName": "System.Exception",
    "Message": "An error occurred during processing.",
    "Data": null,
    "InnerException": null,
    "HelpURL": null,
    "StackTraceString": "at Nibo.Api.Controllers.InstallmentsController.GetSchedules(String installmentId)\n   at lambda_method(Closure , Object , Object[] )
   at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.ExecuteAsync(IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)",
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": "Nibo.Api.Controllers.InstallmentsController.GetSchedules(System.String)",
    "HResult": -2146233088,
    "WatsonBuckets": null
  }
}
```
```

--------------------------------

### Cost Center Allocation Example (JSON)

Source: https://nibo.readme.io/reference/agendar-pagamento-json

Demonstrates how to specify cost center allocation for a payment. It shows examples for both percentage-based and value-based allocation, depending on the `costCenterValueType`.

```json
{
    "costCenterValueType": 1, // por porcentagem
    "costCenters": [
        {
            "costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823",
            "percent":100
        }    
    ]
}
{
    "costCenterValueType": 0, // por valor
    "costCenters": [
        {
            "costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823",
            "value": 500
        }    
    ]
}
```

--------------------------------

### GET /v1/accounts/{accountId}/views/statement

Source: https://nibo.readme.io/reference/consultar-extrato

Retrieves the statement for a specific company bank account within a specified date range. Requires the account ID, start date, and end date.

```APIDOC
## GET /v1/accounts/{accountId}/views/statement

### Description
Permite obter o extrato de uma conta bancária específica da empresa, fornecendo detalhes das transações dentro de um intervalo de datas especificado. É necessário informar o AccountId da conta, além das datas de início (startDate) e fim (endDate) para a consulta.

### Method
GET

### Endpoint
https://api.nibo.com.br/empresas/v1/accounts/{accountId}/views/statement

### Parameters
#### Path Parameters
- **accountId** (string) - Required - O identificador da conta bancária

#### Query Parameters
- **startDate** (string) - Required - Data de início do período. Formato: YYYY-MM-DD
- **endDate** (string) - Required - Data de fim do período. Formato: YYYY-MM-DD

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **items** (array) - Lista de transações.
  - **scheduleId** (string) - Identificador do agendamento.
  - **entryId** (string) - Identificador da entrada.
  - **stakeholderId** (string) - Identificador da parte interessada.
  - **stakeholderName** (string) - Nome da parte interessada.
  - **stakeholderType** (string) - Tipo da parte interessada.
  - **stakeholderIsDeleted** (boolean) - Indica se a parte interessada foi excluída.
  - **description** (string) - Descrição da transação.
  - **value** (number) - Valor da transação.
  - **date** (string) - Data da transação.
  - **createDate** (string) - Data de criação do registro.
  - **currentBalance** (number) - Saldo atual da conta.
  - **isTransfer** (boolean) - Indica se a transação é uma transferência.
  - **type** (string) - Tipo da transação.
  - **isReconciliated** (boolean) - Indica se a transação foi conciliada.
- **count** (number) - Número total de transações.

#### Response Example
```json
{
  "items": [
    {
      "scheduleId": "string",
      "entryId": "string",
      "stakeholderId": "string",
      "stakeholderName": "string",
      "stakeholderType": "string",
      "stakeholderIsDeleted": true,
      "description": "string",
      "value": 0,
      "date": "string",
      "createDate": "string",
      "currentBalance": 0,
      "isTransfer": true,
      "type": "string",
      "isReconciliated": true
    }
  ],
  "count": 0
}
```

#### Error Response (500)
- **error** (string) - Código do erro.
- **error_description** (string) - Descrição do erro.
- **exception** (object) - Detalhes da exceção.
  - **ClassName** (string) - Nome da classe da exceção.
  - **Message** (string) - Mensagem da exceção.
  - **StackTraceString** (string) - String da pilha de chamadas.
  - **ExceptionMethod** (string) - Método que gerou a exceção.
  - **HResult** (integer) - Código HResult da exceção.

#### Error Response Example
```json
{
  "error": "string",
  "error_description": "string",
  "exception": {
    "ClassName": "string",
    "Message": "string",
    "Data": null,
    "InnerException": null,
    "HelpURL": null,
    "StackTraceString": "string",
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": "string",
    "HResult": 0,
    "WatsonBuckets": null
  }
}
```
```

--------------------------------

### GET /websites/nibo_readme_io_reference/suppliers/{supplierId}

Source: https://nibo.readme.io/reference/buscar-fornecedor-por-id

Busca informações de um fornecedor específico, identificado pelo supplierId.

```APIDOC
## GET /websites/nibo_readme_io_reference/suppliers/{supplierId}

### Description
Permite buscar informações de um fornecedor específico, identificado pelo supplierId.

### Method
GET

### Endpoint
/websites/nibo_readme_io_reference/suppliers/{supplierId}

### Parameters
#### Path Parameters
- **supplierId** (string) - Required - O ID único do fornecedor a ser buscado.

### Response
#### Success Response (200)
- **supplierId** (string) - O ID do fornecedor.
- **name** (string) - O nome do fornecedor.
- **email** (string) - O endereço de e-mail do fornecedor.
- **phone** (string) - O número de telefone do fornecedor.

#### Response Example
{
  "supplierId": "supplier-123",
  "name": "Exemplo Fornecedor",
  "email": "contato@exemplo.com",
  "phone": "(11) 98765-4321"
}
```

--------------------------------

### Listar Grupos de Clientes

Source: https://nibo.readme.io/reference/listar-grupos-de-clientes

Recupera uma lista paginada de grupos de clientes associados a um escritório contábil. Suporta filtros e ordenação via OData.

```APIDOC
## GET /websites/nibo_readme_io_reference/customer_groups

### Description
Permite obter uma lista paginada de até 100 grupos de clientes vinculados a um escritório contábil, com suporte a OData.

### Method
GET

### Endpoint
/websites/nibo_readme_io_reference/customer_groups

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Permite filtrar os resultados usando a sintaxe OData.
- **$orderby** (string) - Optional - Permite ordenar os resultados usando a sintaxe OData.
- **$top** (integer) - Optional - Define o número máximo de itens a serem retornados (padrão 100).
- **$skip** (integer) - Optional - Define o número de itens a serem pulados para paginação.

### Request Example
```
GET /websites/nibo_readme_io_reference/customer_groups?$filter=name eq 'Grupo A'&$orderby=id desc&$top=10
```

### Response
#### Success Response (200)
- **value** (array) - Uma lista de objetos representando os grupos de clientes.
  - **id** (integer) - O identificador único do grupo de clientes.
  - **name** (string) - O nome do grupo de clientes.
  - **company_id** (integer) - O identificador da empresa associada ao grupo.

#### Response Example
```json
{
  "value": [
    {
      "id": 1,
      "name": "Grupo A",
      "company_id": 123
    },
    {
      "id": 2,
      "name": "Grupo B",
      "company_id": 123
    }
  ]
}
```
```

--------------------------------

### Create Employee Example (JSON)

Source: https://nibo.readme.io/reference/criar-funcionario

This JSON structure demonstrates the required fields for creating a new employee record. It includes personal details, contact information, address, bank account details, and company information.

```json
{
  "name": "string",
  "document": {
    "number": "string",
    "type": "string"
  },
  "communication": {
    "contactName": "string",
    "email": "string",
    "phone": "string",
    "cellPhone": "string",
    "webSite": "string"
  },
  "address": {
    "line1": "string",
    "line2": "string",
    "number": 0,
    "district": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "country": "string"
  },
  "bankAccountInformation": {
    "bankNumber": "string",
    "agency": "string",
    "accountNumber": "string",
    "bankAccountType": 1,
    "pixKey": "12345678901",
    "pixKeyType": 3
  },
  "companyInformation": {
    "companyName": "string",
    "municipalInscription": "string"
  }
}
```

--------------------------------

### List Organizations Node.js Request

Source: https://nibo.readme.io/reference/empresas

Example of how to list organizations using Node.js with the 'axios' library. It demonstrates making a GET request to the Nibo API endpoint.

```javascript
const axios = require('axios');

axios
  .get('https://api.nibo.com.br/empresas/v1/organizations', {
    headers: {
      'accept': 'application/json'
    }
  })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });
```

--------------------------------

### List Annotations API Request (Python)

Source: https://nibo.readme.io/reference/anota%C3%A7%C3%B5es

Python code example for fetching annotations from the Nibo API. This snippet demonstrates how to send a GET request and handle the JSON response.

```python
# Python example would go here, likely using 'requests'
# import requests
# 
# def list_annotations(schedule_id):
#     url = f"https://api.nibo.com.br/empresas/v1/public/schedules/{schedule_id}/annotations"
#     headers = {'accept': 'application/json'}
#     response = requests.get(url, headers=headers)
#     response.raise_for_status()  # Raise an exception for bad status codes
#     return response.json()
```

--------------------------------

### Create File for Upload

Source: https://nibo.readme.io/reference/criar-arquivo-para-fazer-upload

This endpoint allows you to create a file for upload. It details the requirements for file naming, the destination URL, the request method, necessary headers, and how to use the returned ID after a successful upload.

```APIDOC
## POST /websites/nibo_readme_io_reference/upload

### Description
Allows the creation of a file to perform an upload. The file name must include the corresponding format extension (e.g., arquivo.pdf, planilha.xlsx, documento.doc).

### Method
PUT

### Endpoint
/websites/nibo_readme_io_reference/upload

### Parameters
#### Header Parameters
- **x-ms-blob-type** (string) - Required - Must be set to 'BlockBlob'.
- **x-ms-blob-content-type** (string) - Required - The format of the file (e.g., 'application/pdf', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/msword').

### Request Body
(No specific request body is detailed in the provided text, but the `sharedAccessSignature` URL is used as the destination.)

### Response
#### Success Response (200)
- **fileId** (string) - The ID of the uploaded file, which can be used in other routes.

#### Response Example
```json
{
  "fileId": "some-unique-file-id"
}
```

### Notes
- The `sharedAccessSignature` property is a temporary URL with specific permissions and is valid for **10 minutes** from its generation. The file upload must be completed within this interval.
- Use the `sharedAccessSignature` URL directly as the destination for the upload request. It contains all necessary authentication and parameters.
```
Tokens:
Raw