@api-emulator/intuit
v0.2.2
Published
Intuit QuickBooks Online provides accounting APIs for OAuth, company info, query, customers, invoices, payments, and accounts.
Downloads
506
Readme
@api-emulator/intuit
Intuit QuickBooks Online provides accounting APIs for OAuth, company info, query, customers, invoices, payments, and accounts.
Use this emulator for local tests, CI, and offline agent runs. It keeps your tests separate from the production API.
Start the emulator
- Install the package.
npm install @api-emulator/intuit- From this registry, start the emulator.
npx -p api-emulator api --plugin ./providers/@intuit/api-emulator.mjs --service intuitThe emulator uses the local URL that api-emulator prints. Set your client base URL to this local URL.
Supported API
POST /oauth2/v1/tokens/bearerGET /v3/company/:realmId/companyinfo/:companyIdGET /v3/company/:realmId/queryPOST /v3/company/:realmId/queryPOST /v3/company/:realmId/customerGET /v3/company/:realmId/customer/:idPOST /v3/company/:realmId/invoiceGET /v3/company/:realmId/invoice/:idPOST /v3/company/:realmId/paymentGET /v3/company/:realmId/account/:idGET /intuit/inspect/stateGET /inspect/contract
Coverage
- Level:
smoke-only - Meaning: A smoke test starts the emulator and checks its main behavior.
- Evidence: a direct smoke test exists, but a conformance manifest does not exist.
Credentials
Use a fixed bearer token or API key in each test. The emulator does not send these credentials to the provider.
Test data
Add repeatable test data to the provider configuration.
intuit:
# Add provider-specific seed state here.