org.openbravo.kikobar.banqup/README.md

**Objective**

This project attempts to extract data from Openbravo to generate a JSON to submit
to the Banqup API of Unifiedpost.

**Requirements**
* Python installed on the machine running this application.
* Credentials for accessing an Openbravo 3+ instance running with the REST API enabled.
* The role in Openbravo used for the extraction/integration must have read access to 'Sales Invoices' and 'Product' via web services. 
* Credentials for accessing the Banqup API by Unifiedpost
* Add the businessPartner id to the 'Customer code' of the customer on the 'Customers & Suppliers' section of the Banqup portal - This is critical, this programs requires this field to extract some parameters that only exist in the Banqup platform.

**How to run this application**

* Copy the file `config-sample.py` to `config.py`.
* Edit `config.py` with your credentials for Openbravo and Banqup.
* Run `python3 extract_invoice.py <documentNo>`, where `<documentNo>` is the human readable invoice number in Openbravo.
* The application will do the following:
  * Fetch the invoice `<documentNo>` from Openbravo.
  * Authenticate with Banqup using OAuth2, for which it will launch a webbrowser to complete the authentication. The browser will receive the response from the Banqup server including the authentication token. The user will need to 'Copy' and 'Paste' this response at the corresponding prompt in the terminal.
  * Fetch the corresponding `businessPartner` from Banqup to verify its existence and correct setup.
  * Build a json in compatible format with the Banqup API.
  * Post the invoice to the Banqup API for the creation of the corresponding invoice in Banqup.
  * Display the response from the Banqup API, confirming the success or failure of the request.
  * The new invoice will be created as a 'Draft' in the Banqup portal, so that it could be further processed.
Edit README.md 2023-06-21 15:53:43 +00:00			`Objective`
Project creation 2023-06-21 04:26:36 +00:00
Add 5 new fields available for the API integration: po_number buyer_reference customer_reference supplier_reference contract_number 2023-06-25 04:00:58 +00:00			`This project attempts to extract data from Openbravo to generate a JSON to submit`
Project creation 2023-06-21 04:26:36 +00:00			`to the Banqup API of Unifiedpost.`
Edit README.md 2023-06-21 15:53:43 +00:00
			`Requirements`
Improve README 2023-06-29 09:24:05 +00:00			`* Python installed on the machine running this application.`
			`* Credentials for accessing an Openbravo 3+ instance running with the REST API enabled.`
Add support for product code (searchKey) to submitted via the Banqup API instead of leaving the field blank 2023-06-29 07:59:16 +00:00			`* The role in Openbravo used for the extraction/integration must have read access to 'Sales Invoices' and 'Product' via web services.`
Edit README.md 2023-06-21 15:53:43 +00:00			`* Credentials for accessing the Banqup API by Unifiedpost`
Improve README 2023-06-29 09:24:05 +00:00			`* Add the businessPartner id to the 'Customer code' of the customer on the 'Customers & Suppliers' section of the Banqup portal - This is critical, this programs requires this field to extract some parameters that only exist in the Banqup platform.`
Edit README.md 2023-06-21 15:53:43 +00:00
			`How to run this application`
Edit README.md 2023-06-21 15:55:23 +00:00
Improve README 2023-06-29 09:24:05 +00:00			* Copy the file `config-sample.py` to `config.py`.
			* Edit `config.py` with your credentials for Openbravo and Banqup.
			* Run `python3 extract_invoice.py <documentNo>`, where `<documentNo>` is the human readable invoice number in Openbravo.
			`* The application will do the following:`
			* Fetch the invoice `<documentNo>` from Openbravo.
			`* Authenticate with Banqup using OAuth2, for which it will launch a webbrowser to complete the authentication. The browser will receive the response from the Banqup server including the authentication token. The user will need to 'Copy' and 'Paste' this response at the corresponding prompt in the terminal.`
			* Fetch the corresponding `businessPartner` from Banqup to verify its existence and correct setup.
			`* Build a json in compatible format with the Banqup API.`
			`* Post the invoice to the Banqup API for the creation of the corresponding invoice in Banqup.`
			`* Display the response from the Banqup API, confirming the success or failure of the request.`
			`* The new invoice will be created as a 'Draft' in the Banqup portal, so that it could be further processed.`