Skip to main content
Odoo logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: ODOO
  • Version: 20261101_00

Tools

Slug: ODOO_CALL_ODOO_JSONRPCCall Odoo’s external JSON-RPC services using JSON encoding. The API was deprecated in Odoo 19 and is scheduled for removal in Odoo 22 and Odoo Online 21.1.

Input Parameters

array
Arguments to pass to the method. The structure depends on the service and method being called. For example, authenticate requires [db, login, password], execute_kw requires [db, uid, password, model, method, args, kwargs].
string
required
The method to call on the service (e.g., ‘version’, ‘authenticate’, ‘execute’, ‘execute_kw’). For ‘common’ service: version, authenticate, login. For ‘object’ service: execute, execute_kw.
string
required
The service to call (e.g., ‘common’, ‘object’, ‘db’). Common services include ‘common’ for version/authentication and ‘object’ for model operations.
string
The database name to connect to. If not provided, defaults to ‘openerp’ for Odoo.com instances or attempts to extract from metadata.
integer
JSON-RPC request ID used to match responses with requests. Can be any integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_CREATE_CONTACTCreate a new contact (customer, supplier, or generic partner) in Odoo’s res.partner model. Use this action when you need to add a new person or company to the Odoo database. Set customer_rank > 0 to mark as a customer, supplier_rank > 0 to mark as a supplier, or leave both unset for a generic contact.

Input Parameters

string
IANA timezone identifier for the contact (e.g., ‘America/New_York’, ‘Europe/Brussels’).
string
Internal reference code for the contact.
string
Tax/VAT identification number of the contact.
string
City of the contact’s address.
string
Language locale code for the contact (e.g., ‘en_US’, ‘fr_FR’, ‘es_ES’).
string
required
The name of the contact. For companies, use the company name. For individuals, use the full name.
string
Email address of the contact.
string
Phone number of the contact.
integer
ID of the partner title (res.partner.title model) such as Mr., Ms., Dr., etc.
string
Mobile phone number of the contact.
string
Street address line 1 of the contact.
string
Internal notes about the contact (can contain HTML).
string
Street address line 2 (apartment, suite, etc.) of the contact.
string
Website URL of the contact or company.
string
Job title or position of the contact person.
integer
ID of the state/province (res.country.state model).
string
Postal/ZIP code of the contact’s address. Will be mapped to Odoo’s ‘zip’ field.
integer
ID of the parent company partner to link this contact under. Used to create a contact person belonging to a company.
integer
ID of the country (res.country model). If you need to find the country ID, use search_read on res.country model first.
boolean
True if the partner is a company, False if an individual person. Defaults to False.
string ("person" | "company")
Type of the partner: ‘person’ for an individual or ‘company’ for an organization.
integer
Customer rank. Set to a value greater than 0 to mark the partner as a customer.
integer
Supplier rank. Set to a value greater than 0 to mark the partner as a vendor/supplier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_GET_APPLICANT_RESULTTool to retrieve parsing results for a previously submitted resume/applicant document. Use when you need to check the status and get extracted fields (name, email, phone, mobile) from a resume that was previously submitted for parsing.

Input Parameters

integer
API version number to use for the request
string
required
IAP (In-App Purchase) account token for authentication
string
required
Token received from the parse response that identifies the document to retrieve results for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_GET_BANK_STATEMENT_RESULTTool to retrieve parsing results for a previously submitted bank statement. Returns extracted fields including balance_start, balance_end, date, and bank_statement_lines. Use when you need to check the status and get extracted data from a bank statement document using Odoo’s Extract API.

Input Parameters

integer
required
API version number. Use 1 for current version.
string
required
IAP account token for authentication.
string
required
Token received from the bank statement parse submission response. Use this to retrieve parsing results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_GET_EXPENSE_RESULTRetrieve parsing results for a previously submitted expense document. Returns extracted fields including description, country, date, total, and currency. Use this after submitting an expense document to get the OCR/extraction results.

Input Parameters

integer
required
API version number to use for the request
string
required
IAP account token for authentication and billing
string
required
Token identifying the document, returned from the parse/submit request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_GET_INVOICE_RESULTTool to retrieve parsing results for a previously submitted invoice from Odoo Extract API. Use when you need to check the status and get extracted data from an invoice. Poll this endpoint until the status field is ‘success’ - processing may take time depending on document complexity.

