> ## 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.

# FlyUp BPO as a data source

> Bring financial entries, bank balances, bank reconciliations, income statements (DRE) and financial planning from FlyUp BPO to Nekt.

FlyUp BPO is a financial back-office (BPO) platform: accounts payable and receivable, bank reconciliation, cash flow, income statement (DRE) and financial planning for companies whose finances are managed in it. This connector signs in to FlyUp BPO with a user's email and password and brings the financial entries, scheduled entries, bank accounts and their monthly balances, the bank reconciliations with their imported statement lines, the income statements, financial goals and plans, and the registries you need to read them: companies (clients), units, customers and suppliers, projects and the chart of accounts.

> [!NOTE]
>
> The connector only reads data. It never creates, changes or deletes anything in FlyUp BPO.

## Configuring FlyUp BPO 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 FlyUp BPO option from the list of connectors.

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

### 1. Add account access

The connector signs in with the **email and password of a FlyUp BPO user**, the same ones used to sign in to the FlyUp BPO web app. It sees exactly what that user sees: a company user sees its own company (or companies), and a FlyUp BPO operator sees the companies assigned to them. We recommend a user created for Nekt, so that a password change by a person does not stop your syncs.

The following configurations are available:

* **Email**: Email of the FlyUp BPO user.
* **Password**: Password of that user.
* **Client IDs** (advanced, optional): Comma-separated identifiers (UUIDs) of the FlyUp BPO companies (clients) to sync. Leave it empty to sync every company the user can see. You can find the identifiers in the `id` column of the **Clients** table after a first sync. Every identifier must be a company this user can see, otherwise the sync stops with a message naming it. **Plan Groups**, **Proposals** and **Contracts** don't belong to a company, so they are always synced in full.

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.

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**: every FlyUp BPO stream is FULL\_TABLE: every time the extraction happens, we get the current state of the data, so records deleted in FlyUp BPO also leave your catalog.

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.md), 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 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).

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.

# Streams and Fields

## Available streams

The table below lists every stream, its **slug** (the exact identifier to pass when creating the source via API) and a short description.

| Stream | Slug | Description |
| - | - | - |
| Transactions | `transactions` | Financial entries: payables, receivables and realized cash movements (cash flow). |
| Scheduled Transactions | `scheduled_transactions` | Scheduled entries: installment plans, recurrences and single future entries. |
| Bank Accounts | `bank_accounts` | Bank accounts (and cards, gateways, marketplaces) of each client, with the current balance. |
| Bank Account Balance History | `bank_account_balance_history` | Monthly balance history per bank account: realized and forecast debits and credits. |
| Conciliations | `conciliations` | Bank reconciliations: one per imported bank statement (OFX, Excel, PDF, Open Finance or manual). |
| Imported Transactions | `imported_transactions` | Bank-statement lines imported for reconciliation, with their reconciliation status. |
| DRE (Income Statement) | `dre` | Income statements (DRE) stored by FlyUp BPO per client, period and unit. |
| Financial Goals | `financial_goals` | Yearly financial goals (budget) per client, with pessimistic, realistic and optimistic scenarios. |
| Financial Plans | `financial_plans` | Financial plans (planned values per scenario) of each financial goal. |
| Scenario Analyses | `scenario_analyses` | What-if scenario analyses (desired margin, average price) per client and year. |
| Clients | `clients` | FlyUp BPO clients (the companies whose finances are managed) visible to the source's user. |
| Units | `units` | Business units (branches) of each client. |
| Customers and Suppliers | `persons` | Customers and suppliers (pessoas) used in the financial entries. |
| Projects | `projects` | Projects (cost centers) of each client. |
| Plan Groups | `plan_groups` | Top level of the chart of accounts: groups and how they enter the income statement (DRE). |
| Plan Categories | `plan_categories` | Second level of the chart of accounts: categories inside each group, per client. |
| Plan Subcategories | `plan_subcategories` | Third level of the chart of accounts: the subcategories financial entries are classified in. |
| Proposals | `proposals` | Commercial proposals sent from FlyUp BPO. |
| Contracts | `contracts` | Contracts generated from FlyUp BPO and their signature status. |

