@mojoio/sevdesk
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.42 • Public • Published

    @mojoio/sevdesk

    mojoio integration package for sevdesk

    Availabililty and Links

    Status for master

    Status Category Status Badge
    GitLab Pipelines pipeline status
    GitLab Pipline Test Coverage coverage report
    npm npm downloads per month
    Snyk Known Vulnerabilities
    TypeScript Support TypeScript
    node Support node
    Code Style Code Style
    PackagePhobia (total standalone install weight) PackagePhobia
    PackagePhobia (package size on registry) PackagePhobia
    BundlePhobia (total size when bundled) BundlePhobia
    Platform support Supports Windows 10 Supports Mac OS X

    Usage

    Use TypeScript for best in class instellisense.

    This package aims to be a fully typed (TypeScript), easy to use unofficial nodejs API package for sevdesk.com.

    The basic concept of this library consists of classes that expose static functions (factories) for retrieving instances from the sevdesk API while abstracting enough to not needing to know the specifics of that API.

    Typings and constructor options follow the world view of @tsclass/tsclass, a package that exposes generalized interfaces for real world objects.

    Available Classes

    • SevdeskAccount -> handles the basic Account setup for authentication
    • SevdeskContact -> handles contacts within sevdesk
    • SevdeskVoucher -> handles expenses/receipts/vouchers within sevdesk
    • SevdeskCheckingAccount -> handles CheckingAccounts within sevdesk
    • SevdeskTransaction -> handles Transactions within sevdesk
    import * as sevdesk from '@mojoio/sevdesk';
     
    const run = async () => {
      const sevdeskAccount = new sevdesk.SevdeskAccount('myTokenString1234567890');
      const contacts: sevdesk.SevdeskContact[] = await sevdeskAccount.getContacts();
      const certainContact = contacts.find((contact) => {
        return contact.customerNumber === '1000';
      });
     
      // lets update the name of a contact
      certainContact.name = 'My New Name';
      await certainContact.save();
    };
    run();

    A simple example to create Transactions:

    import * as sevdesk from '@mojoio/sevdesk';
     
    const run = async () => {
      const sevdeskAccount = new sevdesk.SevdeskAccount('myTokenString1234567890');
      const sevdeskCheckingAccounts: sevdesk.SevdeskCheckingAccount[] = await sevdeskAccount.getCheckingAccounts();
     
      // lets create a new checking account
      const myCommerzbankAccount = await sevdeskAccount.createCheckingAccount({
        currency: 'EUR',
        name: 'commerzbank',
        transactions: [],
      });
     
      const myNewTransaction = await myCommerzbankAccount.createTransaction({
        payeeName: 'Max Mustermann',
        amount: 100,
        date: new Date(),
        status: 'unpaid',
        description: 'a cool description',
      });
    };
     
    run();

    Contribution

    We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

    For further information read the linked docs at the top of this readme.

    MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

    repo-footer

    Keywords

    none

    Install

    npm i @mojoio/sevdesk

    DownloadsWeekly Downloads

    3

    Version

    1.5.42

    License

    MIT

    Unpacked Size

    105 kB

    Total Files

    44

    Last publish

    Collaborators

    • lossless