parser-de-notas-de-corretagem 0.7.23 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -3
- package/notes-parser.js +1 -1
- package/notes-parser.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Parse Brazilian brokerage notes PDFs (Rico and
|
|
1
|
+
# Parse Brazilian brokerage notes PDFs (Rico, Clear, and Inter holders available)
|
|
2
2
|
|
|
3
3
|
 [](https://github.com/planetsLightningArrester/parser-de-notas-de-corretagem/actions/workflows/ci.yml) [](https://github.com/planetsLightningArrester/parser-de-notas-de-corretagem/actions/workflows/assets-auto-update.yml)
|
|
4
4
|
|
|
@@ -6,6 +6,8 @@ Easing the PITA of making IRPF
|
|
|
6
6
|
|
|
7
7
|
> Note: This is a JS/TS package. If you want the end-user solution, check the [Leitor de notas de corretagem](https://github.com/planetsLightningArrester/leitor-de-notas-de-corretagem)
|
|
8
8
|
|
|
9
|
+
> Note: Inter support only v0.8.0 onwards
|
|
10
|
+
|
|
9
11
|
## Example result
|
|
10
12
|
> The `price` and `average` fields already include the fees paid
|
|
11
13
|
```JSON
|
|
@@ -143,17 +145,24 @@ assetsParser.parseNote(filePath, fileContent, filePasswords);
|
|
|
143
145
|
### Add a custom stock
|
|
144
146
|
```Typescript
|
|
145
147
|
const assets = new NoteParser();
|
|
146
|
-
// Old stocks aren't available by default, but you can add them
|
|
148
|
+
// Old stocks aren't available by default, but you can add them.
|
|
149
|
+
// CNPJ as the third argument is optional
|
|
147
150
|
assets.defineStock('BIDI3', 'BANCO INTER ON');
|
|
148
151
|
assets.defineStock('BIDI11', 'BANCO INTER UNT');
|
|
152
|
+
// If the same asset can have multiple codes, add a "_2", "_3", etc. with the names
|
|
153
|
+
this.defineStock('KDIF11', 'KINEA INFRAF FIDC', '26.324.298/0001-89');
|
|
154
|
+
this.defineStock('KDIF11_2', 'FDC KINEAINF FIDC', '26.324.298/0001-89');
|
|
149
155
|
```
|
|
150
156
|
|
|
151
157
|
## P.S.
|
|
152
158
|
* Total values include fees
|
|
153
159
|
* The values can deviate from cents. It's always a good call to double-check if the result is as expected. Check the [License](#license)
|
|
160
|
+
* Inter broker has only a few tests, so please open [Issues](https://github.com/planetsLightningArrester/parser-de-notas-de-corretagem/issues) if you find something wrong
|
|
161
|
+
* Local auto-update isn't persistent. New releases are done everyday with persistent updates
|
|
162
|
+
* Other brokers may work with the internal PDF architecture is the same as the supported brokers
|
|
154
163
|
|
|
155
164
|
## Contributors
|
|
156
|
-
Thanks to whom sent
|
|
165
|
+
Thanks to whom sent the notes for the tests ❤️. Personal data is not stored neither used on tests, only the notes' content.
|
|
157
166
|
|
|
158
167
|
## Thanks? U welcome
|
|
159
168
|
Consider thanking me: send a "Thanks!" 👋 by [PIX](https://www.bcb.gov.br/en/financialstability/pix_en) 😊
|