sfin_contract

Description:

sfin contract

sfin_contract #
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:
sfin_contract:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
copied to clipboard
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
sfin_contract:
path: /path/to/sfin_contract
copied to clipboard
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:sfin_contract/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');
}

copied to clipboard
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
accountTransactionsByBankCode
GET /api/v1/banks/accounts/{code}/transactions
List account transactions by bank code


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
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
getBankStatementByReference
GET /api/v1/banks/statements/{reference}
find bank statement by reference


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
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
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


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
approveImportedBankStatements
PUT /api/v1/importers/banks/statement-files/approve
approve imported bank-statements


ConfigApi
approveImportedCustomerInvoices
PUT /api/v1/importers/customers/invoices/approve
approve imported customer-invoices


ConfigApi
approveImportedCustomers
PUT /api/v1/importers/customers/approve
approve imported customers


ConfigApi
approveImportedProducts
PUT /api/v1/importers/products/approve
approve imported products


ConfigApi
approveImportedSupplierInvoices
PUT /api/v1/importers/suppliers/invoices/approve
approve imported supplier-invoices


ConfigApi
approveImportedSuppliers
PUT /api/v1/importers/suppliers/approve
approve imported suppliers


ConfigApi
archiveImportTemplateByReference
DELETE /api/v1/importers/configs/archive/{reference}
Archive Import template by reference


ConfigApi
attachImportedFile
PUT /api/v1/importers/files/{reference}
Attach imported file


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
importConfigs
GET /api/v1/importers/configs
Import configs


ConfigApi
importCustomerInvoices
POST /api/v1/importers/customers/invoices
import customer invoices but yet to be approved/activated


ConfigApi
importSupplierInvoices
POST /api/v1/importers/suppliers/invoices
import supplier-invoices but yet to be approved/activated


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


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
updateChartOfAccount
PUT /api/v1/configurations/chart-of-accounts
update chart of account


ConfigurationApi
updateVatCode
PUT /api/v1/configurations/vat-code
update vat code


CustomerApi
archiveCustomer
PUT /api/v1/customers/{reference}/archive



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
Get customer code


CustomerApi
getCustomerCodeByReference
GET /api/v1/customers/{reference}/codes
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
getCustomerInvoiceByReference
GET /api/v1/customers/invoices/{reference}
Get customer invoice by reference


CustomerApi
getCustomerInvoiceNo
GET /api/v1/customers/invoices/next-invoice-no
get next customer invoice no


CustomerApi
getCustomerTransactionsByReference
GET /api/v1/customers/{reference}/transactions
Get customer transactions by reference


CustomerApi
getOpeningBalanceByReference
GET /api/v1/customers/opening-balances/{reference}
get opening balance by reference


CustomerApi
notifyCustomerInvoice
POST /api/v1/customers/invoices/{reference}/notify
notify invoice to customer


CustomerApi
restoreCustomerInvoiceByReferences
PUT /api/v1/customers/invoices/imports/restore/references
restore customer invoice by references


CustomerApi
skipCustomerInvoices
DELETE /api/v1/customers/invoices/imports/skip
skip customer invoices


CustomerApi
unarchiveCustomer
PUT /api/v1/customers/{reference}/unarchive



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
updateOpeningBalanceByReference
PUT /api/v1/customers/opening-balances/{reference}
update opening balance by reference


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
findAgentByReference
GET /api/v1/firms/{reference}/agent-users/{agentReference}
Find Agent by firm-reference and agent-reference


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 Agent


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
updateAdminPermissions
PUT /api/v1/users/{reference}/admins/permissions
update permissions by admin-reference


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
updateJournalInvoice
PUT /api/v1/journals/{reference}
update journal invoice by reference


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
updatePurchaseOrder
PUT /api/v1/orders/{reference}
Update Purchase Order


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
archiveProduct
PUT /api/v1/products/{reference}/archive
Archive Product


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
getProductByReference
GET /api/v1/products/{reference}
Get product by reference


ProductApi
getProductCode
GET /api/v1/products/codes
Get product code


ProductApi
unarchiveProduct
PUT /api/v1/products/{reference}/unarchive
Unarchive Product


ProductApi
updateDamagedStockByProductReferenceAndReference
PUT /api/v1/products/{reference}/damaged-stocks/{stockReference}
Update Damaged Stock


ProductApi
updateProduct
PUT /api/v1/products/{reference}
Update Product


QuotationApi
cloneQuotationByReference
GET /api/v1/quotations/{reference}/clone
Clone quotation by reference


QuotationApi
copyQuotationByReference
GET /api/v1/quotations/{reference}/copy
Copy quotation by reference


QuotationApi
createQuotation
POST /api/v1/quotations
create a Quotation


QuotationApi
deleteQuotationByReference
DELETE /api/v1/quotations/{reference}
delete quotation by reference


QuotationApi
getAllQuotations
GET /api/v1/quotations
get all quotations


QuotationApi
getNextQuotationNo
GET /api/v1/quotations/next-quotation-no
get next quotation no


QuotationApi
getQuotationByReference
GET /api/v1/quotations/{reference}
Get quotation by reference


QuotationApi
notifyQuotation
POST /api/v1/quotations/{reference}/notify
notify quotation to customer


QuotationApi
updateQuotation
PUT /api/v1/quotations/{reference}
Update Quotation


