https://github.com/mathewmeconry/bexio
NPM Package for bexio.com
https://github.com/mathewmeconry/bexio
bexio bexioapi npm-package npm-package-typescript typescript
Last synced: 3 months ago
JSON representation
NPM Package for bexio.com
- Host: GitHub
- URL: https://github.com/mathewmeconry/bexio
- Owner: mathewmeconry
- License: mit
- Created: 2018-11-26T14:29:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-03-18T16:57:45.000Z (3 months ago)
- Last Synced: 2026-03-19T06:21:23.368Z (3 months ago)
- Topics: bexio, bexioapi, npm-package, npm-package-typescript, typescript
- Language: TypeScript
- Size: 768 KB
- Stars: 10
- Watchers: 2
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Bexio
[](https://github.com/mathewmeconry/bexio/actions)
## Description
**Basic build and NPM-Package is in ES6!**
NPM Package for the API of [Bexio](https://www.bexio.com)
## Typings
The typings for the module are already included in the package
## API Documentation
The whole documentation of the API can be found here: [https://docs.bexio.com/](https://docs.bexio.com/)
## Support
NodeJS >= 18.14
## Functions
Not all API endpoints are implemented yet. If an endpoint you need is missing, please open a pull request.
## Example
How to use this library
```typescript
// import the module
import Bexio from "bexio";
// init the module with the API_TOKEN
const bexio = new Bexio(API_TOKEN);
// show the contact with ID 1 (Promise)
bexio.contacts.show(1).then((contact) => {
console.log(contact);
});
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
MIT