Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[17.0][IMP] account_statement_import_sheet_file: Improve readme #724

Open
wants to merge 2 commits into
base: 17.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 103 additions & 14 deletions account_statement_import_sheet_file/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Bank Statement TXT/CSV/XLSX Import
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:90ec58274c675f5d4eb830271ef275cb5cd09e5c62babf88fd1ee82e5f228368
!! source digest: sha256:a81423792c6f54b75b043e2526b1bb7768ed6db7404f13ee64aaee7c07049081
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
Expand All @@ -28,32 +28,121 @@ Bank Statement TXT/CSV/XLSX Import

|badge1| |badge2| |badge3| |badge4| |badge5|

This module allows you to import any TXT/CSV or XLSX file in Odoo as
bank statements.
This module allows users to import bank statements into Odoo using files
in TXT, CSV, or XLSX formats. It is designed to streamline the process
of importing and managing bank statement data within Odoo, making it
easier to handle financial records and reconcile transactions.

**Table of contents**

.. contents::
:local:

Use Cases / Context
===================

Business need
-------------

The account_statement_import_sheet_file module addresses a critical
business requirement: the efficient and accurate importation of bank
statement data into Odoo. This need arises due to: Manual data entry
limitations Financial Accuracy and Compliance Operational Efficiency

Approach
--------

The module allows users to import bank statements in TXT, CSV, or XLSX
formats directly into Odoo, reducing the need for manual data entry.

Users can configure column mappings to match the format of their bank
statements, ensuring that the imported data aligns correctly with Odoo’s
data structure.

The module integrates smoothly with Odoo’s accounting functionalities,
allowing for easy reconciliation of imported transactions with existing
records.

Useful information
------------------

The module depends on Odoo’s accounting features. Users should ensure
that the core accounting module is properly configured before using this
module.

Configuration
=============

To create TXT/CSV/XLSX statement sheet columns mapping:
To configure this module, you need to:

1. Create a Statement Sheet Mappings: Go to > Invoicing > Configuration
> Accounting > Statement Sheet Mappings

|Alt Text|

2. Create a New Mapping and configure it:

|Alt Text|

- Name: Specify the name of the field as per your bank statement.
- Thousands Separator and Decimal Separator: Specify the format of the
number.
- Timestamp Format: Specify the format of the date. For example:

- %d/%m/%Y = 01/05/2022
- %d/%m/%y = 01/05/22
- %d-%m-%Y = 01-05-2022
- %Y-%m-%dT%H:%M:%SZ = 2022-05-01T15:22:10Z

1. Open *Invoicing > Configuration > Accounting > Statement Sheet
Mappings*
2. Create mapping(s) according to your online banking software statement
format
- Header lines skip count: The number of the line that contains the
tags of the data.
- Footer lines skip count: Amount of lines to skip of the footer.

3. Configure the columns to match your bank statement format:

At least, you have to configure:

- Timestamp Column
- Amount type and amount Column
- Description Column

|Alt Text|

4. Set the Mapping as default in the bank journal and the bank feeds:

|Alt Text|

|Alt Text|

.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/config1.png
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/config2.png
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/config3.png
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/config4.png
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/config5.png

Usage
=====

To use this module, you need to:
Once you have the Mapping and the Journal set up, you have to import the
bank statement

1. Go to Account > Dashboard
2. Click “Import OCA” in the bank journal configured.

|Alt Text|

3. Then “Upload your file”

|Alt Text|

4. Pick your bank file already downloaded.
5. Import and Start to Reconcile

|Alt Text|

1. Get statement in TXT/CSV or XLSX from your online banking software
2. Go to Odoo and and import the statement file, selecting corresponding
format
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/usage1.png
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/usage2.png
.. |Alt Text| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_sheet_file/static/usage3.png

