Accountingsh - JavaScript client for accountingsh Accounting is an all-in-one accounting software that allows you to easily manage all your finance in one place. We provide a free API to control every aspect of our accounting solution and here is the JS SDK.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 7.5.8
- Package version: 7.5.8
- Generator version: 7.6.0-SNAPSHOT
For more information, please visit https://accounting.sh
Then install it via:
npm install accountingsh --saveFinally, you need to build the module:
npm run buildTo use the library locally, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:
npm installNext, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm linkTo use the link you just defined in your project, switch to the directory you want to use your accountingsh from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>Finally, you need to build the module:
npm run buildTo use this library directly from a git repository, e.g.https://github.com/accounting-sh/js_sdk install it via:
npm install accounting-sh/js_sdk --savePlease follow the installation instruction and execute the following JS code:
import { Accounting } from "accountingsh";
let accounting = new Accounting("api-token");
let uuid = "uuid_example"; // {String} The account uuid
accounting.accountConnections
.deleteAccountConnection(uuid)
.then((data) => {
console.log(data);
})
.catch((error) => {
console.error(error);
});All URIs are relative to https://api.accounting.sh
| Class | Method | HTTP request | Description |
|---|---|---|---|
| Accountingsh.AccountConnectionsApi | deleteAccountConnection | DELETE /accounts/{uuid}/connect | Delete an account's connection |
| Accountingsh.AccountConnectionsApi | listAccountConnections | GET /accounts/{uuid}/connect | List account's connections |
| Accountingsh.AccountConnectionsApi | listBanks | GET /accounts/{uuid}/connect/banks | List available bank connections |
| Accountingsh.AccountingCodesApi | addAccountingCode | POST /accounting/codes | Add an accounting code |
| Accountingsh.AccountingCodesApi | deleteAccountingCode | DELETE /accounting/codes/{uuid} | Delete an accounting code |
| Accountingsh.AccountingCodesApi | getAccountingCode | GET /accounting/codes/{uuid} | Get an accounting code |
| Accountingsh.AccountingCodesApi | listAccountingCodes | GET /accounting/codes | List company's accounting code |
| Accountingsh.AccountingCodesApi | updateAccountingCode | PUT /accounting/codes/{uuid} | Update an accounting code |
| Accountingsh.AccountsApi | addAccount | POST /accounts | Add an account |
| Accountingsh.AccountsApi | deleteAccount | DELETE /accounts/{uuid} | Delete an account |
| Accountingsh.AccountsApi | getAccount | GET /accounts/{uuid} | Get an account |
| Accountingsh.AccountsApi | listAccounts | GET /accounts | List company's accounts |
| Accountingsh.AccountsApi | updateAccount | PUT /accounts/{uuid} | Update an account |
| Accountingsh.AttachmentsApi | addAttachment | POST /attachments | Add an attachment |
| Accountingsh.AttachmentsApi | deleteAttachment | DELETE /attachments/{uuid} | Delete an attachment |
| Accountingsh.AttachmentsApi | getAttachment | GET /attachments/{uuid} | Get an attachment |
| Accountingsh.AttachmentsApi | listAttachments | GET /attachments | List company's attachments |
| Accountingsh.AttachmentsApi | retrieveAttachments | GET /attachments/resource/{resource} | List company's attachments link to resource |
| Accountingsh.AttachmentsApi | updateAttachment | PUT /attachments/{uuid} | Update an attachment |
| Accountingsh.BillsApi | addBill | POST /expenses/bills | Add a bill |
| Accountingsh.BillsApi | addBillPayment | POST /expenses/bills/{uuid}/payments | Add a bill payment |
| Accountingsh.BillsApi | deleteBill | DELETE /expenses/bills/{uuid} | Delete a bill |
| Accountingsh.BillsApi | getBill | GET /expenses/bills/{uuid} | Get a bill |
| Accountingsh.BillsApi | getBillDocument | GET /expenses/bills/{uuid}/document | Get a bill in PDF |
| Accountingsh.BillsApi | listBills | GET /expenses/bills | List company's bills |
| Accountingsh.BillsApi | updateBill | PUT /expenses/bills/{uuid} | Update a bill |
| Accountingsh.BillsApi | updateBillPayment | PUT /expenses/bills/{uuid}/payments/{payment} | Update a bill payment |
| Accountingsh.CategoriesApi | addCategory | POST /categories | Add a category |
| Accountingsh.CategoriesApi | deleteCategory | DELETE /categories/{uuid} | Delete a category |
| Accountingsh.CategoriesApi | getCategory | GET /categories/{uuid} | Get a category |
| Accountingsh.CategoriesApi | listCategories | GET /categories | List company's categories |
| Accountingsh.CategoriesApi | updateCategory | PUT /categories/{uuid} | Update a category |
| Accountingsh.CompaniesApi | addCompany | POST /companies | Add a company |
| Accountingsh.CompaniesApi | deleteCompany | DELETE /companies/{uuid} | Delete a company |
| Accountingsh.CompaniesApi | getCompany | GET /companies/{uuid} | Get a company |
| Accountingsh.CompaniesApi | getCompanyCustomization | GET /companies/{uuid}/customization | Get a company's customization parameters |
| Accountingsh.CompaniesApi | getCompanyFeatureSet | GET /companies/{uuid}/features | List a company's feature set |
| Accountingsh.CompaniesApi | listCompanies | GET /companies | List companies on this instance |
| Accountingsh.CompaniesApi | updateCompany | PUT /companies/{uuid} | Update a company |
| Accountingsh.CompanyStatisticsApi | getStatistics | GET /companies/{uuid}/statistics/period | Get company's statistic |
| Accountingsh.ContactsApi | addContact | POST /contacts | Create a new contact |
| Accountingsh.ContactsApi | deleteContact | DELETE /contacts/{uuid} | Delete a contact |
| Accountingsh.ContactsApi | getContact | GET /contacts/{uuid} | Retrieve a contact |
| Accountingsh.ContactsApi | listContactBills | GET /contacts/{uuid}/bills | List a contact's bills |
| Accountingsh.ContactsApi | listContactInvoices | GET /contacts/{uuid}/invoices | List a contact's invoices |
| Accountingsh.ContactsApi | listContacts | GET /contacts | List company's contacts |
| Accountingsh.ContactsApi | updateContact | PUT /contact/{uuid} | Update a contact |
| Accountingsh.CountriesApi | getTranslatedCountries | GET /countries/{lang} | Get translated list of countries |
| Accountingsh.CredentialsApi | addCredential | POST /credentials | Add a credential |
| Accountingsh.CredentialsApi | deleteCredential | DELETE /credentials/{uuid} | Delete a credential |
| Accountingsh.CredentialsApi | getCredential | GET /credentials/{uuid} | Get a credential |
| Accountingsh.CredentialsApi | listCredentials | GET /credentials | List company's credentials |
| Accountingsh.CredentialsApi | listPermissions | GET /credentials/permissions | List available permissions |
| Accountingsh.CredentialsApi | me | GET /me | Get current credential informations |
| Accountingsh.CredentialsApi | updateCredential | PUT /credentials/{uuid} | Update a credential |
| Accountingsh.CredentialsApi | userveria | POST /userveria | Exchange a my stantabcorp (userveria) token for an Accounting Token |
| Accountingsh.CurrencyApi | getExchangeRate | GET /currency/{from}/{to} | Get the latest currency exchange rate |
| Accountingsh.DocumentsApi | cancelReview | DELETE /documents/{uuid}/review | Cancel document review |
| Accountingsh.DocumentsApi | deleteDocument | DELETE /documents/{uuid} | Delete a document |
| Accountingsh.DocumentsApi | getDocument | GET /documents/{uuid} | Get a document |
| Accountingsh.DocumentsApi | listDocuments | GET /documents | List company's documents |
| Accountingsh.DocumentsApi | processDocument | GET /documents/{uuid}/process | Process a document |
| Accountingsh.DocumentsApi | reviewUrl | GET /documents/{uuid}/review | Get url to review a document |
| Accountingsh.DocumentsApi | updateDocument | PUT /documents/{uuid} | Update a document |
| Accountingsh.DocumentsApi | uploadDocument | POST /documents | Upload a document |
| Accountingsh.DocumentsApi | viewDocument | GET /documents/{uuid}/view | View a document |
| Accountingsh.ExpenseReportsApi | addExpenseReport | POST /expenses/expense-reports | Add an expense report |
| Accountingsh.ExpenseReportsApi | deleteExpenseReport | DELETE /expenses/expense-reports/{uuid} | Delete an expense report |
| Accountingsh.ExpenseReportsApi | expenseReportOAuthLogin | GET /expenses/expense-reports/login/{method} | OAuth Login |
| Accountingsh.ExpenseReportsApi | getExpenseReport | GET /expenses/expense-reports/{uuid} | Get an expense report |
| Accountingsh.ExpenseReportsApi | getExpenseReportAccount | GET /expenses/expense-reports/me | Get the currently connected expense report user details |
| Accountingsh.ExpenseReportsApi | getExpenseReportUser | GET /expenses/expense-reports/users/{uuid} | Get an user details |
| Accountingsh.ExpenseReportsApi | listExpenseReports | GET /expenses/expense-reports | List company's expense reports. |
| Accountingsh.ExpenseReportsApi | sendExpenseReportLoginEmail | POST /expenses/expense-reports/login | Request login email |
| Accountingsh.ExpenseReportsApi | updateExpenseReport | PUT /expenses/expense-reports/{uuid} | Update an expense report |
| Accountingsh.ExpenseReportsApi | updateExpenseReportAccount | PUT /expenses/expense-reports/me | Update the currently connected expense report user |
| Accountingsh.ExpenseReportsApi | updateExpenseReportSettings | POST /expenses/expense-reports/settings | Retrieve company settings for expense reports |
| Accountingsh.ExpenseReportsApi | verifyExpenseReportSettings | POST /expenses/expense-reports/verify | Verify expense reports settings |
| Accountingsh.ExportApi | listExports | GET /export | List company's exports |
| Accountingsh.ExportApi | requestExport | POST /export | Request an export |
| Accountingsh.InvoicesApi | addInvoice | POST /incomes/invoices | Add an invoice |
| Accountingsh.InvoicesApi | addInvoicePayment | POST /incomes/invoices/{uuid}/payments | Add an invoice payment |
| Accountingsh.InvoicesApi | deleteInvoice | DELETE /incomes/invoices/{uuid} | Delete an invoice |
| Accountingsh.InvoicesApi | getInvoice | GET /incomes/invoices/{uuid} | Get an invoice |
| Accountingsh.InvoicesApi | getInvoiceDocument | GET /incomes/invoices/{uuid}/document | Get an invoice in PDF |
| Accountingsh.InvoicesApi | listInvoices | GET /incomes/invoices | List company's invoices |
| Accountingsh.InvoicesApi | listUnpaidInvoices | GET /incomes/invoices/unpaid | List company's unpaid invoices |
| Accountingsh.InvoicesApi | updateInvoice | PUT /incomes/invoices/{uuid} | Update an invoice |
| Accountingsh.InvoicesApi | updateInvoicePayment | PUT /incomes/invoices/{uuid}/payments/{payment} | Update an invoice payment |
| Accountingsh.LogsApi | logs | GET /logs | List company's logs |
| Accountingsh.NotificationApi | listNotificationPreferences | GET /notifications/preferences/{notification} | List notification preferences |
| Accountingsh.NotificationApi | listNotifications | GET /notifications | List company's notifications |
| Accountingsh.NotificationApi | sendNotification | POST /notifications/send | Send a notification |
| Accountingsh.NotificationApi | updateNotificationPreferences | PUT /notifications/preferences/{notification} | Update notification preferences |
| Accountingsh.NotificationTypesApi | addNotificationType | POST /notifications/types | Add a notification type |
| Accountingsh.NotificationTypesApi | deleteNotificationType | DELETE /notifications/types/{uuid} | Delete a notification type |
| Accountingsh.NotificationTypesApi | getNotificationType | GET /notifications/types/{uuid} | Get a notification type |
| Accountingsh.NotificationTypesApi | listNotificationTypes | GET /notifications/types | List company's notification types |
| Accountingsh.NotificationTypesApi | updateNotificationType | PUT /notifications/types/{uuid} | Update a notification type |
| Accountingsh.OAuthConfigApi | addOAuthConfiguration | POST /oauth | Add an OAuth configuration |
| Accountingsh.OAuthConfigApi | deleteOAuthConfiguration | DELETE /oauth/{uuid} | Delete an oauth configuration |
| Accountingsh.OAuthConfigApi | getOAuthConfiguration | GET /oauth/{uuid} | Get an OAuth configuration |
| Accountingsh.OAuthConfigApi | listOAuthConfigurations | GET /oauth | List company's oauth configurations |
| Accountingsh.OAuthConfigApi | listProviders | GET /oauth/providers | List available providers |
| Accountingsh.OAuthConfigApi | updateOAuthConfiguration | PUT /oauth/{uuid} | Update an oauth configuration |
| Accountingsh.PaymentsApi | addPayment | POST /expenses/payments | Add a payment |
| Accountingsh.PaymentsApi | deletePayment | DELETE /expenses/payments/{uuid} | Delete a payment |
| Accountingsh.PaymentsApi | getPayment | GET /expenses/payments/{uuid} | Get a payment |
| Accountingsh.PaymentsApi | listPayments | GET /expenses/payments | List company's payments |
| Accountingsh.PaymentsApi | updatePayment | PUT /expenses/payments/{uuid} | Update a payment |
| Accountingsh.QuotesApi | addQuote | POST /quotes | Add a quote |
| Accountingsh.QuotesApi | deleteQuote | DELETE /quotes/{uuid} | Delete a quote |
| Accountingsh.QuotesApi | getQuote | GET /quotes/{uuid} | Get a quote |
| Accountingsh.QuotesApi | getQuoteDocument | GET /quotes/{uuid}/document | Get a quote in PDF |
| Accountingsh.QuotesApi | listQuotes | GET /quotes | List company's quotes |
| Accountingsh.QuotesApi | updateQuote | PUT /quotes/{uuid} | Update a quote |
| Accountingsh.ReceiptsApi | addReceipt | POST /receipts | Add a receipt |
| Accountingsh.ReceiptsApi | deleteReceipt | DELETE /receipts/{uuid} | Delete a receipt |
| Accountingsh.ReceiptsApi | getReceipt | GET /receipts/{uuid} | Get a receipt |
| Accountingsh.ReceiptsApi | getReceiptDocument | GET /receipts/{uuid}/document | Get a receipt in PDF |
| Accountingsh.ReceiptsApi | listReceipts | GET /receipts | List company's receipts |
| Accountingsh.ReceiptsApi | updateReceipt | PUT /receipts/{uuid} | Update a receipt |
| Accountingsh.RevenuesApi | addRevenue | POST /incomes/revenues | Add a revenue |
| Accountingsh.RevenuesApi | deleteRevenue | DELETE /incomes/revenues/{uuid} | Delete a revenue |
| Accountingsh.RevenuesApi | getRevenue | GET /incomes/revenues/{uuid} | Get a revenue |
| Accountingsh.RevenuesApi | listRevenues | GET /incomes/revenues | List company's revenues |
| Accountingsh.RevenuesApi | updateRevenue | PUT /incomes/revenues/{uuid} | Update a revenue |
| Accountingsh.RossumApi | listReviews | GET /external/rossum/reviews | List documents to be reviewes |
| Accountingsh.SearchApi | search | GET /search | Search |
| Accountingsh.SettingsApi | getSettings | GET /companies/{uuid}/settings/{key} | Get a company's settings |
| Accountingsh.SettingsApi | listSettings | GET /companies/{uuid}/settings | List company's settings |
| Accountingsh.SettingsApi | updateSettings | PUT /companies/{uuid}/settings/{key} | Update a company's settings |
| Accountingsh.TagsApi | addTag | POST /tags | Add a tag |
| Accountingsh.TagsApi | deleteTag | DELETE /tags/{uuid} | Delete a tag |
| Accountingsh.TagsApi | getTag | GET /tags/{uuid} | Get a tag |
| Accountingsh.TagsApi | listTags | GET /tags | List company's tags |
| Accountingsh.TagsApi | listTagsByResource | GET /tags/attachments/{resource} | List company's tags by resource attachment |
| Accountingsh.TagsApi | updateTag | PUT /tags/{uuid} | Update a tag |
| Accountingsh.TaxApi | getTaxRate | GET /tax/{country} | Get the latest tax rate for a country |
| Accountingsh.TaxApi | verifyVatId | GET /vat/verify/{number} | Verify a VAT ID |
| Accountingsh.TransactionsApi | addTransaction | POST /transactions | Add a transaction |
| Accountingsh.TransactionsApi | addTransactionCode | POST /transactions/{uuid}/codes | Add a transaction's code |
| Accountingsh.TransactionsApi | deleteTransaction | DELETE /transactions/{uuid} | Delete a transaction |
| Accountingsh.TransactionsApi | deleteTransactionCode | DELETE /transactions/{uuid}/codes/{code} | Delete a transaction's code |
| Accountingsh.TransactionsApi | getTransaction | GET /transactions/{uuid} | Get a transaction |
| Accountingsh.TransactionsApi | importTransactions | POST /transactions/import | Import transactions - INTERNAL |
| Accountingsh.TransactionsApi | listTransactionCodes | GET /transactions/{uuid}/codes | List transaction's codes |
| Accountingsh.TransactionsApi | listTransactions | GET /transactions | List company's transactions |
| Accountingsh.TransactionsApi | updateTransaction | PUT /transactions/{uuid} | Update a transaction |
| Accountingsh.TransactionsApi | updateTransactionCode | PUT /transactions/{uuid}/codes | Update a transaction's code |
| Accountingsh.TransfersApi | addTransfer | POST /transfers | Add a transfer |
| Accountingsh.TransfersApi | deleteTransfer | DELETE /transfers/{uuid} | Delete a transfer |
| Accountingsh.TransfersApi | getTransfer | GET /transfers/{uuid} | Get a transfer |
| Accountingsh.TransfersApi | listTransfers | GET /transfers | List company's transfers |
| Accountingsh.TransfersApi | updateTransfer | PUT /transfers/{uuid} | Update a transfer |
| Accountingsh.VATIDApi | addCompanyVatId | POST /companies/{uuid}/vat | Add a company's Vat Id |
| Accountingsh.VATIDApi | deleteCompanyVatId | DELETE /companies/{uuid}/vat/{key} | Delete a company's Vat Id |
| Accountingsh.VATIDApi | getCompanyVatId | GET /companies/{uuid}/vat/{key} | Get a company's Vat Id |
| Accountingsh.VATIDApi | listCompanyVatId | GET /companies/{uuid}/vat | List company's Vat Id |
| Accountingsh.VATIDApi | updateCompanyVatId | PUT /companies/{uuid}/vat/{key} | Update a company's Vat Id |
| Accountingsh.WebhooksApi | addWebhook | POST /webhooks | Add a webhook |
| Accountingsh.WebhooksApi | deleteWebhook | DELETE /webhooks/{uuid} | Delete a webhook |
| Accountingsh.WebhooksApi | getWebhook | GET /webhooks/{uuid} | Get a webhook |
| Accountingsh.WebhooksApi | getWebhookHistory | GET /webhooks/{uuid}/history | Get webhook's history |
| Accountingsh.WebhooksApi | listWebhookEvents | GET /webhooks/events | List available webhook events |
| Accountingsh.WebhooksApi | listWebhooks | GET /webhooks | List company's webhooks |
| Accountingsh.WebhooksApi | updateWebhook | PUT /webhooks/{uuid} | Update a webhook |
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header