Input Parameters

integer
required
API version number (must match the version used in the parse request)
string
required
IAP (In-App Purchase) account token used for the original parse request
string
required
Token returned from the invoice parse request. Used to identify the document being processed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_LIST_DATABASESTool to list all available Odoo databases on the server. Use when you need to see which databases are available on the Odoo instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_PARSE_APPLICANTTool to submit a resume/CV document for OCR parsing and data extraction via Odoo Extract API. Extracts name, email, phone, and mobile from applicant resumes. Returns a document_token to poll for results. Cost: 1 IAP credit per successful parse.

Input Parameters

integer
API version number. Latest version is 102. Use this to ensure compatibility with the Extract API.
string
required
Base64-encoded resume/CV document (PDF or image format). The document should be encoded as a base64 string before submission.
string
JSON-RPC request identifier for tracking. Can be any unique string to identify this request.
string
required
IAP (In-App Purchase) account token for billing. Each successful parse consumes 1 IAP credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_PARSE_BANK_STATEMENTTool to submit a bank statement document for OCR parsing and data extraction via Odoo Extract API. Extracts balance_start, balance_end, date, and bank_statement_lines. Returns a document_token to poll for results. Cost: 1 IAP credit per successful parse.

Input Parameters

integer
required
API version number to use. Latest version is 100. Required to ensure compatibility with response format.
array
required
Array containing exactly one Base64-encoded document. Supported formats: PDF, PNG, JPG. The document will be parsed to extract bank statement fields (balance_start, balance_end, date, bank_statement_lines).
string
JSON-RPC request ID. Auto-generated UUID if not provided. Used to match responses with requests.
string
required
IAP (In-App Purchase) account token for billing. Each successful parse costs 1 IAP credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_PARSE_EXPENSETool to submit an expense document for OCR parsing and data extraction. Extracts description, country, date, total, and currency from expense receipts. Returns a document_token to poll for results. Use when you need to process expense documents using Odoo’s Extract API.

Input Parameters

integer
required
API version to use. Latest version is 132.
array
required
Array containing one Base64-encoded document image to parse. Only the first document in the array will be processed.
string
required
IAP account token for billing. Cost: 1 IAP credit per successful parse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_PARSE_INVOICETool to submit an invoice document for OCR parsing and data extraction via Odoo Extract API. Uses AI-based algorithms to extract fields like total, due date, invoice lines, VAT numbers, IBAN, supplier, client, and currency. Returns a document_token to poll for results. Cost: 1 IAP credit per successful parse.

Input Parameters

string
Unique identifier of the Odoo database. Used for tracking and analytics.
integer
required
API version number to use. Latest version is 123. Required to ensure compatibility with response format.
array
required
Array containing exactly one Base64-encoded document. Supported formats: PDF, PNG, JPG. The document will be parsed to extract invoice fields.
string
JSON-RPC request ID. Auto-generated UUID if not provided. Used to match responses with requests.
object
Optional user information to enhance OCR accuracy.
string
URL to receive a POST notification when parsing is complete. Useful for asynchronous processing.
string
required
IAP (In-App Purchase) account token for billing. Each successful parse costs 1 IAP credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ODOO_UPDATE_RECORDUpdate one or more records in an Odoo model via the JSON-2 API write endpoint, using the same specified field values for each record. Supports relational fields with command tuples.

Input Parameters

string
required
The Odoo model name to update records in (e.g., ‘res.partner’, ‘crm.lead’, ‘sale.order’, ‘account.move’, ‘product.product’). Must use dot notation for model names.
object
required
Dictionary mapping field names to new values. For many2many fields, use Odoo command tuples: [(6,0,[ids])] to replace all links, [(4,id)] to add a link, [(3,id)] to remove a link. For one2many fields: [(0,0,vals)] to create new records, [(1,id,vals)] to update existing records, [(2,id)] to delete records.
array
required
List of Odoo record IDs to update. Must contain at least one ID. All specified records will be updated with the same values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not