aade-mydata-client/README.md

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

# aade-mydata-client
Node.js Client for AADE myDATA (my Digital Accounting and Tax Application) REST API

## Features

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

## Installation
    npm install -S aade-mydata-client


## Usage

#### TypeScript

   ```ts
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
```js
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

<table>
	<tr>
		<td align="center"><a href="https://johnmakridis.github.io"><img src="https://avatars.githubusercontent.com/u/19326052?v=4" width="120px;" alt="John Makridis"/>	<br />John Makridis</a>
		</td>
	</tr>
</table>

## Contributors

If you want to contribute to this repository  <a href="https://johnmakridis.github.io">send me a message</a>.