odoo-addon-contract-api-somconnexio 16.0.1.0.11

Expose the REST API used in Som Connexió to create and manage contracts in Odoo.

This module is a part of SomConnexió original module.

We are working to separate the monolitic original module in small modules splited by functionalities.

This module manage the Contract API. The API is used to get, create and modify contracts using the Som Connexió processes.

Table of contents

• Configuration

• Usage

• Contributors

Configuration

Create a API key with a user related with the needed security rights to read and modify contracts.

You can follow the next instruccions:

• Settings > Technical (debug mode) > Auth API Key

• click create and select a user, save.

• communicate the API-KEY to the client or app to use the API.

Usage

This module provides a REST API to manage contract-related operations in Odoo. Below are the key endpoints and their functionalities:

• Create Contract

  • Endpoint: /api/contract/create

  • Method: POST

  • Description: Create a new contract with the provided details.

• Get Contract

  • Endpoint: /api/contract/get

  • Method: GET

  • Description: Retrieve details of an existing contract.

• Update the Services

  • Change Tariff

    • Endpoint: /api/contract/service/change_tariff

    • Method: PUT

    • Description: Update the tariff of an existing service.

  • Add One Shot

    • Endpoint: /api/contract/service/add_one_shot

    • Method: POST

    • Description: Add a one-time service to the contract.

  • Terminate Contract

    • Endpoint: /api/contract/service/terminate

    • Method: DELETE

    • Description: Terminate a specific service in the contract.

• Update the Contract Data

  • Change Email

    • Endpoint: /api/contract/update/email

    • Method: PUT

    • Description: Update the email address associated with the contract.

  • Change IBAN

    • Endpoint: /api/contract/update/iban

    • Method: PUT

    • Description: Update the IBAN for payments related to the contract.

• Query Actions

  • Terminate Reasons

    • Endpoint: /api/contract/query/terminate_reasons

    • Method: GET

    • Description: Retrieve a list of valid reasons for contract termination.

  • Available Fibers

    • Endpoint: /api/contract/query/available_fibers

    • Method: GET

    • Description: Get a list of available fiber connections to link with mobile services.

  • Contract Count

    • Endpoint: /api/contract/query/count

    • Method: GET

    • Description: Get the total number of contracts in the system.

More info about the listeners: https://odoo-connector.com/api/api_components.html#listeners

Contributors

• Som Connexió SCCL <https://somconnexio.coop/>

  • Gerard Funonsas [e-mail]

  • Borja Gimeno [e-mail]

• Coopdevs Treball SCCL <https://coopdevs.coop/>

  • Daniel Palomar [e-mail]

  • Cesar Lopez [e-mail]

  • Carla Berenguer [e-mail]