> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BIU as a data source

> Bring data from BIU to Nekt.

BIU is a Brazilian financial management platform focused on automating invoice issuance (NFe and NFs) for digital product sales. It integrates with major sales platforms like Hotmart, Eduzz, and others, consolidating sales data, fiscal notes, and financial dashboards in one place.

<img height="50" src="https://mintlify.s3.us-west-1.amazonaws.com/nekt/assets/logo/logo-biu.png" />

## Configuring BIU as a Source

In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the BIU option from the list of connectors.

Click **Next** and you'll be prompted to add your access.

### 1. Add account access

You'll need to provide your BIU API token to authenticate. You can generate a token at [https://app.somosbiu.com/api-token](https://app.somosbiu.com/api-token).

The following configurations are available:

* **API Token**: Your BIU API bearer token for authentication.

* **Start Date**: (Optional) Earliest date to sync data from. If not set, all available data will be extracted.

Once you're done, click **Next**.

### 2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis.

Select the streams and click **Next**.

### 3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table and the type of sync.

* **Layer**: choose between the existing layers on your catalog.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **Table name**: you can customize the name or add a **prefix** to all tables at once.
* **Sync Type**: choose between INCREMENTAL and FULL\_TABLE.

Once you are done configuring, click **Next**.

### 4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters.

To define your [Trigger](https://docs.nekt.com/runs/scheduling-and-triggers), consider how often you want data to be extracted from this source.

Once you are ready, click **Next** to finalize the setup.

### 5. Check your new source

You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

<Warning>For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.</Warning>

# Streams and Fields

Below you'll find all available data streams from BIU and their corresponding fields:

<AccordionGroup>
  <Accordion title="Dashboard">
    Consolidated financial performance summary including sales totals, fiscal notes (NFe/NFs), and operational alerts for a given competence period.

    **Key fields:**

    | Field                             | Type    | Description                                    |
    | :-------------------------------- | :------ | :--------------------------------------------- |
    | `competence`                      | String  | Monthly period in YYYY-MM format (primary key) |
    | `start_date`                      | String  | Start date of the period                       |
    | `end_date`                        | String  | End date of the period                         |
    | `sales_date_field`                | String  | Date field used for filtering                  |
    | `sales_warning`                   | Number  | Sales amount flagged as warning                |
    | `sales_warning_qtt`               | Integer | Number of warning sales                        |
    | `sales_pending`                   | Number  | Pending sales amount                           |
    | `sales_pending_qtt`               | Integer | Number of pending sales                        |
    | `sales_canceled`                  | Number  | Canceled sales amount                          |
    | `sales_canceled_qtt`              | Integer | Number of canceled sales                       |
    | `sales_coproducer`                | Number  | Coproducer sales amount                        |
    | `sales_coproducer_qtt`            | Integer | Number of coproducer sales                     |
    | `sales_processed`                 | Number  | Processed sales amount                         |
    | `sales_processed_qtt`             | Integer | Number of processed sales                      |
    | `sales_dont_issue`                | Number  | Sales marked as "don't issue" amount           |
    | `sales_dont_issue_qtt`            | Integer | Number of "don't issue" sales                  |
    | `sales_total_qtt`                 | Integer | Total number of sales                          |
    | `sales_processed_pct`             | Number  | Percentage of processed sales                  |
    | `fnp_warning`                     | Number  | NFe warnings amount                            |
    | `fnp_warning_qtt`                 | Integer | Number of NFe warnings                         |
    | `fnp_pending`                     | Number  | Pending NFe amount                             |
    | `fnp_pending_qtt`                 | Integer | Number of pending NFe                          |
    | `fnp_canceled`                    | Number  | Canceled NFe amount                            |
    | `fnp_canceled_qtt`                | Integer | Number of canceled NFe                         |
    | `fnp_coproducer`                  | Number  | Coproducer NFe amount                          |
    | `fnp_coproducer_qtt`              | Integer | Number of coproducer NFe                       |
    | `fnp_processed`                   | Number  | Processed NFe amount                           |
    | `fnp_processed_qtt`               | Integer | Number of processed NFe                        |
    | `fnp_dont_issue`                  | Number  | "Don't issue" NFe amount                       |
    | `fnp_dont_issue_qtt`              | Integer | Number of "don't issue" NFe                    |
    | `fnp_total_qtt`                   | Integer | Total NFe count                                |
    | `fnp_processed_pct`               | Number  | Percentage of processed NFe                    |
    | `fns_warning`                     | Number  | NFs warnings amount                            |
    | `fns_warning_qtt`                 | Integer | Number of NFs warnings                         |
    | `fns_pending`                     | Number  | Pending NFs amount                             |
    | `fns_pending_qtt`                 | Integer | Number of pending NFs                          |
    | `fns_canceled`                    | Number  | Canceled NFs amount                            |
    | `fns_canceled_qtt`                | Integer | Number of canceled NFs                         |
    | `fns_coproducer`                  | Number  | Coproducer NFs amount                          |
    | `fns_coproducer_qtt`              | Integer | Number of coproducer NFs                       |
    | `fns_processed`                   | Number  | Processed NFs amount                           |
    | `fns_processed_qtt`               | Integer | Number of processed NFs                        |
    | `fns_dont_issue`                  | Number  | "Don't issue" NFs amount                       |
    | `fns_dont_issue_qtt`              | Integer | Number of "don't issue" NFs                    |
    | `fns_total_qtt`                   | Integer | Total NFs count                                |
    | `fns_processed_pct`               | Number  | Percentage of processed NFs                    |
    | `alerts_pending_products_qtt`     | Integer | Number of pending products                     |
    | `alerts_expired_certificates_qtt` | Integer | Number of expired certificates                 |
    | `alerts_is_single_company`        | Boolean | Whether the account is a single company        |
    | `alerts_cert_expires`             | String  | Certificate expiration date                    |
    | `alerts_cert_days_left`           | Integer | Days until certificate expires                 |
    | `alerts_cert_expired`             | Boolean | Whether the certificate is expired             |

    **Notes:**

    * **Replication**: The stream uses `competence` as the replication key. Incremental syncs request data starting from the last replicated month.
    * **Pagination**: The connector iterates one month at a time from the configured `start_date` (or the last saved state) up to the current month to fetch all records seamlessly.
  </Accordion>
</AccordionGroup>

## API Limits

The BIU API enforces a rate limit of 20 requests per minute per company. Exceeding it blocks the company for 1 hour. The connector automatically handles this by restricting calls to 15 requests per 60 seconds to stay safely under the limit.

## Skills for agents

<Snippet file="agent-skills-intro.mdx" />

<Card title="Download BIU skills file" icon="wand-magic-sparkles" href="/sources/biu.md">
  BIU connector documentation as plain markdown, for use in AI agent contexts.
</Card>
