https://github.com/mawrkus/holded-client
💎 A Node.js client for the Holded API
https://github.com/mawrkus/holded-client
api-client holded invoice-api invoicing javascript
Last synced: 6 months ago
JSON representation
💎 A Node.js client for the Holded API
- Host: GitHub
- URL: https://github.com/mawrkus/holded-client
- Owner: mawrkus
- Created: 2018-04-29T13:24:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T01:26:59.000Z (over 2 years ago)
- Last Synced: 2025-04-23T04:43:57.440Z (6 months ago)
- Topics: api-client, holded, invoice-api, invoicing, javascript
- Language: JavaScript
- Homepage:
- Size: 781 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💎 Holded invoice API client
[](https://www.npmjs.org/package/holded-client) [](https://www.npmjs.org/package/holded-client)
A Node.js client for the Holded *invoice* API v1.0, see https://developers.holded.com/
## Installation
```bash
yarn install holded-client
```
## Usage
For example:
```js
const HoldedClient = require('holded-client');
const client = new HoldedClient({ apiKey: 'your private api key' });
const { docTypes } = client.documents;
const invoicesList = await client.documents.list({ type: docTypes.INVOICE });
```
## API
The client exposes the following Promise-based APIs:
- `contacts`
- `saleschannels`
- `products`
- `warehouses`
- `treasury`
- `expensesaccounts`
- `payments`
- `documents`
Each api exposes the following methods:
- `list()`
- `create({ resource })`
- `get({ id })`
- `update({ id, resource })`
- `delete({ id })`
Except for the documents API:
- `list({ type })`
- `create({ type, document })`
- `get({ type, id })`
- `update({ type, id, document })`
- `delete({ type, id })`
- `downloadPdf({ type, id })`
- `pay({ type, id, payment })`
## Testing
Clone the repository and execute:
```bash
yarn test
```
## Contribute
1. Fork it: `git clone https://github.com/mawrkus/holded-client.git`
2. Create your feature branch: `git checkout -b feature/my-new-feature`
3. Commit your changes: `git commit -am 'Added some feature'`
4. Check the build: `npm run build`
5. Push to the branch: `git push origin my-new-feature`
6. Submit a pull request :D
## Roadmap
- Invoice API -> `/numberingseries` support
- Projects API?
- CRM API?