## Fields by stream

### Financial entries and cash

> [accordion] Transactions
>
> Financial entries: payables, receivables and realized cash movements (cash flow).
>
> Table: `transactions` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the financial entry. |
> | `client_id` | String | Identifier (UUID) of the FlyUp BPO client (company) the entry belongs to. |
> | `status` | String | Status of the entry (PAID, RECEIVED, OPEN, CANCELLED, DELAYED, REVERSED, PAY\_TODAY, RECEIVE\_TODAY, PENDING). |
> | `transaction_date` | Date | Date of the entry (competence date). |
> | `realized_date` | Date | Date the entry was paid or received. |
> | `expiration_date` | Date | Due date of the entry. |
> | `description` | String | Description of the entry. |
> | `to_receive` | Integer | Amount to receive. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `to_pay` | Integer | Amount to pay. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `entry_flow` | Integer | Realized inflow. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `outflow` | Integer | Realized outflow. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `discount` | Integer | Discount. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `interest` | Integer | Interest. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `fine` | Integer | Late fine. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `plan_id` | Integer | Identifier of the chart-of-accounts subcategory (plano de contas) of the entry, when FlyUp BPO returns it. |
> | `plan_name` | String | Name of the chart-of-accounts subcategory (plano de contas) of the entry as FlyUp BPO displays it. |
> | `person_id` | Integer | Identifier of the customer or supplier of the entry, when FlyUp BPO returns it. |
> | `person_name` | String | Name of the customer or supplier of the entry as FlyUp BPO displays it. |
> | `project_id` | Integer | Identifier of the project (cost center) of the entry, when FlyUp BPO returns it. |
> | `project_name` | String | Name of the project (cost center) of the entry as FlyUp BPO displays it. |
> | `bank_account_id` | Integer | Identifier of the bank account of the entry, when FlyUp BPO returns it. |
> | `bank_account_name` | String | Name of the bank account of the entry as FlyUp BPO displays it. |
> | `unit_id` | Integer | Identifier of the business unit of the entry, when FlyUp BPO returns it. |
> | `unit_name` | String | Name of the business unit of the entry as FlyUp BPO displays it. |
> | `scheduled_transaction_id` | Integer | Identifier of the scheduled entry (installment or recurrence) that generated this entry. |
> | `imported_transaction_id` | Integer | Identifier of the imported bank-statement line this entry was reconciled with. |
> | `period_locked_until` | Date | The bank account is closed up to this date, so the entry can no longer be changed. |
> | `is_active` | Boolean | Whether the entry is active (inactive entries were removed in FlyUp BPO). |
> | `document` | String | Link to the document attached to the entry. |
> | `requires_document` | Boolean | Whether the entry requires a document. |
> | `proof` | String | Link to the payment proof attached to the entry. |
> | `requires_proof` | Boolean | Whether the entry requires a payment proof. |
> | `payment_method` | String | Payment method (PIX, BOLETO, TED, DDA, DEBITO\_AUTOMATICO, CHEQUE, CARTAO, DINHEIRO, OUTRO). |
> | `payment_complement` | String | Payment details (PIX key, barcode, card data, etc.). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Scheduled Transactions
>
> Scheduled entries: installment plans, recurrences and single future entries.
>
> Table: `scheduled_transactions` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the scheduled entry. |
> | `client_id` | String | Identifier (UUID) of the FlyUp BPO client (company) the scheduled entry belongs to. |
> | `type_of_transaction` | String | Kind of schedule (INSTALLMENT, RECURRENT, SINGLE). |
> | `installment` | Integer | Number of installments. |
> | `recurrence` | String | Recurrence (DAILY, WEEKLY, BI\_WEEKLY, MONTHLY, QUARTERLY, SEMI\_ANNUAL, YEARLY). |
> | `status` | String | Status of the entry (PAID, RECEIVED, OPEN, CANCELLED, DELAYED, REVERSED, PAY\_TODAY, RECEIVE\_TODAY, PENDING). |
> | `date` | Date | Date of the scheduled entry. |
> | `realized_date` | Date | Date the scheduled entry was paid or received. |
> | `expiration_date` | Date | Due date of the scheduled entry. |
> | `description` | String | Description of the scheduled entry. |
> | `to_receive` | Integer | Amount to receive. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `to_pay` | Integer | Amount to pay. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `discount` | Integer | Discount. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `interest` | Integer | Interest. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `fine` | Integer | Late fine. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `plan_id` | Integer | Identifier of the chart-of-accounts subcategory (plano de contas), when FlyUp BPO returns it. |
> | `plan_name` | String | Name of the chart-of-accounts subcategory (plano de contas) as FlyUp BPO displays it. |
> | `person_id` | Integer | Identifier of the customer or supplier, when FlyUp BPO returns it. |
> | `person_name` | String | Name of the customer or supplier as FlyUp BPO displays it. |
> | `project_id` | Integer | Identifier of the project (cost center), when FlyUp BPO returns it. |
> | `project_name` | String | Name of the project (cost center) as FlyUp BPO displays it. |
> | `bank_account_id` | Integer | Identifier of the bank account, when FlyUp BPO returns it. |
> | `bank_account_name` | String | Name of the bank account as FlyUp BPO displays it. |
> | `unit_id` | Integer | Identifier of the business unit, when FlyUp BPO returns it. |
> | `unit_name` | String | Name of the business unit as FlyUp BPO displays it. |
> | `is_dda` | Boolean | Whether the entry comes from a Direct Debit Authorization (DDA). |
> | `payment_method` | String | Payment method (PIX, BOLETO, TED, DDA, DEBITO\_AUTOMATICO, CHEQUE, CARTAO, DINHEIRO, OUTRO). |
> | `payment_complement` | String | Payment details (PIX key, barcode, card data, etc.). |
> | `is_active` | Boolean | Whether the scheduled entry is active. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Bank Accounts
>
> Bank accounts (and cards, gateways, marketplaces) of each client, with the current balance.
>
> Table: `bank_accounts` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the bank account. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company) that owns the account. |
> | `name` | String | Name of the bank account. |
> | `agency` | String | Bank branch (agência). |
> | `account_number` | String | Account number. |
> | `bank_code` | String | Bank code. |
> | `account_type` | String | Kind of account (CHECKING, INVESTMENT, CREDIT\_CARD, PAYMENT\_GATEWAY, MARKETPLACES). |
> | `balance` | Integer | Current balance. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `balance_initial_date` | Date | Date of the opening balance. |
> | `balance_initial_value` | Integer | Opening balance. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `is_active` | Boolean | Whether the account is active. |
> | `is_auto_conciliated` | Boolean | Whether the account is reconciled automatically. |
> | `ai_auto_conciliation_enabled` | Boolean | Whether AI auto-reconciliation is enabled for the account. |
> | `ai_auto_conciliation_threshold` | Number | Minimum score (0.0 to 1.0) for AI auto-reconciliation. |
> | `closed_until` | Date | Entries realized up to this date (inclusive) can no longer be changed. |
> | `last_conciliation_date` | String | Date of the last bank reconciliation, as FlyUp BPO returns it. |
> | `last_transaction_date` | String | Date of the last entry of the account, as FlyUp BPO returns it. |
> | `conciliation_status` | String | Reconciliation status of the account. |
> | `conciliation_status_reason` | String | Why the account has its reconciliation status. |
> | `consent` | String (JSON) | Open Finance consent linked to the account (JSON when FlyUp BPO returns an object). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Bank Account Balance History
>
> Monthly balance history per bank account: realized and forecast debits and credits.
>
> Table: `bank_account_balance_history` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the monthly balance record. |
> | `bank_account_id` | Integer | Identifier of the bank account (filled by the connector, which reads the history account by account). |
> | `year` | String | Year of the balance. |
> | `month` | String | Month of the balance. |
> | `balance_previous_month` | Integer | Balance of the previous month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `balance_forecasted_previous_month` | Integer | Forecast balance of the previous month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `balance_next_month` | Integer | Balance carried to the next month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `balance_forecasted_next_month` | Integer | Forecast balance carried to the next month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `debts_made` | Integer | Realized debits of the month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `credits_made` | Integer | Realized credits of the month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `debts_forecasted` | Integer | Forecast debits of the month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `credits_forecasted` | Integer | Forecast credits of the month. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `bank_account_balance` | Integer | Identifier of the parent balance record, as FlyUp BPO returns it. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

