KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

node-fatturazione-elettronica-aruba

★ 21 Open GitHub ↗

Node.js client to integrate the Aruba API for electronic invoicing ("Fatturazione Elettronica") within your project.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# fatturazione-elettronica-aruba

[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![Release](https://github.com/andreafalzetti/node-fatturazione-elettronica-aruba/actions/workflows/on-push-master-release.yml/badge.svg)](https://github.com/andreafalzetti/node-fatturazione-elettronica-aruba/actions/workflows/on-push-master-release.yml) [![npm version](https://img.shields.io/npm/v/fatturazione-elettronica-aruba.svg?style=flat)](https://www.npmjs.com/package/fatturazione-elettronica-aruba) [![Coverage Status](https://coveralls.io/repos/github/andreafalzetti/node-fatturazione-elettronica-aruba/badge.svg?branch=master&service=github)](https://coveralls.io/github/andreafalzetti/node-fatturazione-elettronica-aruba?branch=master) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fandreafalzetti%2Fnode-fatturazione-elettronica-aruba.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fandreafalzetti%2Fnode-fatturazione-elettronica-aruba?ref=badge_shield) [![Known Vulnerabilities](https://snyk.io//test/github/andreafalzetti/node-fatturazione-elettronica-aruba/badge.svg?targetFile=package.json)](https://snyk.io//test/github/andreafalzetti/node-fatturazione-elettronica-aruba?targetFile=package.json) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Node.js client to integrate the Aruba API for electronic invoicing ("Fatturazione Elettronica") within your project.

## Roadmap

-   Complete support for Notifications
-   Implement MonitorCheck API
-   Add any new feature introduces by Aruba last minute

## Links

* Aruba API docs: <https://fatturazioneelettronica.aruba.it/apidoc/docs_EN.html>
* npm: <https://www.npmjs.com/package/fatturazione-elettronica-aruba>

## Requirements

This module calls the Aruba Fatturazione Elettronica API, therefore you need a valid set of credentials with their service in order to use this module.

## Install

```
npm install fatturazione-elettronica-aruba
```

## How to use

```js
const ArubaClient = require('fatturazione-elettronica-aruba');

const arubaClient = new ArubaClient();

await arubaClient.signIn({
  username: 'YOUR_ARUBA_USERNAME',
  password: 'YOUR_ARUBA_PASSWORD'
});

await arubaClient.uploadInvoice({ dataFile: 'BASE64_ENCODED_XML' });
```

## Examples

See the [examples](EXAMPLES.md) page for additional use cases and demos.

## API

#### Table of Contents

- [fatturazione-elettronica-aruba](#fatturazione-elettronica-aruba)
  - [Roadmap](#roadmap)
  - [Links](#links)
  - [Requirements](#requirements)
  - [Install](#install)
  - [How to use](#how-to-use)
  - [Examples](#examples)
  - [API](#api)
      - [Table of Contents](#table-of-contents)
    - [ArubaClient](#arubaclient)
      - [Parameters](#parameters)
      - [signIn](#signin)
        - [Parameters](#parameters-1)
      - [refreshToken](#refreshtoken)
      - [searchInvoice](#searchinvoice)
        - [Parameters](#parameters-2)
      - [getInvoiceNotifications](#getinvoicenotifications)
        - [Parameters](#parameters-3)
      - [uploadInvoice](#uploadinvoice)
        - [Parameters](#parameters-4)
  - [Disclaimer](#disclaimer)
  - [License](#license)
  - [Support on Beerpay](#support-on-beerpay)

### ArubaClient

ArubaClient constructor

#### Parameters

-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**
    -   `options.env` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Aruba environment (demo or prod)

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns an instance of ArubaClient

#### signIn

Calls Aruba to generate a JWT that will be used for future calls

##### Parameters

-   `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    -   `data.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Aruba username
    -   `data.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Aruba password

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Resolves to an boolean if successful, or an object
                   containing the error message

#### refreshToken

Calls Aruba to refresh the JWT

#### searchInvoice

Search an invoice by username, filename, or id

##### Parameters

-   `data`   (optional, default `{}`)

#### getInvoiceNotifications

Get the invoice notifications

##### Parameters

-   `data`   (optional, default `{}`)

#### uploadInvoice

Calls Aruba to upload an invoice

##### Parameters

-   `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
    -   `data.dataFile` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base64 encoded XML
    -   `data.signed` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** leave false if you are not sure (optional, default `false`)
    -   `data.credential` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** signature creds (leave false if you are not sure)
    -   `data.domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** signature domain (leave false if you are not sure)

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Resolves with the uploadFileName if successfull

## Disclaimer

This is a community driven open-source module.

## License

`node-fattura-elettronica-aruba` is MIT licensed.

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fandreafalzetti%2Fnode-fatturazione-elettronica-aruba.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fandreafalzetti%2Fnode-fatturazione-elettronica-aruba?ref=badge_large)

## Support on Beerpay
Hey dude! Help me out for a couple of :beers:!

[![Beerpay](https://beerpay.io/andreafalzetti/node-fatturazione-elettronica-aruba/badge.svg?style=beer-square)](https://beerpay.io/andreafalzetti/node-fatturazione-elettronica-aruba)  [![Beerpay](https://beerpay.io/andreafalzetti/node-fatturazione-elettronica-aruba/make-wish.svg?style=flat-square)](https://beerpay.io/andreafalzetti/node-fatturazione-elettronica-aruba?focus=wish)

node-fatturazione-elettronica-aruba

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README