RecurringTransactionsApi
archiveRecurringTransaction
DELETE /api/v1/recurring-transactions/archive/{reference}
Archive 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
getCreditorBalanceTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/balance
get supplier balance transactions


ReportApi
getCreditorCurrentTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/current
get supplier balance transactions


ReportApi
getCreditorOlderTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/older
get supplier older transactions


ReportApi
getCreditorOneMonthTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/one-month
get supplier plus one-month transactions


ReportApi
getCreditorThreeMonthTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/three-month
get supplier plus three-month transactions


ReportApi
getCreditorTurnoverTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/turnover
get supplier turnover transactions


ReportApi
getCreditorTwoMonthTransactionsBySupplierReference
GET /api/v1/reports/creditors/{supplierReference}/transactions/two-month
get supplier plus two-month transactions


ReportApi
getCreditorsList
GET /api/v1/reports/creditors
get creditors list


ReportApi
getDebtorBalanceTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/balance
get customer balance transactions


ReportApi
getDebtorCurrentTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/current
get customer balance transactions


ReportApi
getDebtorOlderTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/older
get customer older transactions


ReportApi
getDebtorOneMonthTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/one-month
get customer plus one-month transactions


ReportApi
getDebtorThreeMonthTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/three-month
get customer plus three-month transactions


ReportApi
getDebtorTurnoverTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/turnover
get customer turnover transactions


ReportApi
getDebtorTwoMonthTransactionsByCustomerReference
GET /api/v1/reports/debtors/{customerReference}/transactions/two-month
get customer plus two-month transactions


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
getProfitLoss
POST /api/v1/reports/profit-loss
get profit loss balance


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-subscription-plans
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
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/active-subscription-plans



SubscriptionApi
updateTrialSubscriptionPlan
PUT /api/v1/subscriptions/trial-subscription-plan/{reference}



SupplierApi
archiveSupplier
PUT /api/v1/suppliers/{reference}/archive



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
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
getOpeningBalanceByReference
GET /api/v1/suppliers/opening-balances/{reference}
get opening balance by reference


SupplierApi
getStockSupplierInvoices
GET /api/v1/suppliers/invoices/{productReference}/stocks
get all stock supplier invoice by product reference


SupplierApi
getSupplierByReference
GET /api/v1/suppliers/{reference}
Get supplier by reference


SupplierApi
getSupplierCode
GET /api/v1/suppliers/codes
Get supplier code


SupplierApi
getSupplierCodeByReference
GET /api/v1/suppliers/{reference}/codes
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
getSupplierInvoiceNo
GET /api/v1/suppliers/invoices/next-invoice-no
get next supplier invoice no


SupplierApi
getSupplierTransactionsByReference
GET /api/v1/suppliers/{reference}/transactions
Get supplier transactions by reference


SupplierApi
restoreSupplierInvoiceByReferences
PUT /api/v1/suppliers/invoices/imports/restore/references
restore supplier invoice by references


SupplierApi
skipSupplierInvoices
DELETE /api/v1/suppliers/invoices/imports/skip
skip supplier invoices


SupplierApi
unarchiveSupplier
PUT /api/v1/suppliers/{reference}/unarchive



SupplierApi
updateMultipleInvoice
PUT /api/v1/suppliers/invoices/batch-entries
Update multiple Supplier Bill Bulk


SupplierApi
updateOpeningBalanceByReference
PUT /api/v1/suppliers/opening-balances/{reference}
update opening balance by reference


SupplierApi
updateSupplier
PUT /api/v1/suppliers/{reference}
Update Supplier


SupplierApi
updateSupplierInvoice
PUT /api/v1/suppliers/invoices/{reference}
Update Supplier Invoice



Documentation For Models #

Account
AccountContract
AgentContract
AgentFirmContract
AgentFirmListContract
AgentListContract
Amount
ApiErrorContract
ApiErrorsContract
AuditContract
AuditListContract
AuditTransactionContract
AuditTransactionListContract
BalanceSheetQuery
Bank
BankCashContract
BankCashListContract
BankNoteContract
BankStatementContract
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
EmailConfigContract
EntityColumnContract
EntityColumnHeaderContract
FeatureContract
FiltrationContract
FiltrationContractFiltrationQueryListInner
GrantCompaniesContract
GroupListContract
GroupRequest
HmrcVatReturnContract
IdentityContract
ImportConfigContract
ImportTemplateContract
ImportedFileContract
ImportedFilesContract
InvitationContract
JournalInvoiceContract
JournalTransactionContract
LoggedInAgentContract
LogoContract
LogoList
NestedCustomerInvoiceList
NestedSupplierInvoiceList
NominalCodeTransaction
NominalCodeTransactionListContract
OpeningBalanceAuditTransactionContract
OpeningBalanceContract
OpeningStockContract
OrderListContract
PageResource
PageableContract
PermissionContract
PlaidConfigContract
PredefinedRolePermissionContract
PredefinedRolePermissionListContract
ProductAuditTransactionContract
ProductContract
ProductListContract
ProductTransactionContract
ProfitLossQuery
PurchaseOrderContract
QuotationContract
QuotationListContract
QuotationNotificationContract
RecurringTransactionContract
RecurringTransactionListContract
ReportResource
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 #