0.12.39 β€’ Published 6 months ago

parser-de-notas-de-corretagem v0.12.39

Weekly downloads
-
License
GNU GPLv3
Repository
github
Last release
6 months ago

🦜 Brazilian brokerage notes PDFs parser

Note: This is a JS/TS package. If you want the end-user solution, check the Leitor de notas de corretagem

npm CI Assets auto update

Easing the PITA of making IRPF.

!WARNING ❗ Inter is only supported from v0.8.0 onwards.

❗ Nubank in only supported from v0.12.0 onwards.

πŸ“° Contents

🚧 Support

!TIP πŸ§ͺ Under test

βœ… Good support

  • Rico βœ…
  • Clear βœ…
  • Inter βœ…
  • Nubank πŸ§ͺ
    • Default πŸ§ͺ
    • Sinacor ❓

!TIP As of 2025, Nubank provides non-Sinacor versions of brokerage notes by default. This parser is focused on parsing those non-Sinacor ones (for now).

πŸ’‘ Example result

The price and average fields already include the fees paid

[
  {
    "number": "11111",    // Brokerage note number
    "buyTotal": "4054.58",
    "sellTotal": "0.00",
    "buyFees": "1.24",
    "sellFees": "0.00",
    "fees": "1.24",
    "date": "02/02/2022", // Can also output in yyyy-MM-dd format changing `NoteParser.dateFormat`
    "holder": "rico",
    "deals": [
      {
        "type": "buy",
        "code": "FLRY3",
        "quantity": 62,
        "average": "16.30",
        "price": "1010.91",
        "date": "02/02/2022",
        "cnpj": "60.840.055/0001-31",
        "isFII": false
      },
      {
        "type": "buy",
        "code": "ALZR11",
        "quantity": 5,
        "average": "112.80",
        "price": "564.02",
        "date": "02/02/2022",
        "cnpj": "28.737.771/0001-85",
        "isFII": true
      },
      {
        "type": "buy",
        "code": "HGRU11",
        "quantity": 5,
        "average": "112.03",
        "price": "560.17",
        "date": "02/02/2022",
        "cnpj": "29.641.226/0001-53",
        "isFII": true
      },
      {
        "type": "buy",
        "code": "VISC11",
        "quantity": 15,
        "average": "97.38",
        "price": "1460.69",
        "date": "02/02/2022",
        "cnpj": "17.554.274/0001-25",
        "isFII": true
      },
      {
        "type": "buy",
        "code": "XPML11",
        "quantity": 5,
        "average": "91.76",
        "price": "458.79",
        "date": "02/02/2022",
        "cnpj": "28.757.546/0001-00",
        "isFII": true
      }
    ]
  }
]

πŸ› οΈ Install

npm i parser-de-notas-de-corretagem

πŸ“š Usage

πŸš€ Full NodeJS example

import fs from 'fs';
import path from 'path';
import { Deal, NoteParser, type NegotiationNote } from 'parser-de-notas-de-corretagem';