### Bank reconciliation

> [accordion] Conciliations
>
> Bank reconciliations: one per imported bank statement (OFX, Excel, PDF, Open Finance or manual).
>
> Table: `conciliations` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the reconciliation. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company) of the reconciliation. |
> | `bank_account_id` | Integer | Identifier of the reconciled bank account (filled by the connector, which reads reconciliations account by account). |
> | `bank_account_name` | String | Name of the reconciled bank account. |
> | `conciliation_type` | String | How the statement was imported (OFX, MANUAL, EXCEL, PDF, OPEN\_FINANCE). |
> | `status` | String | Status of the reconciliation (PENDING, IN\_PROGRESS, CONCLUDED, REJECTED). |
> | `operator` | Integer | Identifier of the operator in charge of the reconciliation. |
> | `operator_name` | String | Name of the operator in charge of the reconciliation. |
> | `start_date` | Date | First day covered by the statement. |
> | `end_date` | Date | Last day covered by the statement. |
> | `uploaded_at` | Datetime | When the statement was uploaded. |
> | `imported_count` | Integer | Number of bank lines imported from the statement. |
> | `suggestion_count` | Integer | Number of reconciliation suggestions for the statement. |
> | `created_count` | Integer | Number of financial entries created while reconciling the statement. |

> [accordion] Imported Transactions
>
> Bank-statement lines imported for reconciliation, with their reconciliation status.
>
> Table: `imported_transactions` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the imported bank line. |
> | `client_id` | String | Identifier (UUID) of the FlyUp BPO client (company), from the line's reconciliation. |
> | `bank_account_id` | Integer | Identifier of the bank account, from the line's reconciliation. |
> | `conciliation_id` | Integer | Identifier of the reconciliation (imported statement) the line belongs to. |
> | `conciliation_status` | String | Status of the line's reconciliation (PENDING, IN\_PROGRESS, CONCLUDED, REJECTED). |
> | `conciliation_balance_calculated` | Integer | Balance calculated for the statement. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `conciliation_balance_expected` | Integer | Balance expected for the statement. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `conciliation_final_balance` | Integer | Final statement balance entered by the user. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `transaction_key` | String | Key that identifies the line in the bank statement. |
> | `transaction_date` | Date | Date of the bank line. |
> | `value` | Integer | Amount of the bank line. Integer amount exactly as FlyUp BPO stores it (the API carries money as integers, without a decimal separator). |
> | `description` | String | Description of the bank line. |
> | `name` | String | Name of the bank line. |
> | `type_of_transaction` | String | CREDIT or DEBIT. |
> | `is_conciliated` | Boolean | Whether the line has been reconciled with financial entries. |
> | `is_ai_auto_conciliated` | Boolean | Whether the line was reconciled automatically by the AI engine. |
> | `is_active` | Boolean | Whether the line is active. |
> | `is_loading` | Boolean | Whether the line is still being loaded. |
> | `payer_document` | String | CPF or CNPJ (digits only) of the payer or payee, from Open Finance. |
> | `payer_name` | String | Name of the payer or payee, from Open Finance. |
> | `payment_method` | String | Payment method of the line (PIX, TED, DOC, BOLETO, ...). |
> | `pluggy_category` | String | Financial category returned by Pluggy (Open Finance). |
> | `pluggy_category_id` | String | Identifier of the Pluggy category. |
> | `suggested_transactions` | String (JSON) | Financial entries suggested for this line (JSON). |
> | `metadata` | String (JSON) | Extra information from the import (JSON). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

