> ## 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.
# Nibo as a data source
> Bring data from Nibo to your Lakehouse.
Nibo is a Brazilian financial management platform used by companies and their accounting offices to control accounts payable and receivable, bank accounts and reconciliation, service invoices (NFS-e) and boletos. This source brings the data from **Nibo Gestão Financeira** (the "Empresa" API) into your Lakehouse.
## Configuring Nibo 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 Nibo option from the list of connectors.
Click **Next** and you'll be prompted to add your access.
### 1. Add account access
The Nibo API is only available on the **Premium** plan of Nibo Gestão Financeira. If your company is on another plan, the API token will not be available.
To generate your token, open Nibo and go to your company, then **Mais opções → Configurações → API**. Copy the token shown there.
The following configurations are available:
* **API token**: The token you copied from the Nibo API settings screen. It is sent on every request and identifies a single company, so create one source per Nibo company you want to extract.
* **Initial sync date**: (Optional) The earliest date used by the streams that require an explicit date range — the `Account Statement` and the `Budgets`. Every other stream always returns your company's full history. When left empty, it defaults to the beginning of the year two years ago.
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. You can select entire groups of streams or pick specific ones.
> Tip: The stream can be found more easily by typing its name.
`Schedules` is the union of `Credit Schedules` and `Debit Schedules`, and `Stakeholders` is the union of `Customers`, `Suppliers`, `Employees` and `Partners`. If you select both the union and its parts, the same records will be extracted more than once, into different tables.
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 (which will effectively contain the fetched data) and the type of sync.
* **Layer**: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** to all tables at once and make this process faster!
* **Sync Type**: you can choose between INCREMENTAL and FULL\_TABLE.
* Incremental: every time the extraction happens, we'll get only the new data - which is good if, for example, you want to keep every record ever fetched.
* Full table: every time the extraction happens, we'll get the current state of the data - which is good if, for example, you don't want to have deleted data in your catalog.
Nibo's API does not offer a reliable "changed since" filter, so every Nibo stream reads the full collection on each run. **FULL\_TABLE is the recommended sync type**: it keeps your tables an exact mirror of Nibo, including edits made to old records, which financial data receives often.
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/get-started/core-concepts/triggers), consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).
Optionally, you can define some additional settings:
* Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource [here](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync)**. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
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.
For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.
## Good to know
* **Nested data is flattened.** Nibo nests objects inside its records (the contact, the category, the cost center, the tax blocks of an invoice). They are extracted as scalar columns with a prefix, such as `stakeholder_name`, `category_id` or `service_iss_value`, so they can be queried directly.
* **Lists become JSON.** When a record carries a list — the categories or cost centers an amount was split across, the payment methods of a boleto — the column holds a JSON string, so the table structure never changes as those lists grow.
* **Missing modules are skipped, not fatal.** If a module such as NFS-e or boletos is not enabled for your company, the corresponding stream is skipped with a warning in the run log and the rest of the extraction proceeds normally.
* **Page size.** Nibo caps every query at 500 records per page, and this source paginates through the whole collection automatically.
# Streams and Fields
Below you'll find all available data streams from Nibo and their corresponding fields:
The company the API token belongs to, with its Nibo plan and the features enabled for it.
**Primary key:** `organization_id`
**Fields:**
* `organization_id` - Unique identifier of the company in Nibo
* `name` - Name of the company
* `cnpj` - Brazilian company tax number (CNPJ)
* `plan` - Nibo plan the company is on. The API requires the Premium plan
* `subscription_plan` - Subscription plan currently billed for the company
* `type` - Numeric code for the kind of Nibo account the company holds
* `is_financial_management` - Whether the company uses Nibo Gestao Financeira
* `invoice_enabled` - Whether the company can issue service invoices (NFS-e) from Nibo
* `accountant_id` - Identifier of the accounting office linked to the company
* `accountant_name` - Name of the accounting office linked to the company
* `users` - Users with access to the company (JSON array with userId, email, name and isOwner)
* `features` - Features enabled for the company (JSON array of feature keys)
* `address_line1` - First line of the company address, usually the street name
* `address_line2` - Second line of the company address, usually the complement
* `address_district` - District or neighbourhood
* `address_city` - City of the company address
* `address_state` - Brazilian state (UF)
* `address_zip_code` - Postal code (CEP)
Users invited to the company, with their roles and whether they have accepted the invitation.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the user
* `email` - Email address the user signs in with
* `create_date` - Timestamp when the user was invited to the company
* `accept_date` - Timestamp when the user accepted the invitation
* `is_organization_owner` - Whether the user owns the company account
* `is_organization_user` - Whether the user belongs to the company itself
* `is_accountant_user` - Whether the user belongs to the accounting office instead of the company
* `roles_text` - Roles and permissions granted to the user, as displayed by Nibo
Bank accounts registered in the company, including whether the statement is imported automatically from the bank.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the bank account
* `name` - Name given to the account inside Nibo
* `type` - Kind of account, such as a checking account, cash or an investment account
* `open_balance` - Opening balance the account started with in Nibo
* `date_of_open_balance` - Date the opening balance refers to
* `is_virtual` - Whether the account is virtual rather than a real bank account
* `is_reconcilable` - Whether entries in this account can be reconciled against a bank statement
* `is_archived` - Whether the account has been archived and is no longer used for new entries
* `bank_agency` - Branch number of the bank account
* `bank_account` - Number of the bank account
* `bank_account_verification_number` - Check digit of the bank account number
* `bank_number` - Brazilian bank code (COMPE) of the institution holding the account
* `scraping_enabled` - Whether Nibo automatically imports this account's statement from the bank
* `scraping_configuration_valid` - Whether the automatic statement import is correctly configured
* `is_automated` - Whether the account is currently automated (connected to the bank)
* `can_be_automated` - Whether this account's bank supports automation in Nibo
* `automation_requires_migration` - Whether the existing automation has to be migrated to keep working
* `automated_account_open_balance_date` - Date from which the automated import starts bringing the balance
* `is_open_finance` - Whether the connection to the bank uses Open Finance
* `has_mfa` - Whether the bank connection uses multi-factor authentication
* `is_mfa_required` - Whether the bank requires multi-factor authentication for this account
* `has_payment_operation` - Whether payments can be sent to the bank directly from this account
* `boleto_enabled` - Whether the account can issue Brazilian bank slips (boletos)
* `cnab_enabled` - Whether the account exchanges CNAB files with the bank
* `update_date` - Timestamp of the last change made to the account
* `update_user` - User who last changed the account
Current balance of every bank account, both as recorded in Nibo and as reported by the bank.
**Primary key:** `account_id`
**Fields:**
* `account_id` - Identifier of the bank account
* `account_name` - Name of the bank account in Nibo
* `balance` - Balance of the account according to the entries recorded in Nibo
* `bank_balance` - Balance reported by the bank itself for automated accounts
* `agency` - Branch number of the bank account
* `account_number` - Number of the bank account
* `account_verification_number` - Check digit of the bank account number
* `is_virtual` - Whether the account is virtual rather than a real bank account
* `is_reconcilable` - Whether entries in this account can be reconciled against a bank statement
* `is_account_automated` - Whether the account statement is imported automatically from the bank
* `pending_reconciliation_count` - Number of entries still waiting to be reconciled in this account
* `total_open_reconciliations` - Total amount of the entries still waiting to be reconciled
* `is_pj_bank_virtual_account_waiting_approve` - Whether a PJBank virtual account is still waiting for approval
Reference list of the banks Nibo supports. Join it with an account's `bank_number`.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the bank in Nibo
* `code` - Short code Nibo uses for the bank
* `name` - Name of the banking institution
* `bank_number` - Brazilian bank code (COMPE) of the institution
* `color` - Brand colour Nibo uses for the bank
* `scraping_enabled` - Whether Nibo can import statements from this bank automatically
* `automation_enabled` - Whether accounts at this bank can be automated in Nibo
Transfers made between two bank accounts of the company, with both legs of the movement.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the transfer
* `origin_entry_entry_id` - Identifier of the entry debited in the origin account
* `origin_entry_account_id` - Identifier of the account the money came from
* `origin_entry_account_name` - Name of the account the money came from
* `origin_entry_date` - Date the money left the origin account
* `origin_entry_identifier` - Identifier Nibo shows for the entry in the origin account
* `origin_entry_value` - Amount debited from the origin account
* `origin_entry_is_transfer` - Always true: the origin entry belongs to a transfer
* `destiny_entry_entry_id` - Identifier of the entry credited in the destination account
* `destiny_entry_account_id` - Identifier of the account the money went to
* `destiny_entry_account_name` - Name of the account the money went to
* `destiny_entry_date` - Date the money arrived in the destination account
* `destiny_entry_identifier` - Identifier Nibo shows for the entry in the destination account
* `destiny_entry_value` - Amount credited to the destination account
* `destiny_entry_is_transfer` - Always true: the destination entry belongs to a transfer
Bank statement of each account: every entry with its running balance. Read month by month from the configured start date.
**Primary key:** `account_id`, `entry_id`
**Fields:**
* `account_id` - Identifier of the bank account this statement line belongs to
* `account_name` - Name of the bank account this statement line belongs to
* `entry_id` - Unique identifier of the entry
* `schedule_id` - Identifier of the schedule (payable or receivable) that produced the entry
* `date` - Date the entry hit the account
* `create_date` - Timestamp when the entry was recorded in Nibo
* `description` - Description of the entry as shown on the statement
* `value` - Amount of the entry: positive for money in, negative for money out
* `current_balance` - Balance of the account right after this entry (running balance)
* `type` - Kind of entry, such as a receipt, a payment or a transfer
* `is_transfer` - Whether the entry is one leg of a transfer between own accounts
* `is_reconciliated` - Whether the entry has already been reconciled against the bank
* `stakeholder_id` - Identifier of the contact involved in the entry
* `stakeholder_name` - Name of the contact involved in the entry
* `stakeholder_type` - Kind of contact involved: customer, supplier, employee or partner
* `stakeholder_is_deleted` - Whether the contact involved in the entry has been deleted in Nibo
Entries of each account still waiting to be reconciled against the bank.
**Primary key:** `account_id`, `account_entry_id`
**Fields:**
* `account_id` - Identifier of the bank account being reconciled
* `account_name` - Name of the bank account being reconciled
* `account_entry_id` - Identifier of the bank entry waiting to be reconciled
* `account_entry_account_id` - Identifier of the account the bank entry belongs to
* `account_entry_value` - Amount of the bank entry
* `account_entry_date` - Date the bank entry hit the account
* `account_entry_description` - Description of the entry as sent by the bank
* `account_entry_rank` - Ranking Nibo assigns to the entry when suggesting matches
* `account_entry_discussions` - Comments exchanged about this entry (JSON array)
* `mapping` - Nibo entries this bank entry can be reconciled against (JSON array)
Every contact of the company in a single table: customers, suppliers, employees and partners. This is the convenient dimension to join financial entries against, since a `stakeholder_id` always resolves here.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the contact in Nibo
* `name` - Display name of the contact
* `initials_name` - Short name or initials shown by Nibo when space is limited
* `email` - Main email address of the contact
* `phone` - Main phone number of the contact
* `type` - Kind of contact as classified by Nibo: customer, supplier, employee or partner
* `person_type` - Numeric code telling whether the contact is an individual or a company
* `is_company` - Whether the contact is a legal entity (company) rather than an individual
* `is_deleted` - Whether the contact has been deleted in Nibo
* `is_archived` - Whether the contact has been archived and is no longer offered for new entries
* `document_number` - Brazilian tax document of the contact (CPF for individuals, CNPJ for companies)
* `document_type` - Which tax document the number refers to (CPF or CNPJ)
* `communication_contact_name` - Name of the person to contact at this customer, supplier or partner
* `communication_email` - Email used for billing and notification messages sent by Nibo
* `communication_phone` - Landline number registered for communication with the contact
* `communication_cell_phone` - Mobile number registered for communication with the contact
* `communication_web_site` - Website of the contact
* `address_line1` - First line of the address, usually the street name
* `address_line2` - Second line of the address, usually the complement
* `address_number` - Street number of the address
* `address_district` - District or neighbourhood
* `address_city` - City of the address
* `address_state` - Brazilian state (UF) of the address
* `address_zip_code` - Postal code (CEP) of the address
* `address_country` - Country of the address
* `address_ibge_code` - IBGE code of the city, used by Brazilian tax documents
* `bank_account_information_bank` - Bank where the contact holds the account used for payments or receipts
* `bank_account_information_agency` - Branch number of the contact's bank account
* `bank_account_information_account_number` - Account number of the contact's bank account
* `company_information_company_name` - Registered legal name (razao social) when the contact is a company
* `company_information_municipal_inscription` - Municipal taxpayer registration of the company, used when issuing invoices
* `update_date` - Timestamp of the last change made to the contact
* `update_user` - User who last changed the contact
Customers registered in the company, the counterparty of every receivable.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the contact in Nibo
* `name` - Display name of the contact
* `initials_name` - Short name or initials shown by Nibo when space is limited
* `email` - Main email address of the contact
* `phone` - Main phone number of the contact
* `type` - Kind of contact as classified by Nibo: customer, supplier, employee or partner
* `person_type` - Numeric code telling whether the contact is an individual or a company
* `is_company` - Whether the contact is a legal entity (company) rather than an individual
* `is_deleted` - Whether the contact has been deleted in Nibo
* `is_archived` - Whether the contact has been archived and is no longer offered for new entries
* `document_number` - Brazilian tax document of the contact (CPF for individuals, CNPJ for companies)
* `document_type` - Which tax document the number refers to (CPF or CNPJ)
* `communication_contact_name` - Name of the person to contact at this customer, supplier or partner
* `communication_email` - Email used for billing and notification messages sent by Nibo
* `communication_phone` - Landline number registered for communication with the contact
* `communication_cell_phone` - Mobile number registered for communication with the contact
* `communication_web_site` - Website of the contact
* `address_line1` - First line of the address, usually the street name
* `address_line2` - Second line of the address, usually the complement
* `address_number` - Street number of the address
* `address_district` - District or neighbourhood
* `address_city` - City of the address
* `address_state` - Brazilian state (UF) of the address
* `address_zip_code` - Postal code (CEP) of the address
* `address_country` - Country of the address
* `address_ibge_code` - IBGE code of the city, used by Brazilian tax documents
* `bank_account_information_bank` - Bank where the contact holds the account used for payments or receipts
* `bank_account_information_agency` - Branch number of the contact's bank account
* `bank_account_information_account_number` - Account number of the contact's bank account
* `company_information_company_name` - Registered legal name (razao social) when the contact is a company
* `company_information_municipal_inscription` - Municipal taxpayer registration of the company, used when issuing invoices
* `update_date` - Timestamp of the last change made to the contact
* `update_user` - User who last changed the contact
Suppliers registered in the company, the counterparty of most payables.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the contact in Nibo
* `name` - Display name of the contact
* `initials_name` - Short name or initials shown by Nibo when space is limited
* `email` - Main email address of the contact
* `phone` - Main phone number of the contact
* `type` - Kind of contact as classified by Nibo: customer, supplier, employee or partner
* `person_type` - Numeric code telling whether the contact is an individual or a company
* `is_company` - Whether the contact is a legal entity (company) rather than an individual
* `is_deleted` - Whether the contact has been deleted in Nibo
* `is_archived` - Whether the contact has been archived and is no longer offered for new entries
* `document_number` - Brazilian tax document of the contact (CPF for individuals, CNPJ for companies)
* `document_type` - Which tax document the number refers to (CPF or CNPJ)
* `communication_contact_name` - Name of the person to contact at this customer, supplier or partner
* `communication_email` - Email used for billing and notification messages sent by Nibo
* `communication_phone` - Landline number registered for communication with the contact
* `communication_cell_phone` - Mobile number registered for communication with the contact
* `communication_web_site` - Website of the contact
* `address_line1` - First line of the address, usually the street name
* `address_line2` - Second line of the address, usually the complement
* `address_number` - Street number of the address
* `address_district` - District or neighbourhood
* `address_city` - City of the address
* `address_state` - Brazilian state (UF) of the address
* `address_zip_code` - Postal code (CEP) of the address
* `address_country` - Country of the address
* `address_ibge_code` - IBGE code of the city, used by Brazilian tax documents
* `bank_account_information_bank` - Bank where the contact holds the account used for payments or receipts
* `bank_account_information_agency` - Branch number of the contact's bank account
* `bank_account_information_account_number` - Account number of the contact's bank account
* `company_information_company_name` - Registered legal name (razao social) when the contact is a company
* `company_information_municipal_inscription` - Municipal taxpayer registration of the company, used when issuing invoices
* `update_date` - Timestamp of the last change made to the contact
* `update_user` - User who last changed the contact
Employees registered in the company, used on payroll-related payables.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the contact in Nibo
* `name` - Display name of the contact
* `initials_name` - Short name or initials shown by Nibo when space is limited
* `email` - Main email address of the contact
* `phone` - Main phone number of the contact
* `type` - Kind of contact as classified by Nibo: customer, supplier, employee or partner
* `person_type` - Numeric code telling whether the contact is an individual or a company
* `is_company` - Whether the contact is a legal entity (company) rather than an individual
* `is_deleted` - Whether the contact has been deleted in Nibo
* `is_archived` - Whether the contact has been archived and is no longer offered for new entries
* `document_number` - Brazilian tax document of the contact (CPF for individuals, CNPJ for companies)
* `document_type` - Which tax document the number refers to (CPF or CNPJ)
* `communication_contact_name` - Name of the person to contact at this customer, supplier or partner
* `communication_email` - Email used for billing and notification messages sent by Nibo
* `communication_phone` - Landline number registered for communication with the contact
* `communication_cell_phone` - Mobile number registered for communication with the contact
* `communication_web_site` - Website of the contact
* `address_line1` - First line of the address, usually the street name
* `address_line2` - Second line of the address, usually the complement
* `address_number` - Street number of the address
* `address_district` - District or neighbourhood
* `address_city` - City of the address
* `address_state` - Brazilian state (UF) of the address
* `address_zip_code` - Postal code (CEP) of the address
* `address_country` - Country of the address
* `address_ibge_code` - IBGE code of the city, used by Brazilian tax documents
* `bank_account_information_bank` - Bank where the contact holds the account used for payments or receipts
* `bank_account_information_agency` - Branch number of the contact's bank account
* `bank_account_information_account_number` - Account number of the contact's bank account
* `company_information_company_name` - Registered legal name (razao social) when the contact is a company
* `company_information_municipal_inscription` - Municipal taxpayer registration of the company, used when issuing invoices
* `update_date` - Timestamp of the last change made to the contact
* `update_user` - User who last changed the contact
Partners (socios) of the company, used on profit distribution entries.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the contact in Nibo
* `name` - Display name of the contact
* `initials_name` - Short name or initials shown by Nibo when space is limited
* `email` - Main email address of the contact
* `phone` - Main phone number of the contact
* `type` - Kind of contact as classified by Nibo: customer, supplier, employee or partner
* `person_type` - Numeric code telling whether the contact is an individual or a company
* `is_company` - Whether the contact is a legal entity (company) rather than an individual
* `is_deleted` - Whether the contact has been deleted in Nibo
* `is_archived` - Whether the contact has been archived and is no longer offered for new entries
* `document_number` - Brazilian tax document of the contact (CPF for individuals, CNPJ for companies)
* `document_type` - Which tax document the number refers to (CPF or CNPJ)
* `communication_contact_name` - Name of the person to contact at this customer, supplier or partner
* `communication_email` - Email used for billing and notification messages sent by Nibo
* `communication_phone` - Landline number registered for communication with the contact
* `communication_cell_phone` - Mobile number registered for communication with the contact
* `communication_web_site` - Website of the contact
* `address_line1` - First line of the address, usually the street name
* `address_line2` - Second line of the address, usually the complement
* `address_number` - Street number of the address
* `address_district` - District or neighbourhood
* `address_city` - City of the address
* `address_state` - Brazilian state (UF) of the address
* `address_zip_code` - Postal code (CEP) of the address
* `address_country` - Country of the address
* `address_ibge_code` - IBGE code of the city, used by Brazilian tax documents
* `bank_account_information_bank` - Bank where the contact holds the account used for payments or receipts
* `bank_account_information_agency` - Branch number of the contact's bank account
* `bank_account_information_account_number` - Account number of the contact's bank account
* `company_information_company_name` - Registered legal name (razao social) when the contact is a company
* `company_information_municipal_inscription` - Municipal taxpayer registration of the company, used when issuing invoices
* `update_date` - Timestamp of the last change made to the contact
* `update_user` - User who last changed the contact
Categories used to classify receivables and payables. This is the dimension a profit and loss report groups by.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the category
* `name` - Name of the category
* `type` - Whether the category classifies money in (in) or money out (out)
* `group_id` - Identifier of the group the category belongs to
* `group_name` - Name of the group the category belongs to
* `subgroup_id` - Identifier of the subgroup the category belongs to
* `subgroup_name` - Name of the subgroup the category belongs to
* `is_editable` - Whether the category was created by the company and can be edited
Top level groups the categories are organized into.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the category group
* `name` - Name of the category group
* `reference_code` - Code Nibo uses to reference the group in reports
Full hierarchy of groups, subgroups and categories, with each group's children as a JSON array.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the group
* `name` - Name of the group
* `reference_code` - Code Nibo uses to reference the group in reports
* `order` - Position of the group in the hierarchy shown in Nibo
* `children` - Categories and subgroups under this group (JSON array with id, name, type, isSubgroup, isEditable, order and isDeleted for each child)
Cost centers used to split an entry across areas of the company.
**Primary key:** `cost_center_id`
**Fields:**
* `cost_center_id` - Unique identifier of the cost centre
* `description` - Name of the cost centre as shown in Nibo
* `update_date` - Timestamp of the last change made to the cost centre
* `update_user` - User who last changed the cost centre
Every schedule of the company, receivables and payables together. This is the only endpoint that also returns the recurrence and the boleto linked to each schedule.
**Primary key:** `schedule_id`
**Fields:**
* `schedule_id` - Unique identifier of the schedule
* `type` - Kind of schedule: a receivable (credit) or a payable (debit)
* `description` - Description given to the schedule in Nibo
* `value` - Full amount of the schedule
* `paid_value` - Amount already settled, whether received or paid
* `open_value` - Amount still outstanding on the schedule
* `due_date` - Date the schedule is due to be received or paid
* `schedule_date` - Date the schedule was recorded for, used as the cash-basis date
* `accrual_date` - Date the schedule is recognised on, used as the accrual-basis date
* `is_paid` - Whether the schedule has been fully settled
* `is_dued` - Whether the schedule is past its due date and still open
* `is_entry` - Whether the schedule represents money coming in
* `is_bill` - Whether the schedule is billed with a Brazilian bank slip (boleto)
* `is_debit_note` - Whether the schedule is a debit note
* `is_flagged` - Whether the schedule was flagged for attention in Nibo
* `is_payment_scheduled` - Whether a payment has already been scheduled with the bank
* `stakeholder_id` - Identifier of the contact the schedule refers to
* `stakeholder_name` - Name of the contact the schedule refers to
* `stakeholder_type` - Kind of contact: customer, supplier, employee or partner
* `stakeholder_cpf_cnpj` - Tax document (CPF or CNPJ) of the contact
* `stakeholder_is_deleted` - Whether the contact has been deleted in Nibo
* `category_id` - Identifier of the category the schedule is classified under
* `category_name` - Name of the category the schedule is classified under
* `category_type` - Whether the category classifies money in (in) or money out (out)
* `category_is_deleted` - Whether the category has been deleted in Nibo
* `categories` - Every category the amount was split across (JSON array with categoryId, categoryName, value, type and the parent category)
* `cost_center_id` - Identifier of the main cost centre of the schedule
* `cost_center_description` - Name of the main cost centre of the schedule
* `cost_center_is_deleted` - Whether the cost centre has been deleted in Nibo
* `cost_centers` - Every cost centre the amount was split across (JSON array with costCenterId, percent and value)
* `cost_center_value_type` - Whether the cost centre split is expressed as a percentage or an amount
* `has_installment` - Whether the schedule is one instalment of a larger agreement
* `installment_id` - Identifier shared by every schedule of the same instalment plan
* `has_recurrence` - Whether the schedule repeats on a recurring basis
* `recurrence_id` - Identifier shared by every schedule of the same recurrence
* `recurrence_interval` - How many periods there are between two occurrences
* `recurrence_interval_type` - Numeric code for the period the interval is counted in (day, month, year)
* `recurrence_end_type` - Numeric code for how the recurrence ends (never, on a date, after N times)
* `recurrence_provision_in_advance` - How many future occurrences Nibo creates in advance
* `recurrence_base_day` - Day of the month the recurrence falls on
* `has_invoice` - Whether a service invoice (NFS-e) has been issued for the schedule
* `has_pending_invoice` - Whether a service invoice is still waiting to be issued
* `has_schedule_invoice` - Whether the invoice is scheduled to be issued automatically
* `auto_generate_nf_se_type` - Numeric code for when Nibo issues the service invoice automatically
* `auto_generate_collection_type` - Numeric code for when Nibo issues the bank slip automatically
* `collection_id` - Identifier of the bank slip issued for the schedule
* `collection_status_code` - Numeric status of the bank slip issued for the schedule
* `collection_status_description` - Human readable status of the bank slip issued for the schedule
* `has_entry_promise` - Whether a payment promise was recorded for the schedule
* `has_open_entry_promise` - Whether a payment promise is still open for the schedule
* `auto_generate_entry_promise` - Whether Nibo records the payment promise automatically
* `custom_attributes` - Custom fields defined by the company (JSON object). The keys differ from company to company, so the value is kept as JSON
* `create_date` - Timestamp when the schedule was created in Nibo
* `create_user` - User who created the schedule
* `update_date` - Timestamp of the last change made to the schedule
* `update_user` - User who last changed the schedule
Accounts receivable: everything the company is scheduled to receive.
**Primary key:** `schedule_id`
**Fields:**
* `schedule_id` - Unique identifier of the schedule
* `type` - Kind of schedule: a receivable (credit) or a payable (debit)
* `description` - Description given to the schedule in Nibo
* `value` - Full amount of the schedule
* `paid_value` - Amount already settled, whether received or paid
* `open_value` - Amount still outstanding on the schedule
* `due_date` - Date the schedule is due to be received or paid
* `schedule_date` - Date the schedule was recorded for, used as the cash-basis date
* `accrual_date` - Date the schedule is recognised on, used as the accrual-basis date
* `is_paid` - Whether the schedule has been fully settled
* `is_dued` - Whether the schedule is past its due date and still open
* `is_entry` - Whether the schedule represents money coming in
* `is_bill` - Whether the schedule is billed with a Brazilian bank slip (boleto)
* `is_debit_note` - Whether the schedule is a debit note
* `is_flagged` - Whether the schedule was flagged for attention in Nibo
* `is_payment_scheduled` - Whether a payment has already been scheduled with the bank
* `stakeholder_id` - Identifier of the contact the schedule refers to
* `stakeholder_name` - Name of the contact the schedule refers to
* `stakeholder_type` - Kind of contact: customer, supplier, employee or partner
* `stakeholder_cpf_cnpj` - Tax document (CPF or CNPJ) of the contact
* `stakeholder_is_deleted` - Whether the contact has been deleted in Nibo
* `category_id` - Identifier of the category the schedule is classified under
* `category_name` - Name of the category the schedule is classified under
* `category_type` - Whether the category classifies money in (in) or money out (out)
* `category_is_deleted` - Whether the category has been deleted in Nibo
* `categories` - Every category the amount was split across (JSON array with categoryId, categoryName, value, type and the parent category)
* `cost_center_id` - Identifier of the main cost centre of the schedule
* `cost_center_description` - Name of the main cost centre of the schedule
* `cost_center_is_deleted` - Whether the cost centre has been deleted in Nibo
* `cost_centers` - Every cost centre the amount was split across (JSON array with costCenterId, percent and value)
* `cost_center_value_type` - Whether the cost centre split is expressed as a percentage or an amount
* `has_installment` - Whether the schedule is one instalment of a larger agreement
* `installment_id` - Identifier shared by every schedule of the same instalment plan
* `has_recurrence` - Whether the schedule repeats on a recurring basis
* `recurrence_id` - Identifier shared by every schedule of the same recurrence
* `recurrence_interval` - How many periods there are between two occurrences
* `recurrence_interval_type` - Numeric code for the period the interval is counted in (day, month, year)
* `recurrence_end_type` - Numeric code for how the recurrence ends (never, on a date, after N times)
* `recurrence_provision_in_advance` - How many future occurrences Nibo creates in advance
* `recurrence_base_day` - Day of the month the recurrence falls on
* `has_invoice` - Whether a service invoice (NFS-e) has been issued for the schedule
* `has_pending_invoice` - Whether a service invoice is still waiting to be issued
* `has_schedule_invoice` - Whether the invoice is scheduled to be issued automatically
* `auto_generate_nf_se_type` - Numeric code for when Nibo issues the service invoice automatically
* `auto_generate_collection_type` - Numeric code for when Nibo issues the bank slip automatically
* `collection_id` - Identifier of the bank slip issued for the schedule
* `collection_status_code` - Numeric status of the bank slip issued for the schedule
* `collection_status_description` - Human readable status of the bank slip issued for the schedule
* `has_entry_promise` - Whether a payment promise was recorded for the schedule
* `has_open_entry_promise` - Whether a payment promise is still open for the schedule
* `auto_generate_entry_promise` - Whether Nibo records the payment promise automatically
* `custom_attributes` - Custom fields defined by the company (JSON object). The keys differ from company to company, so the value is kept as JSON
* `create_date` - Timestamp when the schedule was created in Nibo
* `create_user` - User who created the schedule
* `update_date` - Timestamp of the last change made to the schedule
* `update_user` - User who last changed the schedule
Accounts payable: everything the company is scheduled to pay.
**Primary key:** `schedule_id`
**Fields:**
* `schedule_id` - Unique identifier of the schedule
* `type` - Kind of schedule: a receivable (credit) or a payable (debit)
* `description` - Description given to the schedule in Nibo
* `value` - Full amount of the schedule
* `paid_value` - Amount already settled, whether received or paid
* `open_value` - Amount still outstanding on the schedule
* `due_date` - Date the schedule is due to be received or paid
* `schedule_date` - Date the schedule was recorded for, used as the cash-basis date
* `accrual_date` - Date the schedule is recognised on, used as the accrual-basis date
* `is_paid` - Whether the schedule has been fully settled
* `is_dued` - Whether the schedule is past its due date and still open
* `is_entry` - Whether the schedule represents money coming in
* `is_bill` - Whether the schedule is billed with a Brazilian bank slip (boleto)
* `is_debit_note` - Whether the schedule is a debit note
* `is_flagged` - Whether the schedule was flagged for attention in Nibo
* `is_payment_scheduled` - Whether a payment has already been scheduled with the bank
* `stakeholder_id` - Identifier of the contact the schedule refers to
* `stakeholder_name` - Name of the contact the schedule refers to
* `stakeholder_type` - Kind of contact: customer, supplier, employee or partner
* `stakeholder_cpf_cnpj` - Tax document (CPF or CNPJ) of the contact
* `stakeholder_is_deleted` - Whether the contact has been deleted in Nibo
* `category_id` - Identifier of the category the schedule is classified under
* `category_name` - Name of the category the schedule is classified under
* `category_type` - Whether the category classifies money in (in) or money out (out)
* `category_is_deleted` - Whether the category has been deleted in Nibo
* `categories` - Every category the amount was split across (JSON array with categoryId, categoryName, value, type and the parent category)
* `cost_center_id` - Identifier of the main cost centre of the schedule
* `cost_center_description` - Name of the main cost centre of the schedule
* `cost_center_is_deleted` - Whether the cost centre has been deleted in Nibo
* `cost_centers` - Every cost centre the amount was split across (JSON array with costCenterId, percent and value)
* `cost_center_value_type` - Whether the cost centre split is expressed as a percentage or an amount
* `has_installment` - Whether the schedule is one instalment of a larger agreement
* `installment_id` - Identifier shared by every schedule of the same instalment plan
* `has_recurrence` - Whether the schedule repeats on a recurring basis
* `recurrence_id` - Identifier shared by every schedule of the same recurrence
* `recurrence_interval` - How many periods there are between two occurrences
* `recurrence_interval_type` - Numeric code for the period the interval is counted in (day, month, year)
* `recurrence_end_type` - Numeric code for how the recurrence ends (never, on a date, after N times)
* `recurrence_provision_in_advance` - How many future occurrences Nibo creates in advance
* `recurrence_base_day` - Day of the month the recurrence falls on
* `has_invoice` - Whether a service invoice (NFS-e) has been issued for the schedule
* `has_pending_invoice` - Whether a service invoice is still waiting to be issued
* `has_schedule_invoice` - Whether the invoice is scheduled to be issued automatically
* `auto_generate_nf_se_type` - Numeric code for when Nibo issues the service invoice automatically
* `auto_generate_collection_type` - Numeric code for when Nibo issues the bank slip automatically
* `collection_id` - Identifier of the bank slip issued for the schedule
* `collection_status_code` - Numeric status of the bank slip issued for the schedule
* `collection_status_description` - Human readable status of the bank slip issued for the schedule
* `has_entry_promise` - Whether a payment promise was recorded for the schedule
* `has_open_entry_promise` - Whether a payment promise is still open for the schedule
* `auto_generate_entry_promise` - Whether Nibo records the payment promise automatically
* `custom_attributes` - Custom fields defined by the company (JSON object). The keys differ from company to company, so the value is kept as JSON
* `create_date` - Timestamp when the schedule was created in Nibo
* `create_user` - User who created the schedule
* `update_date` - Timestamp of the last change made to the schedule
* `update_user` - User who last changed the schedule
Receivables that were actually received, already linked to the bank account they hit.
**Primary key:** `entry_id`
**Fields:**
* `entry_id` - Unique identifier of the entry
* `schedule_id` - Identifier of the schedule this entry settles
* `date` - Date the money moved, used as the cash-basis date
* `accrual_date` - Date the entry is recognised on, used as the accrual-basis date
* `value` - Amount received or paid
* `description` - Description recorded for the entry
* `identifier` - Identifier Nibo shows for the entry on the account statement
* `reference` - Free reference recorded with the entry, such as a document number
* `check_num` - Cheque number, when paid by cheque
* `is_virtual` - Whether the entry sits in a virtual account rather than a real one
* `is_reconciliated` - Whether the entry has been reconciled against the bank statement
* `is_transfer` - Whether the entry is one leg of a transfer between own accounts
* `is_flagged` - Whether the entry was flagged for attention in Nibo
* `bank_balance_date_is_greater_than_entry_date` - Whether the bank balance is already more recent than this entry, which means the entry is covered by the imported statement
* `account_id` - Identifier of the bank account the money moved through
* `account_name` - Name of the bank account the money moved through
* `account_is_deleted` - Whether that bank account has been deleted in Nibo
* `stakeholder_id` - Identifier of the contact the money was received from or paid to
* `stakeholder_name` - Name of the contact the money was received from or paid to
* `stakeholder_is_deleted` - Whether the contact has been deleted in Nibo
* `category_id` - Identifier of the category the entry is classified under
* `category_name` - Name of the category the entry is classified under
* `category_type` - Whether the category classifies money in (in) or money out (out)
* `category_is_deleted` - Whether the category has been deleted in Nibo
* `categories` - Every category the amount was split across (JSON array with categoryId, categoryName, value, type and the parent category)
* `cost_center_id` - Identifier of the main cost centre of the entry
* `cost_center_description` - Name of the main cost centre of the entry
* `cost_centers` - Every cost centre the amount was split across (JSON array with costCenterId, percent and value)
Payables that were actually paid, already linked to the bank account they hit.
**Primary key:** `entry_id`
**Fields:**
* `entry_id` - Unique identifier of the entry
* `schedule_id` - Identifier of the schedule this entry settles
* `date` - Date the money moved, used as the cash-basis date
* `accrual_date` - Date the entry is recognised on, used as the accrual-basis date
* `value` - Amount received or paid
* `description` - Description recorded for the entry
* `identifier` - Identifier Nibo shows for the entry on the account statement
* `reference` - Free reference recorded with the entry, such as a document number
* `check_num` - Cheque number, when paid by cheque
* `is_virtual` - Whether the entry sits in a virtual account rather than a real one
* `is_reconciliated` - Whether the entry has been reconciled against the bank statement
* `is_transfer` - Whether the entry is one leg of a transfer between own accounts
* `is_flagged` - Whether the entry was flagged for attention in Nibo
* `bank_balance_date_is_greater_than_entry_date` - Whether the bank balance is already more recent than this entry, which means the entry is covered by the imported statement
* `account_id` - Identifier of the bank account the money moved through
* `account_name` - Name of the bank account the money moved through
* `account_is_deleted` - Whether that bank account has been deleted in Nibo
* `stakeholder_id` - Identifier of the contact the money was received from or paid to
* `stakeholder_name` - Name of the contact the money was received from or paid to
* `stakeholder_is_deleted` - Whether the contact has been deleted in Nibo
* `category_id` - Identifier of the category the entry is classified under
* `category_name` - Name of the category the entry is classified under
* `category_type` - Whether the category classifies money in (in) or money out (out)
* `category_is_deleted` - Whether the category has been deleted in Nibo
* `categories` - Every category the amount was split across (JSON array with categoryId, categoryName, value, type and the parent category)
* `cost_center_id` - Identifier of the main cost centre of the entry
* `cost_center_description` - Name of the main cost centre of the entry
* `cost_centers` - Every cost centre the amount was split across (JSON array with costCenterId, percent and value)
Brazilian service invoices (NFS-e) issued through Nibo, with every tax block flattened into its own column.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the service invoice
* `status_code` - Numeric status of the invoice in Nibo
* `status_description` - Human readable status of the invoice, such as issued or cancelled
* `last_message` - Last message Nibo recorded about the invoice
* `last_status_message` - Last message returned by the city hall about the invoice
* `last_status_change` - Timestamp of the last status change of the invoice
* `value` - Total amount of the invoice
* `deductions` - Amount deducted from the base used to calculate the taxes
* `discounts` - Discount granted on the invoice
* `remarks` - Free remarks printed on the invoice
* `schedule_id` - Identifier of the receivable the invoice was issued for
* `schedule_due_date` - Due date of the receivable the invoice was issued for
* `schedule_date` - Date recorded on the receivable the invoice was issued for
* `schedule_value` - Amount of the receivable the invoice was issued for
* `schedule_description` - Description of the receivable the invoice was issued for
* `schedule_is_deleted` - Whether that receivable has been deleted in Nibo
* `service_profile_id` - Identifier of the service profile used to issue the invoice
* `service_profile_name` - Name of the service profile used to issue the invoice
* `service_profile_is_deleted` - Whether that service profile has been deleted in Nibo
* `stakeholder_id` - Identifier of the contact the invoice was issued to
* `stakeholder_name` - Name of the contact the invoice was issued to
* `stakeholder_type` - Kind of contact the invoice was issued to
* `stakeholder_is_deleted` - Whether that contact has been deleted in Nibo
* `customer_name` - Name of the customer as printed on the invoice
* `customer_cpf_cnpj` - Tax document (CPF or CNPJ) of the customer on the invoice
* `customer_email` - Email the invoice was sent to
* `customer_phone` - Phone number of the customer on the invoice
* `customer_legal_type` - Legal nature of the customer, individual or company
* `customer_address_address` - Street of the customer address printed on the invoice
* `customer_address_number` - Street number of the customer address
* `customer_address_complement` - Complement of the customer address
* `customer_address_district` - District of the customer address
* `customer_address_city` - City of the customer address
* `customer_address_uf` - Brazilian state (UF) of the customer address
* `customer_address_postal_code` - Postal code (CEP) of the customer address
* `service_city_service_code` - Service code defined by the city hall for the service provided
* `service_cnae_code` - CNAE code of the economic activity the service belongs to
* `service_list_item_lc116` - Item of the LC 116 national service list the service falls under
* `service_remove_iss_value_from_base_value_to_calculate_pis_and_cofins` - Whether the ISS is removed from the base used to calculate PIS and COFINS
* `service_iss_aliquot` - ISS rate applied
* `service_iss_value` - ISS amount of the invoice
* `service_iss_retained` - Whether the ISS is withheld by the customer
* `service_iss_retained_description` - Reason recorded for withholding the ISS
* `service_pis_aliquot` - PIS rate applied
* `service_pis_value` - PIS amount of the invoice
* `service_pis_retained` - Whether the PIS is withheld by the customer
* `service_pis_reduction_base` - Reduction applied to the PIS calculation base
* `service_cofins_aliquot` - COFINS rate applied
* `service_cofins_value` - COFINS amount of the invoice
* `service_cofins_retained` - Whether the COFINS is withheld by the customer
* `service_cofins_reduction_base` - Reduction applied to the COFINS calculation base
* `service_csll_aliquot` - CSLL rate applied
* `service_csll_value` - CSLL amount of the invoice
* `service_csll_retained` - Whether the CSLL is withheld by the customer
* `service_ir_aliquot` - Income tax (IR) rate applied
* `service_ir_value` - Income tax (IR) amount of the invoice
* `service_ir_retained` - Whether the income tax is withheld by the customer
* `service_inss_aliquot` - INSS rate applied
* `service_inss_value` - INSS amount of the invoice
* `service_inss_retained` - Whether the INSS is withheld by the customer
* `service_inss_reduction_base` - Reduction applied to the INSS calculation base
* `service_federal_tax_aliquot` - Aggregated federal tax rate printed on the invoice
* `service_federal_tax_value` - Aggregated federal tax amount printed on the invoice
* `create_date` - Timestamp when the invoice was created in Nibo
* `create_user` - User who created the invoice
* `update_date` - Timestamp of the last change made to the invoice
* `update_user` - User who last changed the invoice
Service profiles: the reusable tax templates a service invoice is issued from.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the service profile
* `name` - Name of the service profile
* `description` - Description of the service printed on the invoice
* `additional_remarks` - Additional remarks printed on every invoice issued with this profile
* `is_suggestion` - Whether the profile was suggested by Nibo rather than created by the company
* `city_service_code` - Service code defined by the city hall for this profile
* `cnae_code` - CNAE code of the economic activity of this profile
* `service_list_item_lc116` - Item of the LC 116 national service list this profile falls under
* `remove_iss_value_from_base_value_to_calculate_pis_and_cofins` - Whether the ISS is removed from the base used to calculate PIS and COFINS
* `iss_aliquot` - ISS rate configured on the profile
* `iss_retained` - Whether invoices issued with this profile withhold the ISS
* `pis_aliquot` - PIS rate configured on the profile
* `pis_retained` - Whether invoices issued with this profile withhold the PIS
* `pis_reduction_base` - Reduction applied to the PIS calculation base
* `cofins_aliquot` - COFINS rate configured on the profile
* `cofins_retained` - Whether invoices issued with this profile withhold the COFINS
* `cofins_reduction_base` - Reduction applied to the COFINS calculation base
* `csll_aliquot` - CSLL rate configured on the profile
* `csll_retained` - Whether invoices issued with this profile withhold the CSLL
* `ir_aliquot` - Income tax (IR) rate configured on the profile
* `ir_retained` - Whether invoices issued with this profile withhold the income tax
* `inss_aliquot` - INSS rate configured on the profile
* `inss_retained` - Whether invoices issued with this profile withhold the INSS
* `inss_reduction_base` - Reduction applied to the INSS calculation base
* `federal_tax_aliquot` - Aggregated federal tax rate configured on the profile
* `construction_enabled` - Whether the profile supports construction specific invoice fields
* `event_enabled` - Whether the profile supports event specific invoice fields
Brazilian bank slips (boletos) issued to customers through Nibo.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the bank slip
* `schedule_id` - Identifier of the receivable the bank slip was issued for
* `stakeholder_id` - Identifier of the customer the bank slip was issued to
* `collection_profile_id` - Identifier of the profile whose fine, interest and reminder rules were applied
* `description` - Description printed on the bank slip
* `due_date` - Date the bank slip is due
* `value` - Amount charged on the bank slip
* `paid_value` - Amount actually paid by the customer
* `status_code` - Numeric status of the bank slip
* `status_description` - Human readable status of the bank slip, such as open, paid or cancelled
* `las_status_change_date` - Timestamp of the last status change of the bank slip. The field name carries the typo Nibo uses in its API
* `debtor_name` - Name of the customer being charged
* `debtor_document` - Tax document (CPF or CNPJ) of the customer being charged
* `beneficiary_name` - Name of the company receiving the payment
* `beneficiary_document` - Tax document (CNPJ) of the company receiving the payment
* `url` - Link where the customer can pay the bank slip
* `pdf` - Link to the PDF version of the bank slip
* `create_date` - Timestamp when the bank slip was issued
* `create_user` - User who issued the bank slip
Profiles that define the fine, interest and reminder rules applied to boletos.
**Primary key:** `id`
**Fields:**
* `id` - Unique identifier of the collection profile
* `organization_id` - Identifier of the company the profile belongs to
* `name` - Name of the collection profile
* `fine_percentage` - Fine charged, as a percentage, once the bank slip is overdue
* `interest_percentage` - Interest charged, as a percentage, while the bank slip stays overdue
* `interest_period_type_code` - Numeric code for the period the interest rate refers to
* `interest_period_type_description` - Period the interest rate refers to, such as per day or per month
* `display_beneficiary_business_name` - Whether the legal name of the company is printed on the bank slip
* `notification_strategy_json` - Rules for the reminders sent to the customer, as the JSON string Nibo returns
* `payment_methods` - Payment methods accepted by the profile (JSON array with paymentForm and provider)
* `create_date` - Timestamp when the profile was created
* `create_user` - User who created the profile
* `update_date` - Timestamp of the last change made to the profile
* `update_user` - User who last changed the profile
Budget planned per category, exploded into one row per category and month.
**Primary key:** `year`, `category_id`, `month`
**Fields:**
* `organization_id` - Identifier of the company the budget belongs to
* `year` - Year the budget was planned for
* `month` - Month of the year the planned amount refers to, from 1 to 12
* `category_id` - Identifier of the category the amount was budgeted for
* `value` - Amount planned for this category in this month