async function main() {

  console.log(`Leitor de Notas de NegociaΓ§Γ£o - GNU GPLv3`);

  const assets = new NoteParser();
  try {

    // Get all negotiation notes inside a PDF, even with password
    const possiblePDFpasswords: string[] = ['123', '456'];
    let pdfPath = path.join(__dirname, 'note.pdf');
    let parseResult: NegotiationNote[]
    try {
      parseResult = await assets.parseNote(path.basename(pdfPath), fs.readFileSync(pdfPath), possiblePDFpasswords);
    } catch (error: unknown) {
      if (error instanceof UnknownAsset) {
        console.log(`Unknown asset found: ${error.asset}`)
        // Ignore unknown assets and parse again. Unknown assets will have `code` as `UNDEF: <name>`
        parseResult = await assets.parseNote(path.basename(pdfPath), fs.readFileSync(pdfPath), possiblePDFpasswords, true);
      } else throw error
    }

    // Merge all negotiation notes
    let allDeals: Deal[][] = [];
    parseResult.forEach(note => {
      note.deals.forEach(deal => {
        let index = allDeals.findIndex(el => el.some(subEl => subEl.code === deal.code));
        if (index === -1) {
          allDeals.push([deal]);
        } else {
          allDeals[index].push(deal);
        }
      })
    })

    // Generate a .csv result
    let result: string = `CΓ³digo\tCNPJ\tData\tC/V\tQuantidade\tPreΓ§o+custos\n`;
    allDeals.forEach(asset => {
      asset.forEach(deal => {
        result += `${deal.code}\t${deal.cnpj}\t${deal.date}\t${deal.type=='buy'?'C':'V'}\t${deal.quantity}\t${deal.price.replace(/\./g, ',')}\n`;
      })
      result += `\n`;
    });

    fs.writeFileSync(path.join(__dirname, '..', '..', 'Resultado.csv'), result);

    console.log(`Todas as ${parseResult.length} notas foram processadas`);
    console.log(`O arquivo "Resultado.csv" foi gerado no diretΓ³rio atual.`);

  } catch (error) {
    console.log(error);
  }
}

main();

🌐 Browser

Since only Uint8Array is accepted, use the following code to convert a string using the browser

if (typeof fileContent === 'string') fileContent = Uint8Array.from(fileContent, x => x.charCodeAt(0));
await assetsParser.parseNote(filePath, fileContent, filePasswords);

🎨 Add a custom stock

There are many assets out there and some of them (like funds) are kind of hard to keep track. If some asset is not recognized, parseNote will throw the error UnknownAsset

const assets = new NoteParser();
try {
  await assets.parseNote(filePath, fileContent, filePasswords)
} catch (error) {
  if (error instanceof UnknownAsset) {
    console.log(`Unknown asset found: ${error.asset}`)
  } else console.log(error)
}

One can parse the note ignoring this error by passing continueOnError as true. Unknown assets will have the code UNDEF: <name> whereas the <name> is the name of the asset as in the note.

const assets = new NoteParser();
await assets.parseNote(filePath, fileContent, filePasswords, true)

For unknown assets to be properly parsed, one can add custom stocks with .defineStock

const assets = new NoteParser();
// Old stocks aren't available by default, but you can add them.
// CNPJ as the third argument is optional
assets.defineStock('BIDI3', 'BANCO INTER ON');
assets.defineStock('BIDI11', 'BANCO INTER UNT');
// Some codes can appear with multiple names. Add as many as needed
assets.defineStock('KDIF11', 'KINEA INFRAF FIDC', '26.324.298/0001-89');
assets.defineStock('KDIF11', 'FDC KINEAINF FIDC', '26.324.298/0001-89');
// Backward compatible with the below too
assets.defineStock('KDIF11_2', 'FDC KINEAINF FIDC', '26.324.298/0001-89');

🎭 Behavior

  • Total values include fees
  • The values can deviate from cents. It's always a good call to double-check if the result is as expected. Check the 🏦 License
  • Inter broker has only a few tests, so please open Issues if you find something wrong
  • Local auto-update isn't persistent. New releases are done everyday with persistent updates
  • Other brokers may work with the internal PDF architecture is the same as the supported brokers

❀️ Contributors

Thanks to whom sent the notes for the tests ❀️. Personal data is not stored neither used on tests, only the notes' content.

πŸ™πŸ» Thanks? You're welcome

Consider thanking me: send a "Thanks!" πŸ‘‹ by PIX 😊

a09e5878-2355-45f7-9f36-6df4ccf383cf

🏦 License

As license, this software is provided as is, free of charge, without any warranty whatsoever. Its author is not responsible for its usage. Use it by your own risk.

GNU GPLv3

0.12.30

6 months ago

0.12.31

6 months ago

0.12.32

6 months ago

0.12.33

6 months ago

0.11.8

8 months ago

0.11.9

7 months ago

0.12.38

