Configuring Conexa as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Conexa option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
Conexa authenticates with an Application Token and your account’s subdomain. To create the token, an administrator goes to Config > Integrações > API / Token in Conexa, creates a token, and copies it. The following configurations are available:-
Subdomain: the first part of the address you use to open Conexa. For
https://mycompany.conexa.app, entermycompany. Required. - Application Token: the token created in API / Token. Required.
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: all Conexa streams are FULL_TABLE: Conexa does not let the connector ask only for records changed since the last sync, so every sync reads the whole table. Read more about Sync Types here.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, 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. Once you are ready, click Next to finalize the setup.5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Limits and behavior
- Conexa allows 60 requests per minute per account, shared with any other integration that uses the same account. The connector reads 100 records per request and stays under that limit, so large accounts take longer to sync: about 6,000 records per minute.
- If the token cannot read a stream (for example, a module that is not part of your Conexa plan), that stream is skipped with a warning and its table is not updated. The sync fails only when none of the selected streams can be read.
- Fields marked “Conexa Coworking” are only filled for accounts of that product.
Streams and Fields
Below you’ll find all available data streams from Conexa and their corresponding fields. API reference: Conexa API v2.Timestamps are stored in UTC. Objects and lists of objects (addresses, custom fields, quotas, complementary services) are stored as JSON text, and the most used values inside them also get their own columns (for example
cpf, cnpj, product_id, place_name).Companies (units)
Companies (units)
The units (branches) your Conexa account manages (
GET /companies).Primary key: company_idCustomers
Customers
Your customers, individuals or companies, with documents, contacts, address, tax withholding settings, and custom fields (
GET /customers).Primary key: customer_idPersons
Persons
People linked to customers: partners, guarantors, and staff with access to the customer area (
GET /persons).Primary key: person_idPlans
Plans
The plans contracts are built on, with prices per billing periodicity and the quotas they include (
GET /plans).Primary key: plan_idContracts
Contracts
Recurring agreements with your customers: plan, amount, billing frequency, start and end dates, and complementary services (
GET /contracts).Primary key: contract_idProducts
Products
The services and items you sell (
GET /products).Primary key: product_idService Categories
Service Categories
Service categories and their tax settings for service invoices (
GET /serviceCategories).Primary key: service_category_idExtra Fields
Extra Fields
Custom fields defined for customers, plans, and contracts (
GET /extraFields).Primary key: idSales
Sales
Every sale, whether registered by hand or generated by a contract or a recurring sale (
GET /sales).Primary key: sale_idRecurring Sales
Recurring Sales
Sales repeated on a schedule (
GET /recurringSales).Primary key: recurring_sale_idCharges
Charges
What your customers are billed, with amounts, due and payment dates, status, and bank slip details (
GET /charges).Primary key: charge_idInvoicing Methods
Invoicing Methods
How charges are issued (
GET /invoicingMethods).Primary key: invoicing_method_idReceiving Methods
Receiving Methods
How payments are received, with their fees and settlement times (
GET /receivingMethods).Primary key: receiving_method_idPayment Methods
Payment Methods
How expenses are paid (
GET /paymentMethods).Primary key: payment_method_idBills
Bills
Your expenses, with supplier, category, amounts, and due and payment dates (
GET /bills).Primary key: bill_idBill Categories
Bill Categories
Expense categories (
GET /billCategories).Primary key: bill_category_idBill Subcategories
Bill Subcategories
Expense subcategories and the income statement (DRE) group each one is reported under (
GET /billSubcategories).Primary key: bill_subcategory_idSuppliers
Suppliers
Your suppliers (
GET /suppliers).Primary key: supplier_idCost Centers
Cost Centers
Cost centers (
GET /costCenters).Primary key: cost_center_idAccounts
Accounts
Bank and cash accounts money moves through (
GET /accounts).Primary key: account_idRoom Bookings
Room Bookings
Meeting room bookings (
GET /room/bookings). Only for Conexa Coworking accounts with the module enabled by Conexa’s support; otherwise the stream is skipped with a warning. Access passwords are not extracted.Primary key: booking_id