aade-mydata-client
TypeScript icon, indicating that this package has built-in type declarations

1.2.3 • Public • Published

aade-mydata-client

Node.js Client for AADE myDATA (my Digital Accounting and Tax Application) REST API

Features

✅   HTTP requests to AADE myDATA REST API through axios
✅   XML to JSON conversion (currently myData API only supports response data in XML. The client parses these data in JSON format.)
✅   JSON to XML conversion (The client parses your JSON data to XML for the request body.)
✅   Javascript/Typescript support
✅   Compatible with myDATA REST API v1.0.2
📝   TODO: Methods requestTransmittedDocs(), sendIncomeClassification(), sendExpensesClassification() are not yet ready

Installation

npm install -S aade-mydata-client

Usage

TypeScript

import { AADEmyDataClient } from 'aade-mydata-client';

class YourClass {

 public myDataClient: AADEmyDataClient;

 constructor() {

     this.myDataClient = new AADEmyDataClient({
         userId: 'YOUR_USER_ID',
         subscriptionKey: 'YOUR_SUBSCRIPTION_KEY',
         livemode: false // true for production API requests
     });

 }

 // Example call for RequestDocs
 async main(): Promise<void> {

     const invoices = await this.myDataClient.requestDocs({ mark: 0 });
     // this method returns Invoice[] for credentials you defined in the client above

 }

}

CommonJS

const AADEmyDataClient = require('aade-mydata-client').AADEmyDataClient;

const myDataClient = new AADEmyDataClient({
    userId: 'YOUR_USER_ID',
    subscriptionKey: 'YOUR_SUBSCRIPTION_KEY',
    livemode: false // true for production API requests
});

const main = async () => {

    try {

        const invoices = await myDataClient.requestDocs({ mark: 0 });
        console.log(invoices);

    } catch (error) {

    }

}

main();

Methods

sendInvoices()

Submits one or more invoices, including corrected/amending

requestDocs()

Returns all documents submitted for the corresponding AADE account.

requestTransmittedDocs()

Request transmitted documents

sendIncomeClassification()

Submits invoice for income

sendExpensesClassification()

Submit invoice for expenses

cancelInvoice()

Method for cancelling a invoice

Author

John Makridis
John Makridis

Contributors

If you want to contribute to this repository send me a message.

Package Sidebar

Install

npm i aade-mydata-client

Weekly Downloads

14

Version

1.2.3

License

none

Unpacked Size

252 kB

Total Files

64

Last publish

Collaborators

  • johnmakridis