6 months ago

0.11.0

8 months ago

0.12.39

6 months ago

0.11.1

8 months ago

0.11.2

8 months ago

0.11.3

8 months ago

0.12.34

6 months ago

0.11.4

8 months ago

0.12.35

6 months ago

0.11.5

8 months ago

0.12.36

6 months ago

0.11.6

8 months ago

0.12.37

6 months ago

0.11.7

8 months ago

0.12.7

7 months ago

0.12.8

7 months ago

0.12.9

7 months ago

0.12.0

7 months ago

0.12.1

7 months ago

0.12.2

7 months ago

0.12.3

7 months ago

0.12.4

7 months ago

0.12.5

7 months ago

0.12.6

7 months ago

0.12.10

7 months ago

0.12.11

7 months ago

0.12.16

7 months ago

0.12.17

7 months ago

0.12.18

7 months ago

0.12.19

7 months ago

0.12.12

7 months ago

0.12.13

7 months ago

0.12.14

7 months ago

0.12.15

7 months ago

0.12.20

7 months ago

0.12.21

7 months ago

0.12.22

6 months ago

0.12.27

6 months ago

0.12.28

6 months ago

0.12.29

6 months ago

0.12.23

6 months ago

0.12.24

6 months ago

0.12.25

6 months ago

0.12.26

6 months ago

0.11.10

7 months ago

0.11.11

7 months ago

0.11.12

7 months ago

0.11.13

7 months ago

0.11.14

7 months ago

0.10.220

10 months ago

0.10.211

10 months ago

0.10.210

10 months ago

0.10.213

10 months ago

0.10.212

10 months ago

0.10.215

10 months ago

0.10.214

10 months ago

0.10.217

10 months ago

0.10.216

10 months ago

0.10.219

10 months ago

0.10.218

10 months ago

0.10.231

9 months ago

0.10.230

9 months ago

0.10.222

10 months ago

0.10.221

10 months ago

0.10.224

10 months ago

0.10.223

10 months ago

0.10.226

10 months ago

0.10.225

10 months ago

0.10.228

9 months ago

0.10.227

9 months ago

0.10.229

9 months ago

0.10.240

9 months ago

0.10.242

9 months ago

0.10.241

9 months ago

0.10.233

9 months ago

0.10.232

9 months ago

0.10.235

9 months ago

0.10.234

9 months ago

0.10.237

9 months ago

0.10.236

9 months ago

0.10.239

9 months ago

0.10.238

9 months ago

0.10.251

9 months ago

0.10.250

9 months ago

0.10.253

9 months ago

0.10.252

9 months ago

0.10.244

9 months ago

0.10.243

9 months ago

0.10.246

9 months ago

0.10.245

9 months ago

0.10.248

9 months ago

0.10.247

9 months ago

0.10.249

9 months ago

0.10.260

8 months ago

0.10.262

8 months ago

0.10.261

8 months ago

0.10.264

8 months ago

0.10.263

8 months ago

0.10.255

8 months ago

0.10.254

8 months ago

0.10.257

8 months ago

0.10.256

8 months ago

0.10.259

8 months ago

0.10.258

8 months ago

0.10.266

8 months ago

0.10.265

8 months ago

0.10.267

8 months ago

0.10.204

10 months ago

0.10.206

10 months ago

0.10.205

10 months ago

0.10.208

10 months ago

0.10.207

10 months ago

0.10.209

10 months ago

0.10.202

10 months ago

0.10.201

11 months ago

0.10.203

10 months ago

0.10.200

11 months ago

0.10.199

11 months ago

0.10.181

11 months ago

0.10.180

11 months ago

0.10.183

11 months ago

0.10.182

11 months ago

0.10.185

11 months ago

0.10.184

11 months ago

0.10.187

11 months ago

0.10.186

11 months ago

0.10.178

11 months ago

0.10.177

11 months ago

0.10.179

11 months ago

0.10.190

11 months ago

0.10.192