Changelog
=========
Expand Down Expand Up @@ -91,13 +180,13 @@ Contributors
- Alexis de Lattre <[email protected]>
- Sebastien BEAU <[email protected]>
- Katherine Zaoral
- Tecnativa (https://www.tecnativa.com)
- Tecnativa (`https://www.tecnativa.com <https://www.tecnativa.com>`__)

- Vicent Cubells
- Victor M.M. Torres
- Víctor Martínez

- ForgeFlow (https://www.forgeflow.com)
- ForgeFlow (`https://www.forgeflow.com <https://www.forgeflow.com>`__)

- Jordi Ballester Alomar <[email protected]>
- Miquel Raïch Regué <[email protected]>
Expand Down
38 changes: 33 additions & 5 deletions account_statement_import_sheet_file/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
To create TXT/CSV/XLSX statement sheet columns mapping:
To configure this module, you need to:
1. Create a Statement Sheet Mappings: Go to > Invoicing > Configuration > Accounting > Statement Sheet Mappings

![ Alt Text](../static/config1.png)

2. Create a New Mapping and configure it:

![ Alt Text](../static/config2.png)

- Name: Specify the name of the field as per your bank statement.
- Thousands Separator and Decimal Separator: Specify the format of the number.
- Timestamp Format: Specify the format of the date. For example:
- %d/%m/%Y = 01/05/2022
- %d/%m/%y = 01/05/22
- %d-%m-%Y = 01-05-2022
- %Y-%m-%dT%H:%M:%SZ = 2022-05-01T15:22:10Z
- Header lines skip count: The number of the line that contains the tags of the data.
- Footer lines skip count: Amount of lines to skip of the footer.

3. Configure the columns to match your bank statement format:

At least, you have to configure:
- Timestamp Column
- Amount type and amount Column
- Description Column

![ Alt Text](../static/config3.png)

4. Set the Mapping as default in the bank journal and the bank feeds:

![ Alt Text](../static/config4.png)

![ Alt Text](../static/config5.png)

1. Open *Invoicing \> Configuration \> Accounting \> Statement Sheet
Mappings*
2. Create mapping(s) according to your online banking software
statement format
21 changes: 21 additions & 0 deletions account_statement_import_sheet_file/readme/CONTEXT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Business need
-------------

The account_statement_import_sheet_file module addresses a critical business requirement: the efficient and accurate importation of bank statement data into Odoo. This need arises due to:
Manual data entry limitations
Financial Accuracy and Compliance
Operational Efficiency

Approach
--------

The module allows users to import bank statements in TXT, CSV, or XLSX formats directly into Odoo, reducing the need for manual data entry.

Users can configure column mappings to match the format of their bank statements, ensuring that the imported data aligns correctly with Odoo’s data structure.

The module integrates smoothly with Odoo’s accounting functionalities, allowing for easy reconciliation of imported transactions with existing records.

Useful information
------------------

The module depends on Odoo’s accounting features. Users should ensure that the core accounting module is properly configured before using this module.
3 changes: 1 addition & 2 deletions account_statement_import_sheet_file/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
This module allows you to import any TXT/CSV or XLSX file in Odoo as
bank statements.
This module allows users to import bank statements into Odoo using files in TXT, CSV, or XLSX formats. It is designed to streamline the process of importing and managing bank statement data within Odoo, making it easier to handle financial records and reconcile transactions.
20 changes: 16 additions & 4 deletions account_statement_import_sheet_file/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
To use this module, you need to:
Once you have the Mapping and the Journal set up, you have to import the bank statement

1. Go to Account > Dashboard
2. Click “Import OCA” in the bank journal configured.

![ Alt Text](../static/usage1.png)

3. Then “Upload your file”

![ Alt Text](../static/usage2.png)

4. Pick your bank file already downloaded.
5. Import and Start to Reconcile

![ Alt Text](../static/usage3.png)


1. Get statement in TXT/CSV or XLSX from your online banking software
2. Go to Odoo and and import the statement file, selecting
corresponding format
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading