Documentation of the Sage Business Cloud Accounting API.
For more information, please visit mailto:[email protected].
PHP 8.1 and later.
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/synergitech/sage-php.git"
}
],
"require": {
"synergitech/sage-php": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
<?php
require_once('/path/to/Sage-PHP/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SynergiTech\Sage\Api\AddressRegionsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$itemsPerPage = 20; // int | Returns the given number of States per request.
$page = 1; // int | Go to specific page of States
$attributes = 'attributes_example'; // string | 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)
$countryId = 'countryId_example'; // string | Use this to filter by country id
try {
$result = $apiInstance->getAddressRegions($itemsPerPage, $page, $attributes, $countryId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressRegionsApi->getAddressRegions: ', $e->getMessage(), PHP_EOL;
}
All URIs are relative to https://api.accounting.sage.com/v3.1
Class | Method | HTTP request | Description |
---|---|---|---|
AddressRegionsApi | getAddressRegions | GET /address_regions | Returns all Address Regions |
AddressRegionsApi | getAddressRegionsKey | GET /address_regions/{key} | Returns a Address Region |
AddressTypesApi | getAddressTypes | GET /address_types | Returns all Address Types |
AddressTypesApi | getAddressTypesKey | GET /address_types/{key} | Returns a Address Type |
AddressesApi | deleteAddressesKey | DELETE /addresses/{key} | Deletes a Address |
AddressesApi | getAddresses | GET /addresses | Returns all Addresses |
AddressesApi | getAddressesKey | GET /addresses/{key} | Returns a Address |
AddressesApi | postAddresses | POST /addresses | Creates a Address |
AddressesApi | putAddressesKey | PUT /addresses/{key} | Updates a Address |
AnalysisTypeCategoriesApi | deleteAnalysisTypeCategoriesKey | DELETE /analysis_type_categories/{key} | Deletes a Analysis Type Category |
AnalysisTypeCategoriesApi | getAnalysisTypeCategories | GET /analysis_type_categories | Returns all Analysis Type Categories |
AnalysisTypeCategoriesApi | getAnalysisTypeCategoriesKey | GET /analysis_type_categories/{key} | Returns a Analysis Type Category |
AnalysisTypeCategoriesApi | postAnalysisTypeCategories | POST /analysis_type_categories | Creates a Analysis Type Category |
AnalysisTypeCategoriesApi | putAnalysisTypeCategoriesKey | PUT /analysis_type_categories/{key} | Updates a Analysis Type Category |
AnalysisTypesApi | getAnalysisTypes | GET /analysis_types | Returns all Analysis Types |
AnalysisTypesApi | getAnalysisTypesKey | GET /analysis_types/{key} | Returns a Analysis Type |
AnalysisTypesApi | putAnalysisTypesKey | PUT /analysis_types/{key} | Updates a Analysis Type |
ArtefactStatusesApi | getArtefactStatuses | GET /artefact_statuses | Returns all Artefact Statuses |
ArtefactStatusesApi | getArtefactStatusesKey | GET /artefact_statuses/{key} | Returns a Artefact Status |
AttachmentContextTypesApi | getAttachmentContextTypes | GET /attachment_context_types | Returns all Attachment Context Types |
AttachmentContextTypesApi | getAttachmentContextTypesKey | GET /attachment_context_types/{key} | Returns a Attachment Context Type |
AttachmentsApi | deleteAttachmentsKey | DELETE /attachments/{key} | Deletes a Attachment |
AttachmentsApi | getAttachments | GET /attachments | Returns all Attachments |
AttachmentsApi | getAttachmentsKey | GET /attachments/{key} | Returns a Attachment |
AttachmentsApi | getAttachmentsKeyFile | GET /attachments/{key}/file | Returns an Attachment File |
AttachmentsApi | postAttachments | POST /attachments | Creates a Attachment |
AttachmentsApi | putAttachmentsKey | PUT /attachments/{key} | Updates a Attachment |
BankAccountTypesApi | getBankAccountTypes | GET /bank_account_types | Returns all Bank Account Types |
BankAccountTypesApi | getBankAccountTypesKey | GET /bank_account_types/{key} | Returns a Bank Account Type |
BankAccountsApi | deleteBankAccountsKey | DELETE /bank_accounts/{key} | Deletes a Bank Account |
BankAccountsApi | getBankAccounts | GET /bank_accounts | Returns all Bank Accounts |
BankAccountsApi | getBankAccountsKey | GET /bank_accounts/{key} | Returns a Bank Account |
BankAccountsApi | getBankAccountsKeyBankFeed | GET /bank_accounts/{key}/bank_feed | Bank feed endpoint for Banking Cloud Bank accounts |
BankAccountsApi | postBankAccounts | POST /bank_accounts | Creates a Bank Account |
BankAccountsApi | putBankAccountsKey | PUT /bank_accounts/{key} | Updates a Bank Account |
BankDepositsApi | deleteBankDepositsKey | DELETE /bank_deposits/{key} | Deletes a Bank Deposit |
BankDepositsApi | getBankDeposits | GET /bank_deposits | Returns all Bank Deposits |
BankDepositsApi | getBankDepositsKey | GET /bank_deposits/{key} | Returns a Bank Deposit |
BankDepositsApi | postBankDeposits | POST /bank_deposits | Creates a Bank Deposit |
BankOpeningBalancesApi | deleteBankOpeningBalancesKey | DELETE /bank_opening_balances/{key} | Deletes a Bank Opening Balance |
BankOpeningBalancesApi | getBankOpeningBalances | GET /bank_opening_balances | Returns all Bank Opening Balances |
BankOpeningBalancesApi | getBankOpeningBalancesKey | GET /bank_opening_balances/{key} | Returns a Bank Opening Balance |
BankOpeningBalancesApi | postBankOpeningBalances | POST /bank_opening_balances | Creates a Bank Opening Balance |
BankOpeningBalancesApi | putBankOpeningBalancesKey | PUT /bank_opening_balances/{key} | Updates a Bank Opening Balance |
BankReconciliationsApi | getBankReconciliations | GET /bank_reconciliations | Returns all Bank Reconciliations |
BankReconciliationsApi | getBankReconciliationsKey | GET /bank_reconciliations/{key} | Returns a Bank Reconciliation |
BankReconciliationsApi | postBankReconciliations | POST /bank_reconciliations | Creates a Bank Reconciliation |
BankReconciliationsApi | putBankReconciliationsKey | PUT /bank_reconciliations/{key} | Updates a Bank Reconciliation |
BankTransfersApi | deleteBankTransfersKey | DELETE /bank_transfers/{key} | Deletes a Bank Transfer |
BankTransfersApi | getBankTransfers | GET /bank_transfers | Returns all Bank Transfers |
BankTransfersApi | getBankTransfersKey | GET /bank_transfers/{key} | Returns a Bank Transfer |
BankTransfersApi | postBankTransfers | POST /bank_transfers | Creates a Bank Transfer |
BankTransfersApi | putBankTransfersKey | PUT /bank_transfers/{key} | Updates a Bank Transfer |
BusinessActivityTypesApi | getBusinessActivityTypes | GET /business_activity_types | Returns all Business Activity Types |
BusinessActivityTypesApi | getBusinessActivityTypesKey | GET /business_activity_types/{key} | Returns a Business Activity Type |
BusinessExchangeRatesApi | deleteBusinessExchangeRatesKey | DELETE /business_exchange_rates/{key} | Deletes a Business Exchange Rate |
BusinessExchangeRatesApi | getBusinessExchangeRates | GET /business_exchange_rates | Returns all Business Exchange Rates |
BusinessExchangeRatesApi | getBusinessExchangeRatesKey | GET /business_exchange_rates/{key} | Returns a Business Exchange Rate |
BusinessExchangeRatesApi | postBusinessExchangeRates | POST /business_exchange_rates | Creates a Business Exchange Rate |
BusinessExchangeRatesApi | putBusinessExchangeRatesKey | PUT /business_exchange_rates/{key} | Updates a Business Exchange Rate |
BusinessSettingsApi | getBusinessSettings | GET /business_settings | Returns all Business Settings |
BusinessSettingsApi | putBusinessSettings | PUT /business_settings | Updates a Business Settings |
BusinessTypesApi | getBusinessTypes | GET /business_types | Returns all Business Types |
BusinessTypesApi | getBusinessTypesKey | GET /business_types/{key} | Returns a Business Type |
CatalogItemTypesApi | getCatalogItemTypes | GET /catalog_item_types | Returns all Catalog Item Types |
CatalogItemTypesApi | getCatalogItemTypesKey | GET /catalog_item_types/{key} | Returns a Catalog Item Type |
CisSettingsApi | getCisSettings | GET /cis_settings | Returns all Cis Settings |
CisSettingsApi | putCisSettings | PUT /cis_settings | Updates a Cis Settings |
CoaAccountsApi | getCoaAccounts | GET /coa_accounts | Returns all Coa Accounts |
CoaAccountsApi | getCoaAccountsKey | GET /coa_accounts/{key} | Returns a Coa Account |
CoaTemplatesApi | getCoaTemplates | GET /coa_templates | Returns all Coa Templates |
CoaTemplatesApi | getCoaTemplatesKey | GET /coa_templates/{key} | Returns a Coa Template |
ContactAllocationsApi | deleteContactAllocationsKey | DELETE /contact_allocations/{key} | Deletes a Contact Allocation |
ContactAllocationsApi | getContactAllocations | GET /contact_allocations | Returns all Contact Allocations |
ContactAllocationsApi | getContactAllocationsKey | GET /contact_allocations/{key} | Returns a Contact Allocation |
ContactAllocationsApi | postContactAllocations | POST /contact_allocations | Creates a Contact Allocation |
ContactAllocationsApi | putContactAllocationsKey | PUT /contact_allocations/{key} | Updates a Contact Allocation |
ContactOpeningBalanceTypesApi | getContactOpeningBalanceTypes | GET /contact_opening_balance_types | Returns all Contact Opening Balance Types |
ContactOpeningBalanceTypesApi | getContactOpeningBalanceTypesKey | GET /contact_opening_balance_types/{key} | Returns a Contact Opening Balance Type |
ContactOpeningBalancesApi | deleteContactOpeningBalancesKey | DELETE /contact_opening_balances/{key} | Deletes a Contact Opening Balance |
ContactOpeningBalancesApi | getContactOpeningBalances | GET /contact_opening_balances | Returns all Contact Opening Balances |
ContactOpeningBalancesApi | getContactOpeningBalancesKey | GET /contact_opening_balances/{key} | Returns a Contact Opening Balance |
ContactOpeningBalancesApi | postContactOpeningBalances | POST /contact_opening_balances | Creates a Contact Opening Balance |
ContactOpeningBalancesApi | putContactOpeningBalancesKey | PUT /contact_opening_balances/{key} | Updates a Contact Opening Balance |
ContactPaymentsApi | deleteContactPaymentsKey | DELETE /contact_payments/{key} | Deletes a Contact Payment |
ContactPaymentsApi | getContactPayments | GET /contact_payments | Returns all Contact Payments |
ContactPaymentsApi | getContactPaymentsKey | GET /contact_payments/{key} | Returns a Contact Payment |
ContactPaymentsApi | postContactPayments | POST /contact_payments | Creates a Contact Payment |
ContactPaymentsApi | putContactPaymentsKey | PUT /contact_payments/{key} | Updates a Contact Payment |
ContactPeopleApi | deleteContactPersonsKey | DELETE /contact_persons/{key} | Deletes a Contact Person |
ContactPeopleApi | getContactPersons | GET /contact_persons | Returns all Contact People |
ContactPeopleApi | getContactPersonsKey | GET /contact_persons/{key} | Returns a Contact Person |
ContactPeopleApi | postContactPersons | POST /contact_persons | Creates a Contact Person |
ContactPeopleApi | putContactPersonsKey | PUT /contact_persons/{key} | Updates a Contact Person |
ContactPersonTypesApi | getContactPersonTypes | GET /contact_person_types | Returns all Contact Person Types |
ContactPersonTypesApi | getContactPersonTypesKey | GET /contact_person_types/{key} | Returns a Contact Person Type |
ContactTypesApi | getContactTypes | GET /contact_types | Returns all Contact Types |
ContactTypesApi | getContactTypesKey | GET /contact_types/{key} | Returns a Contact Type |
ContactsApi | deleteContactsKey | DELETE /contacts/{key} | Deletes a Contact |
ContactsApi | getContacts | GET /contacts | Returns all Contacts |
ContactsApi | getContactsKey | GET /contacts/{key} | Returns a Contact |
ContactsApi | postContacts | POST /contacts | Creates a Contact |
ContactsApi | putContactsKey | PUT /contacts/{key} | Updates a Contact |
CorrectiveReasonCodesApi | getCorrectiveReasonCodes | GET /corrective_reason_codes | Returns all Corrective Reason Codes |
CorrectiveReasonCodesApi | getCorrectiveReasonCodesKey | GET /corrective_reason_codes/{key} | Returns a Corrective Reason Code |
CountriesApi | getCountries | GET /countries | Returns all Countries |
CountriesApi | getCountriesKey | GET /countries/{key} | Returns a Country |
CountryGroupsApi | getCountryGroups | GET /country_groups | Returns all Country Groups |
CountryGroupsApi | getCountryGroupsKey | GET /country_groups/{key} | Returns a Country Group |
CountryOfRegistrationsApi | getCountriesOfRegistration | GET /countries_of_registration | Returns all Country Of Registrations |
CountryOfRegistrationsApi | getCountriesOfRegistrationKey | GET /countries_of_registration/{key} | Returns a Country Of Registration |
CurrenciesApi | getCurrencies | GET /currencies | Returns all Currencies |
CurrenciesApi | getCurrenciesKey | GET /currencies/{key} | Returns a Currency |
DatevSettingsApi | getDatevSettings | GET /datev_settings | Returns all Datev Settings |
DatevSettingsApi | putDatevSettings | PUT /datev_settings | Updates a Datev Settings |
EUGoodsServicesTypesApi | getEuGoodsServicesTypes | GET /eu_goods_services_types | Returns all EU Goods Services Types |
EUGoodsServicesTypesApi | getEuGoodsServicesTypesKey | GET /eu_goods_services_types/{key} | Returns a EU Goods Services Type |
EUSalesDescriptionsApi | getEuSalesDescriptions | GET /eu_sales_descriptions | Returns all EU Sales Descriptions |
EUSalesDescriptionsApi | getEuSalesDescriptionsKey | GET /eu_sales_descriptions/{key} | Returns a EU Sales Description |
EmailSettingsApi | getEmailSettings | GET /email_settings | Returns all Email Settings |
EmailSettingsApi | putEmailSettings | PUT /email_settings | Updates a Email Settings |
ExchangeRatesApi | getExchangeRates | GET /exchange_rates | Returns all Exchange Rates |
ExchangeRatesApi | getExchangeRatesKey | GET /exchange_rates/{key} | Returns a Exchange Rate |
FinancialSettingsApi | getFinancialSettings | GET /financial_settings | Returns all Financial Settings |
FinancialSettingsApi | putFinancialSettings | PUT /financial_settings | Updates a Financial Settings |
HostedArtefactPaymentSettingsApi | deleteHostedArtefactPaymentSettingsKey | DELETE /hosted_artefact_payment_settings/{key} | Deletes a Hosted Artefact Payment Setting |
HostedArtefactPaymentSettingsApi | getHostedArtefactPaymentSettings | GET /hosted_artefact_payment_settings | Returns all Hosted Artefact Payment Settings |
HostedArtefactPaymentSettingsApi | getHostedArtefactPaymentSettingsKey | GET /hosted_artefact_payment_settings/{key} | Returns a Hosted Artefact Payment Setting |
HostedArtefactPaymentSettingsApi | postHostedArtefactPaymentSettings | POST /hosted_artefact_payment_settings | Creates a Hosted Artefact Payment Setting |
InvoiceSettingsApi | getInvoiceSettings | GET /invoice_settings | Returns all Invoice Settings |
InvoiceSettingsApi | putInvoiceSettings | PUT /invoice_settings | Updates a Invoice Settings |
JournalCodeTypesApi | getJournalCodeTypes | GET /journal_code_types | Returns all Journal Code Types |
JournalCodeTypesApi | getJournalCodeTypesKey | GET /journal_code_types/{key} | Returns a Journal Code Type |
JournalCodesApi | deleteJournalCodesKey | DELETE /journal_codes/{key} | Deletes a Journal Code |
JournalCodesApi | getJournalCodes | GET /journal_codes | Returns all Journal Codes |
JournalCodesApi | getJournalCodesKey | GET /journal_codes/{key} | Returns a Journal Code |
JournalCodesApi | postJournalCodes | POST /journal_codes | Creates a Journal Code |
JournalCodesApi | putJournalCodesKey | PUT /journal_codes/{key} | Updates a Journal Code |
JournalsApi | deleteJournalsKey | DELETE /journals/{key} | Deletes a Journal |
JournalsApi | getJournals | GET /journals | Returns all Journals |
JournalsApi | getJournalsKey | GET /journals/{key} | Returns a Journal |
JournalsApi | postJournals | POST /journals | Creates a Journal |
JournalsApi | postJournalsKeyReissue | POST /journals/{key}/reissue | Reissues an existing Journal by voiding the existing one and creating a new one |
LedgerAccountClassificationsApi | getLedgerAccountClassifications | GET /ledger_account_classifications | Returns all Ledger Account Classifications |
LedgerAccountClassificationsApi | getLedgerAccountClassificationsKey | GET /ledger_account_classifications/{key} | Returns a Ledger Account Classification |
LedgerAccountOpeningBalancesApi | deleteLedgerAccountOpeningBalancesKey | DELETE /ledger_account_opening_balances/{key} | Deletes a Ledger Account Opening Balance |
LedgerAccountOpeningBalancesApi | getLedgerAccountOpeningBalances | GET /ledger_account_opening_balances | Returns all Ledger Account Opening Balances |
LedgerAccountOpeningBalancesApi | getLedgerAccountOpeningBalancesKey | GET /ledger_account_opening_balances/{key} | Returns a Ledger Account Opening Balance |
LedgerAccountOpeningBalancesApi | postLedgerAccountOpeningBalances | POST /ledger_account_opening_balances | Creates a Ledger Account Opening Balance |
LedgerAccountOpeningBalancesApi | putLedgerAccountOpeningBalancesKey | PUT /ledger_account_opening_balances/{key} | Updates a Ledger Account Opening Balance |
LedgerAccountTypesApi | getLedgerAccountTypes | GET /ledger_account_types | Returns all Ledger Account Types |
LedgerAccountTypesApi | getLedgerAccountTypesKey | GET /ledger_account_types/{key} | Returns a Ledger Account Type |
LedgerAccountsApi | getLedgerAccounts | GET /ledger_accounts | Returns all Ledger Accounts |
LedgerAccountsApi | getLedgerAccountsKey | GET /ledger_accounts/{key} | Returns a Ledger Account |
LedgerAccountsApi | postLedgerAccounts | POST /ledger_accounts | Creates a Ledger Account |
LedgerAccountsApi | putLedgerAccountsKey | PUT /ledger_accounts/{key} | Updates a Ledger Account |
LedgerEntriesApi | getLedgerEntries | GET /ledger_entries | Returns all Ledger Entries |
LedgerEntriesApi | getLedgerEntriesKey | GET /ledger_entries/{key} | Returns a Ledger Entry |
LegalFormTypesApi | getLegalFormTypes | GET /legal_form_types | Returns all Legal Form Types |
LegalFormTypesApi | getLegalFormTypesKey | GET /legal_form_types/{key} | Returns a Legal Form Type |
LiveExchangeRatesApi | getLiveExchangeRates | GET /live_exchange_rates | Returns all Live Exchange Rates |
LiveExchangeRatesApi | getLiveExchangeRatesKey | GET /live_exchange_rates/{key} | Returns a Live Exchange Rate |
MigrationTaxReturnsApi | getMigrationTaxReturns | GET /migration_tax_returns | Returns all Migration Tax Returns |
MigrationTaxReturnsApi | getMigrationTaxReturnsKey | GET /migration_tax_returns/{key} | Returns a Migration Tax Return |
MigrationTaxReturnsApi | postMigrationTaxReturns | POST /migration_tax_returns | Creates a Migration Tax Return |
MigrationsApi | getMigrations | GET /migrations | Returns all Migrations |
MigrationsApi | putMigrations | PUT /migrations | Updates a Migrations |
OpeningBalanceJournalsApi | deleteOpeningBalanceJournalsKey | DELETE /opening_balance_journals/{key} | Deletes a Opening Balance Journal |
OpeningBalanceJournalsApi | getOpeningBalanceJournals | GET /opening_balance_journals | Returns all Opening Balance Journals |
OpeningBalanceJournalsApi | getOpeningBalanceJournalsKey | GET /opening_balance_journals/{key} | Returns a Opening Balance Journal |
OpeningBalanceJournalsApi | postOpeningBalanceJournals | POST /opening_balance_journals | Creates a Opening Balance Journal |
OtherPaymentsApi | deleteOtherPaymentsKey | DELETE /other_payments/{key} | Deletes a Other Payment |
OtherPaymentsApi | getOtherPayments | GET /other_payments | Returns all Other Payments |
OtherPaymentsApi | getOtherPaymentsKey | GET /other_payments/{key} | Returns a Other Payment |
OtherPaymentsApi | postOtherPayments | POST /other_payments | Creates a Other Payment |
OtherPaymentsApi | putOtherPaymentsKey | PUT /other_payments/{key} | Updates a Other Payment |
PaymentMethodsApi | getPaymentMethods | GET /payment_methods | Returns all Payment Methods |
PaymentMethodsApi | getPaymentMethodsKey | GET /payment_methods/{key} | Returns a Payment Method |
ProductSalesPriceTypesApi | deleteProductSalesPriceTypesKey | DELETE /product_sales_price_types/{key} | Deletes a Product Sales Price Type |
ProductSalesPriceTypesApi | getProductSalesPriceTypes | GET /product_sales_price_types | Returns all Product Sales Price Types |
ProductSalesPriceTypesApi | getProductSalesPriceTypesKey | GET /product_sales_price_types/{key} | Returns a Product Sales Price Type |
ProductSalesPriceTypesApi | postProductSalesPriceTypes | POST /product_sales_price_types | Creates a Product Sales Price Type |
ProductSalesPriceTypesApi | putProductSalesPriceTypesKey | PUT /product_sales_price_types/{key} | Updates a Product Sales Price Type |
ProductsApi | deleteProductsKey | DELETE /products/{key} | Deletes a Product |
ProductsApi | getProducts | GET /products | Returns all Products |
ProductsApi | getProductsKey | GET /products/{key} | Returns a Product |
ProductsApi | postProducts | POST /products | Creates a Product |
ProductsApi | putProductsKey | PUT /products/{key} | Updates a Product |
PurchaseCorrectiveInvoicesApi | deletePurchaseCorrectiveInvoicesKey | DELETE /purchase_corrective_invoices/{key} | Deletes a Purchase Corrective Invoice |
PurchaseCorrectiveInvoicesApi | getPurchaseCorrectiveInvoices | GET /purchase_corrective_invoices | Returns all Purchase Corrective Invoices |
PurchaseCorrectiveInvoicesApi | getPurchaseCorrectiveInvoicesKey | GET /purchase_corrective_invoices/{key} | Returns a Purchase Corrective Invoice |
PurchaseCorrectiveInvoicesApi | postPurchaseCorrectiveInvoices | POST /purchase_corrective_invoices | Creates a Purchase Corrective Invoice |
PurchaseCorrectiveInvoicesApi | putPurchaseCorrectiveInvoicesKey | PUT /purchase_corrective_invoices/{key} | Updates a Purchase Corrective Invoice |
PurchaseCreditNotesApi | deletePurchaseCreditNotesKey | DELETE /purchase_credit_notes/{key} | Deletes a Purchase Credit Note |
PurchaseCreditNotesApi | getPurchaseCreditNotes | GET /purchase_credit_notes | Returns all Purchase Credit Notes |
PurchaseCreditNotesApi | getPurchaseCreditNotesKey | GET /purchase_credit_notes/{key} | Returns a Purchase Credit Note |
PurchaseCreditNotesApi | postPurchaseCreditNotes | POST /purchase_credit_notes | Creates a Purchase Credit Note |
PurchaseCreditNotesApi | postPurchaseCreditNotesKeyRelease | POST /purchase_credit_notes/{key}/release | Releases a Purchase Credit Note |
PurchaseCreditNotesApi | putPurchaseCreditNotesKey | PUT /purchase_credit_notes/{key} | Updates a Purchase Credit Note |
PurchaseInvoicesApi | deletePurchaseInvoicesKey | DELETE /purchase_invoices/{key} | Deletes a Purchase Invoice |
PurchaseInvoicesApi | getPurchaseInvoices | GET /purchase_invoices | Returns all Purchase Invoices |
PurchaseInvoicesApi | getPurchaseInvoicesKey | GET /purchase_invoices/{key} | Returns a Purchase Invoice |
PurchaseInvoicesApi | postPurchaseInvoices | POST /purchase_invoices | Creates a Purchase Invoice |
PurchaseInvoicesApi | postPurchaseInvoicesKeyRelease | POST /purchase_invoices/{key}/release | Releases a Purchase Invoice |
PurchaseInvoicesApi | putPurchaseInvoicesKey | PUT /purchase_invoices/{key} | Updates a Purchase Invoice |
PurchaseQuickEntriesApi | deletePurchaseQuickEntriesKey | DELETE /purchase_quick_entries/{key} | Deletes a Purchase Quick Entry |
PurchaseQuickEntriesApi | getPurchaseQuickEntries | GET /purchase_quick_entries | Returns all Purchase Quick Entries |
PurchaseQuickEntriesApi | getPurchaseQuickEntriesKey | GET /purchase_quick_entries/{key} | Returns a Purchase Quick Entry |
PurchaseQuickEntriesApi | postPurchaseQuickEntries | POST /purchase_quick_entries | Creates a Purchase Quick Entry |
PurchaseQuickEntriesApi | putPurchaseQuickEntriesKey | PUT /purchase_quick_entries/{key} | Updates a Purchase Quick Entry |
QuickEntryTypesApi | getQuickEntryTypes | GET /quick_entry_types | Returns all Quick Entry Types |
QuickEntryTypesApi | getQuickEntryTypesKey | GET /quick_entry_types/{key} | Returns a Quick Entry Type |
SalesCorrectiveInvoicesApi | deleteSalesCorrectiveInvoicesKey | DELETE /sales_corrective_invoices/{key} | Voids a Sales Corrective Invoice |
SalesCorrectiveInvoicesApi | getSalesCorrectiveInvoices | GET /sales_corrective_invoices | Returns all Sales Corrective Invoices |
SalesCorrectiveInvoicesApi | getSalesCorrectiveInvoicesKey | GET /sales_corrective_invoices/{key} | Returns a Sales Corrective Invoice |
SalesCorrectiveInvoicesApi | postSalesCorrectiveInvoices | POST /sales_corrective_invoices | Creates a Sales Corrective Invoice |
SalesCorrectiveInvoicesApi | putSalesCorrectiveInvoicesKey | PUT /sales_corrective_invoices/{key} | Updates a Sales Corrective Invoice |
SalesCreditNotesApi | deleteSalesCreditNotesKey | DELETE /sales_credit_notes/{key} | Voids a Sales Credit Note |
SalesCreditNotesApi | getSalesCreditNotes | GET /sales_credit_notes | Returns all Sales Credit Notes |
SalesCreditNotesApi | getSalesCreditNotesKey | GET /sales_credit_notes/{key} | Returns a Sales Credit Note |
SalesCreditNotesApi | postSalesCreditNotes | POST /sales_credit_notes | Creates a Sales Credit Note |
SalesCreditNotesApi | postSalesCreditNotesKeyRelease | POST /sales_credit_notes/{key}/release | Releases a Sales Credit Note |
SalesCreditNotesApi | putSalesCreditNotesKey | PUT /sales_credit_notes/{key} | Updates a Sales Credit Note |
SalesEstimatesApi | deleteSalesEstimatesKey | DELETE /sales_estimates/{key} | Deletes a Sales Estimate |
SalesEstimatesApi | getSalesEstimates | GET /sales_estimates | Returns all Sales Estimates |
SalesEstimatesApi | getSalesEstimatesKey | GET /sales_estimates/{key} | Returns a Sales Estimate |
SalesEstimatesApi | postSalesEstimates | POST /sales_estimates | Creates a Sales Estimate |
SalesEstimatesApi | putSalesEstimatesKey | PUT /sales_estimates/{key} | Updates a Sales Estimate |
SalesInvoicesApi | deleteSalesInvoicesKey | DELETE /sales_invoices/{key} | Voids a Sales Invoice |
SalesInvoicesApi | getSalesInvoices | GET /sales_invoices | Returns all Sales Invoices |
SalesInvoicesApi | getSalesInvoicesKey | GET /sales_invoices/{key} | Returns a Sales Invoice |
SalesInvoicesApi | postSalesInvoices | POST /sales_invoices | Creates a Sales Invoice |
SalesInvoicesApi | postSalesInvoicesKeyRelease | POST /sales_invoices/{key}/release | Releases a Sales Invoice |
SalesInvoicesApi | putSalesInvoicesKey | PUT /sales_invoices/{key} | Updates a Sales Invoice |
SalesQuickEntriesApi | deleteSalesQuickEntriesKey | DELETE /sales_quick_entries/{key} | Deletes a Sales Quick Entry |
SalesQuickEntriesApi | getSalesQuickEntries | GET /sales_quick_entries | Returns all Sales Quick Entries |
SalesQuickEntriesApi | getSalesQuickEntriesKey | GET /sales_quick_entries/{key} | Returns a Sales Quick Entry |
SalesQuickEntriesApi | postSalesQuickEntries | POST /sales_quick_entries | Creates a Sales Quick Entry |
SalesQuickEntriesApi | putSalesQuickEntriesKey | PUT /sales_quick_entries/{key} | Updates a Sales Quick Entry |
SalesQuotesApi | deleteSalesQuotesKey | DELETE /sales_quotes/{key} | Deletes a Sales Quote |
SalesQuotesApi | getSalesQuotes | GET /sales_quotes | Returns all Sales Quotes |
SalesQuotesApi | getSalesQuotesKey | GET /sales_quotes/{key} | Returns a Sales Quote |
SalesQuotesApi | postSalesQuotes | POST /sales_quotes | Creates a Sales Quote |
SalesQuotesApi | putSalesQuotesKey | PUT /sales_quotes/{key} | Updates a Sales Quote |
ServiceRateTypesApi | deleteServiceRateTypesKey | DELETE /service_rate_types/{key} | Deletes a Service Rate Type |
ServiceRateTypesApi | getServiceRateTypes | GET /service_rate_types | Returns all Service Rate Types |
ServiceRateTypesApi | getServiceRateTypesKey | GET /service_rate_types/{key} | Returns a Service Rate Type |
ServiceRateTypesApi | postServiceRateTypes | POST /service_rate_types | Creates a Service Rate Type |
ServiceRateTypesApi | putServiceRateTypesKey | PUT /service_rate_types/{key} | Updates a Service Rate Type |
ServicesApi | deleteServicesKey | DELETE /services/{key} | Deletes a Service |
ServicesApi | getServices | GET /services | Returns all Services |
ServicesApi | getServicesKey | GET /services/{key} | Returns a Service |
ServicesApi | postServices | POST /services | Creates a Service |
ServicesApi | putServicesKey | PUT /services/{key} | Updates a Service |
StockItemsApi | deleteStockItemsKey | DELETE /stock_items/{key} | Deletes a Stock Item |
StockItemsApi | getStockItems | GET /stock_items | Returns all Stock Items |
StockItemsApi | getStockItemsKey | GET /stock_items/{key} | Returns a Stock Item |
StockItemsApi | postStockItems | POST /stock_items | Creates a Stock Item |
StockItemsApi | putStockItemsKey | PUT /stock_items/{key} | Updates a Stock Item |
StockMovementsApi | deleteStockMovementsKey | DELETE /stock_movements/{key} | Deletes a Stock Movement |
StockMovementsApi | getStockMovements | GET /stock_movements | Returns all Stock Movements |
StockMovementsApi | getStockMovementsKey | GET /stock_movements/{key} | Returns a Stock Movement |
StockMovementsApi | postStockMovements | POST /stock_movements | Creates a Stock Movement |
StockMovementsApi | putStockMovementsKey | PUT /stock_movements/{key} | Updates a Stock Movement |
TaxDeterminationsApi | getTaxDeterminations | GET /tax_determinations | Returns all Tax Determinations |
TaxOfficesApi | getTaxOffices | GET /tax_offices | Returns all Tax Offices |
TaxOfficesApi | getTaxOfficesKey | GET /tax_offices/{key} | Returns a Tax Office |
TaxProfilesApi | getTaxProfiles | GET /tax_profiles | Returns all Tax Profiles |
TaxProfilesApi | getTaxProfilesKey | GET /tax_profiles/{key} | Returns a Tax Profile |
TaxProfilesApi | putTaxProfilesKey | PUT /tax_profiles/{key} | Updates a Tax Profile |
TaxRatesApi | deleteTaxRatesKey | DELETE /tax_rates/{key} | Deletes a Tax Rate (US only) |
TaxRatesApi | getTaxRates | GET /tax_rates | Returns all Tax Rates |
TaxRatesApi | getTaxRatesKey | GET /tax_rates/{key} | Returns a Tax Rate |
TaxRatesApi | postTaxRates | POST /tax_rates | Creates a Tax Rate (US only) |
TaxRatesApi | putTaxRatesKey | PUT /tax_rates/{key} | Updates a Tax Rate (US only) |
TaxReturnFrequenciesApi | getTaxReturnFrequencies | GET /tax_return_frequencies | Returns all Tax Return Frequencies |
TaxReturnFrequenciesApi | getTaxReturnFrequenciesKey | GET /tax_return_frequencies/{key} | Returns a Tax Return Frequency |
TaxSchemesApi | getTaxSchemes | GET /tax_schemes | Returns all Tax Schemes |
TaxSchemesApi | getTaxSchemesKey | GET /tax_schemes/{key} | Returns a Tax Scheme |
TaxTypesApi | getTaxTypes | GET /tax_types | Returns all Tax Types |
TaxTypesApi | getTaxTypesKey | GET /tax_types/{key} | Returns a Tax Type |
TransactionTypesApi | getTransactionTypes | GET /transaction_types | Returns all Transaction Types |
TransactionTypesApi | getTransactionTypesKey | GET /transaction_types/{key} | Returns a Transaction Type |
TransactionsApi | getTransactions | GET /transactions | Returns all Transactions |
TransactionsApi | getTransactionsKey | GET /transactions/{key} | Returns a Transaction |
UnallocatedArtefactsApi | getUnallocatedArtefacts | GET /unallocated_artefacts | Returns all Unallocated Artefacts |
UnallocatedArtefactsApi | getUnallocatedArtefactsKey | GET /unallocated_artefacts/{key} | Returns a Unallocated Artefact |
- Address
- AddressRegion
- AllocatedArtefact
- AllocatedPaymentArtefact
- AnalysisType
- AnalysisTypeCategory
- AnalysisTypeLineItem
- ArtefactDetailedTaxAnalysis
- ArtefactDetailedTaxAnalysisBreakdown
- ArtefactTaxAnalysis
- Attachment
- BankAccount
- BankAccountContact
- BankAccountDetails
- BankDeposit
- BankOpeningBalance
- BankReconciliation
- BankReconciliationStatus
- BankTransfer
- Base
- BaseJournalLine
- BusinessActivityType
- BusinessExchangeRate
- BusinessSettings
- BusinessType
- CisSettings
- 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
- PostAnalysisTypeCategories
- PostAnalysisTypeCategoriesAnalysisTypeCategory
- PostAttachments
- PostAttachmentsAttachment
- PostBankAccounts
- PostBankAccountsBankAccount
- PostBankAccountsBankAccountBankAccountDetails
- PostBankAccountsBankAccountMainAddress
- PostBankAccountsBankAccountMainContactPerson
- PostBankDeposits
- PostBankDepositsBankDeposit
- PostBankOpeningBalances
- PostBankOpeningBalancesBankOpeningBalance
- PostBankReconciliations
- PostBankReconciliationsBankReconciliation
- PostBankTransfers
- PostBankTransfersBankTransfer
- PostBusinessExchangeRates
- PostBusinessExchangeRatesBusinessExchangeRate
- PostContactAllocations
- PostContactAllocationsContactAllocation
- PostContactAllocationsContactAllocationAllocatedArtefactsInner
- PostContactOpeningBalances
- PostContactOpeningBalancesContactOpeningBalance
- PostContactPayments
- PostContactPaymentsContactPayment
- PostContactPaymentsContactPaymentAllocatedArtefactsInner
- PostContactPaymentsContactPaymentPaymentOnAccount
- PostContactPersons
- PostContactPersonsContactPerson
- PostContacts
- PostContactsContact
- PostContactsContactMainContactPerson
- PostContactsContactTaxTreatment
- PostHostedArtefactPaymentSettings
- PostHostedArtefactPaymentSettingsHostedArtefactPaymentSetting
- PostJournalCodes
- PostJournalCodesJournalCode
- PostJournals
- PostJournalsJournal
- PostJournalsJournalJournalCode
- PostJournalsJournalJournalLinesInner
- PostLedgerAccountOpeningBalances
- PostLedgerAccountOpeningBalancesLedgerAccountOpeningBalance
- PostLedgerAccounts
- PostLedgerAccountsLedgerAccount
- PostMigrationTaxReturns
- PostMigrationTaxReturnsMigrationTaxReturn
- PostMigrationTaxReturnsMigrationTaxReturnGb
- PostMigrationTaxReturnsMigrationTaxReturnIe
- PostOpeningBalanceJournals
- PostOpeningBalanceJournalsOpeningBalanceJournal
- PostOpeningBalanceJournalsOpeningBalanceJournalJournalLinesInner
- PostOtherPayments
- PostOtherPaymentsOtherPayment
- PostOtherPaymentsOtherPaymentPaymentLinesInner
- PostProductSalesPriceTypes
- PostProductSalesPriceTypesProductSalesPriceType
- PostProducts
- PostProductsProduct
- PostProductsProductSalesPricesInner
- PostPurchaseCorrectiveInvoices
- PostPurchaseCorrectiveInvoicesPurchaseCorrectiveInvoice
- PostPurchaseCorrectiveInvoicesPurchaseCorrectiveInvoiceInvoiceLinesInner
- PostPurchaseCorrectiveInvoicesPurchaseCorrectiveInvoiceTaxAnalysisInner
- PostPurchaseCreditNotes
- PostPurchaseCreditNotesPurchaseCreditNote
- PostPurchaseCreditNotesPurchaseCreditNoteCreditNoteLinesInner
- PostPurchaseInvoices
- PostPurchaseInvoicesPurchaseInvoice
- PostPurchaseInvoicesPurchaseInvoiceInvoiceLinesInner
- PostPurchaseQuickEntries
- PostPurchaseQuickEntriesPurchaseQuickEntry
- PostPurchaseQuickEntriesPurchaseQuickEntryAnalysisTypeCategoriesInner
- PostSalesCorrectiveInvoices
- PostSalesCorrectiveInvoicesSalesCorrectiveInvoice
- PostSalesCorrectiveInvoicesSalesCorrectiveInvoiceInvoiceLinesInner
- PostSalesCorrectiveInvoicesSalesCorrectiveInvoiceMainAddress
- PostSalesCreditNotes
- PostSalesCreditNotesSalesCreditNote
- PostSalesCreditNotesSalesCreditNoteCreditNoteLinesInner
- PostSalesEstimates
- PostSalesEstimatesSalesEstimate
- PostSalesEstimatesSalesEstimateEstimateLinesInner
- PostSalesInvoices
- PostSalesInvoicesSalesInvoice
- PostSalesInvoicesSalesInvoiceRecurringInvoice
- PostSalesQuickEntries
- PostSalesQuickEntriesSalesQuickEntry
- PostSalesQuotes
- PostSalesQuotesSalesQuote
- PostServiceRateTypes
- PostServiceRateTypesServiceRateType
- PostServices
- PostServicesService
- PostServicesServiceSalesRatesInner
- PostStockItems
- PostStockItemsStockItem
- PostStockMovements
- PostStockMovementsStockMovement
- PostTaxRates
- PostTaxRatesTaxRate
- PostTaxRatesTaxRateComponentTaxRateInner
- PrintContactDetails
- PrintStatements
- Product
- ProductSalesPriceType
- ProfitAnalysis
- ProfitBreakdown
- PurchaseCorrectiveInvoice
- PurchaseCreditNote
- PurchaseCreditNoteLineItem
- PurchaseInvoice
- PurchaseInvoiceLineItem
- PurchaseQuickEntry
- PutAddresses
- PutAddressesAddress
- PutAnalysisTypeCategories
- PutAnalysisTypes
- PutAnalysisTypesAnalysisType
- PutAttachments
- PutAttachmentsAttachment
- PutBankAccounts
- PutBankAccountsBankAccount
- PutBankAccountsBankAccountBankAccountDetails
- PutBankOpeningBalances
- PutBankOpeningBalancesBankOpeningBalance
- PutBankReconciliations
- PutBankReconciliationsBankReconciliation
- PutBankTransfers
- PutBankTransfersBankTransfer
- PutBusinessExchangeRates
- PutBusinessExchangeRatesBusinessExchangeRate
- PutBusinessSettings
- PutBusinessSettingsBusinessSettings
- PutBusinessSettingsBusinessSettingsDefaultLedgerAccounts
- PutCisSettings
- PutCisSettingsCisSettings
- PutContactAllocations
- PutContactAllocationsContactAllocation
- PutContactOpeningBalances
- PutContactOpeningBalancesContactOpeningBalance
- PutContactPayments
- PutContactPaymentsContactPayment
- PutContactPersons
- PutContactPersonsContactPerson
- PutContacts
- PutContactsContact
- PutDatevSettings
- PutDatevSettingsDatevSettings
- PutEmailSettings
- PutEmailSettingsEmailSettings
- PutEmailSettingsEmailSettingsDefaultMessagesInner
- PutFinancialSettings
- PutFinancialSettingsFinancialSettings
- PutInvoiceSettings
- PutInvoiceSettingsInvoiceSettings
- PutInvoiceSettingsInvoiceSettingsDocumentHeadings
- PutInvoiceSettingsInvoiceSettingsFooterDetails
- PutInvoiceSettingsInvoiceSettingsLineItemTitles
- PutInvoiceSettingsInvoiceSettingsPrintContactDetails
- PutInvoiceSettingsInvoiceSettingsPrintStatements
- PutJournalCodes
- PutJournalCodesJournalCode
- PutLedgerAccountOpeningBalances
- PutLedgerAccountOpeningBalancesLedgerAccountOpeningBalance
- PutLedgerAccounts
- PutLedgerAccountsLedgerAccount
- PutMigrations
- PutMigrationsMigrations
- PutOtherPayments
- PutOtherPaymentsOtherPayment
- PutOtherPaymentsOtherPaymentPaymentLinesInner
- PutProductSalesPriceTypes
- PutProductSalesPriceTypesProductSalesPriceType
- PutProducts
- PutProductsProduct
- PutPurchaseCorrectiveInvoices
- PutPurchaseCreditNotes
- PutPurchaseCreditNotesPurchaseCreditNote
- PutPurchaseCreditNotesPurchaseCreditNoteCreditNoteLinesInner
- PutPurchaseInvoices
- PutPurchaseInvoicesPurchaseInvoice
- PutPurchaseInvoicesPurchaseInvoiceInvoiceLinesInner
- PutPurchaseQuickEntries
- PutPurchaseQuickEntriesPurchaseQuickEntry
- PutSalesCorrectiveInvoices
- PutSalesCreditNotes
- PutSalesCreditNotesSalesCreditNote
- PutSalesCreditNotesSalesCreditNoteCreditNoteLinesInner
- PutSalesEstimates
- PutSalesEstimatesSalesEstimate
- PutSalesEstimatesSalesEstimateEstimateLinesInner
- 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
- UnpostedTransaction
All endpoints do not require authorization.
To run the tests, use:
composer install
vendor/bin/phpunit
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
3.1
- Package version:
2024.09.03
- Generator version:
7.12.0-SNAPSHOT
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen