holded-client
v1.1.1
Published
Holded API client
Downloads
23
Readme
💎 Holded invoice API client
A Node.js client for the Holded invoice API v1.0, see https://developers.holded.com/
Installation
yarn install holded-client
Usage
For example:
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:
yarn test
Contribute
- Fork it:
git clone https://github.com/mawrkus/holded-client.git
- Create your feature branch:
git checkout -b feature/my-new-feature
- Commit your changes:
git commit -am 'Added some feature'
- Check the build:
npm run build
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Roadmap
- Invoice API ->
/numberingseries
support - Projects API?
- CRM API?