Configuring Odoo as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Odoo option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need to authorize Nekt to access your Odoo instance. Provide the necessary credentials and connection details for your Odoo installation. The following configurations are available:-
API URL: The base URL of your Odoo instance (e.g.,
https://mycompany.odoo.com). This is the root URL where your Odoo instance is hosted. - API Key: The API key (bearer token) to authenticate against the Odoo API. This token grants access to your Odoo instance and must have the necessary permissions to read the data you want to extract.
- Database: (Optional) The name of the database to connect to. This is only required when a single Odoo server hosts multiple databases. If your instance uses a single database or the database name is determined automatically, you can leave this field empty.
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: 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.
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 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.
- Determine when to execute an 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.
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.Streams and Fields
Below you’ll find all available data streams from Odoo and their corresponding fields:Payment
Payment
Stream for retrieving payment records from Odoo’s
account.payment model. This stream contains payment transactions and their associated details.Key Fields:id- Unique identifier for the payment recordname- Payment number/referenceamount- Payment amountdate- Payment datestate- Payment state (draft, posted, sent, reconciled, cancelled)payment_type- Type of payment (inbound, outbound)partner_type- Partner type (customer, supplier)create_date,write_date- Timestamps
amount_signed- Signed payment amountamount_company_currency_signed- Amount in company currencyamount_available_for_refund- Available refund amountcurrency_id- Currency identifiercompany_currency_id- Company currency identifiereffective_date- Effective payment date
payment_method_id- Payment method identifierpayment_method_code- Payment method codepayment_method_line_id- Payment method line identifierpayment_token_id- Saved payment token identifierpayment_transaction_id- Payment transaction identifieruse_electronic_payment_method- Whether electronic payment method is used
partner_id- Customer/Vendor identifierpartner_bank_id- Recipient bank account identifierrequire_partner_bank_account- Whether partner bank account is requiredshow_partner_bank_account- Whether to show partner bank accountdestination_account_id- Destination account identifieroutstanding_account_id- Outstanding account identifier
journal_id- Journal identifiercompany_id- Company identifieravailable_journal_ids- Available journal identifiersavailable_partner_bank_ids- Available partner bank identifiersavailable_payment_method_line_ids- Available payment method line identifiers
invoice_ids- Related invoice identifiersreconciled_invoice_ids- Reconciled invoice identifiersreconciled_invoices_count- Number of reconciled invoicesreconciled_invoices_type- Type of reconciled invoicesreconciled_bill_ids- Reconciled bill identifiersreconciled_bills_count- Number of reconciled billsreconciled_statement_line_ids- Reconciled statement line identifiersreconciled_statement_lines_count- Number of reconciled statement linesis_reconciled- Whether payment is reconciledis_matched- Whether matched with bank statement
payment_reference- Payment referencebank_reference- Bank referencecheque_reference- Cheque referencecheck_number- Check numbercheck_amount_in_words- Amount in wordscheck_layout_available- Whether check layout is availablecheck_manual_sequencing- Whether manual numbering is usedshow_check_number- Whether to show check numberqr_code- QR Code URLpayment_receipt_title- Payment receipt title
move_id- Journal entry identifiersource_payment_id- Source payment identifierpaired_internal_transfer_payment_id- Paired internal transfer payment identifierduplicate_payment_ids- Duplicate payment identifiersrefunds_count- Number of refunds
activity_ids- Activity identifiersactivity_calendar_event_id- Next activity calendar event identifieractivity_date_deadline- Next activity deadlineactivity_state- Activity stateactivity_summary- Next activity summaryactivity_type_id- Next activity type identifieractivity_user_id- Responsible user identifieractivity_exception_decoration- Activity exception decorationactivity_exception_icon- Activity exception iconactivity_type_icon- Activity type iconmy_activity_date_deadline- My activity deadlinemessage_ids- Message identifiersmessage_follower_ids- Follower identifiersmessage_partner_ids- Follower partner identifiersmessage_attachment_count- Attachment countmessage_main_attachment_id- Main attachment identifiermessage_has_error- Whether message has errormessage_has_error_counter- Number of message errorsmessage_has_sms_error- Whether message has SMS errormessage_is_follower- Whether user is followermessage_needaction- Whether action is neededmessage_needaction_counter- Number of actions neededhas_message- Whether record has messageswebsite_message_ids- Website message identifiers
memo- Payment memo/notesdisplay_name- Display nameis_donation- Whether payment is donationis_sent- Whether payment is sentcountry_code- Country codeneed_cancel_request- Whether cancel request is neededsuitable_payment_token_ids- Suitable payment token identifiersattachment_ids- Attachment identifierscreate_uid- Created by user identifierwrite_uid- Last updated by user identifier
Insurance Quotation
Insurance Quotation
Stream for retrieving insurance quotation records from Odoo’s
mut.insurance.quotation model. This stream contains insurance quotation data specific to your Odoo configuration.Key Fields:id- Unique identifier for the insurance quotation recordname- Quotation/proposal numberstatus- Quotation statuscreate_date,write_date- Timestamps
display_name- Display nameaccess_token- External access tokenactive- Whether quotation is activevalidity_date- End of validity periodstandard_duration- Standard durationquotation_fields_readonly- Whether quotation fields are read-only
partner_id- Proponent identifierproponent_name- Proponent nameproponent_type- Proponent typeproponent_vat- CNPJ/CPFproponent_legal_name- Legal name/company nameproponent_email- Email addressproponent_phone- Phone numberproponent_age- Ageproponent_birth_date- Birth dateproponent_gender- Genderproponent_marital_status- Marital statusproponent_nationality- Nationalityproponent_rg- RG (identity document)proponent_driver_license- Driver’s license (CNH)proponent_pep- Whether principal driver is PEP (Politically Exposed Person)
proponent_address- Addressproponent_street_name- Street nameproponent_street_number- Street numberproponent_street2- Address complementproponent_district- District/neighborhoodproponent_city- Cityproponent_city_id- City identifierproponent_state_id- State identifierproponent_country_id- Country identifierproponent_zip- ZIP codeproponent_zip_number- ZIP code (numbers only)
proponent_company_cnae- Company CNAEproponent_company_email- Company emailproponent_company_phone- Company phoneproponent_company_foundation_date- Company foundation dateproponent_legal_representative_name- Legal representative nameproponent_legal_representative_vat- Legal representative CPF
product_id- Insurance product identifieritem_ids- Certificate/item identifiersitems_display_name- Risk item display nameitems_value- IS value (insured sum)items_total_premium_amount- Total premium amount for itemsextra_product_ids- Additional product identifiers
total_premium_amount- Total premium amountdisplay_installments- Installment amountfirst_installment_amount- First installment amountinstallments_due_day- Installment due daydisplay_payment_term- Payment term displayfactor- Factor
payment_method_id- Payment method identifierpayment_provider_id- Payment provider identifierpayment_term_id- Payment term identifieravailable_payment_method_ids- Available payment method identifiersavailable_payment_provider_ids- Available payment provider identifiers
discount_id- Discount identifierdiscount_status- Discount statusis_enable_discount- Whether discount is enabledenable_commissioning- Whether commissioning is enabledjson_commission_amounts- Commission amounts (JSON)json_commission_rates- Commission rates (JSON)
is_renewal- Whether quotation is renewalorigin_policy_id- Origin policy identifier
is_calc_done- Whether calculation is doneinspection_counter- Inspection counter
user_id- Salesperson identifiersales_team_id- Sales team identifiercompany_id- Company identifiercurrency_id- Currency identifier
activity_ids- Activity identifiersactivity_calendar_event_id- Next activity calendar event identifieractivity_date_deadline- Next activity deadlineactivity_state- Activity stateactivity_summary- Next activity summaryactivity_type_id- Next activity type identifieractivity_user_id- Responsible user identifieractivity_exception_decoration- Activity exception decorationactivity_exception_icon- Activity exception iconactivity_type_icon- Activity type iconmy_activity_date_deadline- My activity deadlinemessage_ids- Message identifiersmessage_follower_ids- Follower identifiersmessage_partner_ids- Follower partner identifiersmessage_attachment_count- Attachment countmessage_has_error- Whether message has errormessage_has_error_counter- Number of message errorsmessage_has_sms_error- Whether message has SMS errormessage_is_follower- Whether user is followermessage_needaction- Whether action is neededmessage_needaction_counter- Number of actions neededhas_message- Whether record has messageswebsite_message_ids- Website message identifiers
create_uid- Created by user identifierwrite_uid- Last updated by user identifier
Data Model
The following diagram illustrates the relationships between the data streams in Odoo. Each stream represents a distinct Odoo model and operates independently.Use Cases for Data Analysis
This guide outlines valuable business intelligence use cases when consolidating Odoo data, along with ready-to-use SQL queries that you can run on Explorer.1. Payment Analysis Overview
Track payment transactions, analyze payment patterns, and monitor financial flows from your Odoo system. Business Value:- Monitor payment transactions and cash flow
- Analyze payment methods and patterns
- Track outstanding payments and reconciliation status
- Generate financial reports based on payment data
SQL query
SQL query
- AWS
- GCP
2. Insurance Quotation Tracking
Analyze insurance quotation trends, conversion rates, and customer behavior patterns. Business Value:- Track quotation creation and conversion rates
- Identify trends in quotation volume over time
- Analyze customer segments and quotation performance
- Monitor quotation status and workflow progression
SQL query
SQL query
- AWS
- GCP
Implementation Notes
Dynamic Schema Discovery
- The Odoo connector uses dynamic schema discovery by calling the
fields_getmethod on each Odoo model - This means the exact fields available may vary based on:
- Your Odoo version
- Installed modules and apps
- Custom fields and configurations
- Model-specific customizations
- If schema discovery fails, the connector falls back to a basic schema with only the
idfield
Data Quality Considerations
- Odoo model fields may include relationships (many2one, one2many, many2many) that are represented as integer IDs or arrays
- Date and datetime fields are automatically converted to appropriate types
- Monetary fields are handled as numeric types
- Binary fields are represented as strings
API Limits & Performance
- The connector uses pagination with a default page size to efficiently extract large datasets
- For faster extractions, select only the streams necessary for your analysis
- Odoo API rate limits may apply depending on your instance configuration
- Ensure your API key has appropriate read permissions for the models you want to extract
Multi-Database Support
- If your Odoo instance hosts multiple databases, specify the database name in the configuration
- The database name is sent as the
X-Odoo-Databaseheader in API requests - Leave the database field empty if your instance uses a single database or auto-detection