### Income statement and planning

> [accordion] DRE (Income Statement)
>
> Income statements (DRE) stored by FlyUp BPO per client, period and unit.
>
> Table: `dre` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the income statement. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company). |
> | `unit` | Integer | Identifier of the business unit, when the statement is per unit. |
> | `year` | String | Year of the income statement. |
> | `month` | String | Month of the income statement (monthly or daily statements). |
> | `type_of_dre` | String | Period of the statement (DAILY, MONTHLY, QUARTERLY, YEARLY). |
> | `is_yearly` | Boolean | Whether the statement is yearly. |
> | `is_quarterly` | Boolean | Whether the statement is quarterly. |
> | `is_processing` | Boolean | Whether FlyUp BPO is still computing the statement. |
> | `data` | String (JSON) | Lines and values of the income statement, as computed by FlyUp BPO (JSON). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Financial Goals
>
> Yearly financial goals (budget) per client, with pessimistic, realistic and optimistic scenarios.
>
> Table: `financial_goals` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the financial goal. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company). |
> | `year` | String | Year of the goal. |
> | `pessimistic_data` | String (JSON) | Planned values of the pessimistic scenario (JSON). |
> | `realistic_data` | String (JSON) | Planned values of the realistic scenario (JSON). |
> | `optimistic_data` | String (JSON) | Planned values of the optimistic scenario (JSON). |
> | `fixed_expenses_data` | String (JSON) | Planned fixed expenses per subcategory, shared by the scenarios (JSON). |
> | `plan_ids` | Array of integers | Identifiers of the financial plans of this goal (see the financial\_plans table). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |

