Skip to main content

Contract API - SomConnexio

Beta License: AGPL-3 coopdevs/som-connexio/odoo-somconnexio

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

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

Metadata

Release files for odoo-addon-contract-api-somconnexio 16.0.1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odoo-addon-contract-api-somconnexio 16.0.1.1.1
File Size Uploaded Provenance Actions
odoo_addon_contract_api_somconnexio-16.0.1.1.1.tar.gz 46.0 kB Without provenance Details for odoo_addon_contract_api_somconnexio-16.0.1.1.1.tar.gz

Release files / odoo_addon_contract_api_somconnexio-16.0.1.1.1.tar.gz

Download URL odoo_addon_contract_api_somconnexio-16.0.1.1.1.tar.gz
Size 46.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c92f924ef9d76804adc6beebd6c99365b64afb7a97129a3459ca3d38846019b2
BLAKE2b-256 checksum
How to use checksums
f5b124f0d2b1caf441d1a39551bb6dba7191a7fe0d9f0001d614f6a3de1b9d52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Security for odoo-addon-contract-api-somconnexio 16.0.1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page