Kitsas Library

Library to connect Kitsas Server. See also template to Kitsas addon.

This typedoc documentation is available at GitHub pages

Installation

npm install kitsas-library
Copy

Main components

Component	Usage
KitsasService	Static class to connect server
KitsasConnectionInterface	General operations
KitsasOfficeInterface	Accounting office, bookshelves and roles
KitsasBookInterface	Accounting interface

First create a connection with KitsasService.

Some examples

Login to Kitsas

import { KitsasService } from 'kitsaslibrary';

const connection = await KitsasService.connect({
  username: 'name@kitsas.fi',
  password: 'secret',
});
Copy

Get list of books

const books = await connection.getBooks();
Copy

Select a book

const book = await connection.getBook('92e71a5d-1c33-4cc9-aa83-281c05c8e4c2');
Copy

Create and save a new document

const document : CreateVoucherDto = { ... } ;
await book.saveVoucher(document, []);
Copy

Using mock implementation

const connection = await KitsasService.connect({
  username: 'test@kitsas.fi',
  password: 'Test+12345',
  mock: true,
});
Copy