Odoo connection for LinkyFlow

LinkyFlow brings Odoo ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

430

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Accounting

Accounting Document Attachments

The original files of any document of the ledger — a journal entry, a bank line’s entry, an invoice, a bill, a receipt —, attached to it or posted in its chatter, never the PDF Odoo generates of an invoice. Each row links to its download. A PDF, JPEG or PNG original is attached to any of them, draft or posted.

Read

Accounting Document Attachments

Route: GET /accountMoveAttachments

Excel formula: =LF.odoo.accountMoveAttachments("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`move_id`	id	No	Only the files of these documents, attached or in their chatter: one ID, or several comma-separated.
`name`	string	No	Only the records whose file name contains this text (case-insensitive).
`mimetype`	string	No	Only these media types: application/pdf for PDFs.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`mimetype` default	string	—	-
`file_size` default	number	—	-
`res_name` default	string	—	-
`download_url` default	string	—	-

Create

Create Accounting Document Attachment

Route: POST /mutation/accountMoveAttachments

Inputs you can set

Name	Type	Required	Description
`datas`	string	Yes	-
`mimetype`	enum	Yes	Values: application/pdf, image/jpeg, image/png
`name`	string	Yes	-
`res_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Accounting Documents

Every document of the ledger, whatever its type: miscellaneous journal entries, the entries of bank lines, invoices, bills, credit notes and receipts. Read only.

Used as filter by

Accounting Document Attachments · move_id

Read

Accounting Documents

Every document of the ledger, whatever its type: miscellaneous journal entries, the entries of bank lines, invoices, bills, credit notes and receipts. Read only.

Route: GET /accountMoves

Excel formula: =LF.odoo.accountMoves("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`move_type`	enum	No	Only these types: entry for journal entries. Values: entry, out_invoice, out_refund, in_invoice, in_refund
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`statement_line_id`	id	No	Only the records of this bank statement line: one ID, or several comma-separated.
`state`	enum	No	Only these statuses. Values: draft, posted, cancel
`name`	string	No	Only the records whose number contains this text (case-insensitive).
`ref`	string	No	Only the records whose reference contains this text (case-insensitive).
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`move_type` default	enum	—	-
`ref` default	string	—	-
`date` default	date	—	-
`journal_id_name` default	string	—	-
`state` default	enum	—	-
`amount_total` default	number	—	-

Adjust Tax Amount

Sets the tax of a draft vendor bill or refund to the amount its supplier’s document states, when Odoo’s rounding differs from it by a cent or so: Odoo books the difference on the bill’s own tax line and its payable, as its form does, and the rate, the lines and the accounts are unchanged. Refused if the tax changed sin...

Create

Adjust Tax Amount

Route: POST /mutation/invoiceTaxAdjust

Inputs you can set

Name	Type	Required	Description
`document`	string	Yes	-
`expected_amount`	number	Yes	-
`id`	id	Yes	-
`new_amount`	number	Yes	-
`reason`	string	Yes	-
`tax_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Bank Reconciliations

Each bank statement line with what would reconcile it with existing invoices and bills, or book it on general accounts: the open journal items it matches (or those named), the accounts named (or the one comparable lines are booked on, suggested), the amount each takes, the journal entry it would leave, what stays due a...

Read

Bank Reconciliations

Route: GET /bankReconciliations

Excel formula: =LF.odoo.bankReconciliations("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`is_reconciled`	boolean	No	Only the reconciled (true) or open (false) lines.
`payment_ref`	string	No	Only the records whose label contains this text (case-insensitive).
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`move_line_ids`	string[]	No	The open journal items (their IDs, in order) to evaluate the reconciliation of one bank line with, named by id: several invoices, or one pai...
`account_lines`	string	No	The general accounts to evaluate booking one bank line on, named by id: a JSON list of {account_id, amount, label} — amount what the account...
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`date` default	date	—	-
`payment_ref` default	string	—	-
`amount` default	number	—	-
`match_status` default	enum	—	-
`move_line_ids` default	string[]	—	-
`account_lines` default	string	—	-
`allocations` default	string[]	—	-
`entry_lines` default	string[]	—	-
`amount_reconciled` default	number	—	-
`anomalies` default	string[]	—	-

Bank Statement Lines

The transactions of the bank and cash journals (account.bank.statement.line), and whether each is reconciled.

Used as filter by

Accounting Documents · statement_line_id

Read

Bank Statement Lines

The transactions of the bank and cash journals (account.bank.statement.line), and whether each is reconciled.

Route: GET /bankStatementLines

Excel formula: =LF.odoo.bankStatementLines("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`is_reconciled`	boolean	No	Only the reconciled (true) or open (false) lines.
`payment_ref`	string	No	Only the records whose label contains this text (case-insensitive).
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`date` default	date	—	-
`payment_ref` default	string	—	-
`amount` default	number	—	-
`partner_id_name` default	string	—	-
`is_reconciled` default	boolean	—	-

Create

Create Bank Statement Line

Route: POST /mutation/bankStatementLines

Inputs you can set

Name	Type	Required	Description
`account_number`	string	No	-
`amount`	number	Yes	-
`date`	date	Yes	-
`journal_id`	id	Yes	-
`partner_id`	id	No	-
`partner_name`	string	No	-
`payment_ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Bank Statement Line

Route: PATCH /mutation/bankStatementLines

Inputs you can set

Name	Type	Required	Description
`account_number`	string	No	-
`amount`	number	Yes	-
`date`	date	Yes	-
`journal_id`	id	Yes	-
`partner_id`	id	No	-
`partner_name`	string	No	-
`payment_ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Bank Statement Line

Route: DELETE /mutation/bankStatementLines

Inputs you can set

Name	Type	Required	Description
`account_number`	string	No	-
`amount`	number	Yes	-
`date`	date	Yes	-
`journal_id`	id	Yes	-
`partner_id`	id	No	-
`partner_name`	string	No	-
`payment_ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Bank Unreconciliations

Each bank statement line matched with journal items, with what undoing those matches would do: the items named (or all of them), what each gets back, what stays matched, the journal entry as it is and as it would be left, and why it cannot be, if so. Reading changes nothing.

Read

Bank Unreconciliations

Route: GET /bankUnreconciliations

Excel formula: =LF.odoo.bankUnreconciliations("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`payment_ref`	string	No	Only the records whose label contains this text (case-insensitive).
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`move_line_ids`	string[]	No	The journal items (their IDs) to evaluate undoing the match of one bank line with, named by id. Absent: all those it is matched with.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`date` default	date	—	-
`payment_ref` default	string	—	-
`amount` default	number	—	-
`undo_status` default	enum	—	-
`move_line_ids` default	string[]	—	-
`allocations` default	string[]	—	-
`entry_before` default	string[]	—	-
`entry_lines` default	string[]	—	-
`amount_undone` default	number	—	-
`anomalies` default	string[]	—	-

Cancel Invoice

Cancels a draft invoice or bill, which is then never posted.

Create

Cancel Invoice

Route: POST /mutation/invoiceCancel

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Journal Entry

Cancels a draft journal entry, which is then never posted.

Create

Cancel Journal Entry

Route: POST /mutation/journalEntryCancel

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Payment

Cancels a draft payment, which is then never confirmed.

Create

Cancel Payment

Route: POST /mutation/paymentCancel

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Confirm Payment

Confirms a draft payment: Odoo numbers it and books its journal entry, awaiting its bank line.

Create

Confirm Payment

Route: POST /mutation/paymentPost

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Credit Notes

Reverses a posted invoice or bill by a draft credit note (or refund) of the same amount, which answers; post it to settle the invoice.

Create

Create Credit Note

Route: POST /mutation/invoiceReverse

Inputs you can set

Name	Type	Required	Description
`date`	date	No	-
`id`	id	Yes	-
`reason`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Delete Draft Invoice

Removes for good a draft invoice, bill or credit note, with its lines and the files attached to it: it cannot be undone, and invoiceCancel, which keeps the document, is not the same. Refused if it was written since it was read (write_date), was ever posted (its number would leave a gap), is matched with a payment or a...

Create

Delete Draft Invoice

Route: POST /mutation/invoiceDraftDelete

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Delete Draft Journal Entry

Removes for good a draft journal entry, with its lines and the files attached to it: it cannot be undone. Refused if it was written since it was read (write_date), is secured by its hash, was once posted and is not the last of its numbering (the gap it would leave), is reversed, matched, the booking of a bank line or a...

Create

Delete Draft Journal Entry

Route: POST /mutation/journalEntryDraftDelete

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoice Attachments

The original files of invoices and bills (and journal entries), attached to them or posted in their chatter: the PDF a supplier sent, a scan, a photo of a receipt — never the PDF Odoo generates of an invoice. Each row links to its download. A PDF, JPEG or PNG original is attached to an invoice or a bill, draft or poste...

Read

Invoice Attachments

Route: GET /invoiceAttachments

Excel formula: =LF.odoo.invoiceAttachments("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`invoice_id`	id	No	Only the files of these invoices or bills, attached or in their chatter: one ID, or several comma-separated.
`name`	string	No	Only the records whose file name contains this text (case-insensitive).
`mimetype`	string	No	Only these media types: application/pdf for PDFs.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`mimetype` default	string	—	-
`file_size` default	number	—	-
`res_name` default	string	—	-
`download_url` default	string	—	-

Create

Create Invoice Attachment

Route: POST /mutation/invoiceAttachments

Inputs you can set

Name	Type	Required	Description
`datas`	string	Yes	-
`mimetype`	enum	Yes	Values: application/pdf, image/jpeg, image/png
`name`	string	Yes	-
`res_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoice Lines

The lines of invoices, bills and vendor receipts — product, label, quantity, unit price, account, taxes, deductibility —, never the tax or payable lines Odoo computes. Added, corrected and removed while the document is a draft.

Read

Invoice Lines

Route: GET /invoiceLines

Excel formula: =LF.odoo.invoiceLines("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`move_id`	id	No	Only the records of this invoice: one ID, or several comma-separated.
`account_id`	id	No	Only the records of this account: one ID, or several comma-separated.
`product_id`	id	No	Only the records of this product: one ID, or several comma-separated.
`parent_state`	enum	No	Only the lines of invoices in these statuses: draft for those that may change. Values: draft, posted, cancel
`name`	string	No	Only the records whose label contains this text (case-insensitive).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`move_id_name` default	string	—	-
`name` default	string	—	-
`quantity` default	number	—	-
`price_unit` default	number	—	-
`account_id_name` default	string	—	-
`price_subtotal` default	number	—	-
`parent_state` default	enum	—	-

Create

Create Invoice Line

Route: POST /mutation/invoiceLines

Inputs you can set

Name	Type	Required	Description
`account_id`	id	No	-
`deductible_amount`	number	No	-
`discount`	number	No	-
`move_id`	id	Yes	-
`name`	string	No	-
`price_unit`	number	No	-
`product_id`	id	No	-
`quantity`	number	No	-
`tax_ids`	string[]	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Invoice Line

Route: PATCH /mutation/invoiceLines

Inputs you can set

Name	Type	Required	Description
`account_id`	id	No	-
`deductible_amount`	number	No	-
`discount`	number	No	-
`move_id`	id	Yes	-
`name`	string	No	-
`price_unit`	number	No	-
`product_id`	id	No	-
`quantity`	number	No	-
`tax_ids`	string[]	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Invoice Line

Route: DELETE /mutation/invoiceLines

Inputs you can set

Name	Type	Required	Description
`account_id`	id	No	-
`deductible_amount`	number	No	-
`discount`	number	No	-
`move_id`	id	Yes	-
`name`	string	No	-
`price_unit`	number	No	-
`product_id`	id	No	-
`quantity`	number	No	-
`tax_ids`	string[]	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoices

Customer invoices and credit notes, vendor bills, refunds and receipts (account.move): their state, payment state, partner, dates and totals.

Used as filter by

Invoice Attachments · invoice_id

Invoice Lines · move_id

Journal Items · move_id

Read

Invoices

Customer invoices and credit notes, vendor bills, refunds and receipts (account.move): their state, payment state, partner, dates and totals.

Route: GET /invoices

Excel formula: =LF.odoo.invoices("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`move_type`	enum	No	Only these types: out_invoice, out_refund (customers), in_invoice, in_refund, in_receipt (vendors). Values: out_invoice, out_refund, in_invoice, in_refund, in_receipt
`state`	enum	No	Only these statuses. Values: draft, posted, cancel
`payment_state`	enum	No	Only these payment statuses: not_paid and partial for what is still due. Values: not_paid, in_payment, paid, partial, reversed
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`name`	string	No	Only the records whose number contains this text (case-insensitive).
`ref`	string	No	Only the records whose reference contains this text (case-insensitive).
`invoice_date_from`	date	No	On or after this date (YYYY-MM-DD).
`invoice_date_to`	date	No	On or before this date (YYYY-MM-DD).
`invoice_date_due_from`	date	No	On or after this date (YYYY-MM-DD).
`invoice_date_due_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`move_type` default	enum	—	-
`state` default	enum	—	-
`payment_state` default	enum	—	-
`partner_id_name` default	string	—	-
`invoice_date` default	date	—	-
`currency_id_name` default	string	—	-
`amount_total` default	number	—	-
`amount_residual` default	number	—	-

Create

Create Invoice

Route: POST /mutation/invoices

Inputs you can set

Name	Type	Required	Description
`currency_id`	id	No	-
`invoice_date`	date	No	-
`invoice_date_due`	date	No	-
`invoice_payment_term_id`	id	No	-
`journal_id`	id	No	-
`lines`	string	Yes	-
`move_type`	enum	Yes	Values: out_invoice, out_refund, in_invoice, in_refund
`partner_id`	id	Yes	-
`payment_reference`	string	No	-
`ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Invoice

Route: PATCH /mutation/invoices

Inputs you can set

Name	Type	Required	Description
`currency_id`	id	No	-
`invoice_date`	date	No	-
`invoice_date_due`	date	No	-
`invoice_payment_term_id`	id	No	-
`journal_id`	id	No	-
`lines`	string	Yes	-
`move_type`	enum	Yes	Values: out_invoice, out_refund, in_invoice, in_refund
`partner_id`	id	Yes	-
`payment_reference`	string	No	-
`ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Journal Entries

Miscellaneous journal entries (account.move of type entry): accruals, adjustments, opening balances — each a set of balanced debit and credit lines.

Read

Journal Entries

Miscellaneous journal entries (account.move of type entry): accruals, adjustments, opening balances — each a set of balanced debit and credit lines.

Route: GET /journalEntries

Excel formula: =LF.odoo.journalEntries("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`state`	enum	No	Only these statuses. Values: draft, posted, cancel
`name`	string	No	Only the records whose number contains this text (case-insensitive).
`ref`	string	No	Only the records whose reference contains this text (case-insensitive).
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`ref` default	string	—	-
`date` default	date	—	-
`journal_id_name` default	string	—	-
`state` default	enum	—	-
`amount_total` default	number	—	-

Create

Create Journal Entry

Route: POST /mutation/journalEntries

Inputs you can set

Name	Type	Required	Description
`date`	date	No	-
`journal_id`	id	No	-
`lines`	string	Yes	-
`ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Journal Entry

Route: PATCH /mutation/journalEntries

Inputs you can set

Name	Type	Required	Description
`date`	date	No	-
`journal_id`	id	No	-
`lines`	string	Yes	-
`ref`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Journal Items

The lines of the general ledger (account.move.line): each debit or credit on an account, with its entry, partner, product and reconciliation.

Read

Journal Items

The lines of the general ledger (account.move.line): each debit or credit on an account, with its entry, partner, product and reconciliation.

Route: GET /journalItems

Excel formula: =LF.odoo.journalItems("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`move_id`	id	No	Only the records of this invoice: one ID, or several comma-separated.
`account_id`	id	No	Only the records of this account: one ID, or several comma-separated.
`account_type`	enum	No	Only the lines on accounts of these types: asset_receivable and liability_payable for what customers and vendors owe. Values: asset_receivable, asset_cash, asset_current, asset_non_current, asset_prepayments
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`product_id`	id	No	Only the records of this product: one ID, or several comma-separated.
`parent_state`	enum	No	Only the lines of entries in these statuses: posted for the ledger. Values: draft, posted, cancel
`display_type`	string	No	Only these line types: product for the lines of an invoice.
`reconciled`	boolean	No	Only the reconciled (true) or open (false) lines.
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`date_maturity_from`	date	No	On or after this date (YYYY-MM-DD).
`date_maturity_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`move_name` default	string	—	-
`date` default	date	—	-
`account_id_name` default	string	—	-
`partner_id_name` default	string	—	-
`name` default	string	—	-
`debit` default	number	—	-
`credit` default	number	—	-
`parent_state` default	enum	—	-

Payments

Customer and vendor payments (account.payment): amount, partner, journal, state and whether they are matched.

Read

Payments

Customer and vendor payments (account.payment): amount, partner, journal, state and whether they are matched.

Route: GET /payments

Excel formula: =LF.odoo.payments("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`payment_type`	enum	No	inbound: received; outbound: sent. Values: inbound, outbound
`partner_type`	enum	No	customer or supplier. Values: customer, supplier
`state`	enum	No	Only these statuses. Values: draft, in_process, paid, canceled, rejected
`memo`	string	No	Only the records whose memo contains this text (case-insensitive).
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`date` default	date	—	-
`payment_type` default	enum	—	-
`partner_id_name` default	string	—	-
`amount` default	number	—	-
`currency_id_name` default	string	—	-
`state` default	enum	—	-

Create

Create Payment

Route: POST /mutation/payments

Inputs you can set

Name	Type	Required	Description
`amount`	number	Yes	-
`currency_id`	id	No	-
`date`	date	No	-
`journal_id`	id	No	-
`memo`	string	No	-
`partner_id`	id	No	-
`partner_type`	enum	Yes	Values: customer, supplier
`payment_type`	enum	Yes	Values: inbound, outbound

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Payment

Route: PATCH /mutation/payments

Inputs you can set

Name	Type	Required	Description
`amount`	number	Yes	-
`currency_id`	id	No	-
`date`	date	No	-
`journal_id`	id	No	-
`memo`	string	No	-
`partner_id`	id	No	-
`partner_type`	enum	Yes	Values: customer, supplier
`payment_type`	enum	Yes	Values: inbound, outbound

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Payment

Route: DELETE /mutation/payments

Inputs you can set

Name	Type	Required	Description
`amount`	number	Yes	-
`currency_id`	id	No	-
`date`	date	No	-
`journal_id`	id	No	-
`memo`	string	No	-
`partner_id`	id	No	-
`partner_type`	enum	Yes	Values: customer, supplier
`payment_type`	enum	Yes	Values: inbound, outbound

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Post Invoice

Posts a draft invoice or bill: Odoo numbers it and books its journal entry, and it becomes payable.

Create

Post Invoice

Route: POST /mutation/invoicePost

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Post Journal Entry

Posts a draft journal entry: Odoo numbers it and books its lines in the ledger.

Create

Post Journal Entry

Route: POST /mutation/journalEntryPost

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reconcile Bank Line

Reconciles a bank statement line already in Odoo with open invoices, bills or credit notes, or books it on general accounts, as Odoo’s bank reconciliation does: the line’s own entry is rebooked from the suspense account onto the items’ receivable or payable accounts, matched with them, and onto each general account for...

Create

Reconcile Bank Line

Route: POST /mutation/bankReconcile

Inputs you can set

Name	Type	Required	Description
`account_lines`	string	No	-
`amount`	number	Yes	-
`id`	id	Yes	-
`move_line_ids`	string[]	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Register Payment

Records a payment of a posted invoice or bill — the whole amount due, or part of it — and reconciles it: the invoice becomes paid (or partially). It moves no money: it books one received or made.

Create

Register Payment

Route: POST /mutation/invoiceRegisterPayment

Inputs you can set

Name	Type	Required	Description
`amount`	number	No	-
`communication`	string	No	-
`id`	id	Yes	-
`journal_id`	id	No	-
`payment_date`	date	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reset Invoice to Draft

Puts a posted or cancelled invoice, bill or vendor receipt back to draft, as Odoo’s Reset to Draft does: its journal entry is unposted, and its number, dates, partner, reference, journal, currency, lines, tax and files stay as they are — and a payment matched with it stays matched. Never cancelled, deleted, recreated o...

Create

Reset Invoice to Draft

Route: POST /mutation/invoiceResetToDraft

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reset Journal Entry to Draft

Puts a posted or cancelled journal entry back to draft, as Odoo’s Reset to Draft does: its lines leave the ledger until it is posted again, and its number, date, reference, journal, lines and files stay as they are. Refused if it was written since it was read (write_date), where Odoo offers no reset (an entry secured b...

Create

Reset Journal Entry to Draft

Route: POST /mutation/journalEntryResetToDraft

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reset Payment to Draft

Puts a confirmed, cancelled or rejected payment back to draft, its journal entry unposted.

Create

Reset Payment to Draft

Route: POST /mutation/paymentResetToDraft

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reverse Journal Entry

Reverses a posted journal entry by an entry of opposite lines on its journal, linked to it (reversed_entry_id), which answers: its effect leaves the ledger, both stay as its trace. Refused if it was written since it was read (write_date), is reversed already, has a matched line, is the booking of a bank line or a payme...

Create

Reverse Journal Entry

Route: POST /mutation/journalEntryReverse

Inputs you can set

Name	Type	Required	Description
`date`	date	No	-
`id`	id	Yes	-
`reason`	string	Yes	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Undo Bank Reconciliation

Undoes the match of a bank statement line with the journal items named, and nothing else: their residual comes back, the line’s counterparts go back on the suspense account so it can be reconciled again, and its bank account line, its import, its other matches and every other document stay as they are — no payment, no...

Create

Undo Bank Reconciliation

Route: POST /mutation/bankUnreconcile

Inputs you can set

Name	Type	Required	Description
`amount_undone`	number	Yes	-
`id`	id	Yes	-
`move_line_ids`	string[]	Yes	-
`reason`	string	No	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update Journal Entry Lines

Corrects the lines of a draft journal entry — their debit, credit, account and label —, several in one write so that it stays balanced. Its date, journal, reference, currency, files and other lines stay as they are, and it stays a draft: nothing reaches the ledger until it is posted. Refused if it was written since it...

Create

Update Journal Entry Lines

Route: POST /mutation/journalEntryUpdateLines

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`lines`	string	Yes	-
`write_date`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Accounting Reports

Partner Balances

What each customer owes and what is owed to each vendor (the open receivable and payable items, summed by partner), overdue as of a date when asked, in the company’s currency.

Read

Partner Balances

What each customer owes and what is owed to each vendor (the open receivable and payable items, summed by partner), overdue as of a date when asked, in the company’s currency.

Route: GET /partnerBalances

Excel formula: =LF.odoo.partnerBalances("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`account_type`	enum	No	asset_receivable: what customers owe; liability_payable: what is owed to vendors. Values: asset_receivable, liability_payable
`date_maturity_from`	date	No	On or after this date (YYYY-MM-DD).
`date_maturity_to`	date	No	On or before this date (YYYY-MM-DD).
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`partner_id`	id	→ partners	-
`partner_id_name` default	string	—	-
`amount_residual` default	number	—	-
`balance`	number	—	-
`count`	number	—	-

Trial Balance

The posted journal items summed by account (a trial balance): debit, credit and balance of each account over the period asked, in the company’s currency.

Read

Trial Balance

The posted journal items summed by account (a trial balance): debit, credit and balance of each account over the period asked, in the company’s currency.

Route: GET /accountBalances

Excel formula: =LF.odoo.accountBalances("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`date_from`	date	No	On or after this date (YYYY-MM-DD).
`date_to`	date	No	On or before this date (YYYY-MM-DD).
`account_type`	enum	No	Only accounts of these types: income and expense for a result, the others for a balance sheet. Values: asset_receivable, asset_cash, asset_current, asset_non_current, asset_prepayments
`account_id`	id	No	Only the records of this account: one ID, or several comma-separated.
`journal_id`	id	No	Only the records of this journal: one ID, or several comma-separated.
`partner_id`	id	No	Only the records of this partner: one ID, or several comma-separated.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`account_id`	id	→ accounts	-
`account_id_name` default	string	—	-
`debit` default	number	—	-
`credit` default	number	—	-
`balance` default	number	—	-
`count`	number	—	-

Accounting Setup

Accounts

The chart of accounts (account.account): code, name, type and current balance.

Used as filter by

Trial Balance · account_id

Invoice Lines · account_id

Journal Items · account_id

Read

Accounts

The chart of accounts (account.account): code, name, type and current balance.

Route: GET /accounts

Excel formula: =LF.odoo.accounts("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`code`	string	No	Only the accounts whose code contains this text (411).
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`account_type`	enum	No	Only accounts of these types. Values: asset_receivable, asset_cash, asset_current, asset_non_current, asset_prepayments
`active`	boolean	No	False: the archived accounts.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`code` default	string	—	-
`name` default	string	—	-
`account_type` default	enum	—	-
`reconcile`	boolean	—	-
`currency_id`	id	→ currencies	-
`currency_id_name`	string	—	-
`current_balance` default	number	—	-
`note`	string	—	-
`active`	boolean	—	-

Create

Create Account

Route: POST /mutation/accounts

Inputs you can set

Name	Type	Required	Description
`account_type`	enum	Yes	Values: asset_receivable, asset_cash, asset_current, asset_non_current, asset_prepayments
`code`	string	Yes	-
`currency_id`	id	No	-
`name`	string	Yes	-
`note`	string	No	-
`reconcile`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Account

Route: PATCH /mutation/accounts

Inputs you can set

Name	Type	Required	Description
`account_type`	enum	Yes	Values: asset_receivable, asset_cash, asset_current, asset_non_current, asset_prepayments
`code`	string	Yes	-
`currency_id`	id	No	-
`name`	string	Yes	-
`note`	string	No	-
`reconcile`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Analytic Accounts

The analytic accounts (account.analytic.account) a line’s amount is split over, with their balance.

Read

Analytic Accounts

The analytic accounts (account.analytic.account) a line’s amount is split over, with their balance.

Route: GET /analyticAccounts

Excel formula: =LF.odoo.analyticAccounts("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`plan_id`	id	No	Only the records of this plan: one ID, or several comma-separated.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`partner_id`	id	No	Only the records of this customer: one ID, or several comma-separated.
`active`	boolean	No	False: the archived accounts.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`code` default	string	—	-
`plan_id`	id	→ analyticPlans	-
`plan_id_name` default	string	—	-
`partner_id`	id	→ partners	-
`partner_id_name`	string	—	-
`debit`	number	—	-
`credit`	number	—	-
`balance` default	number	—	-
`active`	boolean	—	-

Create

Create Analytic Account

Route: POST /mutation/analyticAccounts

Inputs you can set

Name	Type	Required	Description
`code`	string	No	-
`name`	string	Yes	-
`partner_id`	id	No	-
`plan_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Analytic Account

Route: PATCH /mutation/analyticAccounts

Inputs you can set

Name	Type	Required	Description
`code`	string	No	-
`name`	string	Yes	-
`partner_id`	id	No	-
`plan_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Analytic Plans

The analytic plans (account.analytic.plan) that group analytic accounts: projects, departments, cost centers.

Used as filter by

Analytic Accounts · plan_id

Read

Analytic Plans

The analytic plans (account.analytic.plan) that group analytic accounts: projects, departments, cost centers.

Route: GET /analyticPlans

Excel formula: =LF.odoo.analyticPlans("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`complete_name` default	string	—	-
`parent_id`	id	→ analyticPlans	-
`parent_id_name`	string	—	-

Currencies

The currencies of the database (res.currency): the active ones and their current rate against the company’s.

Used as filter by

Currency Rates · currency_id

Read

Currencies

The currencies of the database (res.currency): the active ones and their current rate against the company’s.

Route: GET /currencies

Excel formula: =LF.odoo.currencies("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose code contains this text (case-insensitive).
`active`	boolean	No	False: the currencies not in use, which a list leaves out otherwise.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`full_name` default	string	—	-
`symbol`	string	—	-
`rate` default	number	—	-
`decimal_places`	number	—	-
`active`	boolean	—	-

Currency Rates

The exchange rates of each currency by date (res.currency.rate), against the company’s currency.

Read

Currency Rates

The exchange rates of each currency by date (res.currency.rate), against the company’s currency.

Route: GET /currencyRates

Excel formula: =LF.odoo.currencyRates("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`currency_id`	id	No	Only the records of this currency: one ID, or several comma-separated.
`name_from`	date	No	On or after this date (YYYY-MM-DD).
`name_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`currency_id`	id	→ currencies	-
`currency_id_name` default	string	—	-
`name` default	date	—	-
`rate` default	number	—	-

Create

Create Currency Rate

Route: POST /mutation/currencyRates

Inputs you can set

Name	Type	Required	Description
`currency_id`	id	Yes	-
`name`	date	Yes	-
`rate`	number	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Currency Rate

Route: PATCH /mutation/currencyRates

Inputs you can set

Name	Type	Required	Description
`currency_id`	id	Yes	-
`name`	date	Yes	-
`rate`	number	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Fiscal Positions

The fiscal positions (account.fiscal.position) that map taxes and accounts by customer or vendor: domestic, intra-EU, export.

Read

Fiscal Positions

The fiscal positions (account.fiscal.position) that map taxes and accounts by customer or vendor: domestic, intra-EU, export.

Route: GET /fiscalPositions

Excel formula: =LF.odoo.fiscalPositions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`auto_apply` default	boolean	—	-
`country_id`	id	—	-
`country_id_name`	string	—	-
`vat_required`	boolean	—	-
`active`	boolean	—	-

Journals

The accounting journals (account.journal): sales, purchase, bank, cash, credit card and miscellaneous.

Used as filter by

Trial Balance · journal_id

Accounting Documents · journal_id

Bank Reconciliations · journal_id

Bank Statement Lines · journal_id

Bank Unreconciliations · journal_id

Invoices · journal_id

Journal Entries · journal_id

Journal Items · journal_id

Payments · journal_id

Read

Journals

The accounting journals (account.journal): sales, purchase, bank, cash, credit card and miscellaneous.

Route: GET /journals

Excel formula: =LF.odoo.journals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`type`	enum	No	Only journals of these types: bank and cash for payments. Values: sale, purchase, cash, bank, credit
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`company_id`	id	No	Only the records of this company: one ID, or several comma-separated.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`code` default	string	—	-
`type` default	enum	—	-
`currency_id`	id	→ currencies	-
`currency_id_name`	string	—	-
`default_account_id`	id	→ accounts	-
`default_account_id_name`	string	—	-
`company_id`	id	—	-
`company_id_name`	string	—	-
`active`	boolean	—	-

Payment Terms

The payment terms (account.payment.term) an invoice or an order is due by: immediate, 30 days, end of month…

Read

Payment Terms

The payment terms (account.payment.term) an invoice or an order is due by: immediate, 30 days, end of month…

Route: GET /paymentTerms

Excel formula: =LF.odoo.paymentTerms("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`early_discount`	boolean	—	-
`active`	boolean	—	-

Taxes

The taxes of the database (account.tax): rate, computation and whether they apply to sales or purchases.

Read

Taxes

The taxes of the database (account.tax): rate, computation and whether they apply to sales or purchases.

Route: GET /taxes

Excel formula: =LF.odoo.taxes("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`type_tax_use`	enum	No	sale, purchase or none. Values: sale, purchase, none
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`active`	boolean	No	False: the archived taxes.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`amount` default	number	—	-
`amount_type`	enum	—	-
`type_tax_use` default	enum	—	-
`price_include`	boolean	—	-
`invoice_label`	string	—	-
`tax_group_id`	id	—	-
`tax_group_id_name`	string	—	-
`active`	boolean	—	-

Catalog

Product Categories

The categories that sort the catalogue (product.category), each with its full path.

Used as filter by

Product Categories · parent_id

Products · categ_id

Read

Product Categories

The categories that sort the catalogue (product.category), each with its full path.

Route: GET /productCategories

Excel formula: =LF.odoo.productCategories("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`parent_id`	id	No	Only the records of this parent category: one ID, or several comma-separated.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`complete_name` default	string	—	-
`parent_id`	id	→ productCategories	-
`parent_id_name`	string	—	-

Products

The products of the catalogue (product.product): each variant with its internal reference, barcode, prices and category.

Used as filter by

Invoice Lines · product_id

Journal Items · product_id

Purchase Order Lines · product_id

Sales Order Lines · product_id

Read

Products

The products of the catalogue (product.product): each variant with its internal reference, barcode, prices and category.

Route: GET /products

Excel formula: =LF.odoo.products("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`default_code`	string	No	Only these SKUs: one, or several comma-separated, exactly as written.
`barcode`	string	No	Only these barcodes: one, or several comma-separated.
`type`	enum	No	Only products of these types. Values: consu, service, combo
`categ_id`	id	No	Only the records of this category: one ID, or several comma-separated.
`sale_ok`	boolean	No	Only products that can (true) or cannot (false) be sold.
`purchase_ok`	boolean	No	Only products that can (true) or cannot (false) be purchased.
`active`	boolean	No	False: the archived products, which a list leaves out otherwise.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`default_code` default	string	—	-
`barcode`	string	—	-
`type`	enum	—	-
`categ_id`	id	→ productCategories	-
`categ_id_name` default	string	—	-
`lst_price` default	number	—	-
`standard_price`	number	—	-
`uom_id`	id	—	-
`uom_id_name`	string	—	-
`sale_ok`	boolean	—	-
`purchase_ok`	boolean	—	-
`description_sale`	string	—	-
`active`	boolean	—	-
`product_tmpl_id`	id	—	-
`write_date`	date	—	-

Create

Create Product

Route: POST /mutation/products

Inputs you can set

Name	Type	Required	Description
`barcode`	string	No	-
`categ_id`	id	No	-
`default_code`	string	No	-
`description_sale`	string	No	-
`lst_price`	number	No	-
`name`	string	Yes	-
`purchase_ok`	boolean	No	-
`sale_ok`	boolean	No	-
`standard_price`	number	No	-
`type`	enum	No	Values: consu, service, combo

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Route: PATCH /mutation/products

Inputs you can set

Name	Type	Required	Description
`barcode`	string	No	-
`categ_id`	id	No	-
`default_code`	string	No	-
`description_sale`	string	No	-
`lst_price`	number	No	-
`name`	string	Yes	-
`purchase_ok`	boolean	No	-
`sale_ok`	boolean	No	-
`standard_price`	number	No	-
`type`	enum	No	Values: consu, service, combo

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contacts

Partners

Customers and vendors of the database (res.partner): companies, and the people and addresses under them.

Used as filter by

Trial Balance · partner_id

Accounting Documents · partner_id

Analytic Accounts · partner_id

Bank Reconciliations · partner_id

Bank Statement Lines · partner_id

Invoices · partner_id

Journal Items · partner_id

Partner Balances · partner_id

Partners · parent_id

Payments · partner_id

Purchase Orders · partner_id

Sales Orders · partner_id

Read

Partners

Customers and vendors of the database (res.partner): companies, and the people and addresses under them.

Route: GET /partners

Excel formula: =LF.odoo.partners("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`name`	string	No	Only the records whose name contains this text (case-insensitive).
`email`	string	No	Only the records whose email contains this text (case-insensitive).
`vat`	string	No	Only the records whose tax id contains this text (case-insensitive).
`is_company`	boolean	No	True: companies only; false: people and addresses only.
`parent_id`	id	No	Only the records of this parent company: one ID, or several comma-separated.
`country_id`	id	No	Only the records of this country: one ID, or several comma-separated.
`customer_rank_min`	number	No	Customers only: 1 keeps the partners that have been sold to or invoiced.
`supplier_rank_min`	number	No	Vendors only: 1 keeps the partners that have been bought from or have billed.
`active`	boolean	No	False: the archived partners, which a list leaves out otherwise.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`is_company` default	boolean	—	-
`email` default	string	—	-
`city` default	string	—	-
`country_id_name` default	string	—	-

Create

Create Partner

Route: POST /mutation/partners

Inputs you can set

Name	Type	Required	Description
`city`	string	No	-
`country_id`	id	No	-
`email`	string	No	-
`is_company`	boolean	No	-
`name`	string	Yes	-
`parent_id`	id	No	-
`phone`	string	No	-
`ref`	string	No	-
`street`	string	No	-
`street2`	string	No	-
`vat`	string	No	-
`website`	string	No	-
`zip`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Partner

Route: PATCH /mutation/partners

Inputs you can set

Name	Type	Required	Description
`city`	string	No	-
`country_id`	id	No	-
`email`	string	No	-
`is_company`	boolean	No	-
`name`	string	Yes	-
`parent_id`	id	No	-
`phone`	string	No	-
`ref`	string	No	-
`street`	string	No	-
`street2`	string	No	-
`vat`	string	No	-
`website`	string	No	-
`zip`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Purchase

Cancel Purchase Order

Cancels a request for quotation, or an order still awaiting approval.

Create

Cancel Purchase Order

Route: POST /mutation/purchaseOrderCancel

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Confirm Purchase Order

Confirms a request for quotation: it becomes a purchase order sent to receive and bill — or waits for approval where the company asks for one.

Create

Confirm Purchase Order

Route: POST /mutation/purchaseOrderConfirm

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Purchase Order Lines

The lines of requests for quotation and purchase orders (purchase.order.line): product, quantities ordered, received and billed, prices.

Read

Purchase Order Lines

The lines of requests for quotation and purchase orders (purchase.order.line): product, quantities ordered, received and billed, prices.

Route: GET /purchaseOrderLines

Excel formula: =LF.odoo.purchaseOrderLines("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`order_id`	id	No	Only the records of this purchase order: one ID, or several comma-separated.
`product_id`	id	No	Only the records of this product: one ID, or several comma-separated.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`order_id_name` default	string	—	-
`product_id_name` default	string	—	-
`product_qty` default	number	—	-
`price_unit` default	number	—	-
`price_subtotal` default	number	—	-

Purchase Orders

Requests for quotation and purchase orders (purchase.order): vendor, state, dates, totals and what remains to be billed.

Used as filter by

Purchase Order Lines · order_id

Read

Purchase Orders

Requests for quotation and purchase orders (purchase.order): vendor, state, dates, totals and what remains to be billed.

Route: GET /purchaseOrders

Excel formula: =LF.odoo.purchaseOrders("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`partner_id`	id	No	Only the records of this vendor: one ID, or several comma-separated.
`state`	enum	No	Only these statuses: draft and sent for requests for quotation, purchase for orders. Values: draft, sent, to approve, purchase, cancel
`invoice_status`	enum	No	Only these billing statuses. Values: no, to invoice, invoiced
`name`	string	No	Only the records whose number contains this text (case-insensitive).
`partner_ref`	string	No	Only the records whose vendor reference contains this text (case-insensitive).
`date_order_from`	date	No	On or after this date (YYYY-MM-DD).
`date_order_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`state` default	enum	—	-
`partner_id_name` default	string	—	-
`date_order` default	date	—	-
`currency_id_name` default	string	—	-
`amount_total` default	number	—	-

Create

Create Purchase Order

Route: POST /mutation/purchaseOrders

Inputs you can set

Name	Type	Required	Description
`lines`	string	Yes	-
`origin`	string	No	-
`partner_id`	id	Yes	-
`partner_ref`	string	No	-
`payment_term_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Purchase Order

Route: PATCH /mutation/purchaseOrders

Inputs you can set

Name	Type	Required	Description
`lines`	string	Yes	-
`origin`	string	No	-
`partner_id`	id	Yes	-
`partner_ref`	string	No	-
`payment_term_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Purchase Order

Route: DELETE /mutation/purchaseOrders

Inputs you can set

Name	Type	Required	Description
`lines`	string	Yes	-
`origin`	string	No	-
`partner_id`	id	Yes	-
`partner_ref`	string	No	-
`payment_term_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Sales

Confirm Sales Order

Confirms a quotation: it becomes a sales order, ready to deliver and invoice.

Create

Confirm Sales Order

Route: POST /mutation/salesOrderConfirm

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Sales Order Lines

The lines of quotations and sales orders (sale.order.line): product, quantities ordered, delivered and invoiced, prices.

Read

Sales Order Lines

The lines of quotations and sales orders (sale.order.line): product, quantities ordered, delivered and invoiced, prices.

Route: GET /salesOrderLines

Excel formula: =LF.odoo.salesOrderLines("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`order_id`	id	No	Only the records of this sales order: one ID, or several comma-separated.
`product_id`	id	No	Only the records of this product: one ID, or several comma-separated.
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`order_id_name` default	string	—	-
`product_id_name` default	string	—	-
`product_uom_qty` default	number	—	-
`price_unit` default	number	—	-
`price_subtotal` default	number	—	-

Sales Orders

Quotations and sales orders (sale.order): customer, state, dates, totals and what remains to invoice.

Used as filter by

Sales Order Lines · order_id

Read

Sales Orders

Quotations and sales orders (sale.order): customer, state, dates, totals and what remains to invoice.

Route: GET /salesOrders

Excel formula: =LF.odoo.salesOrders("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only these records: one ID, or several comma-separated. An unknown ID answers no row.
`partner_id`	id	No	Only the records of this customer: one ID, or several comma-separated.
`state`	enum	No	Only these statuses: draft and sent for quotations, sale for orders. Values: draft, sent, sale, cancel
`invoice_status`	enum	No	Only these invoice statuses. Values: upselling, invoiced, to invoice, no
`name`	string	No	Only the records whose number contains this text (case-insensitive).
`client_order_ref`	string	No	Only the records whose customer reference contains this text (case-insensitive).
`date_order_from`	date	No	On or after this date (YYYY-MM-DD).
`date_order_to`	date	No	On or before this date (YYYY-MM-DD).
`per_page`	number	No	Rows per page (max 200) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`state` default	enum	—	-
`partner_id_name` default	string	—	-
`date_order` default	date	—	-
`currency_id_name` default	string	—	-
`amount_total` default	number	—	-

Create

Create Sales Order

Route: POST /mutation/salesOrders

Inputs you can set

Name	Type	Required	Description
`client_order_ref`	string	No	-
`lines`	string	Yes	-
`origin`	string	No	-
`partner_id`	id	Yes	-
`payment_term_id`	id	No	-
`validity_date`	date	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Sales Order

Route: PATCH /mutation/salesOrders

Inputs you can set

Name	Type	Required	Description
`client_order_ref`	string	No	-
`lines`	string	Yes	-
`origin`	string	No	-
`partner_id`	id	Yes	-
`payment_term_id`	id	No	-
`validity_date`	date	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Sales Order

Route: DELETE /mutation/salesOrders

Inputs you can set

Name	Type	Required	Description
`client_order_ref`	string	No	-
`lines`	string	Yes	-
`origin`	string	No	-
`partner_id`	id	Yes	-
`payment_term_id`	id	No	-
`validity_date`	date	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

← PreviousOdoo connection setup Next →LinkyFlow for BigCommerce