> [accordion] Financial Plans
>
> Financial plans (planned values per scenario) of each financial goal.
>
> Table: `financial_plans` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the financial plan. |
> | `client_id` | String | Identifier (UUID) of the FlyUp BPO client (company) (filled by the connector, which reads plans client by client). |
> | `financial_goal` | Integer | Identifier of the financial goal the plan belongs to. |
> | `year` | String | Year of the plan. |
> | `scenario` | Integer | Scenario of the plan. |
> | `scenario_name` | String | Name of the scenario. |
> | `data` | String (JSON) | Planned values of the plan (JSON). |

> [accordion] Scenario Analyses
>
> What-if scenario analyses (desired margin, average price) per client and year.
>
> Table: `scenario_analyses` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the scenario analysis. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company). |
> | `year` | String | Year of the analysis. |
> | `name` | String | Name of the analysis. |
> | `desired_profit_margin` | Number | Desired profit margin (%). |
> | `average_price` | Integer | Average price of the products or services, as an integer amount exactly as FlyUp BPO stores it. |
> | `data` | String (JSON) | Values of the analysis (JSON). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

### Companies and registries

> [accordion] Clients
>
> FlyUp BPO clients (the companies whose finances are managed) visible to the source's user.
>
> Table: `clients` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | String | Unique identifier (UUID) of the client (company). |
> | `client_type` | String | Kind of service the client has (BPO, CONSULTANCY). |
> | `is_active` | Boolean | Whether the client is active. |
> | `is_onboarding` | Boolean | Whether the client is still onboarding. |
> | `newsletter_subscribed` | Boolean | Whether the client subscribed to the newsletter. |
> | `folder_id` | String | Identifier of the client's document folder. |
> | `system_id` | String | Identifier of the client in an external system. |
> | `customer_gateway_id` | String | Identifier of the client in the payment gateway. |
> | `logo` | String | Link to the client's logo. |
> | `user_id` | Integer | Identifier of the client's main FlyUp BPO user. |
> | `user_first_name` | String | First name of the client's main user. |
> | `user_last_name` | String | Last name of the client's main user. |
> | `user_email` | String | Email of the client's main user. |
> | `user_phone` | String | Phone of the client's main user. |
> | `user_cpf_cnpj` | String | CPF/CNPJ of the client's main user. |
> | `user_is_active` | Boolean | Whether the client's main user is active. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Units
>
> Business units (branches) of each client.
>
> Table: `units` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the unit. |
> | `client_id` | String | Identifier (UUID) of the FlyUp BPO client (company) of the unit. |
> | `name` | String | Name of the unit. |
> | `description` | String | Description of the unit. |
> | `cpf_cnpj` | String | CPF/CNPJ of the unit. |
> | `is_active` | Boolean | Whether the unit is active. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Customers and Suppliers
>
> Customers and suppliers (pessoas) used in the financial entries.
>
> Table: `persons` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the customer or supplier. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company) the customer or supplier belongs to. |
> | `name` | String | Name. |
> | `cpf_cnpj` | String | CPF/CNPJ. |
> | `email` | String | Email. |
> | `phone` | String | Phone. |
> | `is_active` | Boolean | Whether the customer or supplier is active. |
> | `default_plan_entry` | Integer | Identifier of the default subcategory for inflows. |
> | `default_plan_exit` | Integer | Identifier of the default subcategory for outflows. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Projects
>
> Projects (cost centers) of each client.
>
> Table: `projects` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the project. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company). |
> | `name` | String | Name of the project. |
> | `is_active` | Boolean | Whether the project is active. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Plan Groups
>
> Top level of the chart of accounts: groups and how they enter the income statement (DRE).
>
> Table: `plan_groups` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the group. |
> | `name` | String | Name of the group. |
> | `description` | String | Description of the group. |
> | `dre_group_type` | String | Line of the income statement the group feeds (REVENUE, REVENUE\_DEDUCTIONS, VARIABLE\_COSTS, FIXED\_EXPENSES, NON\_OPERATIONAL, INVESTMENTS, ...). |
> | `dre_calculation_type` | String | How the group is calculated in the income statement. |
> | `dre_order` | Integer | Display order in the income statement (0 = first). |
> | `is_active_in_dre` | Boolean | Whether the group appears in the income statement. |
> | `default_color` | String | Default color (hexadecimal). |
> | `flow_type` | String | Whether it is revenue, expense or both (flow type). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Plan Categories
>
> Second level of the chart of accounts: categories inside each group, per client.
>
> Table: `plan_categories` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the category. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company). |
> | `plan_group` | Integer | Identifier of the group of the category. |
> | `name` | String | Name of the category. |
> | `description` | String | Description of the category. |
> | `code` | String | Internal code of the category. |
> | `category_order` | Integer | Order inside the group (0 = first). |
> | `is_active` | Boolean | Whether the category is active. |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Plan Subcategories
>
> Third level of the chart of accounts: the subcategories financial entries are classified in.
>
> Table: `plan_subcategories` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the subcategory. |
> | `client` | String | Identifier (UUID) of the FlyUp BPO client (company). |
> | `plan_category` | Integer | Identifier of the category of the subcategory. |
> | `name` | String | Name of the subcategory. |
> | `description` | String | Description of the subcategory. |
> | `code` | String | Internal code of the subcategory. |
> | `subcategory_order` | Integer | Order inside the category (0 = first). |
> | `is_active` | Boolean | Whether the subcategory is active. |
> | `is_highlighted` | Boolean | Whether the subcategory is highlighted in the income statement. |
> | `flow_type` | String | Whether it is revenue, expense or both (flow type). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

