odoo-ts

Node.js TypeScript client library for odoo ERP using xmlrpc.

Node version

Works better with NodeJS v11.16 and further

Installation

$ npm install --save odoo-api-ts

Usage

import Odoo from "odoo-api-ts";

Configuration

import Odoo from "odoo-api-ts";

var odoo = new Odoo({
  url: "<url>",
  port: "<port>",
  db: "<database>",
  username: "<username>",
  password: "<api key>",
});

Logging in

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);
  } catch (err) {
    console.log(err);
  }
})();

Module Specific Usage

Contacts & Companies

Get All Contacts

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const contacts = await odoo.getAllContacts({});
    console.log(contacts);
  } catch (err) {
    console.log(err);
  }
})();

Get Contact(s) by name

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const contacts = await odoo.getContact({ name: "Mark" });
    console.log(contacts);
  } catch (err) {
    console.log(err);
  }
})();

Get All Companies

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companies = await odoo.getAllCompanies({});
    console.log(companies);
  } catch (err) {
    console.log(err);
  }
})();

Get Company(ies) by name

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companies = await odoo.getCompany({ name: "Odoo" });
    console.log(companies);
  } catch (err) {
    console.log(err);
  }
})();

Save Contact

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    var contact = await odoo.saveContact({
      name: "TS Test",
      phone: "12345678903",
      email: "[email protected]",
      company: "Odoo",
      title: "developer",
    });
    console.log(contact);
  } catch (err) {
    console.log(err);
  }
})();

Save Company

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    var company = await odoo.saveCompany({
      name: "Test Company",
      phone: "1234567801123",
      email: "[email protected]",
    });
    console.log(company);
  } catch (err) {
    console.log(err);
  }
})();

Basic API Access

List Records

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companyIds = await odoo.execute_kw({
      model: "res.partner",
      method: "search",
      params: [[[["is_company", "=", true]], 0, 5]],
    });
  } catch (err) {
    console.log(err);
  }
})();

Pagination

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companyIds = await odoo.execute_kw({
      model: "res.partner",
      method: "search",
      params: [
        [
          [["is_company", "=", true]],
          0, //offset
          5, //limit
        ],
      ],
    });
  } catch (err) {
    console.log(err);
  }
})();

Count records

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const count = await odoo.execute_kw({
      model: "res.partner",
      method: "search_count",
      params: [[[["is_company", "=", true]]]],
    });
  } catch (err) {
    console.log(err);
  }
})();

Read records

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companyIds = await odoo.execute_kw({
      model: "res.partner",
      method: "search",
      params: [[[["is_company", "=", true]], 0, 1]],
    });

    const companies = await odoo.execute_kw({
      model: "res.partner",
      method: "read",
      params: [[companyIds]],
    });

    console.log("Result: ", companies);
  } catch (err) {
    console.log(err);
  }
})();

Read records filtered by fields

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companyIds = await odoo.execute_kw({
      model: "res.partner",
      method: "search",
      params: [[[["is_company", "=", true]], 0, 1]],
    });

    const companies = await odoo.execute_kw({
      model: "res.partner",
      method: "read",
      params: [[companyIds, ["name", "country_id", "comment"]]],
    });

    console.log("Result: ", companies);
  } catch (err) {
    console.log(err);
  }
})();

Listing record fields

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companies = await odoo.execute_kw({
      model: "res.partner",
      method: "fields_get",
      params: [[[[], [], [], ["string"]]]],
    });

    console.log("Result: ", companies);
  } catch (err) {
    console.log(err);
  }
})();

Search and read

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const companies = await odoo.execute_kw({
      model: "res.partner",
      method: "search_read",
      params: [
        [[["is_company", "=", true]], ["name", "country_id", "comment"], 0, 5],
      ],
    });

    console.log("Result: ", companies);
  } catch (err) {
    console.log(err);
  }
})();

Create records

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const company = await odoo.execute_kw({
      model: "res.partner",
      method: "create",
      params: [[[{ name: "New Partner" }]]],
    });

    console.log("Result: ", company);
  } catch (err) {
    console.log(err);
  }
})();

Update records

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const result = await odoo.execute_kw({
      model: "res.partner",
      method: "write",
      params: [[238, { name: "New Partner Updated" }]],
    });

    console.log("Result: ", result);
  } catch (err) {
    console.log(err);
  }
})();

Delete records

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const company = await odoo.execute_kw({
      model: "res.partner",
      method: "unlink",
      params: [[[238]]],
    });

    console.log("Result: ", company);
  } catch (err) {
    console.log(err);
  }
})();

Report printing

(async () => {
  try {
    const uid = await odoo.connect();
    console.log("Connected to Odoo server. Uid: ", uid);

    const invoiceIds = await odoo.execute_kw({
      model: "account.move", //Since Odoo 13, account.invoice has been replaced by account.move
      method: "search",
      params: [[[["move_type", "=", "in_invoice"]]]],
    });

    console.log("invoiceIds: ", invoiceIds);

    const [reportId] = await odoo.execute_kw({
      model: "ir.actions.report",
      method: "search",
      params: [[[["report_type", "=", "qweb-pdf"]]]],
    });

    // I don't find the action to get pdf in doc
  } catch (err) {
    console.log(err);
  }
})();

Reference

• Odoo Technical Documentation
• Odoo Web Service API

License

Copyright 2024 Reyem Technlogies Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.