0.3.1 • Published 8 months ago

accountingsh v0.3.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
8 months ago

accountingsh

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.10
  • Package version: 7.5.10
  • Generator version: 7.6.0-SNAPSHOT

For more information, please visit https://accounting.sh

Installation

npm

Then install it via:

npm install accountingsh --save

Finally, you need to build the module:

npm run build

Local development

To 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 install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To 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 build

git

To 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 --save

Getting Started

Please 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);
  });

Documentation for API Endpoints

All URIs are relative to https://api.accounting.sh

ClassMethodHTTP requestDescription
Accountingsh.AccountConnectionsApideleteAccountConnectionDELETE /accounts/{uuid}/connectDelete an account's connection
Accountingsh.AccountConnectionsApilistAccountConnectionsGET /accounts/{uuid}/connectList account's connections
Accountingsh.AccountConnectionsApilistBanksGET /accounts/{uuid}/connect/banksList available bank connections
Accountingsh.AccountingCodesApiaddAccountingCodePOST /accounting/codesAdd an accounting code
Accountingsh.AccountingCodesApideleteAccountingCodeDELETE /accounting/codes/{uuid}Delete an accounting code
Accountingsh.AccountingCodesApigetAccountingCodeGET /accounting/codes/{uuid}Get an accounting code
Accountingsh.AccountingCodesApilistAccountingCodesGET /accounting/codesList company's accounting code
Accountingsh.AccountingCodesApiupdateAccountingCodePUT /accounting/codes/{uuid}Update an accounting code
Accountingsh.AccountsApiaddAccountPOST /accountsAdd an account
Accountingsh.AccountsApideleteAccountDELETE /accounts/{uuid}Delete an account
Accountingsh.AccountsApigetAccountGET /accounts/{uuid}Get an account
Accountingsh.AccountsApilistAccountsGET /accountsList company's accounts
Accountingsh.AccountsApiupdateAccountPUT /accounts/{uuid}Update an account
Accountingsh.AttachmentsApiaddAttachmentPOST /attachmentsAdd an attachment
Accountingsh.AttachmentsApideleteAttachmentDELETE /attachments/{uuid}Delete an attachment
Accountingsh.AttachmentsApigetAttachmentGET /attachments/{uuid}Get an attachment
Accountingsh.AttachmentsApilistAttachmentsGET /attachmentsList company's attachments
Accountingsh.AttachmentsApiretrieveAttachmentsGET /attachments/resource/{resource}List company's attachments link to resource
Accountingsh.AttachmentsApiupdateAttachmentPUT /attachments/{uuid}Update an attachment
Accountingsh.BillsApiaddBillPOST /expenses/billsAdd a bill
Accountingsh.BillsApiaddBillPaymentPOST /expenses/bills/{uuid}/paymentsAdd a bill payment
Accountingsh.BillsApideleteBillDELETE /expenses/bills/{uuid}Delete a bill
Accountingsh.BillsApigetBillGET /expenses/bills/{uuid}Get a bill
Accountingsh.BillsApigetBillDocumentGET /expenses/bills/{uuid}/documentGet a bill in PDF
Accountingsh.BillsApilistBillsGET /expenses/billsList company's bills
Accountingsh.BillsApiupdateBillPUT /expenses/bills/{uuid}Update a bill
Accountingsh.BillsApiupdateBillPaymentPUT /expenses/bills/{uuid}/payments/{payment}Update a bill payment
Accountingsh.CategoriesApiaddCategoryPOST /categoriesAdd a category
Accountingsh.CategoriesApideleteCategoryDELETE /categories/{uuid}Delete a category
Accountingsh.CategoriesApigetCategoryGET /categories/{uuid}Get a category
Accountingsh.CategoriesApilistCategoriesGET /categoriesList company's categories
Accountingsh.CategoriesApiupdateCategoryPUT /categories/{uuid}Update a category
Accountingsh.CompaniesApiaddCompanyPOST /companiesAdd a company
Accountingsh.CompaniesApideleteCompanyDELETE /companies/{uuid}Delete a company
Accountingsh.CompaniesApigetCompanyGET /companies/{uuid}Get a company
Accountingsh.CompaniesApigetCompanyCustomizationGET /companies/{uuid}/customizationGet a company's customization parameters
Accountingsh.CompaniesApigetCompanyFeatureSetGET /companies/{uuid}/featuresList a company's feature set
Accountingsh.CompaniesApilistCompaniesGET /companiesList companies on this instance
Accountingsh.CompaniesApiupdateCompanyPUT /companies/{uuid}Update a company
Accountingsh.CompanyStatisticsApigetStatisticsGET /companies/{uuid}/statistics/periodGet company's statistic
Accountingsh.ContactsApiaddContactPOST /contactsCreate a new contact
Accountingsh.ContactsApideleteContactDELETE /contacts/{uuid}Delete a contact
Accountingsh.ContactsApigetContactGET /contacts/{uuid}Retrieve a contact
Accountingsh.ContactsApilistContactBillsGET /contacts/{uuid}/billsList a contact's bills
Accountingsh.ContactsApilistContactInvoicesGET /contacts/{uuid}/invoicesList a contact's invoices
Accountingsh.ContactsApilistContactsGET /contactsList company's contacts
Accountingsh.ContactsApiupdateContactPUT /contacts/{uuid}Update a contact
Accountingsh.CountriesApigetTranslatedCountriesGET /countries/{lang}Get translated list of countries
Accountingsh.CredentialsApiaddCredentialPOST /credentialsAdd a credential
Accountingsh.CredentialsApideleteCredentialDELETE /credentials/{uuid}Delete a credential
Accountingsh.CredentialsApigetCredentialGET /credentials/{uuid}Get a credential
Accountingsh.CredentialsApilistCredentialsGET /credentialsList company's credentials
Accountingsh.CredentialsApilistPermissionsGET /credentials/permissionsList available permissions
Accountingsh.CredentialsApimeGET /meGet current credential informations
Accountingsh.CredentialsApiupdateCredentialPUT /credentials/{uuid}Update a credential
Accountingsh.CredentialsApiuserveriaPOST /userveriaExchange a my stantabcorp (userveria) token for an Accounting Token
Accountingsh.CurrencyApigetExchangeRateGET /currency/{from}/{to}Get the latest currency exchange rate
Accountingsh.DocumentsApicancelReviewDELETE /documents/{uuid}/reviewCancel document review
Accountingsh.DocumentsApideleteDocumentDELETE /documents/{uuid}Delete a document
Accountingsh.DocumentsApigetDocumentGET /documents/{uuid}Get a document
Accountingsh.DocumentsApilistDocumentsGET /documentsList company's documents
Accountingsh.DocumentsApiprocessDocumentGET /documents/{uuid}/processProcess a document
Accountingsh.DocumentsApireviewUrlGET /documents/{uuid}/reviewGet url to review a document
Accountingsh.DocumentsApiupdateDocumentPUT /documents/{uuid}Update a document
Accountingsh.DocumentsApiuploadDocumentPOST /documentsUpload a document
Accountingsh.DocumentsApiviewDocumentGET /documents/{uuid}/viewView a document
Accountingsh.ExpenseReportsApiaddExpenseReportPOST /expenses/expense-reportsAdd an expense report
Accountingsh.ExpenseReportsApideleteExpenseReportDELETE /expenses/expense-reports/{uuid}Delete an expense report
Accountingsh.ExpenseReportsApiexpenseReportOAuthLoginGET /expenses/expense-reports/login/{method}OAuth Login
Accountingsh.ExpenseReportsApigetExpenseReportGET /expenses/expense-reports/{uuid}Get an expense report
Accountingsh.ExpenseReportsApigetExpenseReportAccountGET /expenses/expense-reports/meGet the currently connected expense report user details
Accountingsh.ExpenseReportsApigetExpenseReportUserGET /expenses/expense-reports/users/{uuid}Get an user details
Accountingsh.ExpenseReportsApilistExpenseReportsGET /expenses/expense-reportsList company's expense reports.
Accountingsh.ExpenseReportsApisendExpenseReportLoginEmailPOST /expenses/expense-reports/loginRequest login email
Accountingsh.ExpenseReportsApiupdateExpenseReportPUT /expenses/expense-reports/{uuid}Update an expense report
Accountingsh.ExpenseReportsApiupdateExpenseReportAccountPUT /expenses/expense-reports/meUpdate the currently connected expense report user
Accountingsh.ExpenseReportsApiupdateExpenseReportSettingsPOST /expenses/expense-reports/settingsRetrieve company settings for expense reports
Accountingsh.ExpenseReportsApiverifyExpenseReportSettingsPOST /expenses/expense-reports/verifyVerify expense reports settings
Accountingsh.ExportApilistExportsGET /exportList company's exports
Accountingsh.ExportApirequestExportPOST /exportRequest an export
Accountingsh.InvoicesApiaddInvoicePOST /incomes/invoicesAdd an invoice
Accountingsh.InvoicesApiaddInvoicePaymentPOST /incomes/invoices/{uuid}/paymentsAdd an invoice payment
Accountingsh.InvoicesApideleteInvoiceDELETE /incomes/invoices/{uuid}Delete an invoice
Accountingsh.InvoicesApigetInvoiceGET /incomes/invoices/{uuid}Get an invoice
Accountingsh.InvoicesApigetInvoiceDocumentGET /incomes/invoices/{uuid}/documentGet an invoice in PDF
Accountingsh.InvoicesApilistInvoicesGET /incomes/invoicesList company's invoices
Accountingsh.InvoicesApilistUnpaidInvoicesGET /incomes/invoices/unpaidList company's unpaid invoices
Accountingsh.InvoicesApiupdateInvoicePUT /incomes/invoices/{uuid}Update an invoice
Accountingsh.InvoicesApiupdateInvoicePaymentPUT /incomes/invoices/{uuid}/payments/{payment}Update an invoice payment
Accountingsh.LogsApilogsGET /logsList company's logs
Accountingsh.NotificationApilistNotificationPreferencesGET /notifications/preferences/{notification}List notification preferences
Accountingsh.NotificationApilistNotificationsGET /notificationsList company's notifications
Accountingsh.NotificationApisendNotificationPOST /notifications/sendSend a notification
Accountingsh.NotificationApiupdateNotificationPreferencesPUT /notifications/preferences/{notification}Update notification preferences
Accountingsh.NotificationTypesApiaddNotificationTypePOST /notifications/typesAdd a notification type
Accountingsh.NotificationTypesApideleteNotificationTypeDELETE /notifications/types/{uuid}Delete a notification type
Accountingsh.NotificationTypesApigetNotificationTypeGET /notifications/types/{uuid}Get a notification type
Accountingsh.NotificationTypesApilistNotificationTypesGET /notifications/typesList company's notification types
Accountingsh.NotificationTypesApiupdateNotificationTypePUT /notifications/types/{uuid}Update a notification type
Accountingsh.OAuthConfigApiaddOAuthConfigurationPOST /oauthAdd an OAuth configuration
Accountingsh.OAuthConfigApideleteOAuthConfigurationDELETE /oauth/{uuid}Delete an oauth configuration
Accountingsh.OAuthConfigApigetOAuthConfigurationGET /oauth/{uuid}Get an OAuth configuration
Accountingsh.OAuthConfigApilistOAuthConfigurationsGET /oauthList company's oauth configurations
Accountingsh.OAuthConfigApilistProvidersGET /oauth/providersList available providers
Accountingsh.OAuthConfigApiupdateOAuthConfigurationPUT /oauth/{uuid}Update an oauth configuration
Accountingsh.PaymentsApiaddPaymentPOST /expenses/paymentsAdd a payment
Accountingsh.PaymentsApideletePaymentDELETE /expenses/payments/{uuid}Delete a payment
Accountingsh.PaymentsApigetPaymentGET /expenses/payments/{uuid}Get a payment
Accountingsh.PaymentsApilistPaymentsGET /expenses/paymentsList company's payments
Accountingsh.PaymentsApiupdatePaymentPUT /expenses/payments/{uuid}Update a payment
Accountingsh.QuotesApiaddQuotePOST /quotesAdd a quote
Accountingsh.QuotesApideleteQuoteDELETE /quotes/{uuid}Delete a quote
Accountingsh.QuotesApigetQuoteGET /quotes/{uuid}Get a quote
Accountingsh.QuotesApigetQuoteDocumentGET /quotes/{uuid}/documentGet a quote in PDF
Accountingsh.QuotesApilistQuotesGET /quotesList company's quotes
Accountingsh.QuotesApiupdateQuotePUT /quotes/{uuid}Update a quote
Accountingsh.ReceiptsApiaddReceiptPOST /receiptsAdd a receipt
Accountingsh.ReceiptsApideleteReceiptDELETE /receipts/{uuid}Delete a receipt
Accountingsh.ReceiptsApigetReceiptGET /receipts/{uuid}Get a receipt
Accountingsh.ReceiptsApigetReceiptDocumentGET /receipts/{uuid}/documentGet a receipt in PDF
Accountingsh.ReceiptsApilistReceiptsGET /receiptsList company's receipts
Accountingsh.ReceiptsApiupdateReceiptPUT /receipts/{uuid}Update a receipt
Accountingsh.RevenuesApiaddRevenuePOST /incomes/revenuesAdd a revenue
Accountingsh.RevenuesApideleteRevenueDELETE /incomes/revenues/{uuid}Delete a revenue
Accountingsh.RevenuesApigetRevenueGET /incomes/revenues/{uuid}Get a revenue
Accountingsh.RevenuesApilistRevenuesGET /incomes/revenuesList company's revenues
Accountingsh.RevenuesApiupdateRevenuePUT /incomes/revenues/{uuid}Update a revenue
Accountingsh.RossumApilistReviewsGET /external/rossum/reviewsList documents to be reviewes
Accountingsh.SearchApisearchGET /searchSearch
Accountingsh.SettingsApigetSettingsGET /companies/{uuid}/settings/{key}Get a company's settings
Accountingsh.SettingsApilistSettingsGET /companies/{uuid}/settingsList company's settings
Accountingsh.SettingsApiupdateSettingsPUT /companies/{uuid}/settings/{key}Update a company's settings
Accountingsh.TagsApiaddTagPOST /tagsAdd a tag
Accountingsh.TagsApideleteTagDELETE /tags/{uuid}Delete a tag
Accountingsh.TagsApigetTagGET /tags/{uuid}Get a tag
Accountingsh.TagsApilistTagsGET /tagsList company's tags
Accountingsh.TagsApilistTagsByResourceGET /tags/attachments/{resource}List company's tags by resource attachment
Accountingsh.TagsApiupdateTagPUT /tags/{uuid}Update a tag
Accountingsh.TaxApigetTaxRateGET /tax/{country}Get the latest tax rate for a country
Accountingsh.TaxApiverifyVatIdGET /vat/verify/{number}Verify a VAT ID
Accountingsh.TransactionsApiaddTransactionPOST /transactionsAdd a transaction
Accountingsh.TransactionsApiaddTransactionCodePOST /transactions/{uuid}/codesAdd a transaction's code
Accountingsh.TransactionsApideleteTransactionDELETE /transactions/{uuid}Delete a transaction
Accountingsh.TransactionsApideleteTransactionCodeDELETE /transactions/{uuid}/codes/{code}Delete a transaction's code
Accountingsh.TransactionsApigetTransactionGET /transactions/{uuid}Get a transaction
Accountingsh.TransactionsApiimportTransactionsPOST /transactions/importImport transactions - INTERNAL
Accountingsh.TransactionsApilistTransactionCodesGET /transactions/{uuid}/codesList transaction's codes
Accountingsh.TransactionsApilistTransactionsGET /transactionsList company's transactions
Accountingsh.TransactionsApiupdateTransactionPUT /transactions/{uuid}Update a transaction
Accountingsh.TransactionsApiupdateTransactionCodePUT /transactions/{uuid}/codesUpdate a transaction's code
Accountingsh.TransfersApiaddTransferPOST /transfersAdd a transfer
Accountingsh.TransfersApideleteTransferDELETE /transfers/{uuid}Delete a transfer
Accountingsh.TransfersApigetTransferGET /transfers/{uuid}Get a transfer
Accountingsh.TransfersApilistTransfersGET /transfersList company's transfers
Accountingsh.TransfersApiupdateTransferPUT /transfers/{uuid}Update a transfer
Accountingsh.VATIDApiaddCompanyVatIdPOST /companies/{uuid}/vatAdd a company's Vat Id
Accountingsh.VATIDApideleteCompanyVatIdDELETE /companies/{uuid}/vat/{key}Delete a company's Vat Id
Accountingsh.VATIDApigetCompanyVatIdGET /companies/{uuid}/vat/{key}Get a company's Vat Id
Accountingsh.VATIDApilistCompanyVatIdGET /companies/{uuid}/vatList company's Vat Id
Accountingsh.VATIDApiupdateCompanyVatIdPUT /companies/{uuid}/vat/{key}Update a company's Vat Id
Accountingsh.WebhooksApiaddWebhookPOST /webhooksAdd a webhook
Accountingsh.WebhooksApideleteWebhookDELETE /webhooks/{uuid}Delete a webhook
Accountingsh.WebhooksApigetWebhookGET /webhooks/{uuid}Get a webhook
Accountingsh.WebhooksApigetWebhookHistoryGET /webhooks/{uuid}/historyGet webhook's history
Accountingsh.WebhooksApilistWebhookEventsGET /webhooks/eventsList available webhook events
Accountingsh.WebhooksApilistWebhooksGET /webhooksList company's webhooks
Accountingsh.WebhooksApiupdateWebhookPUT /webhooks/{uuid}Update a webhook

Documentation for Authorization

Authentication schemes defined for the API:

bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
0.3.1

8 months ago

0.3.0

8 months ago

0.2.0

1 year ago

0.1.0

1 year ago