11 months ago

0.10.191

11 months ago

0.10.194

11 months ago

0.10.193

11 months ago

0.10.196

11 months ago

0.10.195

11 months ago

0.10.198

11 months ago

0.10.197

11 months ago

0.10.189

11 months ago

0.10.188

11 months ago

0.10.152

1 year ago

0.10.151

1 year ago

0.10.154

1 year ago

0.10.153

1 year ago

0.10.161

12 months ago

0.10.160

12 months ago

0.10.163

12 months ago

0.10.162

12 months ago

0.10.165

12 months ago

0.10.164

12 months ago

0.10.156

1 year ago

0.10.155

1 year ago

0.10.158

12 months ago

0.10.157

12 months ago

0.10.159

12 months ago

0.10.170

12 months ago

0.10.172

12 months ago

0.10.171

12 months ago

0.10.174

12 months ago

0.10.173

12 months ago

0.10.176

11 months ago

0.10.175

12 months ago

0.10.167

12 months ago

0.10.166

12 months ago

0.10.169

12 months ago

0.10.168

12 months ago

0.10.110

1 year ago

0.10.101

1 year ago

0.10.100

1 year ago

0.10.103

1 year ago

0.10.102

1 year ago

0.10.105

1 year ago

0.10.104

1 year ago

0.10.107

1 year ago

0.10.106

1 year ago

0.10.109

1 year ago

0.10.108

1 year ago

0.10.121

1 year ago

0.10.120

1 year ago

0.10.112

1 year ago

0.10.111

1 year ago

0.10.114

1 year ago

0.10.113

1 year ago

0.10.116

1 year ago

0.10.115

1 year ago

0.10.118

1 year ago

0.10.117

1 year ago

0.10.119

1 year ago

0.10.130

1 year ago

0.10.132

1 year ago

0.10.131

1 year ago

0.10.123

1 year ago

0.10.122

1 year ago

0.10.125

1 year ago

0.10.124

1 year ago

0.10.127

1 year ago

0.10.126

1 year ago

0.10.129

1 year ago

0.10.128

1 year ago

0.10.95

1 year ago

0.10.96

1 year ago

0.10.97

1 year ago

0.10.141

1 year ago

0.10.140

1 year ago

0.10.143

1 year ago

0.10.142

1 year ago

0.10.134

1 year ago

0.10.133

1 year ago

0.10.136

1 year ago

0.10.135

1 year ago

0.10.138

1 year ago

0.10.137

1 year ago

0.10.139

1 year ago

0.10.98

1 year ago

0.10.99

1 year ago

0.10.150

1 year ago

0.10.145

1 year ago

0.10.144

1 year ago

0.10.147

1 year ago

0.10.146

1 year ago

0.10.149

1 year ago

0.10.148

1 year ago

0.10.94

1 year ago

0.10.91

1 year ago

0.10.92

1 year ago

0.10.93

1 year ago

0.10.90

1 year ago

0.10.88

1 year ago

0.10.87

1 year ago

0.10.86

1 year ago

0.10.85

1 year ago

0.10.84

1 year ago

0.10.83

1 year ago

0.10.82

1 year ago

0.10.80

1 year ago

0.10.81

1 year ago

0.10.79

1 year ago

0.10.78

1 year ago

0.10.77

1 year ago

0.10.76

1 year ago

0.10.75

1 year ago

0.10.74

1 year ago

0.10.73

1 year ago

0.10.72

1 year ago

0.10.71

1 year ago

0.10.70

1 year ago

0.10.69

1 year ago

0.10.68

1 year ago

0.10.66

1 year ago

0.10.67

1 year ago

0.10.64

1 year ago

0.10.65

1 year ago

0.10.63

1 year ago

0.10.62

1 year ago

0.10.61

1 year ago

0.10.60

1 year ago

0.10.58

1 year ago

0.10.59

1 year ago

0.10.56

1 year ago

0.10.57

1 year ago

0.10.55

