@invoice-sdk/api
v1.19.1
Published
Invoice API client
Readme
Invoice SDK API
A TypeScript SDK for invoice management APIs supporting multiple providers.
All URIs are relative to Invoice Hub Document https://stag-invoice-docs.atomsolution.vn/docs/intro
Installation
NPM Package
npm install @invoice-sdk/apiCDN Usage
<!-- Include dependencies -->
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script src="https://unpkg.com/crypto-js/crypto-js.js"></script>
<!-- Include the SDK -->
<script src="https://unpkg.com/@invoice-sdk/api@latest/dist/index.umd.js"></script>
<script>
// SDK is available as window.InvoiceSDK
const { Configuration, Provider } = window.InvoiceSDK;
</script>Usage
ES Modules (Node.js/Modern Browsers)
import { Configuration, Provider, InvoiceApi } from '@invoice-sdk/api';
const config = new Configuration({
provider: Provider.MInvoice,
apiKey: 'your-api-key',
basePath: 'https://api.example.com'
});
const invoiceApi = new InvoiceApi(config);CommonJS (Node.js)
const { Configuration, Provider, InvoiceApi } = require('@invoice-sdk/api');
const config = new Configuration({
provider: Provider.MInvoice,
apiKey: 'your-api-key',
basePath: 'https://api.example.com'
});
const invoiceApi = new InvoiceApi(config);Browser UMD
<script src="https://unpkg.com/@invoice-sdk/api@latest/dist/index.umd.js"></script>
<script>
const { Configuration, Provider, InvoiceApi } = window.InvoiceSDK;
const config = new Configuration({
provider: Provider.MInvoice,
apiKey: 'your-api-key',
basePath: 'https://api.example.com'
});
const invoiceApi = new InvoiceApi(config);
</script>Supported Providers
- M-Invoice:
Provider.MInvoice - FPT:
Provider.FPT - MISA:
Provider.MISA
Development
Build
npm run buildDevelopment Mode (Watch)
npm run devPreview
npm run previewPackage Exports
The package provides multiple build formats:
- ES Module:
dist/index.esm.js(for modern bundlers) - CommonJS:
dist/index.js(for Node.js) - UMD:
dist/index.umd.js(for browsers via CDN) - Types:
dist/index.d.ts(TypeScript definitions)
CDN Links
You can use the package directly from CDN services:
- unpkg:
https://unpkg.com/@invoice-sdk/api@latest/dist/index.umd.js - jsDelivr:
https://cdn.jsdelivr.net/npm/@invoice-sdk/api@latest/dist/index.umd.js
License
MIT
