Documentation of the Sage Business Cloud Accounting API.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 3.1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit mailto:sbc-accounting-api-developers@sage.com
This package was extended by combining the generated SDK from the openapi.json (link) file along with another generated SDK using openapi.user_business.json (link) and the OAuth2 structure found in the xero-python package. Both SDK packages were generated using the python package openapi-generator-cli@4.3.1.
The OAuth2 structure that was ported over mainly relates to the file sage/oauth2.py however other modifications were made throughout the api_client.py file and all files in the /api directory to enforce the OAuth2 flow was used for authentication. Additionally the strucutre imported from xero-python had to be slightly modified in order to work accordingly with the autogenerated structure in this SDK. The majority of these edits took place in the sage/oauth2.py file.
Python 2.7 and 3.4+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import sageInstall 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 sagePlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import sage
from sage.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.accounting.sage.com/v3.1
# See configuration.py for a list of all supported configuration parameters.
configuration = sage.Configuration(
host = "https://api.accounting.sage.com/v3.1"
)
# Enter a context with an instance of the API client
with sage.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = sage.AddressRegionsApi(api_client)
items_per_page = 20 # int | Returns the given number of States per request. (optional) (default to 20)
page = 1 # int | Go to specific page of States (optional) (default to 1)
attributes = 'attributes_example' # str | Specify the attributes that you want to expose for the States (expose all attributes with 'all'). These are in addition to the base attributes (name, path) (optional)
country_id = 'country_id_example' # str | Use this to filter by country id (optional)
try:
# Returns all Address Regions
api_response = api_instance.get_address_regions(items_per_page=items_per_page, page=page, attributes=attributes, country_id=country_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AddressRegionsApi->get_address_regions: %s\n" % e)
All URIs are relative to https://api.accounting.sage.com/v3.1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AddressRegionsApi | get_address_regions | GET /address_regions | Returns all Address Regions |
| AddressRegionsApi | get_address_regions_key | GET /address_regions/{key} | Returns a Address Region |
| AddressTypesApi | get_address_types | GET /address_types | Returns all Address Types |
| AddressTypesApi | get_address_types_key | GET /address_types/{key} | Returns a Address Type |
| AddressesApi | delete_addresses_key | DELETE /addresses/{key} | Deletes a Address |
| AddressesApi | get_addresses | GET /addresses | Returns all Addresses |
| AddressesApi | get_addresses_key | GET /addresses/{key} | Returns a Address |
| AddressesApi | post_addresses | POST /addresses | Creates a Address |
| AddressesApi | put_addresses_key | PUT /addresses/{key} | Updates a Address |
| ArtefactStatusesApi | get_artefact_statuses | GET /artefact_statuses | Returns all Artefact Statuses |
| ArtefactStatusesApi | get_artefact_statuses_key | GET /artefact_statuses/{key} | Returns a Artefact Status |
| AttachmentContextTypesApi | get_attachment_context_types | GET /attachment_context_types | Returns all Attachment Context Types |
| AttachmentContextTypesApi | get_attachment_context_types_key | GET /attachment_context_types/{key} | Returns a Attachment Context Type |
| AttachmentsApi | delete_attachments_key | DELETE /attachments/{key} | Deletes a Attachment |
| AttachmentsApi | get_attachments | GET /attachments | Returns all Attachments |
| AttachmentsApi | get_attachments_key | GET /attachments/{key} | Returns a Attachment |
| AttachmentsApi | get_attachments_key_file | GET /attachments/{key}/file | Returns an Attachment File |
| AttachmentsApi | post_attachments | POST /attachments | Creates a Attachment |
| AttachmentsApi | put_attachments_key | PUT /attachments/{key} | Updates a Attachment |
| BankAccountTypesApi | get_bank_account_types | GET /bank_account_types | Returns all Bank Account Types |
| BankAccountTypesApi | get_bank_account_types_key | GET /bank_account_types/{key} | Returns a Bank Account Type |
| BankAccountsApi | delete_bank_accounts_key | DELETE /bank_accounts/{key} | Deletes a Bank Account |
| BankAccountsApi | get_bank_accounts | GET /bank_accounts | Returns all Bank Accounts |
| BankAccountsApi | get_bank_accounts_key | GET /bank_accounts/{key} | Returns a Bank Account |
| BankAccountsApi | post_bank_accounts | POST /bank_accounts | Creates a Bank Account |
| BankAccountsApi | put_bank_accounts_key | PUT /bank_accounts/{key} | Updates a Bank Account |
| BankDepositsApi | delete_bank_deposits_key | DELETE /bank_deposits/{key} | Deletes a Bank Deposit |
| BankDepositsApi | get_bank_deposits | GET /bank_deposits | Returns all Bank Deposits |
| BankDepositsApi | get_bank_deposits_key | GET /bank_deposits/{key} | Returns a Bank Deposit |
| BankDepositsApi | post_bank_deposits | POST /bank_deposits | Creates a Bank Deposit |
| BankOpeningBalancesApi | delete_bank_opening_balances_key | DELETE /bank_opening_balances/{key} | Deletes a Bank Opening Balance |
| BankOpeningBalancesApi | get_bank_opening_balances | GET /bank_opening_balances | Returns all Bank Opening Balances |
| BankOpeningBalancesApi | get_bank_opening_balances_key | GET /bank_opening_balances/{key} | Returns a Bank Opening Balance |
| BankOpeningBalancesApi | post_bank_opening_balances | POST /bank_opening_balances | Creates a Bank Opening Balance |
| BankOpeningBalancesApi | put_bank_opening_balances_key | PUT /bank_opening_balances/{key} | Updates a Bank Opening Balance |
| BankReconciliationsApi | get_bank_reconciliations | GET /bank_reconciliations | Returns all Bank Reconciliations |
| BankReconciliationsApi | get_bank_reconciliations_key | GET /bank_reconciliations/{key} | Returns a Bank Reconciliation |
| BankReconciliationsApi | post_bank_reconciliations | POST /bank_reconciliations | Creates a Bank Reconciliation |
| BankReconciliationsApi | put_bank_reconciliations_key | PUT /bank_reconciliations/{key} | Updates a Bank Reconciliation |
| BankTransfersApi | delete_bank_transfers_key | DELETE /bank_transfers/{key} | Deletes a Bank Transfer |
| BankTransfersApi | get_bank_transfers | GET /bank_transfers | Returns all Bank Transfers |
| BankTransfersApi | get_bank_transfers_key | GET /bank_transfers/{key} | Returns a Bank Transfer |
| BankTransfersApi | post_bank_transfers | POST /bank_transfers | Creates a Bank Transfer |
| BankTransfersApi | put_bank_transfers_key | PUT /bank_transfers/{key} | Updates a Bank Transfer |
| BusinessActivityTypesApi | get_business_activity_types | GET /business_activity_types | Returns all Business Activity Types |
| BusinessActivityTypesApi | get_business_activity_types_key | GET /business_activity_types/{key} | Returns a Business Activity Type |
| BusinessExchangeRatesApi | delete_business_exchange_rates_key | DELETE /business_exchange_rates/{key} | Deletes a Business Exchange Rate |
| BusinessExchangeRatesApi | get_business_exchange_rates | GET /business_exchange_rates | Returns all Business Exchange Rates |
| BusinessExchangeRatesApi | get_business_exchange_rates_key | GET /business_exchange_rates/{key} | Returns a Business Exchange Rate |
| BusinessExchangeRatesApi | post_business_exchange_rates | POST /business_exchange_rates | Creates a Business Exchange Rate |
| BusinessExchangeRatesApi | put_business_exchange_rates_key | PUT /business_exchange_rates/{key} | Updates a Business Exchange Rate |
| BusinessSettingsApi | get_business_settings | GET /business_settings | Returns all Business Settings |
| BusinessSettingsApi | put_business_settings | PUT /business_settings | Updates a Business Settings |
| BusinessTypesApi | get_business_types | GET /business_types | Returns all Business Types |
| BusinessTypesApi | get_business_types_key | GET /business_types/{key} | Returns a Business Type |
| CatalogItemTypesApi | get_catalog_item_types | GET /catalog_item_types | Returns all Catalog Item Types |
| CatalogItemTypesApi | get_catalog_item_types_key | GET /catalog_item_types/{key} | Returns a Catalog Item Type |
| CoaAccountsApi | get_coa_accounts | GET /coa_accounts | Returns all Coa Accounts |
| CoaAccountsApi | get_coa_accounts_key | GET /coa_accounts/{key} | Returns a Coa Account |
| CoaTemplatesApi | get_coa_templates | GET /coa_templates | Returns all Coa Templates |
| CoaTemplatesApi | get_coa_templates_key | GET /coa_templates/{key} | Returns a Coa Template |
| ContactAllocationsApi | delete_contact_allocations_key | DELETE /contact_allocations/{key} | Deletes a Contact Allocation |
| ContactAllocationsApi | get_contact_allocations | GET /contact_allocations | Returns all Contact Allocations |
| ContactAllocationsApi | get_contact_allocations_key | GET /contact_allocations/{key} | Returns a Contact Allocation |
| ContactAllocationsApi | post_contact_allocations | POST /contact_allocations | Creates a Contact Allocation |
| ContactAllocationsApi | put_contact_allocations_key | PUT /contact_allocations/{key} | Updates a Contact Allocation |
| ContactOpeningBalanceTypesApi | get_contact_opening_balance_types | GET /contact_opening_balance_types | Returns all Contact Opening Balance Types |
| ContactOpeningBalanceTypesApi | get_contact_opening_balance_types_key | GET /contact_opening_balance_types/{key} | Returns a Contact Opening Balance Type |
| ContactOpeningBalancesApi | delete_contact_opening_balances_key | DELETE /contact_opening_balances/{key} | Deletes a Contact Opening Balance |
| ContactOpeningBalancesApi | get_contact_opening_balances | GET /contact_opening_balances | Returns all Contact Opening Balances |
| ContactOpeningBalancesApi | get_contact_opening_balances_key | GET /contact_opening_balances/{key} | Returns a Contact Opening Balance |
| ContactOpeningBalancesApi | post_contact_opening_balances | POST /contact_opening_balances | Creates a Contact Opening Balance |
| ContactOpeningBalancesApi | put_contact_opening_balances_key | PUT /contact_opening_balances/{key} | Updates a Contact Opening Balance |
| ContactPaymentsApi | delete_contact_payments_key | DELETE /contact_payments/{key} | Deletes a Contact Payment |
| ContactPaymentsApi | get_contact_payments | GET /contact_payments | Returns all Contact Payments |
| ContactPaymentsApi | get_contact_payments_key | GET /contact_payments/{key} | Returns a Contact Payment |
| ContactPaymentsApi | post_contact_payments | POST /contact_payments | Creates a Contact Payment |
| ContactPaymentsApi | put_contact_payments_key | PUT /contact_payments/{key} | Updates a Contact Payment |
| ContactPeopleApi | delete_contact_persons_key | DELETE /contact_persons/{key} | Deletes a Contact Person |
| ContactPeopleApi | get_contact_persons | GET /contact_persons | Returns all Contact People |
| ContactPeopleApi | get_contact_persons_key | GET /contact_persons/{key} | Returns a Contact Person |
| ContactPeopleApi | post_contact_persons | POST /contact_persons | Creates a Contact Person |
| ContactPeopleApi | put_contact_persons_key | PUT /contact_persons/{key} | Updates a Contact Person |
| ContactPersonTypesApi | get_contact_person_types | GET /contact_person_types | Returns all Contact Person Types |
| ContactPersonTypesApi | get_contact_person_types_key | GET /contact_person_types/{key} | Returns a Contact Person Type |
| ContactTypesApi | get_contact_types | GET /contact_types | Returns all Contact Types |
| ContactTypesApi | get_contact_types_key | GET /contact_types/{key} | Returns a Contact Type |
| ContactsApi | delete_contacts_key | DELETE /contacts/{key} | Deletes a Contact |
| ContactsApi | get_contacts | GET /contacts | Returns all Contacts |
| ContactsApi | get_contacts_key | GET /contacts/{key} | Returns a Contact |
| ContactsApi | post_contacts | POST /contacts | Creates a Contact |
| ContactsApi | put_contacts_key | PUT /contacts/{key} | Updates a Contact |
| CorrectiveReasonCodesApi | get_corrective_reason_codes | GET /corrective_reason_codes | Returns all Corrective Reason Codes |
| CorrectiveReasonCodesApi | get_corrective_reason_codes_key | GET /corrective_reason_codes/{key} | Returns a Corrective Reason Code |
| CountriesApi | get_countries | GET /countries | Returns all Countries |
| CountriesApi | get_countries_key | GET /countries/{key} | Returns a Country |
| CountryGroupsApi | get_country_groups | GET /country_groups | Returns all Country Groups |
| CountryGroupsApi | get_country_groups_key | GET /country_groups/{key} | Returns a Country Group |
| CountryOfRegistrationsApi | get_countries_of_registration | GET /countries_of_registration | Returns all Country Of Registrations |
| CountryOfRegistrationsApi | get_countries_of_registration_key | GET /countries_of_registration/{key} | Returns a Country Of Registration |
| CurrenciesApi | get_currencies | GET /currencies | Returns all Currencies |
| CurrenciesApi | get_currencies_key | GET /currencies/{key} | Returns a Currency |
| DatevSettingsApi | get_datev_settings | GET /datev_settings | Returns all Datev Settings |
| DatevSettingsApi | put_datev_settings | PUT /datev_settings | Updates a Datev Settings |
| EUGoodsServicesTypesApi | get_eu_goods_services_types | GET /eu_goods_services_types | Returns all EU Goods Services Types |
| EUGoodsServicesTypesApi | get_eu_goods_services_types_key | GET /eu_goods_services_types/{key} | Returns a EU Goods Services Type |
| EUSalesDescriptionsApi | get_eu_sales_descriptions | GET /eu_sales_descriptions | Returns all EU Sales Descriptions |
| EUSalesDescriptionsApi | get_eu_sales_descriptions_key | GET /eu_sales_descriptions/{key} | Returns a EU Sales Description |
| EmailSettingsApi | get_email_settings | GET /email_settings | Returns all Email Settings |
| EmailSettingsApi | put_email_settings | PUT /email_settings | Updates a Email Settings |
| ExchangeRatesApi | get_exchange_rates | GET /exchange_rates | Returns all Exchange Rates |
| ExchangeRatesApi | get_exchange_rates_key | GET /exchange_rates/{key} | Returns a Exchange Rate |
| FinancialSettingsApi | get_financial_settings | GET /financial_settings | Returns all Financial Settings |
| FinancialSettingsApi | put_financial_settings | PUT /financial_settings | Updates a Financial Settings |
| HostedArtefactPaymentSettingsApi | delete_hosted_artefact_payment_settings_key | DELETE /hosted_artefact_payment_settings/{key} | Deletes a Hosted Artefact Payment Setting |
| HostedArtefactPaymentSettingsApi | get_hosted_artefact_payment_settings | GET /hosted_artefact_payment_settings | Returns all Hosted Artefact Payment Settings |
| HostedArtefactPaymentSettingsApi | get_hosted_artefact_payment_settings_key | GET /hosted_artefact_payment_settings/{key} | Returns a Hosted Artefact Payment Setting |
| HostedArtefactPaymentSettingsApi | post_hosted_artefact_payment_settings | POST /hosted_artefact_payment_settings | Creates a Hosted Artefact Payment Setting |
| InvoiceSettingsApi | get_invoice_settings | GET /invoice_settings | Returns all Invoice Settings |
| InvoiceSettingsApi | put_invoice_settings | PUT /invoice_settings | Updates a Invoice Settings |
| JournalCodeTypesApi | get_journal_code_types | GET /journal_code_types | Returns all Journal Code Types |
| JournalCodeTypesApi | get_journal_code_types_key | GET /journal_code_types/{key} | Returns a Journal Code Type |
| JournalCodesApi | delete_journal_codes_key | DELETE /journal_codes/{key} | Deletes a Journal Code |
| JournalCodesApi | get_journal_codes | GET /journal_codes | Returns all Journal Codes |
| JournalCodesApi | get_journal_codes_key | GET /journal_codes/{key} | Returns a Journal Code |
| JournalCodesApi | post_journal_codes | POST /journal_codes | Creates a Journal Code |
| JournalCodesApi | put_journal_codes_key | PUT /journal_codes/{key} | Updates a Journal Code |
| JournalsApi | delete_journals_key | DELETE /journals/{key} | Deletes a Journal |
| JournalsApi | get_journals | GET /journals | Returns all Journals |
| JournalsApi | get_journals_key | GET /journals/{key} | Returns a Journal |
| JournalsApi | post_journals | POST /journals | Creates a Journal |
| JournalsApi | post_journals_key_reissue | POST /journals/{key}/reissue | Reissues an existing Journal by voiding the existing one and creating a new one |
| LedgerAccountClassificationsApi | get_ledger_account_classifications | GET /ledger_account_classifications | Returns all Ledger Account Classifications |
| LedgerAccountClassificationsApi | get_ledger_account_classifications_key | GET /ledger_account_classifications/{key} | Returns a Ledger Account Classification |
| LedgerAccountOpeningBalancesApi | delete_ledger_account_opening_balances_key | DELETE /ledger_account_opening_balances/{key} | Deletes a Ledger Account Opening Balance |
| LedgerAccountOpeningBalancesApi | get_ledger_account_opening_balances | GET /ledger_account_opening_balances | Returns all Ledger Account Opening Balances |
| LedgerAccountOpeningBalancesApi | get_ledger_account_opening_balances_key | GET /ledger_account_opening_balances/{key} | Returns a Ledger Account Opening Balance |
| LedgerAccountOpeningBalancesApi | post_ledger_account_opening_balances | POST /ledger_account_opening_balances | Creates a Ledger Account Opening Balance |
| LedgerAccountOpeningBalancesApi | put_ledger_account_opening_balances_key | PUT /ledger_account_opening_balances/{key} | Updates a Ledger Account Opening Balance |
| LedgerAccountTypesApi | get_ledger_account_types | GET /ledger_account_types | Returns all Ledger Account Types |
| LedgerAccountTypesApi | get_ledger_account_types_key | GET /ledger_account_types/{key} | Returns a Ledger Account Type |
| LedgerAccountsApi | get_ledger_accounts | GET /ledger_accounts | Returns all Ledger Accounts |
| LedgerAccountsApi | get_ledger_accounts_key | GET /ledger_accounts/{key} | Returns a Ledger Account |
| LedgerAccountsApi | post_ledger_accounts | POST /ledger_accounts | Creates a Ledger Account |
| LedgerAccountsApi | put_ledger_accounts_key | PUT /ledger_accounts/{key} | Updates a Ledger Account |
| LedgerEntriesApi | get_ledger_entries | GET /ledger_entries | Returns all Ledger Entries |
| LedgerEntriesApi | get_ledger_entries_key | GET /ledger_entries/{key} | Returns a Ledger Entry |
| LegalFormTypesApi | get_legal_form_types | GET /legal_form_types | Returns all Legal Form Types |
| LegalFormTypesApi | get_legal_form_types_key | GET /legal_form_types/{key} | Returns a Legal Form Type |
| LiveExchangeRatesApi | get_live_exchange_rates | GET /live_exchange_rates | Returns all Live Exchange Rates |
| LiveExchangeRatesApi | get_live_exchange_rates_key | GET /live_exchange_rates/{key} | Returns a Live Exchange Rate |
| MigrationTaxReturnsApi | get_migration_tax_returns | GET /migration_tax_returns | Returns all Migration Tax Returns |
| MigrationTaxReturnsApi | get_migration_tax_returns_key | GET /migration_tax_returns/{key} | Returns a Migration Tax Return |
| MigrationTaxReturnsApi | post_migration_tax_returns | POST /migration_tax_returns | Creates a Migration Tax Return |
| MigrationsApi | get_migrations | GET /migrations | Returns all Migrations |
| MigrationsApi | put_migrations | PUT /migrations | Updates a Migrations |
| OpeningBalanceJournalsApi | delete_opening_balance_journals_key | DELETE /opening_balance_journals/{key} | Deletes a Opening Balance Journal |
| OpeningBalanceJournalsApi | get_opening_balance_journals | GET /opening_balance_journals | Returns all Opening Balance Journals |
| OpeningBalanceJournalsApi | get_opening_balance_journals_key | GET /opening_balance_journals/{key} | Returns a Opening Balance Journal |
| OpeningBalanceJournalsApi | post_opening_balance_journals | POST /opening_balance_journals | Creates a Opening Balance Journal |
| OtherPaymentsApi | delete_other_payments_key | DELETE /other_payments/{key} | Deletes a Other Payment |
| OtherPaymentsApi | get_other_payments | GET /other_payments | Returns all Other Payments |
| OtherPaymentsApi | get_other_payments_key | GET /other_payments/{key} | Returns a Other Payment |
| OtherPaymentsApi | post_other_payments | POST /other_payments | Creates a Other Payment |
| OtherPaymentsApi | put_other_payments_key | PUT /other_payments/{key} | Updates a Other Payment |
| PaymentMethodsApi | get_payment_methods | GET /payment_methods | Returns all Payment Methods |
| PaymentMethodsApi | get_payment_methods_key | GET /payment_methods/{key} | Returns a Payment Method |
| ProductSalesPriceTypesApi | delete_product_sales_price_types_key | DELETE /product_sales_price_types/{key} | Deletes a Product Sales Price Type |
| ProductSalesPriceTypesApi | get_product_sales_price_types | GET /product_sales_price_types | Returns all Product Sales Price Types |
| ProductSalesPriceTypesApi | get_product_sales_price_types_key | GET /product_sales_price_types/{key} | Returns a Product Sales Price Type |
| ProductSalesPriceTypesApi | post_product_sales_price_types | POST /product_sales_price_types | Creates a Product Sales Price Type |
| ProductSalesPriceTypesApi | put_product_sales_price_types_key | PUT /product_sales_price_types/{key} | Updates a Product Sales Price Type |
| ProductsApi | delete_products_key | DELETE /products/{key} | Deletes a Product |
| ProductsApi | get_products | GET /products | Returns all Products |
| ProductsApi | get_products_key | GET /products/{key} | Returns a Product |
| ProductsApi | post_products | POST /products | Creates a Product |
| ProductsApi | put_products_key | PUT /products/{key} | Updates a Product |
| PurchaseCorrectiveInvoicesApi | delete_purchase_corrective_invoices_key | DELETE /purchase_corrective_invoices/{key} | Deletes a Purchase Corrective Invoice |
| PurchaseCorrectiveInvoicesApi | get_purchase_corrective_invoices | GET /purchase_corrective_invoices | Returns all Purchase Corrective Invoices |
| PurchaseCorrectiveInvoicesApi | get_purchase_corrective_invoices_key | GET /purchase_corrective_invoices/{key} | Returns a Purchase Corrective Invoice |
| PurchaseCorrectiveInvoicesApi | post_purchase_corrective_invoices | POST /purchase_corrective_invoices | Creates a Purchase Corrective Invoice |
| PurchaseCorrectiveInvoicesApi | put_purchase_corrective_invoices_key | PUT /purchase_corrective_invoices/{key} | Updates a Purchase Corrective Invoice |
| PurchaseCreditNotesApi | delete_purchase_credit_notes_key | DELETE /purchase_credit_notes/{key} | Deletes a Purchase Credit Note |
| PurchaseCreditNotesApi | get_purchase_credit_notes | GET /purchase_credit_notes | Returns all Purchase Credit Notes |
| PurchaseCreditNotesApi | get_purchase_credit_notes_key | GET /purchase_credit_notes/{key} | Returns a Purchase Credit Note |
| PurchaseCreditNotesApi | post_purchase_credit_notes | POST /purchase_credit_notes | Creates a Purchase Credit Note |
| PurchaseCreditNotesApi | post_purchase_credit_notes_key_release | POST /purchase_credit_notes/{key}/release | Releases a Purchase Credit Note |
| PurchaseCreditNotesApi | put_purchase_credit_notes_key | PUT /purchase_credit_notes/{key} | Updates a Purchase Credit Note |
| PurchaseInvoicesApi | delete_purchase_invoices_key | DELETE /purchase_invoices/{key} | Deletes a Purchase Invoice |
| PurchaseInvoicesApi | get_purchase_invoices | GET /purchase_invoices | Returns all Purchase Invoices |
| PurchaseInvoicesApi | get_purchase_invoices_key | GET /purchase_invoices/{key} | Returns a Purchase Invoice |
| PurchaseInvoicesApi | post_purchase_invoices | POST /purchase_invoices | Creates a Purchase Invoice |
| PurchaseInvoicesApi | post_purchase_invoices_key_release | POST /purchase_invoices/{key}/release | Releases a Purchase Invoice |
| PurchaseInvoicesApi | put_purchase_invoices_key | PUT /purchase_invoices/{key} | Updates a Purchase Invoice |
| PurchaseQuickEntriesApi | delete_purchase_quick_entries_key | DELETE /purchase_quick_entries/{key} | Deletes a Purchase Quick Entry |
| PurchaseQuickEntriesApi | get_purchase_quick_entries | GET /purchase_quick_entries | Returns all Purchase Quick Entries |
| PurchaseQuickEntriesApi | get_purchase_quick_entries_key | GET /purchase_quick_entries/{key} | Returns a Purchase Quick Entry |
| PurchaseQuickEntriesApi | post_purchase_quick_entries | POST /purchase_quick_entries | Creates a Purchase Quick Entry |
| PurchaseQuickEntriesApi | put_purchase_quick_entries_key | PUT /purchase_quick_entries/{key} | Updates a Purchase Quick Entry |
| QuickEntryTypesApi | get_quick_entry_types | GET /quick_entry_types | Returns all Quick Entry Types |
| QuickEntryTypesApi | get_quick_entry_types_key | GET /quick_entry_types/{key} | Returns a Quick Entry Type |
| SalesCorrectiveInvoicesApi | delete_sales_corrective_invoices_key | DELETE /sales_corrective_invoices/{key} | Voids a Sales Corrective Invoice |
| SalesCorrectiveInvoicesApi | get_sales_corrective_invoices | GET /sales_corrective_invoices | Returns all Sales Corrective Invoices |
| SalesCorrectiveInvoicesApi | get_sales_corrective_invoices_key | GET /sales_corrective_invoices/{key} | Returns a Sales Corrective Invoice |
| SalesCorrectiveInvoicesApi | post_sales_corrective_invoices | POST /sales_corrective_invoices | Creates a Sales Corrective Invoice |
| SalesCorrectiveInvoicesApi | put_sales_corrective_invoices_key | PUT /sales_corrective_invoices/{key} | Updates a Sales Corrective Invoice |
| SalesCreditNotesApi | delete_sales_credit_notes_key | DELETE /sales_credit_notes/{key} | Voids a Sales Credit Note |
| SalesCreditNotesApi | get_sales_credit_notes | GET /sales_credit_notes | Returns all Sales Credit Notes |
| SalesCreditNotesApi | get_sales_credit_notes_key | GET /sales_credit_notes/{key} | Returns a Sales Credit Note |
| SalesCreditNotesApi | post_sales_credit_notes | POST /sales_credit_notes | Creates a Sales Credit Note |
| SalesCreditNotesApi | post_sales_credit_notes_key_release | POST /sales_credit_notes/{key}/release | Releases a Sales Credit Note |
| SalesCreditNotesApi | put_sales_credit_notes_key | PUT /sales_credit_notes/{key} | Updates a Sales Credit Note |
| SalesEstimatesApi | delete_sales_estimates_key | DELETE /sales_estimates/{key} | Deletes a Sales Estimate |
| SalesEstimatesApi | get_sales_estimates | GET /sales_estimates | Returns all Sales Estimates |
| SalesEstimatesApi | get_sales_estimates_key | GET /sales_estimates/{key} | Returns a Sales Estimate |
| SalesEstimatesApi | post_sales_estimates | POST /sales_estimates | Creates a Sales Estimate |
| SalesEstimatesApi | put_sales_estimates_key | PUT /sales_estimates/{key} | Updates a Sales Estimate |
| SalesInvoicesApi | delete_sales_invoices_key | DELETE /sales_invoices/{key} | Voids a Sales Invoice |
| SalesInvoicesApi | get_sales_invoices | GET /sales_invoices | Returns all Sales Invoices |
| SalesInvoicesApi | get_sales_invoices_key | GET /sales_invoices/{key} | Returns a Sales Invoice |
| SalesInvoicesApi | post_sales_invoices | POST /sales_invoices | Creates a Sales Invoice |
| SalesInvoicesApi | post_sales_invoices_key_release | POST /sales_invoices/{key}/release | Releases a Sales Invoice |
| SalesInvoicesApi | put_sales_invoices_key | PUT /sales_invoices/{key} | Updates a Sales Invoice |
| SalesQuickEntriesApi | delete_sales_quick_entries_key | DELETE /sales_quick_entries/{key} | Deletes a Sales Quick Entry |
| SalesQuickEntriesApi | get_sales_quick_entries | GET /sales_quick_entries | Returns all Sales Quick Entries |
| SalesQuickEntriesApi | get_sales_quick_entries_key | GET /sales_quick_entries/{key} | Returns a Sales Quick Entry |
| SalesQuickEntriesApi | post_sales_quick_entries | POST /sales_quick_entries | Creates a Sales Quick Entry |
| SalesQuickEntriesApi | put_sales_quick_entries_key | PUT /sales_quick_entries/{key} | Updates a Sales Quick Entry |
| SalesQuotesApi | delete_sales_quotes_key | DELETE /sales_quotes/{key} | Deletes a Sales Quote |
| SalesQuotesApi | get_sales_quotes | GET /sales_quotes | Returns all Sales Quotes |
| SalesQuotesApi | get_sales_quotes_key | GET /sales_quotes/{key} | Returns a Sales Quote |
| SalesQuotesApi | post_sales_quotes | POST /sales_quotes | Creates a Sales Quote |
| SalesQuotesApi | put_sales_quotes_key | PUT /sales_quotes/{key} | Updates a Sales Quote |
| ServiceRateTypesApi | delete_service_rate_types_key | DELETE /service_rate_types/{key} | Deletes a Service Rate Type |
| ServiceRateTypesApi | get_service_rate_types | GET /service_rate_types | Returns all Service Rate Types |
| ServiceRateTypesApi | get_service_rate_types_key | GET /service_rate_types/{key} | Returns a Service Rate Type |
| ServiceRateTypesApi | post_service_rate_types | POST /service_rate_types | Creates a Service Rate Type |
| ServiceRateTypesApi | put_service_rate_types_key | PUT /service_rate_types/{key} | Updates a Service Rate Type |
| ServicesApi | delete_services_key | DELETE /services/{key} | Deletes a Service |
| ServicesApi | get_services | GET /services | Returns all Services |
| ServicesApi | get_services_key | GET /services/{key} | Returns a Service |
| ServicesApi | post_services | POST /services | Creates a Service |
| ServicesApi | put_services_key | PUT /services/{key} | Updates a Service |
| StockItemsApi | delete_stock_items_key | DELETE /stock_items/{key} | Deletes a Stock Item |
| StockItemsApi | get_stock_items | GET /stock_items | Returns all Stock Items |
| StockItemsApi | get_stock_items_key | GET /stock_items/{key} | Returns a Stock Item |
| StockItemsApi | post_stock_items | POST /stock_items | Creates a Stock Item |
| StockItemsApi | put_stock_items_key | PUT /stock_items/{key} | Updates a Stock Item |
| StockMovementsApi | delete_stock_movements_key | DELETE /stock_movements/{key} | Deletes a Stock Movement |
| StockMovementsApi | get_stock_movements | GET /stock_movements | Returns all Stock Movements |
| StockMovementsApi | get_stock_movements_key | GET /stock_movements/{key} | Returns a Stock Movement |
| StockMovementsApi | post_stock_movements | POST /stock_movements | Creates a Stock Movement |
| StockMovementsApi | put_stock_movements_key | PUT /stock_movements/{key} | Updates a Stock Movement |
| TaxOfficesApi | get_tax_offices | GET /tax_offices | Returns all Tax Offices |
| TaxOfficesApi | get_tax_offices_key | GET /tax_offices/{key} | Returns a Tax Office |
| TaxProfilesApi | get_tax_profiles | GET /tax_profiles | Returns all Tax Profiles |
| TaxProfilesApi | get_tax_profiles_key | GET /tax_profiles/{key} | Returns a Tax Profile |
| TaxProfilesApi | put_tax_profiles_key | PUT /tax_profiles/{key} | Updates a Tax Profile |
| TaxRatesApi | delete_tax_rates_key | DELETE /tax_rates/{key} | Deletes a Tax Rate (US only) |
| TaxRatesApi | get_tax_rates | GET /tax_rates | Returns all Tax Rates |
| TaxRatesApi | get_tax_rates_key | GET /tax_rates/{key} | Returns a Tax Rate |
| TaxRatesApi | post_tax_rates | POST /tax_rates | Creates a Tax Rate (US only) |
| TaxRatesApi | put_tax_rates_key | PUT /tax_rates/{key} | Updates a Tax Rate (US only) |
| TaxReturnFrequenciesApi | get_tax_return_frequencies | GET /tax_return_frequencies | Returns all Tax Return Frequencies |
| TaxReturnFrequenciesApi | get_tax_return_frequencies_key | GET /tax_return_frequencies/{key} | Returns a Tax Return Frequency |
| TaxSchemesApi | get_tax_schemes | GET /tax_schemes | Returns all Tax Schemes |
| TaxSchemesApi | get_tax_schemes_key | GET /tax_schemes/{key} | Returns a Tax Scheme |
| TaxTypesApi | get_tax_types | GET /tax_types | Returns all Tax Types |
| TaxTypesApi | get_tax_types_key | GET /tax_types/{key} | Returns a Tax Type |
| TransactionTypesApi | get_transaction_types | GET /transaction_types | Returns all Transaction Types |
| TransactionTypesApi | get_transaction_types_key | GET /transaction_types/{key} | Returns a Transaction Type |
| TransactionsApi | get_transactions | GET /transactions | Returns all Transactions |
| TransactionsApi | get_transactions_key | GET /transactions/{key} | Returns a Transaction |
| UnallocatedArtefactsApi | get_unallocated_artefacts | GET /unallocated_artefacts | Returns all Unallocated Artefacts |
| UnallocatedArtefactsApi | get_unallocated_artefacts_key | GET /unallocated_artefacts/{key} | Returns a Unallocated Artefact |
- Address
- AddressRegion
- AllocatedArtefact
- AllocatedPaymentArtefact
- ArtefactDetailedTaxAnalysis
- ArtefactDetailedTaxAnalysisBreakdown
- ArtefactTaxAnalysis
- Attachment
- BankAccount
- BankAccountContact
- BankAccountDetails
- BankDeposit
- BankOpeningBalance
- BankReconciliation
- BankReconciliationStatus
- BankTransfer
- Base
- BaseJournalLine
- BusinessActivityType
- BusinessExchangeRate
- BusinessSettings
- BusinessType
- CoaAccount
- CoaGroupType
- CoaTemplate
- ComponentTaxRate
- Contact
- ContactAllocation
- ContactCisDeductionRate
- ContactCisSettings
- ContactOpeningBalance
- ContactPayment
- ContactPerson
- ContactPersonType
- ContactTaxTreatment
- DatevSettings
- DefaultLedgerAccounts
- DefaultMessages
- EmailSettings
- EuSalesDescription
- ExchangeRate
- FinancialSettings
- FooterDetails
- GBBoxData
- Generic
- HostedArtefactPaymentSetting
- IEBoxData
- InvoiceSettings
- InvoiceSettingsDocumentHeadings
- InvoiceSettingsLineItemTitles
- Journal
- JournalCode
- JournalCodeType
- JournalLine
- LedgerAccount
- LedgerAccountBalanceDetails
- LedgerAccountOpeningBalance
- LedgerEntry
- LegalFormType
- Link
- LiveExchangeRate
- Migration
- MigrationStatus
- MigrationTaxReturn
- OpeningBalanceJournal
- OtherPayment
- OtherPaymentLineItem
- PaymentAllocation
- PaymentOnAccount
- PostAddresses
- PostAddressesAddress
- PostAttachments
- PostAttachmentsAttachment
- PostBankAccounts
- PostBankAccountsBankAccount
- PostBankAccountsBankAccountBankAccountDetails
- PostBankAccountsBankAccountMainAddress
- PostBankAccountsBankAccountMainContactPerson
- PostBankDeposits
- PostBankDepositsBankDeposit
- PostBankOpeningBalances
- PostBankOpeningBalancesBankOpeningBalance
- PostBankReconciliations
- PostBankReconciliationsBankReconciliation
- PostBankTransfers
- PostBankTransfersBankTransfer
- PostBusinessExchangeRates
- PostBusinessExchangeRatesBusinessExchangeRate
- PostContactAllocations
- PostContactAllocationsContactAllocation
- PostContactAllocationsContactAllocationAllocatedArtefacts
- PostContactOpeningBalances
- PostContactOpeningBalancesContactOpeningBalance
- PostContactPayments
- PostContactPaymentsContactPayment
- PostContactPaymentsContactPaymentAllocatedArtefacts
- PostContactPaymentsContactPaymentPaymentOnAccount
- PostContactPersons
- PostContactPersonsContactPerson
- PostContacts
- PostContactsContact
- PostContactsContactMainContactPerson
- PostContactsContactTaxTreatment
- PostHostedArtefactPaymentSettings
- PostHostedArtefactPaymentSettingsHostedArtefactPaymentSetting
- PostJournalCodes
- PostJournalCodesJournalCode
- PostJournals
- PostJournalsJournal
- PostJournalsJournalJournalCode
- PostJournalsJournalJournalLines
- PostLedgerAccountOpeningBalances
- PostLedgerAccountOpeningBalancesLedgerAccountOpeningBalance
- PostLedgerAccounts
- PostLedgerAccountsLedgerAccount
- PostMigrationTaxReturns
- PostMigrationTaxReturnsMigrationTaxReturn
- PostMigrationTaxReturnsMigrationTaxReturnGb
- PostMigrationTaxReturnsMigrationTaxReturnIe
- PostOpeningBalanceJournals
- PostOpeningBalanceJournalsOpeningBalanceJournal
- PostOpeningBalanceJournalsOpeningBalanceJournalJournalLines
- PostOtherPayments
- PostOtherPaymentsOtherPayment
- PostOtherPaymentsOtherPaymentPaymentLines
- PostProductSalesPriceTypes
- PostProductSalesPriceTypesProductSalesPriceType
- PostProducts
- PostProductsProduct
- PostProductsProductSalesPrices
- PostPurchaseCorrectiveInvoices
- PostPurchaseCorrectiveInvoicesPurchaseCorrectiveInvoice
- PostPurchaseCorrectiveInvoicesPurchaseCorrectiveInvoiceInvoiceLines
- PostPurchaseCorrectiveInvoicesPurchaseCorrectiveInvoiceTaxAnalysis
- PostPurchaseCreditNotes
- PostPurchaseCreditNotesPurchaseCreditNote
- PostPurchaseCreditNotesPurchaseCreditNoteCreditNoteLines
- PostPurchaseInvoices
- PostPurchaseInvoicesPurchaseInvoice
- PostPurchaseInvoicesPurchaseInvoiceInvoiceLines
- PostPurchaseQuickEntries
- PostPurchaseQuickEntriesPurchaseQuickEntry
- PostSalesCorrectiveInvoices
- PostSalesCorrectiveInvoicesSalesCorrectiveInvoice
- PostSalesCorrectiveInvoicesSalesCorrectiveInvoiceInvoiceLines
- PostSalesCorrectiveInvoicesSalesCorrectiveInvoiceMainAddress
- PostSalesCreditNotes
- PostSalesCreditNotesSalesCreditNote
- PostSalesCreditNotesSalesCreditNoteCreditNoteLines
- PostSalesEstimates
- PostSalesEstimatesSalesEstimate
- PostSalesEstimatesSalesEstimateEstimateLines
- PostSalesInvoices
- PostSalesInvoicesSalesInvoice
- PostSalesInvoicesSalesInvoiceRecurringInvoice
- PostSalesQuickEntries
- PostSalesQuickEntriesSalesQuickEntry
- PostSalesQuotes
- PostSalesQuotesSalesQuote
- PostServiceRateTypes
- PostServiceRateTypesServiceRateType
- PostServices
- PostServicesService
- PostServicesServiceSalesRates
- PostStockItems
- PostStockItemsStockItem
- PostStockMovements
- PostStockMovementsStockMovement
- PostTaxRates
- PostTaxRatesTaxRate
- PostTaxRatesTaxRateComponentTaxRate
- PrintContactDetails
- PrintStatements
- Product
- ProductSalesPriceType
- ProfitAnalysis
- ProfitBreakdown
- PurchaseCorrectiveInvoice
- PurchaseCreditNote
- PurchaseCreditNoteLineItem
- PurchaseInvoice
- PurchaseInvoiceLineItem
- PurchaseQuickEntry
- PutAddresses
- PutAddressesAddress
- PutAttachments
- PutAttachmentsAttachment
- PutBankAccounts
- PutBankAccountsBankAccount
- PutBankAccountsBankAccountBankAccountDetails
- PutBankOpeningBalances
- PutBankOpeningBalancesBankOpeningBalance
- PutBankReconciliations
- PutBankReconciliationsBankReconciliation
- PutBankTransfers
- PutBankTransfersBankTransfer
- PutBusinessExchangeRates
- PutBusinessExchangeRatesBusinessExchangeRate
- PutBusinessSettings
- PutBusinessSettingsBusinessSettings
- PutBusinessSettingsBusinessSettingsDefaultLedgerAccounts
- PutContactAllocations
- PutContactAllocationsContactAllocation
- PutContactOpeningBalances
- PutContactOpeningBalancesContactOpeningBalance
- PutContactPayments
- PutContactPaymentsContactPayment
- PutContactPersons
- PutContactPersonsContactPerson
- PutContacts
- PutContactsContact
- PutDatevSettings
- PutDatevSettingsDatevSettings
- PutEmailSettings
- PutEmailSettingsEmailSettings
- PutEmailSettingsEmailSettingsDefaultMessages
- PutFinancialSettings
- PutFinancialSettingsFinancialSettings
- PutInvoiceSettings
- PutInvoiceSettingsInvoiceSettings
- PutInvoiceSettingsInvoiceSettingsDocumentHeadings
- PutInvoiceSettingsInvoiceSettingsFooterDetails
- PutInvoiceSettingsInvoiceSettingsLineItemTitles
- PutInvoiceSettingsInvoiceSettingsPrintContactDetails
- PutInvoiceSettingsInvoiceSettingsPrintStatements
- PutJournalCodes
- PutJournalCodesJournalCode
- PutLedgerAccountOpeningBalances
- PutLedgerAccountOpeningBalancesLedgerAccountOpeningBalance
- PutLedgerAccounts
- PutLedgerAccountsLedgerAccount
- PutMigrations
- PutMigrationsMigrations
- PutOtherPayments
- PutOtherPaymentsOtherPayment
- PutOtherPaymentsOtherPaymentPaymentLines
- PutProductSalesPriceTypes
- PutProductSalesPriceTypesProductSalesPriceType
- PutProducts
- PutProductsProduct
- PutPurchaseCorrectiveInvoices
- PutPurchaseCreditNotes
- PutPurchaseCreditNotesPurchaseCreditNote
- PutPurchaseCreditNotesPurchaseCreditNoteCreditNoteLines
- PutPurchaseInvoices
- PutPurchaseInvoicesPurchaseInvoice
- PutPurchaseInvoicesPurchaseInvoiceInvoiceLines
- PutPurchaseQuickEntries
- PutPurchaseQuickEntriesPurchaseQuickEntry
- PutSalesCorrectiveInvoices
- PutSalesCreditNotes
- PutSalesCreditNotesSalesCreditNote
- PutSalesCreditNotesSalesCreditNoteCreditNoteLines
- PutSalesEstimates
- PutSalesEstimatesSalesEstimate
- PutSalesEstimatesSalesEstimateEstimateLines
- PutSalesInvoices
- PutSalesInvoicesSalesInvoice
- PutSalesQuickEntries
- PutSalesQuickEntriesSalesQuickEntry
- PutSalesQuotes
- PutSalesQuotesSalesQuote
- PutServiceRateTypes
- PutServiceRateTypesServiceRateType
- PutServices
- PutServicesService
- PutStockItems
- PutStockItemsStockItem
- PutStockMovements
- PutStockMovementsStockMovement
- PutTaxProfiles
- PutTaxProfilesTaxProfile
- PutTaxProfilesTaxProfileAddressRegion
- PutTaxRates
- PutTaxRatesTaxRate
- QuickEntry
- QuoteStatus
- Rate
- RecurringSalesInvoice
- SalesArtefactAddress
- SalesCorrectiveInvoice
- SalesCreditNote
- SalesCreditNoteLineItem
- SalesEstimate
- SalesInvoice
- SalesInvoiceLineItem
- SalesInvoiceQuoteEstimate
- SalesPrice
- SalesQuote
- SalesQuoteLineItem
- Service
- ServiceRateType
- StockItem
- StockMovement
- TaxBreakdown
- TaxOffice
- TaxProfile
- TaxRate
- TaxRatePercentage
- TaxScheme
- TaxType
- Transaction
- TransactionOrigin
- UnallocatedArtefact
All endpoints do not require authorization.