accounting-sh 0.4.0

Accounting API

accounting-sh

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.5.5
• Package version: 0.4.0
• Generator version: 7.6.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

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

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install accounting_sh

Then import the package:

import accounting_sh

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import accounting_sh

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import accounting_sh
from accounting_sh.exceptions import ApiException
from pprint import pprint


uuid = 'uuid_example' # str | The account uuid

accounting = accounting_sh.Accounting("access_token")
try:
    # Delete an account's connection
    api_response = accounting.account_connections_api.delete_account_connection(uuid)
    print("The response of AccountConnectionsApi->delete_account_connection:\n")
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountConnectionsApi->delete_account_connection: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountConnectionsApi	delete_account_connection	DELETE /accounts/{uuid}/connect	Delete an account's connection
AccountConnectionsApi	list_account_connections	GET /accounts/{uuid}/connect	List account's connections
AccountConnectionsApi	list_banks	GET /accounts/{uuid}/connect/banks	List available bank connections
AccountingCodesApi	add_accounting_code	POST /accounting/codes	Add an accounting code
AccountingCodesApi	delete_accounting_code	DELETE /accounting/codes/{uuid}	Delete an accounting code
AccountingCodesApi	get_accounting_code	GET /accounting/codes/{uuid}	Get an accounting code
AccountingCodesApi	list_accounting_codes	GET /accounting/codes	List company's accounting code
AccountingCodesApi	update_accounting_code	PUT /accounting/codes/{uuid}	Update an accounting code
AccountsApi	add_account	POST /accounts	Add an account
AccountsApi	delete_account	DELETE /accounts/{uuid}	Delete an account
AccountsApi	get_account	GET /accounts/{uuid}	Get an account
AccountsApi	list_accounts	GET /accounts	List company's accounts
AccountsApi	update_account	PUT /accounts/{uuid}	Update an account
AttachmentsApi	add_attachment	POST /attachments	Add an attachment
AttachmentsApi	delete_attachment	DELETE /attachments/{uuid}	Delete an attachment
AttachmentsApi	get_attachment	GET /attachments/{uuid}	Get an attachment
AttachmentsApi	list_attachments	GET /attachments	List company's attachments
AttachmentsApi	retrieve_attachments	GET /attachments/resource/{resource}	List company's attachments link to resource
AttachmentsApi	update_attachment	PUT /attachments/{uuid}	Update an attachment
BillsApi	add_bill	POST /expenses/bills	Add a bill
BillsApi	add_bill_payment	POST /expenses/bills/{uuid}/payments	Add a bill payment
BillsApi	delete_bill	DELETE /expenses/bills/{uuid}	Delete a bill
BillsApi	get_bill	GET /expenses/bills/{uuid}	Get a bill
BillsApi	get_bill_document	GET /expenses/bills/{uuid}/document	Get a bill in PDF
BillsApi	list_bills	GET /expenses/bills	List company's bills
BillsApi	update_bill	PUT /expenses/bills/{uuid}	Update a bill
BillsApi	update_bill_payment	PUT /expenses/bills/{uuid}/payments/{payment}	Update a bill payment
CategoriesApi	add_category	POST /categories	Add a category
CategoriesApi	delete_category	DELETE /categories/{uuid}	Delete a category
CategoriesApi	get_category	GET /categories/{uuid}	Get a category
CategoriesApi	list_categories	GET /categories	List company's categories
CategoriesApi	update_category	PUT /categories/{uuid}	Update a category
CompaniesApi	add_company	POST /companies	Add a company
CompaniesApi	delete_company	DELETE /companies/{uuid}	Delete a company
CompaniesApi	get_company	GET /companies/{uuid}	Get a company
CompaniesApi	get_company_customization	GET /companies/{uuid}/customization	Get a company's customization parameters
CompaniesApi	get_company_feature_set	GET /companies/{uuid}/features	List a company's feature set
CompaniesApi	list_companies	GET /companies	List companies on this instance
CompaniesApi	update_company	PUT /companies/{uuid}	Update a company
CompanyStatisticsApi	get_statistics	GET /companies/{uuid}/statistics/period	Get company's statistic
ContactsApi	add_contact	POST /contacts	Create a new contact
ContactsApi	delete_contact	DELETE /contacts/{uuid}	Delete a contact
ContactsApi	get_contact	GET /contacts/{uuid}	Retrieve a contact
ContactsApi	list_contact_bills	GET /contacts/{uuid}/bills	List a contact's bills
ContactsApi	list_contact_invoices	GET /contacts/{uuid}/invoices	List a contact's invoices
ContactsApi	list_contacts	GET /contacts	List company's contacts
ContactsApi	update_contact	PUT /contact/{uuid}	Update a contact
CountriesApi	get_translated_countries	GET /countries/{lang}	Get translated list of countries
CredentialsApi	add_credential	POST /credentials	Add a credential
CredentialsApi	delete_credential	DELETE /credentials/{uuid}	Delete a credential
CredentialsApi	get_credential	GET /credentials/{uuid}	Get a credential
CredentialsApi	list_credentials	GET /credentials	List company's credentials
CredentialsApi	list_permissions	GET /credentials/permissions	List available permissions
CredentialsApi	me	GET /me	Get current credential informations
CredentialsApi	update_credential	PUT /credentials/{uuid}	Update a credential
CredentialsApi	userveria	POST /userveria	Exchange a my stantabcorp (userveria) token for an Accounting Token
CurrencyApi	get_exchange_rate	GET /currency/{from}/{to}	Get the latest currency exchange rate
DocumentsApi	cancel_review	DELETE /documents/{uuid}/review	Cancel document review
DocumentsApi	delete_document	DELETE /documents/{uuid}	Delete a document
DocumentsApi	get_document	GET /documents/{uuid}	Get a document
DocumentsApi	list_documents	GET /documents	List company's documents
DocumentsApi	process_document	GET /documents/{uuid}/process	Process a document
DocumentsApi	review_url	GET /documents/{uuid}/review	Get url to review a document
DocumentsApi	update_document	PUT /documents/{uuid}	Update a document
DocumentsApi	upload_document	POST /documents	Upload a document
DocumentsApi	view_document	GET /documents/{uuid}/view	View a document
ExpenseReportsApi	add_expense_report	POST /expenses/expense-reports	Add an expense report
ExpenseReportsApi	delete_expense_report	DELETE /expenses/expense-reports/{uuid}	Delete an expense report
ExpenseReportsApi	expense_report_o_auth_login	GET /expenses/expense-reports/login/{method}	OAuth Login
ExpenseReportsApi	get_expense_report	GET /expenses/expense-reports/{uuid}	Get an expense report
ExpenseReportsApi	get_expense_report_account	GET /expenses/expense-reports/me	Get the currently connected expense report user details
ExpenseReportsApi	get_expense_report_user	GET /expenses/expense-reports/users/{uuid}	Get an user details
ExpenseReportsApi	list_expense_reports	GET /expenses/expense-reports	List company's expense reports.
ExpenseReportsApi	send_expense_report_login_email	POST /expenses/expense-reports/login	Request login email
ExpenseReportsApi	update_expense_report	PUT /expenses/expense-reports/{uuid}	Update an expense report
ExpenseReportsApi	update_expense_report_account	PUT /expenses/expense-reports/me	Update the currently connected expense report user
ExpenseReportsApi	update_expense_report_settings	POST /expenses/expense-reports/settings	Retrieve company settings for expense reports
ExpenseReportsApi	verify_expense_report_settings	POST /expenses/expense-reports/verify	Verify expense reports settings
ExportApi	list_exports	GET /export	List company's exports
ExportApi	request_export	POST /export	Request an export
InvoicesApi	add_invoice	POST /incomes/invoices	Add an invoice
InvoicesApi	add_invoice_payment	POST /incomes/invoices/{uuid}/payments	Add an invoice payment
InvoicesApi	delete_invoice	DELETE /incomes/invoices/{uuid}	Delete an invoice
InvoicesApi	get_invoice	GET /incomes/invoices/{uuid}	Get an invoice
InvoicesApi	get_invoice_document	GET /incomes/invoices/{uuid}/document	Get an invoice in PDF
InvoicesApi	list_invoices	GET /incomes/invoices	List company's invoices
InvoicesApi	list_unpaid_invoices	GET /incomes/invoices/unpaid	List company's unpaid invoices
InvoicesApi	update_invoice	PUT /incomes/invoices/{uuid}	Update an invoice
InvoicesApi	update_invoice_payment	PUT /incomes/invoices/{uuid}/payments/{payment}	Update an invoice payment
LogsApi	logs	GET /logs	List company's logs
NotificationApi	list_notification_preferences	GET /notifications/preferences/{notification}	List notification preferences
NotificationApi	list_notifications	GET /notifications	List company's notifications
NotificationApi	send_notification	POST /notifications/send	Send a notification
NotificationApi	update_notification_preferences	PUT /notifications/preferences/{notification}	Update notification preferences
NotificationTypesApi	add_notification_type	POST /notifications/types	Add a notification type
NotificationTypesApi	delete_notification_type	DELETE /notifications/types/{uuid}	Delete a notification type
NotificationTypesApi	get_notification_type	GET /notifications/types/{uuid}	Get a notification type
NotificationTypesApi	list_notification_types	GET /notifications/types	List company's notification types
NotificationTypesApi	update_notification_type	PUT /notifications/types/{uuid}	Update a notification type
OAuthConfigApi	add_o_auth_configuration	POST /oauth	Add an OAuth configuration
OAuthConfigApi	delete_o_auth_configuration	DELETE /oauth/{uuid}	Delete an oauth configuration
OAuthConfigApi	get_o_auth_configuration	GET /oauth/{uuid}	Get an OAuth configuration
OAuthConfigApi	list_o_auth_configurations	GET /oauth	List company's oauth configurations
OAuthConfigApi	list_providers	GET /oauth/providers	List available providers
OAuthConfigApi	update_o_auth_configuration	PUT /oauth/{uuid}	Update an oauth configuration
PaymentsApi	add_payment	POST /expenses/payments	Add a payment
PaymentsApi	delete_payment	DELETE /expenses/payments/{uuid}	Delete a payment
PaymentsApi	get_payment	GET /expenses/payments/{uuid}	Get a payment
PaymentsApi	list_payments	GET /expenses/payments	List company's payments
PaymentsApi	update_payment	PUT /expenses/payments/{uuid}	Update a payment
QuotesApi	add_quote	POST /quotes	Add a quote
QuotesApi	delete_quote	DELETE /quotes/{uuid}	Delete a quote
QuotesApi	get_quote	GET /quotes/{uuid}	Get a quote
QuotesApi	get_quote_document	GET /quotes/{uuid}/document	Get a quote in PDF
QuotesApi	list_quotes	GET /quotes	List company's quotes
QuotesApi	update_quote	PUT /quotes/{uuid}	Update a quote
ReceiptsApi	add_receipt	POST /receipts	Add a receipt
ReceiptsApi	delete_receipt	DELETE /receipts/{uuid}	Delete a receipt
ReceiptsApi	get_receipt	GET /receipts/{uuid}	Get a receipt
ReceiptsApi	get_receipt_document	GET /receipts/{uuid}/document	Get a receipt in PDF
ReceiptsApi	list_receipts	GET /receipts	List company's receipts
ReceiptsApi	update_receipt	PUT /receipts/{uuid}	Update a receipt
RevenuesApi	add_revenue	POST /incomes/revenues	Add a revenue
RevenuesApi	delete_revenue	DELETE /incomes/revenues/{uuid}	Delete a revenue
RevenuesApi	get_revenue	GET /incomes/revenues/{uuid}	Get a revenue
RevenuesApi	list_revenues	GET /incomes/revenues	List company's revenues
RevenuesApi	update_revenue	PUT /incomes/revenues/{uuid}	Update a revenue
RossumApi	list_reviews	GET /external/rossum/reviews	List documents to be reviewes
SearchApi	search	GET /search	Search
SettingsApi	get_settings	GET /companies/{uuid}/settings/{key}	Get a company's settings
SettingsApi	list_settings	GET /companies/{uuid}/settings	List company's settings
SettingsApi	update_settings	PUT /companies/{uuid}/settings/{key}	Update a company's settings
TagsApi	add_tag	POST /tags	Add a tag
TagsApi	delete_tag	DELETE /tags/{uuid}	Delete a tag
TagsApi	get_tag	GET /tags/{uuid}	Get a tag
TagsApi	list_tags	GET /tags	List company's tags
TagsApi	list_tags_by_resource	GET /tags/attachments/{resource}	List company's tags by resource attachment
TagsApi	update_tag	PUT /tags/{uuid}	Update a tag
TaxApi	get_tax_rate	GET /tax/{country}	Get the latest tax rate for a country
TaxApi	verify_vat_id	GET /vat/verify/{number}	Verify a VAT ID
TransactionsApi	add_transaction	POST /transactions	Add a transaction
TransactionsApi	add_transaction_code	POST /transactions/{uuid}/codes	Add a transaction's code
TransactionsApi	delete_transaction	DELETE /transactions/{uuid}	Delete a transaction
TransactionsApi	delete_transaction_code	DELETE /transactions/{uuid}/codes/{code}	Delete a transaction's code
TransactionsApi	get_transaction	GET /transactions/{uuid}	Get a transaction
TransactionsApi	import_transactions	POST /transactions/import	Import transactions - INTERNAL
TransactionsApi	list_transaction_codes	GET /transactions/{uuid}/codes	List transaction's codes
TransactionsApi	list_transactions	GET /transactions	List company's transactions
TransactionsApi	update_transaction	PUT /transactions/{uuid}	Update a transaction
TransactionsApi	update_transaction_code	PUT /transactions/{uuid}/codes	Update a transaction's code
TransfersApi	add_transfer	POST /transfers	Add a transfer
TransfersApi	delete_transfer	DELETE /transfers/{uuid}	Delete a transfer
TransfersApi	get_transfer	GET /transfers/{uuid}	Get a transfer
TransfersApi	list_transfers	GET /transfers	List company's transfers
TransfersApi	update_transfer	PUT /transfers/{uuid}	Update a transfer
VATIDApi	add_company_vat_id	POST /companies/{uuid}/vat	Add a company's Vat Id
VATIDApi	delete_company_vat_id	DELETE /companies/{uuid}/vat/{key}	Delete a company's Vat Id
VATIDApi	get_company_vat_id	GET /companies/{uuid}/vat/{key}	Get a company's Vat Id
VATIDApi	list_company_vat_id	GET /companies/{uuid}/vat	List company's Vat Id
VATIDApi	update_company_vat_id	PUT /companies/{uuid}/vat/{key}	Update a company's Vat Id
WebhooksApi	add_webhook	POST /webhooks	Add a webhook
WebhooksApi	delete_webhook	DELETE /webhooks/{uuid}	Delete a webhook
WebhooksApi	get_webhook	GET /webhooks/{uuid}	Get a webhook
WebhooksApi	get_webhook_history	GET /webhooks/{uuid}/history	Get webhook's history
WebhooksApi	list_webhook_events	GET /webhooks/events	List available webhook events
WebhooksApi	list_webhooks	GET /webhooks	List company's webhooks
WebhooksApi	update_webhook	PUT /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