1 year ago

0.10.54

1 year ago

0.10.53

1 year ago

0.10.52

1 year ago

0.10.51

1 year ago

0.10.50

1 year ago

0.10.48

1 year ago

0.10.49

1 year ago

0.10.47

1 year ago

0.10.45

1 year ago

0.10.46

1 year ago

0.10.43

1 year ago

0.10.44

1 year ago

0.10.42

1 year ago

0.10.41

1 year ago

0.10.40

1 year ago

0.10.39

1 year ago

0.10.38

1 year ago

0.10.37

1 year ago

0.10.36

1 year ago

0.10.35

2 years ago

0.10.34

2 years ago

0.10.33

2 years ago

0.10.32

2 years ago

0.10.29

2 years ago

0.10.30

2 years ago

0.10.31

2 years ago

0.10.28

2 years ago

0.10.25

2 years ago

0.10.26

2 years ago

0.10.27

2 years ago

0.10.23

2 years ago

0.10.24

2 years ago

0.10.22

2 years ago

0.10.21

2 years ago

0.10.20

2 years ago

0.10.18

2 years ago

0.10.19

2 years ago

0.10.17

2 years ago

0.10.14

2 years ago

0.10.15

2 years ago

0.10.16

2 years ago

0.10.13

2 years ago

0.10.12

2 years ago

0.10.11

2 years ago

0.10.10

2 years ago

0.10.9

2 years ago

0.10.8

2 years ago

0.10.7

2 years ago

0.10.6

2 years ago

0.10.4

2 years ago

0.10.5

2 years ago

0.10.1

2 years ago

0.10.2

2 years ago

0.10.3

2 years ago

0.10.0

2 years ago

0.9.85

2 years ago

0.9.84

2 years ago

0.9.82

2 years ago

0.9.83

2 years ago

0.9.81

2 years ago

0.9.80

2 years ago

0.9.79

2 years ago

0.9.78

2 years ago

0.9.75

2 years ago

0.9.76

2 years ago

0.9.77

2 years ago

0.9.74

2 years ago

0.9.72

2 years ago

0.9.73

2 years ago

0.9.71

2 years ago

0.9.70

2 years ago

0.9.69

2 years ago

0.9.67

2 years ago

0.9.68

2 years ago

0.9.66

2 years ago

0.9.64

2 years ago

0.9.65

2 years ago

0.9.63

2 years ago

0.9.62

2 years ago

0.9.60

2 years ago

0.9.61

2 years ago

0.9.58

2 years ago

0.9.59

2 years ago

0.9.57

2 years ago

0.9.56

2 years ago

0.9.52

2 years ago

0.9.53

2 years ago

0.9.54

2 years ago

0.9.55

2 years ago

0.9.50

2 years ago

0.9.51

2 years ago

0.9.45

2 years ago

0.9.46

2 years ago

0.9.47

2 years ago

0.9.48

2 years ago

0.9.41

2 years ago

0.9.42

2 years ago

0.9.43

2 years ago

0.9.44

2 years ago

0.9.49

2 years ago

0.9.40

2 years ago

0.9.34

2 years ago

0.9.8

2 years ago

0.9.35

2 years ago

0.9.7

2 years ago

0.9.36

2 years ago

0.9.37

2 years ago

0.9.9

2 years ago

0.9.30

2 years ago

0.9.4

2 years ago

0.9.31

2 years ago

0.9.3

2 years ago

0.9.32

2 years ago

0.9.6

2 years ago

0.9.33

2 years ago

0.9.5

2 years ago

0.9.38

2 years ago

0.9.39

2 years ago

0.9.23

2 years ago

0.9.24

2 years ago

0.9.25

2 years ago

0.9.26

2 years ago

0.9.20

2 years ago

0.9.21

2 years ago

0.9.22

2 years ago

0.9.27

2 years ago

0.9.28

2 years ago

0.9.29

2 years ago

0.9.12

2 years ago

0.9.13