### Proposals and contracts

> [accordion] Proposals
>
> Commercial proposals sent from FlyUp BPO.
>
> Table: `proposals` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the proposal. |
> | `name` | String | Name of the proposal. |
> | `description` | String | Description of the proposal. |
> | `client_name` | String | Name of the customer the proposal was sent to. |
> | `client_email` | String | Email of the customer the proposal was sent to. |
> | `status` | String | Status of the proposal (DRAFT, SENT, APPROVED, REJECTED, EXPIRED). |
> | `approved_date` | Datetime | When the proposal was approved. |
> | `is_active` | Boolean | Whether the proposal is active. |
> | `template` | Integer | Identifier of the proposal template. |
> | `contract_template` | Integer | Identifier of the contract template used when the proposal is approved. |
> | `proposal_file` | String | Link to the generated proposal file. |
> | `d4sign_document_uuid` | String | Identifier of the document in D4Sign. |
> | `signatories_emails` | String (JSON) | Emails of the signatories (JSON). |
> | `template_variables` | String (JSON) | Values filled in the proposal template (JSON). |
> | `contract_variables` | String (JSON) | Values filled in the contract template (JSON). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

> [accordion] Contracts
>
> Contracts generated from FlyUp BPO and their signature status.
>
> Table: `contracts` · Primary key: `id` · Sync: Full table
>
> | Field | Type | Description |
> | :- | :- | :- |
> | `id` | Integer | Unique identifier of the contract. |
> | `name` | String | Name of the contract. |
> | `description` | String | Description of the contract. |
> | `client_name` | String | Name of the customer of the contract. |
> | `client_email` | String | Email of the customer of the contract. |
> | `status` | String | Status of the contract (DRAFT, SENT, SIGNED, CANCELLED, EXPIRED). |
> | `signed_date` | Datetime | When the contract was signed. |
> | `is_active` | Boolean | Whether the contract is active. |
> | `template` | Integer | Identifier of the contract template. |
> | `proposal` | Integer | Identifier of the proposal that originated the contract. |
> | `contract_file` | String | Link to the generated contract file. |
> | `contract_file_signed` | String | Link to the signed contract file. |
> | `d4sign_document_uuid` | String | Identifier of the document in D4Sign. |
> | `google_drive_file_id` | String | Identifier of the file in Google Drive. |
> | `signatories_emails` | String (JSON) | Emails of the signatories (JSON). |
> | `template_variables` | String (JSON) | Values filled in the contract template (JSON). |
> | `signatures_log` | String (JSON) | Log of each signatory's signature (JSON). |
> | `created_at` | Datetime | When the record was created in FlyUp BPO. |
> | `updated_at` | Datetime | When the record was last changed in FlyUp BPO. |
> | `created_by_id` | Integer | Identifier of the FlyUp BPO user who created the record. |
> | `updated_by_id` | Integer | Identifier of the FlyUp BPO user who last changed the record. |

