Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2.06 KB

README.md

File metadata and controls

49 lines (35 loc) · 2.06 KB

Tresor-Import - The File Import of Tresor One

This is the PDF and PP-CSV Import used on tresor.one. All supported brokers and apps are listed here.

Installation

npm install @tresor.one/import

Usage

import getActivities from '@tresor.one/import';

async fileHandler() {
  const results = await Promise.all(Array.from(this.$refs.myFiles.files).map(getActivities));
  results.forEach(result => {
    console.log(result);
  });
}

The function getActivities returns an objects with the following fields:

Name Description
file The file name of the input file.
activities List of activities which was parsed from the input file. The activity object is broken down here.
status The status code which contains the information about the reason why no activities was found. For Details see the status table.
successful The simple way to check if at least one activity was found and the status code is equals zero.

The status field can contains one of the following values, described here.

How to calculate the amount

To understand the amount calculation please read the amount documentation here (in German).

Contribute

To contribute:

  1. fork the repo
  2. install and start npm i && npm start
  3. open the logged URL, usually http://localhost:5000, in your browser
  4. Import a PDF. Content is shown in your Javascript console
  5. Write a parser in src/brokers to parse that content - see src/brokers/comdirect.js for inspiration
  6. Add and run all tests npm t
  7. Create a Pull Request