2 years ago

0.9.14

2 years ago

0.9.15

2 years ago

0.9.10

2 years ago

0.9.11

2 years ago

0.9.16

2 years ago

0.9.17

2 years ago

0.9.18

2 years ago

0.9.19

2 years ago

0.9.1

2 years ago

0.8.78

2 years ago

0.8.77

2 years ago

0.8.79

2 years ago

0.8.74

2 years ago

0.8.73

2 years ago

0.8.76

2 years ago

0.8.75

2 years ago

0.8.70

2 years ago

0.8.72

2 years ago

0.8.71

2 years ago

0.8.67

2 years ago

0.8.66

2 years ago

0.8.69

2 years ago

0.8.68

2 years ago

0.8.63

2 years ago

0.8.62

2 years ago

0.8.65

2 years ago

0.8.64

2 years ago

0.8.61

2 years ago

0.9.0

2 years ago

0.8.9

2 years ago

0.8.8

2 years ago

0.8.5

2 years ago

0.8.4

2 years ago

0.8.7

2 years ago

0.8.6

2 years ago

0.7.22

2 years ago

0.7.21

2 years ago

0.7.23

2 years ago

0.7.20

2 years ago

0.7.2

2 years ago

0.7.1

2 years ago

0.7.4

2 years ago

0.7.3

2 years ago

0.7.0

2 years ago

0.7.11

2 years ago

0.7.10

2 years ago

0.7.13

2 years ago

0.7.12

2 years ago

0.7.19

2 years ago

0.7.18

2 years ago

0.7.15

2 years ago

0.7.14

2 years ago

0.7.17

2 years ago

0.7.16

2 years ago

0.8.60

2 years ago

0.8.56

2 years ago

0.8.55

2 years ago

0.8.58

2 years ago

0.8.57

2 years ago

0.8.52

2 years ago

0.8.51

2 years ago

0.8.54

2 years ago

0.8.53

2 years ago

0.8.59

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago

0.8.50

2 years ago

0.8.3

2 years ago

0.8.2

2 years ago

0.8.45

2 years ago

0.8.44

2 years ago

0.8.47

2 years ago

0.8.46

2 years ago

0.8.41

2 years ago

0.8.40

2 years ago

0.8.43

2 years ago

0.8.42

2 years ago

0.8.49

2 years ago

0.8.48

2 years ago

0.8.34

2 years ago

0.8.33

2 years ago

0.8.36

2 years ago

0.8.35

2 years ago

0.8.30

2 years ago

0.8.32

2 years ago

0.8.31

2 years ago

0.8.38

2 years ago

0.8.37

2 years ago

0.8.39

2 years ago

0.8.23

2 years ago

0.8.22

2 years ago

0.7.9

2 years ago

0.8.25

2 years ago

0.8.24

2 years ago

0.7.6

2 years ago

0.7.5

2 years ago

0.8.21

2 years ago

0.7.8

2 years ago

0.8.20

2 years ago

0.7.7

2 years ago

0.8.27

2 years ago

0.8.26

2 years ago

0.8.29

2 years ago

0.8.28

2 years ago

0.8.12

2 years ago

0.8.11

2 years ago

0.8.14

2 years ago

0.8.13

2 years ago

0.8.10

2 years ago

0.8.19

2 years ago

0.8.16

2 years ago

0.8.15

2 years ago

0.8.18

2 years ago

0.8.17

2 years ago

0.5.4

2 years ago

0.5.3

2 years ago

0.5.0

2 years ago

0.6.1

2 years ago

0.5.2

2 years ago

0.6.0

2 years ago

0.5.1

2 years ago

0.1.0

3 years ago

0.3.0

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.4.4

2 years ago

0.4.1

2 years ago

0.2.3

3 years ago

0.0.5

3 years ago

0.4.0

2 years ago

0.3.1

3 years ago

0.2.2

3 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.2.4

3 years ago

0.0.3

3 years ago

0.0.4

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago