contract_package 0.0.1

This is dio contract library

contract_package

API to manage user

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

• API version: v0.0.2
• Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  contract_package:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  contract_package:
    path: /path/to/contract_package

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:contract_package/api.dart';


final api_instance = AuditApi();
final domainType = domainType_example; // String | domain type
final reference = reference_example; // String | audit reference

try {
    final result = api_instance.getByReference(domainType, reference);
    print(result);
} catch (e) {
    print('Exception when calling AuditApi->getByReference: $e\n');
}

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class	Method	HTTP request	Description
AuditApi	getByReference	GET /api/v1/audits/{domainType}/{reference}	Get audit by reference
BankApi	bankStatementTransactions	GET /api/v1/banks/{code}/statements/{reference}/transactions	fetch all bank statements
BankApi	changeBankStatements	PUT /api/v1/banks/statement-files/{reference}	change bank statements file for another account
BankApi	deleteBankAccountByCode	DELETE /api/v1/banks/accounts/{code}	Delete/Archive Bank Account by Bank Code
BankApi	deleteBankNote	DELETE /api/v1/banks/{code}/statements/{reference}/bank-note	deleteBankNote
BankApi	deleteBankStatementDocuments	DELETE /api/v1/banks/{code}/statements/{reference}/documents	Delete bank statement attachments/documents
BankApi	deleteBankStatementTransactionList	DELETE /api/v1/banks/statements/transactions/delete	Delete/Retract Bank statement transaction list by references
BankApi	deleteBankTransactionByReference	DELETE /api/v1/banks/statements/transactions/{reference}	delete the bank statement transaction
BankApi	fetchAllBankStatements	GET /api/v1/banks/statements	fetch all bank statements
BankApi	findBankStatementByBankStatementTransactionReference	GET /api/v1/banks/statements/transactions/{reference}/statement	find bank statement by bank statement reference
BankApi	findBankStatementTransactionByReference	GET /api/v1/banks/statements/transactions/{reference}	find bank statement transaction by reference
BankApi	getAccounts	GET /api/v1/banks/accounts	get all accounts
BankApi	getAllBankStatementFiles	GET /api/v1/banks/statement-files	get all bank statement files
BankApi	getBankStatementDocuments	GET /api/v1/banks/{code}/statements/{reference}/documents	Get bank statement attachments/documents
BankApi	getBankStatementsByBankCode	GET /api/v1/banks/{code}/statements	get bank Statements by bank code
BankApi	getPlaidLinkToken	GET /api/v1/banks/plaid-link-token	get plaid link token
BankApi	importStatement	POST /api/v1/banks/statement-files	import statement file
BankApi	linkBanks	POST /api/v1/banks/plaid-link-bank	linkBanks
BankApi	manualTransact	POST /api/v1/banks/{code}/transactions	manual transact (add or transfer)
BankApi	onAccountByReference	PUT /api/v1/banks/{code}/statements/{reference}/transactions/{transactionReference}/onAccount	On Account bank statement transaction by reference
BankApi	reOpenClosedAccountByBankCode	PUT /api/v1/banks/accounts/{code}/re-open	Re Open Closed Account By Bank Code
BankApi	refreshAccount	GET /api/v1/banks/accounts/{accountId}/refresh	refresh account by id
BankApi	removeBankStatements	DELETE /api/v1/banks/statement-files/{reference}	remove bank statement file
BankApi	restoreStatement	PUT /api/v1/banks/{code}/statements/{reference}/restore	restore skipped bank statement
BankApi	retract	PUT /api/v1/banks/{code}/statements/{reference}/transactions/retract	retractBankStatementTransactions
BankApi	retractByReference	PUT /api/v1/banks/{code}/statements/{reference}/transactions/{transactionReference}/retract	Retract bank statement transaction by reference
BankApi	saveBankNote	POST /api/v1/banks/{code}/statements/{reference}/bank-note	saveBankNote
BankApi	skip	DELETE /api/v1/banks/{code}/statements/{reference}/transactions	skip the bank statement
BankApi	transact	POST /api/v1/banks/{code}/statements/{reference}/transactions	transact (add or transfer)
BankApi	updateBankTransactionByReference	PUT /api/v1/banks/statements/transactions/{reference}	Update bank statement transaction by reference
BankApi	updateBankTransactionListByReference	PUT /api/v1/banks/{code}/statements/{bankStatementReference}/transaction/{transactionReference}	Update bank statement transaction list by reference
BankApi	updateManualBankStatement	PUT /api/v1/banks/statements/manual	update manual bank statement
BankApi	uploadBankStatementDocuments	POST /api/v1/banks/{code}/statements/{reference}/documents	Upload bank statement attachments/documents
ConfigApi	addBusiness	PUT /api/v1/companies/{reference}/initiate-onboarding	add business
ConfigApi	addEmailConfig	POST /api/v1/configs/email-configs	Email config
ConfigApi	addLogo	POST /api/v1/logos	add logo
ConfigApi	archiveImportTemplateByReference	DELETE /api/v1/importers/configs/archive/{reference}	Archive Import template by reference
ConfigApi	checkCloseableMultiCurrency	GET /api/v1/configs/multi-currency	check closeable multi currency
ConfigApi	closeDate	POST /api/v1/close-dates/current	close date
ConfigApi	createFiltrationQuery	POST /api/v1/filtrations	create Filtration Query
ConfigApi	deleteFiltrationQuery	DELETE /api/v1/filtrations	delete saved filtration query
ConfigApi	deleteImportFileByReference	DELETE /api/v1/importers/files/{reference}	Delete Import file by reference
ConfigApi	deleteImportTemplateByReference	DELETE /api/v1/importers/configs/{reference}	Delete Import template by reference
ConfigApi	deleteLogo	DELETE /api/v1/logos/{reference}	delete logo
ConfigApi	disableMultiCurrency	DELETE /api/v1/configs/multi-currency	Disable multi currency support
ConfigApi	findImportTemplateByReference	GET /api/v1/importers/configs/{reference}	Import template by reference
ConfigApi	getAll	GET /api/v1/configs/email-configs	get all email configs
ConfigApi	getAllFiltrationQuery	GET /api/v1/filtrations	get all saved filtration query
ConfigApi	getClientCompanies	GET /api/v1/client-companies	get client companies
ConfigApi	getCompanies	GET /api/v1/companies	get companies
ConfigApi	getCompanyConfig	GET /api/v1/companies/config	get company config
ConfigApi	getCompanyProfile	GET /api/v1/companies/{crn}	get company profile
ConfigApi	getCurrentCloseDate	GET /api/v1/close-dates/current	get current close date
ConfigApi	getDefaultFilterQuery	GET /api/v1/filtrations/default-filter	get default filter for grid
ConfigApi	getExchangeRate	GET /api/v1/configs/exchange-rates	get exchange rate
ConfigApi	getInactiveCompany	GET /api/v1/companies/inactive	get inactive company
ConfigApi	getLogos	GET /api/v1/logos	get logos
ConfigApi	getPreviousCloseDates	GET /api/v1/close-dates/previous-close-dates	get previous close dates
ConfigApi	getVatConfig	GET /api/v1/configs/vat	get vat config
ConfigApi	importedFiles	GET /api/v1/importers/files	Find All Import files
ConfigApi	loadData	POST /api/v1/importers/{template}	Load data
ConfigApi	loadUploadHeaders	POST /api/v1/importers/headers	Load headers
ConfigApi	markAsWelcomed	PUT /api/v1/companies/{reference}/welcomed	mark company as welcomed
ConfigApi	reOpenCloseDate	PUT /api/v1/close-dates/{reference}	re-open close date
ConfigApi	registerTemplate	POST /api/v1/importers/configs	Register new template
ConfigApi	searchCompanies	GET /api/v1/companies/search	search companies
ConfigApi	updateCompanyConfig	PUT /api/v1/companies/config	update company config
ConfigApi	updateDefaultFilterQuery	PUT /api/v1/filtrations/default-filter	save default filter
ConfigApi	updateFiltrationQuery	PUT /api/v1/filtrations	Update Filtration Query
ConfigApi	updateLogo	PUT /api/v1/logos/{reference}	update logo
ConfigApi	updateTemplateByReference	PUT /api/v1/importers/configs/{reference}	Update import template by reference
ConfigApi	updateVatConfig	PUT /api/v1/configs/vat	update vat config
ConfigApi	uploadConfigs	GET /api/v1/importers/configs	Upload configs
ConfigurationApi	createChartOfAccount	POST /api/v1/configurations/chart-of-accounts	create chart of account
ConfigurationApi	createVatCode	POST /api/v1/configurations/vat-code	create vat code
ConfigurationApi	getAllChartOfAccount	GET /api/v1/configurations/chart-of-accounts	get chart of account list
ConfigurationApi	getBankAccountsDetails	GET /api/v1/configurations/bank-accounts-details	get bank accounts details
ConfigurationApi	getBusinessAccountLookup	GET /api/v1/configurations/business-account-lookup	get all business account lookup
ConfigurationApi	getChartOfAccountConfigLookup	GET /api/v1/configurations/chart-of-account-config-lookup	get all chart of account configs
ConfigurationApi	getChartOfAccountDetail	GET /api/v1/configurations/chart-of-account-detail	get chart of account detail
ConfigurationApi	getChartOfAccountLookup	GET /api/v1/configurations/chart-of-account-lookup	get all chart of account
ConfigurationApi	getVatCodeList	GET /api/v1/configurations/vat-code	get vat code list
ConfigurationApi	updateVatCode	PUT /api/v1/configurations/vat-code	update vat code
CustomerApi	approveCustomerInvoiceByImportReference	GET /api/v1/customers/invoices/imports/{reference}/approve	approve all customer invoice by import reference
CustomerApi	approveCustomersByImportReference	GET /api/v1/customers/imports/{reference}/approve	approve all customers by import reference
CustomerApi	createCustomer	POST /api/v1/customers	Create Customer
CustomerApi	createInvoice	POST /api/v1/customers/invoices	create Customer Invoice
CustomerApi	createMultipleInvoice	POST /api/v1/customers/invoices/batch-entries	Post multiple Customer Invoice
CustomerApi	deleteCustomerInvoiceByReference	DELETE /api/v1/customers/invoices/{reference}	delete customer invoice by reference
CustomerApi	deleteUploadedCustomerInvoices	DELETE /api/v1/customers/invoices/batch-entries	delete uploaded customer invoices
CustomerApi	getAllCustomerInvoices	GET /api/v1/customers/invoices	get all customer invoices
CustomerApi	getAllCustomers	GET /api/v1/customers	get all Customers
CustomerApi	getBulkCustomerInvoiceAutoSuggestion	GET /api/v1/customers/invoices/bulk-auto-suggestions	getBulkCustomerInvoiceAutoSuggestion
CustomerApi	getBulkCustomerInvoiceAutoSuggestionByReference	GET /api/v1/customers/{reference}/invoices/bulk-auto-suggestions	getBulkCustomerInvoiceAutoSuggestionByReference
CustomerApi	getCustomerByReference	GET /api/v1/customers/{reference}	Get customer by reference
CustomerApi	getCustomerCode	GET /api/v1/customers/codes/{code}	Get customer code
CustomerApi	getCustomerCodeByReference	GET /api/v1/customers/{reference}/codes/{code}	Get customer code
CustomerApi	getCustomerInvoiceAutoSuggestion	GET /api/v1/customers/invoices/auto-suggestions	getCustomerInvoiceAutoSuggestion
CustomerApi	getCustomerInvoiceAutoSuggestionByReference	GET /api/v1/customers/{reference}/invoices/auto-suggestions	getCustomerInvoiceAutoSuggestionByReference
CustomerApi	getCustomerInvoiceByImportReference	GET /api/v1/customers/invoices/imports/{reference}	get all customer invoice by import reference
CustomerApi	getCustomerInvoiceByReference	GET /api/v1/customers/invoices/{reference}	Get customer invoice by reference
CustomerApi	getCustomerInvoiceDocuments	GET /api/v1/customers/invoices/{reference}/documents	Get customer-invoice attachments/documents
CustomerApi	getCustomerInvoiceNo	GET /api/v1/customers/invoices/next-invoice-no	get next customer invoice no
CustomerApi	getCustomersByImportReference	GET /api/v1/customers/imports/{reference}	get all customers by import reference
CustomerApi	notifyCustomerInvoice	POST /api/v1/customers/invoices/{reference}/notify	notify invoice to customer
CustomerApi	rejectCustomersByImportReference	DELETE /api/v1/customers/imports/{reference}/reject	approve all customers by import reference
CustomerApi	restoreCustomerInvoiceByReferences	PUT /api/v1/customers/invoices/imports/restore/references	restore customer invoice by references
CustomerApi	searchCustomer	GET /api/v1/customers/search	Search customer by name or code
CustomerApi	searchCustomerInvoices	GET /api/v1/customers/invoices/search	Search customer invoices
CustomerApi	skipCustomerInvoices	DELETE /api/v1/customers/invoices/imports/skip	skip customer invoices
CustomerApi	updateCustomer	PUT /api/v1/customers/{reference}	Update Customer
CustomerApi	updateCustomerInvoice	PUT /api/v1/customers/invoices/{reference}	Update Customer Invoice
CustomerApi	updateMultipleInvoice	PUT /api/v1/customers/invoices/batch-entries	Update multiple Customer invoices
CustomerApi	uploadCustomerInvoiceDocuments	POST /api/v1/customers/invoices/{reference}/documents	upload customer invoice documents
HmrcApi	authenticate	GET /api/v1/hmrc/authenticate	authenticate HMRC server and get token config
HmrcApi	connect	GET /api/v1/hmrc/connect	connect to HMRC server to get the authorization code
HmrcApi	getAll	GET /api/v1/hmrc/vat-returns	get all vat returns extra
HmrcApi	getAllVatDetails	GET /api/v1/hmrc/details	get all vat details
HmrcApi	getAllVatLiabilities	GET /api/v1/hmrc/vat-liabilities	get all vat liabilities
HmrcApi	getAllVatObligations	GET /api/v1/hmrc/vat-obligations	get all vat obligations
HmrcApi	getAllVatPayments	GET /api/v1/hmrc/vat-payments	get all vat payments
HmrcApi	getAllVatPenalties	GET /api/v1/hmrc/vat-penalties	get all vat Penalties
HmrcApi	getByReference	GET /api/v1/hmrc/vat-returns/{reference}	get vat return by reference
HmrcApi	getVatObligationDetails	GET /api/v1/hmrc/vat-obligations/details	get vat obligation details
HmrcApi	submit	POST /api/v1/hmrc/vat-obligations/submit	Submit Vat Returns to HMRC MTD API
IdmApi	acceptInvitation	PUT /api/v1/users/accept-invite/{token}	Accept invitation
IdmApi	activateCompany	PUT /api/v1/companies/{reference}/activate	Activate company
IdmApi	cancelInvitation	DELETE /api/v1/users/invited-users/cancel	Cancel Invitation
IdmApi	checkUserRegisteredByEmail	GET /api/v1/users/registered	Check user by email
IdmApi	createGroup	POST /api/v1/groups	create a group
IdmApi	getAllAgentFirms	GET /api/v1/firms	get all agent firms
IdmApi	getAllAgentFirmsByToken	GET /api/v1/token-firms/{token}	get all agent firms by token
IdmApi	getAllAgentUsers	GET /api/v1/firms/{reference}/agent-users	get all agent user
IdmApi	getClientByReference	GET /api/v1/users/{reference}	get by user by reference
IdmApi	getCompaniesByFirmReference	GET /api/v1/firms/{reference}/companies	get companies
IdmApi	getGroupByReference	GET /api/v1/groups/{reference}	get group by reference
IdmApi	getGroups	GET /api/v1/groups	get groups
IdmApi	getInvitedAgentUsers	GET /api/v1/firms/{reference}/agent-users/invited-users	get invited agent-users
IdmApi	getInvitedUsers	GET /api/v1/users/invited-users	get all invited users
IdmApi	getLoggedInAgentUserByFirmReference	GET /api/v1/firms/{reference}/logged-in-agent	get logged-in agent user by firm reference
IdmApi	getProfile	GET /api/v1/users/profile	get profile
IdmApi	getUserPermissions	GET /api/v1/users/{reference}/permissions	get permissions by user-reference
IdmApi	getUsers	GET /api/v1/users	get all users
IdmApi	grantCompanies	PUT /api/v1/firms/{reference}/agent-users/{agentReference}/grant	grant companies to user
IdmApi	hasCompanyRegistered	GET /api/v1/company-registered	check if company has been registered
IdmApi	inviteAgentUser	PUT /api/v1/firms/{reference}/agent-users/invite-agent-user	Invite agent user
IdmApi	inviteUser	PUT /api/v1/users/invite	Invite user
IdmApi	predefinedUserPermissions	GET /api/v1/predefined-role-permissions	predefined user permissions
IdmApi	refreshToken	GET /api/v1/users/refresh/token	Refresh token
IdmApi	registerCompany	POST /api/v1/companies	register company
IdmApi	registerUser	POST /api/v1/signup	Register a new user User
IdmApi	requestResetPassword	PUT /api/v1/users/reset-password	Request to reset password
IdmApi	resetPassword	PUT /api/v1/users/reset-password/{token}	Reset password of the User
IdmApi	revokeAgentUser	DELETE /api/v1/firms/{reference}/agent-users/{agentReference}	Revoke a Agent user
IdmApi	revokeUser	DELETE /api/v1/users/{reference}	Revoke user
IdmApi	transferFirmOwnership	PUT /api/v1/firms/{reference}/agent-users/{agentReference}/transfer	transfer firm ownership
IdmApi	transferOwnership	PUT /api/v1/users/{reference}/transfer	transfer ownership
IdmApi	updateGroup	PUT /api/v1/groups/{reference}	update group
IdmApi	updatePracticeName	PUT /api/v1/firms/{reference}	Update practice name
IdmApi	updateProfile	PUT /api/v1/users/profile	Update profile
IdmApi	updateUserDetails	PUT /api/v1/users/{reference}	Update job title and expiry-date
IdmApi	updateUserPermissions	PUT /api/v1/users/{reference}/permissions	update permissions by user-reference
IdmApi	verifyUser	PUT /api/v1/users/verify/{token}	Verify registered User
JournalApi	createJournalInvoice	POST /api/v1/journals	create journal invoice
JournalApi	getByReference	GET /api/v1/journals/{reference}	Get journal by reference
JournalApi	getJournalDocuments	GET /api/v1/journals/{reference}/documents	Get journal attachments/documents
JournalApi	updateJournalInvoice	PUT /api/v1/journals/{reference}	update journal invoice by reference
JournalApi	uploadJournalDocuments	POST /api/v1/journals/{reference}/documents	upload journal documents
OrderApi	approvePurchaseOrderByReference	GET /api/v1/orders/{reference}/approve	approve purchase-order by reference
OrderApi	clonePurchaseOrderByReference	GET /api/v1/orders/{reference}/clone	Clone purchase-order by reference
OrderApi	copyPurchaseOrderByReference	GET /api/v1/orders/{reference}/copy	Copy purchase-order by reference
OrderApi	createPurchaseOrder	POST /api/v1/orders	create a Order
OrderApi	deleteOrderByReference	DELETE /api/v1/orders/{reference}	delete order by reference
OrderApi	getAllPurchaseOrders	GET /api/v1/orders	get all purchase orders
OrderApi	getNextOrderNo	GET /api/v1/orders/next-order-no	get next order no
OrderApi	getPurchaseOrderByReference	GET /api/v1/orders/{reference}	Get purchase-order by reference
OrderApi	getPurchaseOrderDocuments	GET /api/v1/orders/{reference}/documents	Get purchase order attachments/documents
OrderApi	updatePurchaseOrder	PUT /api/v1/orders/{reference}	Update Purchase Order
OrderApi	uploadPurchaseOrderDocuments	POST /api/v1/orders/{reference}/documents	upload purchase order documents
PaymentGatewayApi	getActiveCheckoutPaymentMethod	GET /api/v1/payment-gateway/stripe/checkouts/active-payment-method	get active active stripe checkout payment-method
PaymentGatewayApi	getAllCheckoutPaymentMethods	GET /api/v1/payment-gateway/stripe/checkouts/payment-methods	get all stripe checkout payment-methods
PaymentGatewayApi	getCheckoutSetupStatus	GET /api/v1/payment-gateway/stripe/checkouts/status	get stripe checkout setup status
PaymentGatewayApi	makeDefaultCheckoutPaymentMethod	PUT /api/v1/payment-gateway/stripe/checkouts/payment-methods/{reference}/make-default	make default to payment-method by reference
PaymentGatewayApi	setupStripeEmbeddedCheckout	POST /api/v1/payment-gateway/stripe/checkouts	Setup stripe embedded checkout
PaymentGatewayApi	stripeWebhook	POST /api/v1/payment-gateway/stripe/webhook	stripe webhook triggered by stripe
ProductApi	approveProductByImportReference	GET /api/v1/products/imports/{reference}/approve	approve all products by import reference
ProductApi	createCategory	POST /api/v1/products/categories	Create Category
ProductApi	createDamagedStock	POST /api/v1/products/{reference}/damaged-stocks	Create Damaged Stock
ProductApi	createProduct	POST /api/v1/products	Create Product
ProductApi	deleteDamagedStockByProductReferenceAndReference	DELETE /api/v1/products/{reference}/damaged-stocks/{stockReference}	Delete Damaged Stock
ProductApi	deleteProduct	DELETE /api/v1/products/{reference}	Create Product
ProductApi	getAllProducts	GET /api/v1/products	get all Products
ProductApi	getCategories	GET /api/v1/products/categories	Get categories
ProductApi	getDamagedStockByProductReferenceAndReference	GET /api/v1/products/{reference}/damaged-stocks/{stockReference}	Get damaged stock by reference
ProductApi	getDamagedStocksByProductReference	GET /api/v1/products/{reference}/damaged-stocks	Get damaged stocks by product reference
ProductApi	getProductByImportReference	GET /api/v1/products/imports/{reference}	get all products by import reference
ProductApi	getProductByReference	GET /api/v1/products/{reference}	Get product by reference
ProductApi	rejectProductByImportReference	DELETE /api/v1/products/imports/{reference}/reject	approve all products by import reference
ProductApi	updateDamagedStockByProductReferenceAndReference	PUT /api/v1/products/{reference}/damaged-stocks/{stockReference}	Update Damaged Stock
ProductApi	updateProduct	PUT /api/v1/products/{reference}	Update Product
RecurringTransactionsApi	archiveRecurringTransaction	DELETE /api/v1/recurring-transactions/archive/{reference}	Archive Recurring Transaction
RecurringTransactionsApi	create	POST /api/v1/recurring-transactions	Create Recurring Transaction
RecurringTransactionsApi	deleteRecurringTransaction	DELETE /api/v1/recurring-transactions/{reference}	Delete Recurring Transaction
RecurringTransactionsApi	getAll	GET /api/v1/recurring-transactions	get all recurring transactions
RecurringTransactionsApi	updateRecurringTransaction	PUT /api/v1/recurring-transactions/{reference}	Update Recurring Transaction
ReportApi	deferTransaction	GET /api/v1/reports/audit-transactions/{reference}/defer	defer transaction by reference
ReportApi	getAll	GET /api/v1/reports/audit-transactions	get all audit transactions
ReportApi	getBalanceSheet	POST /api/v1/reports/balance-sheet	get balance sheet report
ReportApi	getByReference	GET /api/v1/reports/audit-transactions/{reference}	get audit transaction by reference
ReportApi	getCreditorsList	GET /api/v1/reports/creditors	get creditors list
ReportApi	getDebtorsList	GET /api/v1/reports/debtors	get debtors list
ReportApi	getNominalActivities	GET /api/v1/reports/nominal-activities	get nominal code transaction list
ReportApi	getOnAccountTransactions	GET /api/v1/reports/on-account-transactions	get on account audit transactions
ReportApi	getOpeningBalanceByReference	GET /api/v1/reports/audit-transactions/opening-balances/{reference}	get opening balance audit transaction by reference
ReportApi	getProfitLoss	POST /api/v1/reports/profit-loss	get profit loss balance
ReportApi	updateOpeningBalanceByReference	PUT /api/v1/reports/audit-transactions/opening-balances/{reference}	update opening balance by reference
SubscriptionApi	activeSubscriptionPlan	GET /api/v1/subscriptions/active-subscription-plan	Active Subscription plan
SubscriptionApi	approveSubscriptionCancellation	PUT /api/v1/subscriptions/cancellations/approve
SubscriptionApi	cancelCurrentSubscriptionPlan	DELETE /api/v1/subscriptions/current-subscription-plan
SubscriptionApi	getActiveSubscriptions	GET /api/v1/subscriptions/active	Get all active subscription plans
SubscriptionApi	getAllSubscriptions	GET /api/v1/subscriptions	Get all subscription plans
SubscriptionApi	payCurrentSubscriptionPlan	PUT /api/v1/subscriptions/current-subscription-plan
SubscriptionApi	rejectSubscriptionCancellation	DELETE /api/v1/subscriptions/cancellations/reject
SubscriptionApi	scheduleSubscriptionPlan	POST /api/v1/subscriptions/schedule	add new features or users, you must have a paid-plan subscription. This API cannot be initiated while using a trial.
SubscriptionApi	subscribeSubscriptionPlan	POST /api/v1/subscriptions	Subscribe new subscription plan, you must not have any active subscription plan.
SubscriptionApi	subscribeTrial	POST /api/v1/subscriptions/subscribe-trial	Initiate trial Subscription plan
SubscriptionApi	subscriptionLookup	GET /api/v1/subscriptions/lookup	Subscription lookup
SubscriptionApi	trialSubscriptionPlan	GET /api/v1/subscriptions/trial-subscription-plan	Trial Subscription plan
SubscriptionApi	updateSubscriptionPlan	PUT /api/v1/subscriptions/{reference}
SupplierApi	approveSupplierInvoiceByImportReference	GET /api/v1/suppliers/invoices/imports/{reference}/approve	approve all supplier invoice by import reference
SupplierApi	approveSuppliersByImportReference	GET /api/v1/suppliers/imports/{reference}/approve	approve all suppliers by import reference
SupplierApi	checkUniqueSupplierInvoice	GET /api/v1/suppliers/invoices/check	Check unique supplier
SupplierApi	createInvoice	POST /api/v1/suppliers/invoices	create a Supplier
SupplierApi	createMultipleInvoice	POST /api/v1/suppliers/invoices/batch-entries	Post multiple Supplier Invoice Bulk
SupplierApi	createSupplier	POST /api/v1/suppliers	Create Supplier
SupplierApi	deleteSupplierInvoiceByReference	DELETE /api/v1/suppliers/invoices/{reference}	delete supplier invoice by reference
SupplierApi	deleteUploadedSupplierInvoices	DELETE /api/v1/suppliers/invoices/batch-entries	delete uploaded supplier invoices
SupplierApi	getAllInvoices	GET /api/v1/suppliers/invoices/batch-entries	get all invoice suppliers
SupplierApi	getAllSuppliers	GET /api/v1/suppliers	get all suppliers
SupplierApi	getBulkSupplierInvoiceAutoSuggestion	GET /api/v1/suppliers/invoices/bulk-auto-suggestions	getBulkSupplierInvoiceAutoSuggestion
SupplierApi	getBulkSupplierInvoiceAutoSuggestionByReference	GET /api/v1/suppliers/{reference}/invoices/bulk-auto-suggestions	getBulkSupplierInvoiceAutoSuggestionByReference
SupplierApi	getInvoiceByReference	GET /api/v1/suppliers/invoices/{reference}	Get supplier invoice by reference
SupplierApi	getStockSupplierInvoices	GET /api/v1/suppliers/invoices/{productReference}/stocks	get all stock supplier invoice by product reference
SupplierApi	getSupplierByImportReference	GET /api/v1/suppliers/imports/{reference}	get all suppliers by import reference
SupplierApi	getSupplierByReference	GET /api/v1/suppliers/{reference}	Get supplier by reference
SupplierApi	getSupplierCode	GET /api/v1/suppliers/codes/{code}	Get supplier code
SupplierApi	getSupplierCodeByReference	GET /api/v1/suppliers/{reference}/code/{code}	Get supplier code
SupplierApi	getSupplierInvoiceAutoSuggestion	GET /api/v1/suppliers/invoices/auto-suggestions	getSupplierInvoiceAutoSuggestion
SupplierApi	getSupplierInvoiceAutoSuggestionByReference	GET /api/v1/suppliers/{reference}/invoices/auto-suggestions	getSupplierInvoiceAutoSuggestionByReference
SupplierApi	getSupplierInvoiceByImportReference	GET /api/v1/suppliers/invoices/imports/{reference}	get all supplier invoice by import reference
SupplierApi	getSupplierInvoiceDocuments	GET /api/v1/suppliers/invoices/{reference}/documents	Get supplier-invoice attachments/documents
SupplierApi	getSupplierInvoiceNo	GET /api/v1/suppliers/invoices/next-invoice-no	get next supplier invoice no
SupplierApi	rejectSuppliersByImportReference	DELETE /api/v1/suppliers/imports/{reference}/reject	approve all suppliers by import reference
SupplierApi	restoreSupplierInvoiceByReferences	PUT /api/v1/suppliers/invoices/imports/restore/references	restore supplier invoice by references
SupplierApi	searchSupplier	GET /api/v1/suppliers/search	Search supplier by name or code
SupplierApi	searchSupplierInvoice	GET /api/v1/suppliers/invoices/search	Search supplier invoice
SupplierApi	skipSupplierInvoices	DELETE /api/v1/suppliers/invoices/imports/skip	skip supplier invoices
SupplierApi	updateMultipleInvoice	PUT /api/v1/suppliers/invoices/batch-entries	Update multiple Supplier Bill Bulk
SupplierApi	updateSupplier	PUT /api/v1/suppliers/{reference}	Update Supplier
SupplierApi	updateSupplierInvoice	PUT /api/v1/suppliers/invoices/{reference}	Update Supplier Invoice
SupplierApi	uploadSupplierInvoiceDocuments	POST /api/v1/suppliers/invoices/{reference}/documents	upload supplier invoice documents

Documentation For Models

• Account
• AccountContract
• AccountOpeningBalance
• AgentContract
• AgentFirmContract
• AgentFirmListContract
• AgentListContract
• Amount
• ApiErrorContract
• ApiErrorsContract
• AuditContract
• AuditListContract
• AuditTransactionContract
• AuditTransactionListContract
• BalanceSheetRequest
• Bank
• BankCashContract
• BankCashListContract
• BankNoteContract
• BankStatementContract
• BankStatementFileContract
• BankStatementFileListContract
• BankStatementListContract
• BankStatementTransactionContract
• BankStatementTransactionListContract
• CategoryContract
• ChartOfAccountConfigContract
• ChartOfAccountContract
• ChartOfAccountDetailContract
• ChartOfAccountList
• CheckoutPaymentMethodContract
• CloseDateContract
• CoaTransaction
• Code
• CompanyContract
• CompanyRegisteredContract
• Contact
• CustomerContract
• CustomerInvoiceContract
• CustomerInvoiceListContract
• CustomerInvoiceNotificationContract
• CustomerListContract
• DamagedStockContract
• DamagedStockListContract
• DateBalanceSheetFilter
• DateProfitLossFilter
• DocumentContract
• DocumentContract1
• EmailConfigContract
• EntityColumnContract
• EntityColumnHeaderContract
• FeatureContract
• FiltrationContract
• FiltrationContractFiltrationQueryListInner
• GrantCompaniesContract
• GroupListContract
• GroupRequest
• HmrcVatReturnContract
• IdentityContract
• ImportConfigContract
• ImportTemplateContract
• ImportedFileContract
• ImportedFilesContract
• InvitationContract
• JournalInvoiceContract
• JournalTransactionContract
• LoggedInAgentContract
• LogoContract
• LogoList
• NominalCodeTransaction
• NominalCodeTransactionListContract
• OpeningBalanceAuditTransactionContract
• OpeningBalanceContract
• OpeningStockContract
• OrderListContract
• PageResource
• PageableContract
• PermissionContract
• PlaidConfigContract
• PredefinedRolePermissionContract
• PredefinedRolePermissionListContract
• ProductAuditTransactionContract
• ProductContract
• ProductListContract
• ProductTransactionContract
• ProfitLossRequest
• PurchaseOrderContract
• RecurringTransactionContract
• RecurringTransactionListContract
• ReportResource
• ReportTransaction
• ReportTransactionContract
• ResetPasswordContract
• ResetPasswordRequestContract
• ResourceDetailsContract
• ResourceGroupContract
• RoleContract
• RolePermissionsContract
• SetupCheckoutResponseContract
• SetupCheckoutStatusContract
• StockSupplierInvoiceContract
• SubscriptionLookupContract
• SubscriptionModelContract
• SubscriptionPlanContract
• SubscriptionPlanListContract
• SupplierContract
• SupplierInvoiceContract
• SupplierInvoiceListContract
• SupplierListContract
• TokenConfigContract
• Transaction
• TransactionUserListContract
• TransactionUserResource
• TrialBalanceContract
• UploadConfigContract
• UserContract
• UserDetailsContract
• UserListContract
• VatCodeContract
• VatConfigContract
• VatDetailsContract
• VatLiabilityContract
• VatLiabilityListContract
• VatObligationContract
• VatObligationListContract
• VatPaymentContract
• VatPaymentListContract
• VatPenaltyContract
• VatPenaltyListContract
• VatReturnAuditTransactionContract
• VatReturnContract
• VatReturnListContract
• VatReturnResponseContract
• VatReturnTransactionContract
• VatTotalisationsContract

Documentation For Authorization

Endpoints do not require authorization.

Author