Skip to main content
Odoo is an open-source enterprise resource planning (ERP) system that helps businesses manage their operations, including sales, inventory, accounting, manufacturing, and more. It provides a comprehensive suite of integrated business applications designed to streamline workflows and improve efficiency.

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.
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: 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.
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, 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.
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.
For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from Odoo and their corresponding fields:
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 record
  • name - Payment number/reference
  • amount - Payment amount
  • date - Payment date
  • state - 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
Payment Details:
  • amount_signed - Signed payment amount
  • amount_company_currency_signed - Amount in company currency
  • amount_available_for_refund - Available refund amount
  • currency_id - Currency identifier
  • company_currency_id - Company currency identifier
  • effective_date - Effective payment date
Payment Methods:
  • payment_method_id - Payment method identifier
  • payment_method_code - Payment method code
  • payment_method_line_id - Payment method line identifier
  • payment_token_id - Saved payment token identifier
  • payment_transaction_id - Payment transaction identifier
  • use_electronic_payment_method - Whether electronic payment method is used
Partner & Account Information:
  • partner_id - Customer/Vendor identifier
  • partner_bank_id - Recipient bank account identifier
  • require_partner_bank_account - Whether partner bank account is required
  • show_partner_bank_account - Whether to show partner bank account
  • destination_account_id - Destination account identifier
  • outstanding_account_id - Outstanding account identifier
Journal & Company:
  • journal_id - Journal identifier
  • company_id - Company identifier
  • available_journal_ids - Available journal identifiers
  • available_partner_bank_ids - Available partner bank identifiers
  • available_payment_method_line_ids - Available payment method line identifiers
Invoice & Reconciliation:
  • invoice_ids - Related invoice identifiers
  • reconciled_invoice_ids - Reconciled invoice identifiers
  • reconciled_invoices_count - Number of reconciled invoices
  • reconciled_invoices_type - Type of reconciled invoices
  • reconciled_bill_ids - Reconciled bill identifiers
  • reconciled_bills_count - Number of reconciled bills
  • reconciled_statement_line_ids - Reconciled statement line identifiers
  • reconciled_statement_lines_count - Number of reconciled statement lines
  • is_reconciled - Whether payment is reconciled
  • is_matched - Whether matched with bank statement
Payment References:
  • payment_reference - Payment reference
  • bank_reference - Bank reference
  • cheque_reference - Cheque reference
  • check_number - Check number
  • check_amount_in_words - Amount in words
  • check_layout_available - Whether check layout is available
  • check_manual_sequencing - Whether manual numbering is used
  • show_check_number - Whether to show check number
  • qr_code - QR Code URL
  • payment_receipt_title - Payment receipt title
Payment Relationships:
  • move_id - Journal entry identifier
  • source_payment_id - Source payment identifier
  • paired_internal_transfer_payment_id - Paired internal transfer payment identifier
  • duplicate_payment_ids - Duplicate payment identifiers
  • refunds_count - Number of refunds
Activity & Messaging:
  • activity_ids - Activity identifiers
  • activity_calendar_event_id - Next activity calendar event identifier
  • activity_date_deadline - Next activity deadline
  • activity_state - Activity state
  • activity_summary - Next activity summary
  • activity_type_id - Next activity type identifier
  • activity_user_id - Responsible user identifier
  • activity_exception_decoration - Activity exception decoration
  • activity_exception_icon - Activity exception icon
  • activity_type_icon - Activity type icon
  • my_activity_date_deadline - My activity deadline
  • message_ids - Message identifiers
  • message_follower_ids - Follower identifiers
  • message_partner_ids - Follower partner identifiers
  • message_attachment_count - Attachment count
  • message_main_attachment_id - Main attachment identifier
  • message_has_error - Whether message has error
  • message_has_error_counter - Number of message errors
  • message_has_sms_error - Whether message has SMS error
  • message_is_follower - Whether user is follower
  • message_needaction - Whether action is needed
  • message_needaction_counter - Number of actions needed
  • has_message - Whether record has messages
  • website_message_ids - Website message identifiers
Additional Fields:
  • memo - Payment memo/notes
  • display_name - Display name
  • is_donation - Whether payment is donation
  • is_sent - Whether payment is sent
  • country_code - Country code
  • need_cancel_request - Whether cancel request is needed
  • suitable_payment_token_ids - Suitable payment token identifiers
  • attachment_ids - Attachment identifiers
  • create_uid - Created by user identifier
  • write_uid - Last updated by user identifier
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 record
  • name - Quotation/proposal number
  • status - Quotation status
  • create_date, write_date - Timestamps
Quotation Details:
  • display_name - Display name
  • access_token - External access token
  • active - Whether quotation is active
  • validity_date - End of validity period
  • standard_duration - Standard duration
  • quotation_fields_readonly - Whether quotation fields are read-only
Proponent Information:
  • partner_id - Proponent identifier
  • proponent_name - Proponent name
  • proponent_type - Proponent type
  • proponent_vat - CNPJ/CPF
  • proponent_legal_name - Legal name/company name
  • proponent_email - Email address
  • proponent_phone - Phone number
  • proponent_age - Age
  • proponent_birth_date - Birth date
  • proponent_gender - Gender
  • proponent_marital_status - Marital status
  • proponent_nationality - Nationality
  • proponent_rg - RG (identity document)
  • proponent_driver_license - Driver’s license (CNH)
  • proponent_pep - Whether principal driver is PEP (Politically Exposed Person)
