sfin_contract 0.0.154
This is dio contract library
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
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
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
final loadOriginalReference = true; // bool | query param to load original reference
try {
final result = api_instance.getByReference(domainType, reference, loadOriginalReference);
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 | accountBalanceByBankCode | GET /api/v1/banks/accounts/{code}/balance | Get account balance by bank code |
| BankApi | accountTransactionsByBankCode | GET /api/v1/banks/accounts/{code}/transactions | List account transactions by bank code |
| BankApi | bankStatementAutoMatch | GET /api/v1/banks/statements/auto-match | bank statement auto match |
| 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 | 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 | manualStatementWithInvoiceMatchTransact | PUT /api/v1/banks/statements/manual/invoice-payment | create manual bank statement with invoice match |
| BankApi | manualTransact | POST /api/v1/banks/{code}/transactions | manual transact (add or transfer) |
| BankApi | matchInvoiceWithBankStatement | PUT /api/v1/banks/statements/invoice-match | match invoice with bank statement |
| BankApi | matchSingleInvoiceWithMultipleOnAccount | PUT /api/v1/banks/match-invoice-with-multiple-on-account | Match single invoice with multiple on account |
| BankApi | matchSingleOnAccountWithMultipleInvoice | PUT /api/v1/banks/match-on-account-with-multiple-invoice | Match single on account with multiple invoice |
| 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 | 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 | updateBankDetail | PUT /api/v1/banks/bank-detail | update bank detail |
| 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 |
| BudgetApi | deleteBudgetFilter | DELETE /api/v1/budget-management/date-filter | delete budget filter |
| BudgetApi | getBudgetCategoryReport | GET /api/v1/budget-management/category-report | get budget category report |
| BudgetApi | getBudgetFilterList | GET /api/v1/budget-management/date-filter | get budget filter list |
| BudgetApi | getBudgetFixedAssetsReport | GET /api/v1/budget-management/fixed-asset-report | get budget fixed assets report |
| BudgetApi | getBudgetPlanning | GET /api/v1/budget-management/planning | get budget planning summary |
| BudgetApi | getBudgetProfitLoss | GET /api/v1/budget-management/profit-loss | get budget profit loss |
| BudgetApi | saveBudgetFilter | PUT /api/v1/budget-management/date-filter | save budget filter |
| BudgetApi | updateBudgetPlanning | PUT /api/v1/budget-management/planning | update budget planning summary |
| CisApi | addNewSubcontractor | POST /api/v1/cis/subcontractors | addSubcontractor |
| CisApi | amendMonthlyCisReturnByReference | PUT /api/v1/cis/cis-returns/{reference} | Amend monthly CIS returns by reference |
| CisApi | createManualMonthlyCisReturns | POST /api/v1/cis/cis-returns | Create manual monthly CIS returns |
| CisApi | getAllSubcontractors | GET /api/v1/cis/subcontractors | get all subcontractors |
| CisApi | getCisConfig | GET /api/v1/cis/config | get CIS config |
| CisApi | getCisDeductionRate | GET /api/v1/cis/subcontractors/{reference}/deduction-rates | CIS deduction rate |
| CisApi | getCisOverview | GET /api/v1/cis/overview | get CIS overview |
| CisApi | getCisReturnsOverview | GET /api/v1/cis/cis-returns/overview | CIS returns overview |
| CisApi | getMonthlyCisReturnByReference | GET /api/v1/cis/cis-returns/{reference} | Get monthly CIS returns by reference |
| CisApi | getMonthlyCisReturns | GET /api/v1/cis/cis-returns | Get all monthly CIS returns |
| CisApi | sendCisStatements | POST /api/v1/cis/cis-returns/{reference}/statements | Send CIS statements to subcontractors by reference |
| CisApi | submitMonthlyCisReturns | POST /api/v1/cis/cis-returns/{reference} | Submit monthly CIS returns |
| CisApi | updateCisConfig | PUT /api/v1/cis/config | update CIS config |
| CisApi | verifySubcontractor | PUT /api/v1/cis/subcontractors/{reference} | Verify Subcontractor by reference |
| CisApi | verifySubcontractors | PUT /api/v1/cis/subcontractors | Verify Subcontractors by references |
| ConfigApi | addBusiness | PUT /api/v1/companies/{reference}/initiate-onboarding | add business |
| ConfigApi | addFavouriteItem | POST /api/v1/favourite-items | Add favourite item |
| 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 | createQuickLink | POST /api/v1/configs/quicklinks | Create QuickLink |
| ConfigApi | deleteFavouriteItem | DELETE /api/v1/favourite-items/{reference} | Delete favourite-item by reference |
| 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 | deleteQuickLinkByDomain | DELETE /api/v1/configs/quicklinks/domains | delete quickLink by domain reference |
| ConfigApi | deleteQuickLinkByReference | DELETE /api/v1/configs/quicklinks/{reference} | delete quickLink by reference |
| ConfigApi | deleteQuickLinkGroup | DELETE /api/v1/configs/quicklinks/groups/{reference} | delete quickLink by group reference |
| 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 | getAllFavouriteItems | GET /api/v1/favourite-items | Get all favourite items |
| ConfigApi | getAllFiltrationQuery | GET /api/v1/filtrations | get all saved filtration query |
| ConfigApi | getAllInvoiceTemplates | GET /api/v1/invoice-templates | get all invoice templates |
| ConfigApi | getAllQuickLinks | GET /api/v1/configs/quicklinks | get all QuickLinks |
| 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 | getCompanyManagementList | GET /api/v1/company-management | get company list for portal |
| ConfigApi | getCompanyProfile | GET /api/v1/companies/{crn} | get company profile |
| ConfigApi | getCurrentCloseDate | GET /api/v1/close-dates/current | get current close date |
| ConfigApi | getCurrentInvoiceTemplate | GET /api/v1/invoice-templates/current | get current invoice template |
| 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 | getFinancialConfig | GET /api/v1/configs/financial | get financial config |
| 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 | getQuickLinkByReference | GET /api/v1/configs/quicklinks/{reference} | get quickLink by reference |
| ConfigApi | getVatConfig | GET /api/v1/configs/vat | get vat config |
| ConfigApi | hasOnAccountMatch | GET /api/v1/configs/has-on-account-match | check on-account matches |
| 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 | orderQuickLinkGroup | PUT /api/v1/configs/quicklinks/groups/{reference} | update group order by reference |
| 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 | updateFinancialConfig | PUT /api/v1/configs/financial | update financial config |
| ConfigApi | updateInvoiceTemplate | POST /api/v1/invoice-templates | update invoice template |
| ConfigApi | updateLogo | PUT /api/v1/logos/{reference} | update logo |
| ConfigApi | updateQuickLink | PUT /api/v1/configs/quicklinks/{reference} | Update QuickLink |
| ConfigApi | updateQuickLinkGroup | PUT /api/v1/configs/quicklinks/groups | update quick-link-group |
| ConfigApi | updateTemplateByReference | PUT /api/v1/importers/configs/{reference} | Update import template by reference |
| ConfigApi | updateVatConfig | PUT /api/v1/configs/vat | update vat config |
| ConfigurationApi | archiveChartOfAccount | PUT /api/v1/configurations/chart-of-accounts/archive | archive chart of account |
| 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 | deleteChartOfAccount | DELETE /api/v1/configurations/chart-of-accounts | delete |
| ConfigurationApi | getAccountViewConfiguration | GET /api/v1/configurations/chart-of-accounts/settings | Get account configuration settings |
| ConfigurationApi | getAllChartOfAccount | GET /api/v1/configurations/chart-of-accounts | get chart of account list |
| ConfigurationApi | getBalanceSheetSettings | GET /api/v1/configurations/balance-sheet/settings | get balance-sheet settings |
| 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 | getChartOfAccountByNominalCode | GET /api/v1/configurations/chart-of-accounts/{nominalCode} | get chart of account by nominal code |
| 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 | getGlobalChartOfAccount | GET /api/v1/configurations/chart-of-accounts/global/{nominalCode} | get global chart of account detail |
| ConfigurationApi | getProfitAndLossSettings | GET /api/v1/configurations/profit-loss/settings | get profit-and-loss settings |
| ConfigurationApi | getPurchaseAccountLookup | GET /api/v1/configurations/purchase-account-lookup | get all purchase account lookup |
| ConfigurationApi | getSalesAccountLookup | GET /api/v1/configurations/sales-account-lookup | get all sales account lookup |
| ConfigurationApi | getVatCodeList | GET /api/v1/configurations/vat-code | get vat code list |
| ConfigurationApi | unArchiveChartOfAccount | PUT /api/v1/configurations/chart-of-accounts/unarchive | un archive chart of account |
| ConfigurationApi | updateAccountConfiguration | POST /api/v1/configurations/chart-of-accounts/settings | Update account configuration field |
| ConfigurationApi | updateBalanceSheetSettings | PUT /api/v1/configurations/balance-sheet/settings | update balance-sheet settings |
| ConfigurationApi | updateChartOfAccount | PUT /api/v1/configurations/chart-of-accounts | update chart of account |
| ConfigurationApi | updateProfitAndLossSettings | PUT /api/v1/configurations/profit-loss/settings | update profit-and-loss settings |
| ConfigurationApi | updateVatCode | PUT /api/v1/configurations/vat-code | update vat code |
| CustomerApi | archiveCustomer | PUT /api/v1/customers/{reference}/archive | |
| CustomerApi | autoMatchSalesOnAccountsByReference | POST /api/v1/customers/{reference}/sales-on-accounts/auto-match | Auto match sales on accounts |
| CustomerApi | createCustomer | POST /api/v1/customers | Create Customer |
| CustomerApi | createCustomerOnTheFly | POST /api/v1/customers/on-the-fly | Create Customer on-the-fly |
| 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 | getCustomerFinancialOverview | GET /api/v1/customers/{reference}/financial-overview | get customer financial overview |
| 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 | getCustomerOnAccountAuditTransactions | GET /api/v1/customers/invoices/on-accounts | Get customer on accounts audit transactions |
| CustomerApi | getCustomerStatements | GET /api/v1/customers/{reference}/statements | get customer statements |
| CustomerApi | getCustomerTransactionsActivity | GET /api/v1/customers/{reference}/activities | get customer transactions activity |
| CustomerApi | getCustomerTransactionsByReference | GET /api/v1/customers/{reference}/transactions | Get customer transactions by reference |
| CustomerApi | getDeletedCustomerInvoiceByReference | GET /api/v1/customers/invoices/deleted/{reference} | Get deleted customer invoice by reference |
| CustomerApi | getDeletedOpeningBalanceByReference | GET /api/v1/customers/opening-balances/deleted/{reference} | get deleted opening balance by reference |
| CustomerApi | getInvoiceCurrenciesByCustomerReference | GET /api/v1/customers/{reference}/invoices/currencies | Get invoice currencies by customer reference |
| CustomerApi | getOpeningBalanceByReference | GET /api/v1/customers/opening-balances/{reference} | get opening balance by reference |
| CustomerApi | getOutstandingInvoices | GET /api/v1/customers/invoices/outstanding | get count and amount of outstanding invoices |
| CustomerApi | getSalesOnAccountAutoMatches | GET /api/v1/customers/sales-on-accounts/auto-match | List matched sales on accounts |
| CustomerApi | getSalesOnAccountAutoMatchesByReference | GET /api/v1/customers/{reference}/sales-on-accounts/auto-match | List matched sales on accounts by reference |
| CustomerApi | getSalesOverview | GET /api/v1/customers/invoices/sales-overview | get sales overview |
| CustomerApi | notifyCustomerInvoice | POST /api/v1/customers/invoices/{reference}/notify | notify invoice to customer |
| CustomerApi | notifyCustomerStatement | POST /api/v1/customers/{reference}/statements | notify customer statement |
| CustomerApi | restoreCustomerInvoiceByReferences | PUT /api/v1/customers/invoices/imports/restore/references | restore customer invoice by references |
| CustomerApi | retractCreditNoteCustomerInvoicePayment | PUT /api/v1/customers/invoices/payment/retract | retract CreditNote Invoice Payment |
| 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 |
| DashboardApi | createDashboardLayout | POST /api/v1/dashboard/dashboard-layout | create dashboard layout |
| DashboardApi | deleteDashboardLayout | DELETE /api/v1/dashboard/dashboard-layout | delete dashboard layout |
| DashboardApi | getAdminDashboardSummary | GET /api/v1/dashboard/admin/overview | Get Admin Dashboard Summary |
| DashboardApi | getAllDashboardConfigurations | GET /api/v1/dashboard | get all dashboard configurations |
| DashboardApi | getAllDashboardLayouts | GET /api/v1/dashboard/dashboard-layout | get all dashboard layouts |
| DashboardApi | getAllRecentActivityAudits | GET /api/v1/dashboard/recent-activities | get all recent activity audits |
| DashboardApi | getAuthorizedDashboardWidgets | GET /api/v1/dashboard/dashboard-layout/default-layout | getAuthorizedDashboardWidgets |
| DashboardApi | getBankDashboard | GET /api/v1/dashboard/bank/{bankCode} | get bank dashboard information |
| DashboardApi | getCustomerMetricOverview | GET /api/v1/dashboard/customer-metric-overview | Get customer metric overview |
| DashboardApi | getDashboardSettings | GET /api/v1/dashboard/settings | getDashboardSettings |
| DashboardApi | getFinancialSummary | GET /api/v1/dashboard/financial-summary | get financial summary |
| DashboardApi | getIndividualCustomerMetric | GET /api/v1/dashboard/customers/individual-overview | Get individual customer metric |
| DashboardApi | getIndividualSupplierMetric | GET /api/v1/dashboard/suppliers/individual-overview | Get individual supplier metric |
| DashboardApi | getProductMonthlySalesTrend | GET /api/v1/dashboard/product-monthly-sales-trend | Get product monthly sales trend |
| DashboardApi | getProductOverviewByReference | GET /api/v1/dashboard/product-overview | Get product sales overview |
| DashboardApi | getProductSalesOverview | GET /api/v1/dashboard/product-sales-overview | Get product sales overview |
| DashboardApi | getSaleAndCustomerInsight | GET /api/v1/dashboard/sales-and-customer-insight | get sale and customer insight |
| DashboardApi | getSupplierExpenseMetricOverview | GET /api/v1/dashboard/supplier/expense-overview | Get supplier metric expense overview |
| DashboardApi | getSupplierInsights | GET /api/v1/dashboard/supplier-insights | Get supplier insights |
| DashboardApi | getSupplierPurchaseOverview | GET /api/v1/dashboard/supplier-purchase-overview | get supplier purchase overview |
| DashboardApi | setDefaultDashboardLayout | PUT /api/v1/dashboard/dashboard-layout/default-layout | setDefaultDashboardLayout |
| DashboardApi | updateDashboardConfigurations | PUT /api/v1/dashboard | update dashboard configurations |
| DashboardApi | updateDashboardLayout | PUT /api/v1/dashboard/dashboard-layout | update dashboard layout |
| DashboardApi | updateDashboardSettings | PUT /api/v1/dashboard/settings | update dashboardSettings |
| DocumentApi | deleteDocument | DELETE /api/v1/documents/{reference} | delete document by reference |
| DocumentApi | deleteDocuments | POST /api/v1/{documentType}/documents/{parentReference} | delete document by given array of references |
| DocumentApi | getConfigDocuments | GET /api/v1/documents | get all documents |
| DocumentApi | getDocuments | GET /api/v1/{documentType}/documents/{parentReference} | get all documents by parent/service reference |
| DocumentApi | getTotalStorageUsed | GET /api/v1/documents/size | get total storage used size of documents |
| DocumentApi | linkDocument | PUT /api/v1/documents/{reference} | link |
| DocumentApi | renameDocument | PUT /api/v1/{documentType}/documents/{reference}/rename | rename |
| HmrcApi | adjust | POST /api/v1/hmrc/vat-obligations/adjustments | Add Vat adjustment |
| HmrcApi | adjustmentByReference | GET /api/v1/hmrc/vat-obligations/adjustments/{reference} | Get Vat adjustment 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 | deleteAdjustment | DELETE /api/v1/hmrc/vat-obligations/adjustments/{reference} | Delete Vat adjustment |
| 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 |
| HmrcApi | updateAdjustment | PUT /api/v1/hmrc/vat-obligations/adjustments/{reference} | Update Vat adjustment |
| IdmApi | acceptCompanyOwnershipTransferRequest | PUT /api/v1/companies/accept-transfer-request/{token} | Accept company ownership transfer request |
| IdmApi | acceptFirmOwnershipTransferRequest | PUT /api/v1/firms/accept-transfer-request/{token} | Accept firm ownership transfer request |
| 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 | changePassword | PUT /api/v1/auth/change-password | Change password |
| IdmApi | checkUserRegisteredByEmail | GET /api/v1/users/registered | Check user by email |
| IdmApi | createGroup | POST /api/v1/groups | create a group |
| IdmApi | deleteGroupByReference | DELETE /api/v1/groups/{reference} | delete group by reference |
| IdmApi | disable2FA | POST /api/v1/2fa | Disable 2FA |
| IdmApi | enable2FA | PUT /api/v1/2fa | Enable 2FA |
| IdmApi | findAgentByReference | GET /api/v1/firms/{reference}/agent-users/{agentReference} | Find Agent by firm-reference and agent-reference |
| IdmApi | generate2FA | GET /api/v1/2fa | Generate 2FA |
| 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 | getAllAgentsForTransferOwnership | GET /api/v1/firms/{reference}/transfer-ownership/candidates | get all agents for transfer ownership |
| IdmApi | getAllUserForTransferOwnership | GET /api/v1/users/transfer-ownership/candidates | get all user for transfer ownership |
| IdmApi | getCompaniesByFirmReference | GET /api/v1/firms/{reference}/companies | get companies |
| IdmApi | getCompanyManagementByFirmReference | GET /api/v1/firms/{reference}/company-management | get companies by firm reference |
| 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 | getProfileSetting | GET /api/v1/user/profile-settings | Get Profile Setting |
| IdmApi | getUserGroupCountDetails | GET /api/v1/users-groups/counts | get user group count details |
| IdmApi | getUserLookup | GET /api/v1/users/lookup | get user lookup |
| 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 | operationalUserPermissions | GET /api/v1/operational-role-permissions | operational user permissions |
| IdmApi | predefinedUserPermissions | GET /api/v1/predefined-role-permissions | predefined user permissions |
| IdmApi | registerCompany | POST /api/v1/companies | register company |
| IdmApi | registerUser | POST /api/v1/auth/signup | Register a new user User |
| IdmApi | requestResetEmail | PUT /api/v1/auth/reset-email-request | Request to reset email |
| IdmApi | requestResetPassword | PUT /api/v1/auth/reset-password | Request to reset password |
| IdmApi | resendRegistrationVerificationEmail | POST /api/v1/resend-verification-email | Resend registration verification email to a newly created user |
| IdmApi | resetEmail | PUT /api/v1/auth/reset-email | Reset email of the User |
| IdmApi | resetPassword | PUT /api/v1/auth/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 | updateProfileSetting | PUT /api/v1/user/profile-settings | Update Profile Setting |
| 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/auth/verify/{token} | Verify registered User |
| JournalApi | archiveJournal | PUT /api/v1/journals/{reference}/archive | |
| JournalApi | createJournalInvoice | POST /api/v1/journals | create journal invoice |
| JournalApi | getAllJournals | GET /api/v1/journals | |
| JournalApi | getByReference | GET /api/v1/journals/{reference} | Get journal by reference |
| JournalApi | unarchiveJournal | PUT /api/v1/journals/{reference}/unarchive | |
| JournalApi | updateJournalInvoice | PUT /api/v1/journals/{reference} | update journal invoice by reference |
| JournalApi | voidJournal | PUT /api/v1/journals/{reference}/void | |
| JournalApi | voidReversalJournal | PUT /api/v1/journals/{reference}/void-reversal | |
| NotificationApi | addEmailConfig | POST /api/v1/notifications/email-configs | Email config |
| NotificationApi | deleteNotificationByReference | DELETE /api/v1/notifications/{reference} | delete notification by reference |
| NotificationApi | deleteNotificationToByReference | DELETE /api/v1/notifications/{reference}/to | delete notification to by reference |
| NotificationApi | deletePushNotificationDevice | DELETE /api/v1/notifications/devices/{deviceToken} | Delete push-notification device by token |
| NotificationApi | getAll | GET /api/v1/notifications/email-configs | get all email configs |
| NotificationApi | getAllWatchItems | GET /api/v1/notifications/watch-items | List all watch items |
| NotificationApi | latestNotifications | GET /api/v1/notifications | get latest notifications |
| NotificationApi | listAllNotifications | GET /api/v1/notifications/all | List all notifications |
| NotificationApi | registerPushNotificationDevice | POST /api/v1/notifications/devices | Register push-notification device |
| NotificationApi | revertSeen | PUT /api/v1/notifications/{reference} | Revert notification as seen |
| NotificationApi | unwatch | DELETE /api/v1/notifications/{item}/unwatch | Unwatch by item |
| NotificationApi | updateEmailConfig | PUT /api/v1/notifications/email-configs/{reference} | Update Email config by reference |
| NotificationApi | watch | POST /api/v1/notifications/{item}/watch | Watch by item |
| 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 | getDeletedPurchaseOrderByReference | GET /api/v1/orders/deleted/{reference} | Get deleted purchase-order by reference |
| 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 | createProductOnTheFly | POST /api/v1/products/on-the-fly | Create Product on-the-fly |
| ProductApi | deleteCategory | DELETE /api/v1/products/categories/{reference} | Delete Category |
| ProductApi | deleteDamagedStockByProductReferenceAndReference | DELETE /api/v1/products/{reference}/damaged-stocks/{stockReference} | Delete Damaged Stock |
| ProductApi | deleteProduct | DELETE /api/v1/products/{reference} | Create Product |
| ProductApi | findAllCategories | GET /api/v1/products/categories | Find all categories |
| ProductApi | getAllProducts | GET /api/v1/products | get all Products |
| ProductApi | getCategories | GET /api/v1/products/categories/all | Get categories |
| ProductApi | getCategoriesWithProductLookup | GET /api/v1/products/categories/lookup | Get categories with product lookup |
| 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 | getDeletedProductByReference | GET /api/v1/products/deleted/{reference} | Get deleted product by 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 | updateCategory | PUT /api/v1/products/categories/{reference} | Update Category |
| 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 | getDeletedQuotationByReference | GET /api/v1/quotations/deleted/{reference} | Get deleted quotation by reference |
| 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/{reference}/archive | 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 | unarchiveRecurringTransaction | PUT /api/v1/recurring-transactions/{reference}/unarchive | Unarchive Recurring Transaction |
| 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 |
| SfinScanApi | getAll | GET /api/v1/sfin-scan/scanned-documents | get all scanned documents |
| 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 | checkOutstandingVatReturnsAndRecurring | GET /api/v1/subscriptions/outstanding-vat-returns | Check outstanding vat returns |
| SubscriptionApi | checkRecurringMultiCurrency | GET /api/v1/subscriptions/recurring/check-multi-currency | Check recurring multi currency |
| SubscriptionApi | expiredSubscriptionPlan | GET /api/v1/subscriptions/expired-subscription-plan | Expired 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 | renewExpiredSubscriptionPlan | PUT /api/v1/subscriptions/renew | |
| 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 | undoSubscriptionCancellation | DELETE /api/v1/subscriptions/cancellations/undo | |
| 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 | autoMatchPurchaseOnAccountsByReference | POST /api/v1/suppliers/{reference}/purchase-on-accounts/auto-match | Auto match purchase on accounts |
| 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 | createSupplierOnTheFly | POST /api/v1/suppliers/on-the-fly | Create Supplier on-the-fly |
| 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 | getDeletedOpeningBalanceByReference | GET /api/v1/suppliers/opening-balances/deleted/{reference} | get deleted opening balance by reference |
| SupplierApi | getDeletedSupplierInvoiceByReference | GET /api/v1/suppliers/invoices/deleted/{reference} | Get deleted supplier invoice by reference |
| SupplierApi | getInvoiceByReference | GET /api/v1/suppliers/invoices/{reference} | Get supplier invoice by reference |
| SupplierApi | getInvoiceCurrenciesBySupplierReference | GET /api/v1/suppliers/{reference}/invoices/currencies | Get invoice currencies by supplier reference |
| SupplierApi | getOpeningBalanceByReference | GET /api/v1/suppliers/opening-balances/{reference} | get opening balance by reference |
| SupplierApi | getOutstandingInvoices | GET /api/v1/suppliers/invoices/outstanding | get count and amount of outstanding supplier invoices |
| SupplierApi | getPurchaseOnAccountAutoMatches | GET /api/v1/suppliers/purchase-on-accounts/auto-match | List matched purchase on accounts |
| SupplierApi | getPurchaseOnAccountAutoMatchesByReference | GET /api/v1/suppliers/{reference}/purchase-on-accounts/auto-match | List matched purchase on accounts by reference |
| SupplierApi | getPurchaseOverview | GET /api/v1/suppliers/invoices/purchase-overview | get purchase overview |
| 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 | getSupplierFinancialOverview | GET /api/v1/suppliers/{reference}/financial-overview | get supplier financial overview |
| 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 | getSupplierOnAccountAuditTransactions | GET /api/v1/suppliers/invoices/on-accounts | Get supplier on accounts audit transactions |
| SupplierApi | getSupplierStatements | GET /api/v1/suppliers/{reference}/statements | get supplier statements |
| SupplierApi | getSupplierTransactionsActivity | GET /api/v1/suppliers/{reference}/activities | get supplier transactions activity |
| SupplierApi | getSupplierTransactionsByReference | GET /api/v1/suppliers/{reference}/transactions | Get supplier transactions by reference |
| SupplierApi | notifySupplierStatement | POST /api/v1/suppliers/{reference}/statements | notify supplier statement |
| SupplierApi | restoreSupplierInvoiceByReferences | PUT /api/v1/suppliers/invoices/imports/restore/references | restore supplier invoice by references |
| SupplierApi | retractCreditNoteSupplierInvoicePayment | PUT /api/v1/suppliers/invoices/payment/retract | retract Credit Note with Supplier Invoice Payment |
| 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 |
| SupportApi | close | PUT /api/v1/supports/{serviceCode}/close | close support case |
| SupportApi | deleteConversation | DELETE /api/v1/supports/{serviceCode}/conversations/{reference} | delete conversation |
| SupportApi | deleteSupport | DELETE /api/v1/supports/{serviceCode} | Delete support case |
| SupportApi | getByServiceCode | GET /api/v1/supports/{serviceCode} | get support case by service code |
| SupportApi | getSuperAdminSupportDashboard | GET /api/v1/supports/admin/dashboard | get super admin support dashboard |
| SupportApi | getSupportVolumeDashboard | GET /api/v1/supports/admin/dashboard/volume | get support volume super admin support dashboard |
| SupportApi | initiateSupportCase | POST /api/v1/supports | Initiate for a support case |
| SupportApi | listAllSupports | GET /api/v1/supports/all | List all support cases |
| SupportApi | listSupports | GET /api/v1/supports | List support cases |
| SupportApi | markAsSeen | PUT /api/v1/supports/{serviceCode}/conversations/{reference}/seen | mark conversation as seen |
| SupportApi | message | POST /api/v1/supports/{serviceCode}/conversations | message |
| SupportApi | reopen | PUT /api/v1/supports/{serviceCode}/reopen | reopen support case |
| SupportApi | resolve | PUT /api/v1/supports/{serviceCode}/resolve | mark support case as resolved |
| SupportApi | share | PUT /api/v1/supports/{serviceCode}/share | share support case to users/groups |
| SupportApi | subscribeEmailNotification | PUT /api/v1/supports/{serviceCode}/email-notification/{emailSubscription} | subscribe email notification to shared support case |
| SupportApi | updateConversation | PUT /api/v1/supports/{serviceCode}/conversations/{reference} | update conversation |
| SupportApi | updateTitle | PUT /api/v1/supports/{serviceCode}/title | update title |
| UserActivityApi | createUserNote | POST /api/v1/user-notes/{domainType}/{reference} | create user note |
| UserActivityApi | deleteUserNote | DELETE /api/v1/user-notes/{domainType}/{reference} | update user note |
| UserActivityApi | getUserActivitiesByReference | GET /api/v1/activities/{domainType}/{reference} | Get user activity by reference |
| UserActivityApi | getUserNotesByDomainReference | GET /api/v1/user-notes/{domainType}/{reference} | Get user note by domain reference |
| UserActivityApi | updateUserNote | PUT /api/v1/user-notes/{domainType}/{reference} | update user note |
Documentation For Models
- Account
- AccountContract
- AccountSettingContract
- ActivityAuditContract
- AdminDashboardSummary
- AgentContract
- AgentFirmContract
- AgentFirmListContract
- AgentListContract
- Amount
- ApiErrorContract
- ApiErrorsContract
- AuditContract
- AuditListContract
- AuditTransactionContract
- AuditTransactionListContract
- BackgroundScanDataContract
- BackgroundScanDataListContract
- BalanceSheetQuery
- BalanceSheetReportContract
- BalanceSheetSettingsContract
- Bank
- BankAccountBalanceContract
- BankActivityAuditContract
- BankAutoSuggestionContract
- BankCashContract
- BankCashListContract
- BankDashboardContract
- BankStatementContract
- BankStatementInvoiceMatchContract
- BankStatementListContract
- BankStatementTransactionContract
- BankStatementTransactionListContract
- BudgetAccountContract
- BudgetCalculatedTotalContract
- BudgetCategoryLineItemContract
- BudgetCategoryReportContract
- BudgetDateFilterContract
- BudgetLineItemContract
- BudgetProfitAndLossReportContract
- BudgetProfitAndLossSectionContract
- CategoryBudgetContract
- CategoryContract
- CategoryListContract
- CategoryWithProductContract
- ChangePasswordContract
- ChartDataDashboardContact
- ChartDataDashboardContract
- ChartDataDashboardContract1
- ChartOfAccountConfigContract
- ChartOfAccountContract
- ChartOfAccountDetailContract
- ChartOfAccountList
- ChartSeriesContract
- CheckoutPaymentMethodContract
- CisConfigContract
- CisOverviewContract
- CisPaymentTransactionContract
- CisReturnContract
- CisReturnListContract
- CisReturnsOverviewContract
- CloseDateContract
- CoaTransaction
- Code
- CompanyContract
- CompanyManagementContract
- CompanyRegisteredContract
- Contact
- ConversationContract
- CreateManualMonthlyCisReturnsRequest
- CustomerContract
- CustomerFinancialOverviewContract
- CustomerInsightAndSalesOverviewContract
- CustomerInvoiceContract
- CustomerInvoiceListContract
- CustomerInvoiceNotificationContract
- CustomerListContract
- CustomerMatchedSalesOnAccountContract
- CustomerMetricOverviewContract
- CustomerOnTheFlyContract
- CustomerStatementNotificationContract
- DamagedStockContract
- DamagedStockListContract
- DashboardContract
- DashboardLayoutContract
- DashboardSettingsContract
- DateBalanceSheetFilter
- DateProfitLossFilter
- DeductionRateContract
- Disable2FARequest
- DocumentContract
- DocumentContractList
- DocumentSizeContract
- EmailCisStatementRequestContract
- EmailConfigContract
- EntityColumnContract
- EntityColumnHeaderContract
- ExpensesCategoryListContract
- FavouriteItemContract
- FeatureContract
- FieldUpdateContract
- FieldUpdateTypeEnum
- FiltrationContract
- FiltrationContractFiltrationQueryListInner
- FinancialConfigContract
- FinancialRatioContract
- FixedAssetBudgetReportContract
- FixedAssetLineItemContract
- FixedAssetTimelineContract
- GrantCompaniesContract
- GroupListContract
- GroupRequest
- GroupRoleContract
- HmrcVatReturnContract
- IdentityContract
- ImportConfigContract
- ImportTemplateContract
- ImportedFileContract
- ImportedFilesContract
- IndividualCustomerMetricContract
- IndividualSupplierMetricContract
- InvitationContract
- InvoiceActivityAuditContract
- InvoiceConfigContract
- InvoiceOverviewContract
- InvoicePaymentContract
- InvoiceTransactionAuditContract
- JournalActivityAuditContract
- JournalContract
- JournalListContract
- JournalTransactionAuditContract
- JournalTransactionContract
- KeyValueDashboardContract
- KeyValueDashboardContract1
- LoggedInAgentContract
- LogoContract
- LogoList
- MatchOnAccountContract
- MatchedPurchaseOnAccountContract
- MatchedPurchaseOnAccountInvoiceContract
- MatchedPurchaseOnAccountListContract
- MatchedSalesOnAccountContract
- MatchedSalesOnAccountInvoiceContract
- MatchedSalesOnAccountListContract
- MonthlyBudgetContract
- MonthlyTimelineGroupContract
- NestedCustomerInvoiceList
- NestedSupplierInvoiceList
- NominalCodeTransaction
- NominalCodeTransactionListContract
- NotificationBodyContract
- NotificationContract
- NotificationPageableListContract
- NotifyCustomerStatementRequest
- NotifySupplierStatementRequest
- OpeningBalanceAuditTransactionContract
- OpeningBalanceContract
- OpeningStockContract
- OrderListContract
- OutstandingInvoiceContract
- OutstandingVatReturnDateContract
- OutstandingVatReturnsAndRecurringContract
- PageResource
- PageableContract
- PermissionContract
- PieChartDataDashboardContract
- PieChartSeriesContract
- PieChartSeriesContractExtra
- PlaidConfigContract
- PredefinedRolePermissionContract
- PredefinedRolePermissionListContract
- ProductActivityAuditContract
- ProductAnalysisContract
- ProductAuditTransactionContract
- ProductContract
- ProductDashboardContract
- ProductListContract
- ProductOnTheFlyContract
- ProductOverviewContract
- ProductTransactionContract
- ProfitAndLossSettingsContract
- ProfitLossQuery
- PurchaseOrderActivityAuditContract
- PurchaseOrderContract
- PushNotificationDeviceContract
- QuickLinkContract
- QuickLinkGroupContract
- QuickLinkGroupListContract
- QuickLinkGroupUpdateContract
- QuotationActivityAuditContract
- QuotationContract
- QuotationListContract
- QuotationNotificationContract
- RecurringTransactionContract
- RecurringTransactionListContract
- RenameDocumentRequest
- ReportDashboardContract
- ReportResource
- ReportSettingsContract
- ReportTransactionContract
- ResendVerificationEmailContract
- ResetEmailRequest
- ResetEmailRequestContract
- ResetPasswordContract
- ResetPasswordRequestContract
- ResourceDetailsContract
- ResourceGroupContract
- RoleContract
- RolePermissionsContract
- SalesOrPurchaseOverviewContract
- SecondaryReferenceContract
- SetupCheckoutResponseContract
- SetupCheckoutStatusContract
- StockSupplierInvoiceContract
- StringArrayContract
- StringListResponseContract
- StringResponseContract
- SubcontractorContract
- SubcontractorPaymentContract
- SubcontractorReferenceList
- SubscriptionLookupContract
- SubscriptionModelContract
- SubscriptionPlanContract
- SubscriptionPlanListContract
- SupplierContract
- SupplierFinancialOverviewContract
- SupplierInsightsContract
- SupplierInvoiceContract
- SupplierInvoiceListContract
- SupplierListContract
- SupplierMatchedPurchaseOnAccountContract
- SupplierMetricOverviewContract
- SupplierOnTheFlyContract
- SupplierStatementNotificationContract
- SupportAdminDashboardContract
- SupportCaseContract
- SupportCaseListContract
- SupportCaseShareContract
- SupportVolumeData
- TitleUpdateContract
- TokenConfigContract
- TradePartnerActivityAuditContract
- TradePartnerStatementContract
- TradePartnerStatementOverviewContract
- Transaction
- TransactionChartOfAccountContract
- TransactionUserListContract
- TransactionUserResource
- TwoFAContract
- UploadConfigContract
- UserContract
- UserDetailsContract
- UserGroupCountDetailsContract
- UserListContract
- UserNoteContract
- UserNoteMentionsContract
- UserProfileSettingContract
- VatAdjustmentContract
- VatCodeContract
- VatConfigContract
- VatDetailsContract
- VatLiabilityContract
- VatLiabilityListContract
- VatObligationContract
- VatObligationListContract
- VatPaymentContract
- VatPaymentListContract
- VatPenaltyContract
- VatPenaltyListContract
- VatReturnAuditTransactionContract
- VatReturnContract
- VatReturnListContract
- VatReturnResponseContract
- VatReturnTransactionContract
- VatTotalisationsContract
- WatchItemContract
- WatchItemListContract
- WatchItemRequestContract
Documentation For Authorization
Endpoints do not require authorization.