Version Log

Deploy the Application Code

• An experienced Odoo administrator should install the code that was delivered after purchasing the app. Odoo.sh and Odoo On-Premise are supported.

• The following entries must be added to the requirements.txt file:

  oveem==2.2.0
  pyyaml==5.3.1
  phonenumbers==8.12.29
  

• Your purchase will include two directories of files: bbcs_pay_acquire and bbcs_veem_payment. Both directories must be installed for the apps to correctly install.

Install the App

1. Enter Developer Mode and open the Apps module
2. Choose the Update Apps List option
3. After the update is complete, search for "Veem"
4. Install the Veem Online Payments app

Getting Your Veem API Credentials

The following steps will help you find your API credentials in Veem. If you don't have a Veem account yet, visit http://www.blue-bird.cloud/solutions/odoo/veem to read about a special offer when opening a new Veem account.

1. Login as the user that is considered the owner of the Veem account
2. Go to Settings > Integrations and find the tile named Veem API
3. If necessary click Generate and store a copy of Client ID and Client Secret

Configure the Veem Payment Acquirer

1. If you are running a multi-company DB it is suggested you review the Multi-Company Install Notes section below.
2. Go to Accounting > Configuration > Payment Acquirers.
3. Find the Veem payment acquirer and run the Install process.
4. After installation, click into the Veem payment acquirer profile.
5. Ensure the Provider is Veem and set the state to Enabled. (Use Test Mode if you plan to connect to sandbox.veem.com)
6. Set a value for Company if applicable
7. Enter the Client ID and Client Secret from your Veem account
8. Make selections for the remaining options using the help tooltips for guidance
9. Save the record and then use the Test Connection feature to confirm that Odoo can connect to Veem

Sending Invoices Via Veem

• When viewing a confirmed invoice for a Company configured with a Veem Payment Acquirer you will see a Send Veem Invoice button
• Clicking the button will show a dialog box giving you options to confirm or update before the transmission to Veem
• Once satisfied, click Confirm and the invoice will be transmitted to Veem and automatically sent to the recipient
• As soon as Veem knows that the inbound payment has reached the status 'deposited' then the Veem Status of the corresponding invoice in Odoo will also be automatically updated

Sending Bulk Invoices Via Veem

• Use the list view of invoices to check multiple invoices that are ready to send.
• It is best to not select Draft invoices nor invoices that have already been sent via Veem
• Use the Actions menu and select the Send Veem Invoice option
• You will see a dialog box giving you options to confirm or update before the transmission to Veem
• Once satisfied, click Confirm and all of your selected invoices will be transmitted to Veem and automatically sent to the recipient
• Draft invoices and invoices already transmitted to Veem will be skipped

Sending Payments With Veem

• The Odoo-Veem integration uses the existing payment architecture for consistency
• If you wish to use the integration to initiate payments then follow these steps
  • Review your settings in Veem to understand which bank account is set as the Sending Account.
  • You should have a Bank Account defined in Odoo that matches that sending account.
  • Edit the journal for that bank account in Odoo and go to the Payments Configuration subtab.
  • Ensure that the Veem checkbox is checked in the Methods section of the Outgoing Payments section
  • This will offer the option of using Veem to send payment anywhere the Register Payment process is used
• Use the option in the Payment Acquirer profile to control whether the payment should start as a draft in Veem, or whether the payment should automatically be initiated.

Multi-Company Install Notes

• It is recommended that you install the Veem Payments Integration app when logged in with access to the Odoo default company. (id=1)
• A Veem journal is added as part of the installation process and is associated with the default company.
• You should think about which company/companies will be expecting to use the Veem Payments Integration.
  • You should create additional copies of the Veem journal for each additional company that expects to use the Veem functionality
  • After the journals are created, you will also want to create one copy of the Veem Payment Acquirer for each company
  • When following the Configure the Veem Payment Acquirer instructions above you should repeat those steps for each company, adding an additional step of setting the Payment Journal value on the Configuration subtab to the journal that you created for that company specified in the Payment Acquirer record.
  • If you determine that the default company does not need the Veem functions, then you might want to set that Payment Acquirer record to Disabled.