## Implementation notes

* **Full table streams.** FlyUp BPO's lists have no "updated since" filter, so every table is read in full on every sync. Each table is read completely before it is loaded: if the read fails halfway, the table keeps its previous data and the sync shows the error.
* **Amounts.** FlyUp BPO stores money as whole numbers, and the connector loads them exactly as FlyUp BPO returns them, without a decimal separator. Compare a few values with the FlyUp BPO app before building reports (most likely they are in cents, so divide by 100).
* **Which company a row belongs to.** Financial entries, scheduled entries and financial plans don't say which company they belong to, so the connector reads them company by company and fills `client_id`. A row that does not show up under any company the user can see is still loaded, with `client_id` empty. If the list of companies cannot be read because of a temporary error, those tables fail in that sync instead of loading without `client_id`.
* **First sync check.** After the first sync, compare the number of rows in **Transactions** (per company, `client_id`) with the number of entries FlyUp BPO shows for the same company, to confirm the user sees everything you expect.
* **Related records in entries.** In **Transactions** and **Scheduled Transactions**, the subcategory, customer/supplier, project, bank account and unit come as `*_name` (as FlyUp BPO displays them) and `*_id` when FlyUp BPO returns the identifier.
* **Income statements.** The **DRE** table brings the income statements FlyUp BPO has stored, with their lines and values in the `data` column (JSON). It does not ask FlyUp BPO to compute new ones.
* **Permissions.** Before reading anything, the connector checks that the user can read every table you selected. A table the user is not allowed to read, or that FlyUp BPO does not have for your account (a module that is not enabled), is skipped with a warning naming it and saying which of the two happened, and the other tables still load; if the user cannot read any selected table, the sync fails with a message.
* **Rate limits.** If FlyUp BPO asks the connector to slow down, the sync waits and continues, and says so in the sync log.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.