# README.rst

# pingen.com integration

Pingen.com is a paid online service. It sends uploaded documents by letter post.

One can decide, per document / attachment, if it should be pushed to pingen.com. The documents are pushed asynchronously.

The informations of the documents from pingen.com are updated through webhook calls.

Table of contents

- Configuration
- Usage
- Errors
- Dependencies
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

## Configuration

The authentication token, client ID, organization ID and webhook secret is configured on the company’s view. You can also tick a checkbox if the staging environment (https://stage-api.pingen.com) should be used.

Webhooks should be configured on pingen account. Organization ID and webhook secret must match.

## Usage

On the attachment view, a new pingen.com section has been added. You can tick a box to push the document to pingen.com.

There is 3 additional options:

> - Send: the document will not be only uploaded, but will be also be sent
> - Speed: priority or economy
> - Type of print: color or black and white

Once the configuration is done and the attachment saved, a Pingen Document is created. You can directly access to the latter on the Link on the right on the attachment view.

You can find them in Pingen Documents App or in the more convenient Documents menu if you have installed the document module.

## Errors

Sometimes, pingen.com will refuse to send a document because it does not meet its requirements. In such case, the document’s state becomes “Pingen Error” and you will need to manually handle the case, either from the pingen.com backend, or by changing the document on Odoo and resolving the error on the Pingen Document.

When a connection error occurs, the action will be retried on the next scheduler run.

## Dependencies

> - Require the Python library requests_oauthlib
> - The address must be in a format accepted by pingen.com: the last line is the country in English or German.

## Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

## Credits

### Authors

- Camptocamp

### Contributors

- Guewen Baconnier <guewen.baconnier@camptocamp.com>
- Anar Baghirli <a.baghirli@mobilunity.com>
- Akim Juillerat <akim.juillerat@camptocamp.com>
- Anna Janiszewska <anna.janiszewska@camptocamp.com>

### Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainers:

This module is part of the OCA/report-print-send project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.