Proponent Address:
  • proponent_address - Address
  • proponent_street_name - Street name
  • proponent_street_number - Street number
  • proponent_street2 - Address complement
  • proponent_district - District/neighborhood
  • proponent_city - City
  • proponent_city_id - City identifier
  • proponent_state_id - State identifier
  • proponent_country_id - Country identifier
  • proponent_zip - ZIP code
  • proponent_zip_number - ZIP code (numbers only)
Company Information (for corporate proponent):
  • proponent_company_cnae - Company CNAE
  • proponent_company_email - Company email
  • proponent_company_phone - Company phone
  • proponent_company_foundation_date - Company foundation date
  • proponent_legal_representative_name - Legal representative name
  • proponent_legal_representative_vat - Legal representative CPF
Product & Coverage:
  • product_id - Insurance product identifier
  • item_ids - Certificate/item identifiers
  • items_display_name - Risk item display name
  • items_value - IS value (insured sum)
  • items_total_premium_amount - Total premium amount for items
  • extra_product_ids - Additional product identifiers
Pricing & Premium:
  • total_premium_amount - Total premium amount
  • display_installments - Installment amount
  • first_installment_amount - First installment amount
  • installments_due_day - Installment due day
  • display_payment_term - Payment term display
  • factor - Factor
Payment Information:
  • payment_method_id - Payment method identifier
  • payment_provider_id - Payment provider identifier
  • payment_term_id - Payment term identifier
  • available_payment_method_ids - Available payment method identifiers
  • available_payment_provider_ids - Available payment provider identifiers
Discount & Commission:
  • discount_id - Discount identifier
  • discount_status - Discount status
  • is_enable_discount - Whether discount is enabled
  • enable_commissioning - Whether commissioning is enabled
  • json_commission_amounts - Commission amounts (JSON)
  • json_commission_rates - Commission rates (JSON)
Renewal & Origin:
  • is_renewal - Whether quotation is renewal
  • origin_policy_id - Origin policy identifier
Calculation & Status:
  • is_calc_done - Whether calculation is done
  • inspection_counter - Inspection counter
Sales Team & User:
  • user_id - Salesperson identifier
  • sales_team_id - Sales team identifier
  • company_id - Company identifier
  • currency_id - Currency identifier
Activity & Messaging:
  • activity_ids - Activity identifiers
  • activity_calendar_event_id - Next activity calendar event identifier
  • activity_date_deadline - Next activity deadline
  • activity_state - Activity state
  • activity_summary - Next activity summary
  • activity_type_id - Next activity type identifier
  • activity_user_id - Responsible user identifier
  • activity_exception_decoration - Activity exception decoration
  • activity_exception_icon - Activity exception icon
  • activity_type_icon - Activity type icon
  • my_activity_date_deadline - My activity deadline
  • message_ids - Message identifiers
  • message_follower_ids - Follower identifiers
  • message_partner_ids - Follower partner identifiers
  • message_attachment_count - Attachment count
  • message_has_error - Whether message has error
  • message_has_error_counter - Number of message errors
  • message_has_sms_error - Whether message has SMS error
  • message_is_follower - Whether user is follower
  • message_needaction - Whether action is needed
  • message_needaction_counter - Number of actions needed
  • has_message - Whether record has messages
  • website_message_ids - Website message identifiers
System Fields:
  • create_uid - Created by user identifier
  • write_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
SELECT
   DATE(payment_date) AS payment_date,
   payment_method,
   state,
   currency_id,
   SUM(amount) AS total_amount,
   COUNT(*) AS payment_count,
   COUNT(DISTINCT partner_id) AS unique_partners
FROM
   nekt_raw.odoo_payment
WHERE
   payment_date >= CURRENT_DATE - INTERVAL '30' DAY
GROUP BY
   DATE(payment_date),
   payment_method,
   state,
   currency_id
ORDER BY
   payment_date DESC,
   total_amount DESC

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
SELECT
   DATE(create_date) AS quotation_date,
   state,
   product_id,
   COUNT(*) AS quotation_count,
   COUNT(DISTINCT partner_id) AS unique_customers,
   AVG(amount_total) AS avg_quotation_value,
   SUM(CASE WHEN state = 'sale' THEN 1 ELSE 0 END) AS converted_count,
   ROUND(
      SUM(CASE WHEN state = 'sale' THEN 1 ELSE 0 END)::NUMERIC / 
      NULLIF(COUNT(*), 0) * 100, 
      2
   ) AS conversion_rate_percent
FROM
   nekt_raw.odoo_insurance_quotation
WHERE
   create_date >= CURRENT_DATE - INTERVAL '30' DAY
GROUP BY
   DATE(create_date),
   state,
   product_id
ORDER BY
   quotation_date DESC,
   quotation_count DESC

Implementation Notes

Dynamic Schema Discovery

  • The Odoo connector uses dynamic schema discovery by calling the fields_get method 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 id field

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-Database header in API requests
  • Leave the database field empty if your instance uses a single database or auto-detection