This is the initial release of an unofficial TypeScript SDK for the Cuéntica API. This open-source project aims to make it easier for developers to integrate with Cuéntica's accounting and tax management services in their TypeScript/JavaScript applications.
Disclaimer
This is an independent, community-driven project and is not officially associated with or endorsed by Cuéntica. While the SDK aims to provide a reliable interface to Cuéntica's API, users should refer to the official Cuéntica API documentation for the most up-to-date API specifications.
Features
Core Functionality
- Complete TypeScript support with comprehensive type definitions
- Promise-based API design with full async/await support
- Intelligent rate limiting handling with detailed error feedback
- Built-in debug logging system for troubleshooting
- Flexible authentication via direct token or environment variables
- Support for both ESM and CommonJS module systems
API Coverage
- Company Management
- Retrieve detailed company information
- Customer Management
- Full CRUD operations for customer data
- Advanced search and filtering capabilities
- Pagination support for large datasets
- Invoice Management
- Comprehensive invoice filtering and retrieval
- PDF generation and download
- Support for custom tags and date ranges
- Expense Management
- Multi-line expense creation and management
- Advanced filtering options
- Support for various document types
- Document Management
- Document upload with attachment support
- Filtering and search capabilities
- Date-based document retrieval
- Transfer Management
- Bank transfer creation and management
- Support for multiple payment methods
- Comprehensive filtering options
Developer Experience
- Detailed error handling with custom error types
- Rate limit monitoring (600 requests/5 minutes, 7200 requests/day)
- Extensive debugging options with granular control
- Environment variable configuration support
Installation
npm install cuenticaBreaking Changes
- Initial release - no breaking changes
Known Limitations
- Rate limits are enforced by the Cuéntica API:
- 600 requests per 5-minute window
- 7,200 requests per day
- This SDK aims to maintain compatibility with the Cuéntica API, but there might be delays in supporting new API features as they are released
Documentation
Full documentation is available in the repository, including:
- Comprehensive API reference
- TypeScript examples
- Configuration options
- Error handling guidelines
- Debug logging setup
Contributing
This is an open-source project and contributions are welcome! Please feel free to:
- Report bugs or issues
- Suggest new features
- Submit pull requests
- Improve documentation
Before contributing, please review the contribution guidelines in the repository.
License
Released under the MIT License
Support
For SDK-specific issues, please use the GitHub issue tracker. For questions about the Cuéntica API itself, please refer to the official Cuéntica support channels.