Authentication and Rate Limits

Authentication

To authenticate API requests, a user needs to provide a valid and active credential (token).
Create a new API token in the dashboard with the required permissions for the specific actions you intend to perform.

Creating a Token:

Navigate to the Accounting software dashboard at https://dashboard.accounting.sh.
In the dashboard, go to the Credentials section.
Create a new API token, specifying the necessary permissions required for your intended API actions.
Store the generated token securely. Best practice is to store it in an environment variable to prevent inadvertent exposure.

Linux/Mac
Windows

export ACCOUNTING_API_TOKEN="your_generated_token"

$env:ACCOUNTING_API_TOKEN="your_generated_token"

Rate Limits

The current rate limit for API requests is set at 3 requests per 180 seconds. If you requires a higher rate limit, please contact us via email at [email protected].

Permissions:

Explore the following list of permissions along with a quick description of their functionalities:

Permission	Description
`all`	Full access to all features and functionalities.
`list.invoices`	View a list of invoices.
`add.invoice`	Create a new invoice.
`view.invoice`	View details of a specific invoice.
`edit.invoice`	Edit existing invoice details.
`add.invoice.payment`	Add a payment to an invoice.
`edit.invoice.revenues`	Edit revenues associated with an invoice.
`list.revenues`	View a list of revenues.
`add.revenue`	Add a new revenue entry.
`view.revenue`	View details of a specific revenue entry.
`edit.revenue`	Edit existing revenue details.
`list.contacts`	View a list of contacts.
`add.contact`	Add a new contact.
`view.contact`	View details of a specific contact.
`edit.contact`	Edit existing contact details.
`delete.contact`	Delete a contact.
`list.companies`	Internal Use Only - View a list of companies.
`add.company`	Internal Use Only - Add a new company.
`view.company`	View details of a specific company.
`edit.company`	Edit existing company details.
`list.company.settings`	View a list of company settings.
`view.company.settings`	View details of a specific company setting.
`edit.company.settings`	Edit existing company setting details.
`list.payments`	View a list of payments.
`add.payment`	Add a new payment.
`view.payment`	View details of a specific payment.
`edit.payment`	Edit existing payment details.
`delete.payment`	Delete a payment.
`list.bills`	View a list of bills.
`add.bill`	Add a new bill.
`view.bill`	View details of a specific bill.
`edit.bill`	Edit existing bill details.
`delete.bill`	Delete a bill.
`list.categories`	View a list of categories.
`add.category`	Add a new category.
`edit.category`	Edit existing category details.
`view.category`	View details of a specific category.
`delete.category`	Delete a category.
`list.accounts`	View a list of accounts.
`add.account`	Add a new account.
`view.account`	View details of a specific account.
`edit.account`	Edit existing account details.
`delete.account`	Delete an account.
`list.transfers`	View a list of transfers.
`add.transfer`	Add a new transfer.
`view.transfer`	View details of a specific transfer.
`edit.transfer`	Edit existing transfer details.
`delete.transfer`	Delete a transfer.
`list.tags`	View a list of tags.
`add.tag`	Add a new tag.
`view.tag`	View details of a specific tag.
`edit.tag`	Edit existing tag details.
`delete.tag`	Delete a tag.
`list.documents`	View a list of documents.
`add.document`	Add a new document.
`view.document`	View details of a specific document.
`edit.document`	Edit existing document details.
`delete.document`	Delete a document.
`process.document`	Process a document using the AI assistant.
`list.webhooks`	View a list of webhooks.
`add.webhook`	Add a new webhook.
`view.webhook`	View details of a specific webhook.
`edit.webhook`	Edit existing webhook details.
`delete.webhook`	Delete a webhook.
`list.credentials`	View a list of credentials.
`add.credential`	Add a new credential.
`view.credential`	View details of a specific credential.
`edit.credential`	Edit existing credential details.
`delete.credential`	Delete a credential.
`list.quotes`	View a list of quotes.
`add.quote`	Add a new quote.
`view.quote`	View details of a specific quote.
`edit.quote`	Edit existing quote details.
`list.receipts`	View a list of receipts.
`add.receipt`	Add a new receipt.
`view.receipt`	View details of a specific receipt.
`edit.receipt`	Edit existing receipt details.
`view.currency.rates`	View currency exchange rates.
`view.tax.rates`	View tax rates.
`vat.list`	View a list of Value Added Tax ID (VAT ID) entries.
`vat.add`	Add a new VAT ID entry.
`vat.view`	View details of a specific VAT ID entry.
`vat.edit`	Edit existing VAT ID entry details.
`vat.delete`	Delete a VAT ID entry.
`regenerate.invoice`	Regenerate an invoice.
`regenerate.receipt`	Regenerate a receipt.
`regenerate.quote`	Regenerate a quote.
`company.delete`	Internal Use Only - Delete a company.
`invoice.delete`	Delete an invoice.
`quote.delete`	Delete a quote.
`receipt.delete`	Delete a receipt.
`revenue.delete`	Delete a revenue entry.
`transaction.list`	View a list of transactions.
`transaction.add`	Add a new transaction.
`transaction.view`	View details of a specific transaction.
`transaction.edit`	Edit existing transaction details.
`transaction.delete`	Delete a transaction.
`stats.view`	View statistics.
`log.view`	View logs.
`export`	Request a new export.
`attachment.list`	View a list of attachments.
`attachment.add`	Add a new attachment.
`attachment.view`	View details of a specific attachment.
`attachment.edit`	Edit existing attachment details.
`attachment.delete`	Delete an attachment.
`account.connections.list`	View a list of account connections.
`account.connections.delete`	Delete an account connection.
`account.connections.banks`	View a list of bank account connections.
`search`	Perform a search.
`expense_report.list`	View a list of expense reports.
`expense_report.add`	Add a new expense report.
`expense_report.view`	View details of a specific expense report.
`expense_report.edit`	Edit existing expense report details.
`expense_report.delete`	Delete an expense report.
`expense_report.limited_to_self`	Limit expense reports to the user.
`expense_report.view.account`	View expense reports related to a specific account.
`expense_report.view.user`	View expense reports related to a specific user.
`expense_report.edit.account`	Edit expense reports related to a specific account.
`accounting_code.list`	View a list of accounting codes.
`accounting_code.add`	Add a new accounting code.
`accounting_code.view`	View details of a specific accounting code.
`accounting_code.edit`	Edit existing accounting code details.
`accounting_code.delete`	Delete an accounting code.
`transaction_code.list`	View a list of transaction codes.
`transaction_code.add`	Add a new transaction code.
`transaction_code.view`	View details of a specific transaction code.
`transaction_code.edit`	Edit existing transaction code details.
`transaction_code.delete`	Delete a transaction code.
`oauth_config.list`	View a list of OAuth configurations.
`oauth_config.add`	Add a new OAuth configuration.
`oauth_config.view`	View details of a specific OAuth configuration.
`oauth_config.edit`	Edit existing OAuth configuration details.
`oauth_config.delete`	Delete an OAuth configuration.

Customize permissions based on your specific needs, ensuring that your API token has the necessary access rights for the actions you plan to execute.

Authentication​

Creating a Token:​

Rate Limits​

Permissions:​

Authentication

Creating a Token:

Rate Limits

Permissions: