API Calls
Account
Accountant Event
Accountant Note
Accountant Note Attachment
Accountant Task
Accountant Task Recurrence
Account Balance
Account Category
Account Note
Account Note Attachment
Account Opening Balance
Account Payment
Account Receipt
Additional Item Price
Additional Price List
Allocation
Analysis Category
Analysis Type
Asset
Asset Category
Asset Location
Asset Note
Attachment
Balance Sheet
Bank Account
Bank Account Category
Bank Account Note
Bank Account Note Attachment
Bank Account Opening Balance
Bank Account Transaction Listing
Bank Import Mapping
Bank Statement Transaction
Bank Transaction
Bank Transaction Attachment
BAS Report
Budget
Cash Movement
City
Company
Company Entity Type
Company Note
Core Events
Core Tokens
CRM Activity
CRM Activity Category
Currency
Customer
Customer Additional Contact Detail
Customer Additional Contact Options
Customer Adjustment
Customer Ageing
Customer Category
Customer Note
Customer Note Attachment
Customer Opening Balance
Customer Receipt
Customer Return
Customer Return Attachment
Customer Sales History
Customer Statement
Customer Transaction Listing
Customer Write Off
Customer Zone
Dashboard Debtors Manager
Date Format
Detailed Ledger Transaction
Developer Data
Document File Attachment
Document Header Note
Document History
Document Message
Document Number
Document User Defined Fields
Email Signature Template
Email Template Place Holder
Exchange Rates
Final Accounts
Financial Year
Income Vs Expense
Item
Item Adjustment
Item Attachment
Item Bundle
Item Category
Item Movement
Item Note
Item Note Attachment
Item Opening Balance
Item Report Group
Journal Entry
Localization
Login
Outstanding Customer Document
Outstanding Supplier Document
Payroll
Price Listing Report
Process Bank And Credit Card Mapping
Profit And Loss
Purchase Order
Purchase Order Attachment
Purchases By Item
Quote
Quote Attachment
Recurring Invoice
Recurring Journal
Reporting Group
Sales By Item
Sales By Sales Representative
Sales Order
Sales Order Attachment
Sales Representative
Sales Representative Note
Schedule Frequency
Secretarial Company Role
Secretarial Share Class
Secretarial Shareholder
Secretarial Stake Holder
Supplier
Supplier Additional Contact Detail
Supplier Adjustment
Supplier Ageing
Supplier Bank Detail
Supplier Category
Supplier Invoice
Supplier Invoice Attachment
Supplier Note
Supplier Note Attachment
Supplier Opening Balance
Supplier Payment
Supplier Purchase History
Supplier Return
Supplier Return Attachment
Supplier Statement
Supplier Transaction Listing
Support Login Audit
Take On Balance
Tax Adjustment
Tax Invoice
Tax Invoice Attachment
Tax Period
Tax Rate Adjustment
Tax Type
Time Tracking Customer
Time Tracking Expense
Time Tracking Project
Time Tracking Task
Time Tracking Timesheet
Time Tracking User
To Do List
Top Customers By Outstanding Balance
Top Customers By Sales
Top Purchased Items
Top Selling Items
Top Selling Items By Value On Hand
Top Suppliers By Outstanding Balance
Top Suppliers By Purchases
Trial Balance
Trial Balance Export Mapping
User Defined Field
VAT201 Report
Account
The Account Service provides methods that allow for the retrieval, creation and deletion of Accounts. This service requires authentication.
API | Description |
---|---|
GET Account/Get |
Gets a list of Accounts. |
GET Account/Get/{id} |
Gets the specified Account based on the identifier. |
GET Account/GetPayrollTypeOfAccounts |
Gets a list of Expense, Current Liability and Cost of Sale Accounts |
GET Account/GetServiceAccounts |
Gets a list of Cost of Sales and Expenses Accounts |
DELETE Account/Delete/{id} |
Deletes the specified Account. Only succeeds if the Account is not in use. |
POST Account/Save |
Saves the specified Account. |
GET Account/GetWithSystemAccounts |
Gets the list of Accounts including system accounts. |
GET Account/GetAccountsByCategoryId/{id} |
Gets a list of Accounts based on the Category identifier. |
GET Account/GetChartofAccounts |
Get a list of all accounts |
Accountant Event
The Account Event Service provides methods that allow for the retrieval Accountant Events This service requires authentication.
API | Description |
---|---|
POST AccountantEvent/GetEventsInDateRange |
Gets a list of Accountant Events in the specified date range. |
Accountant Note
This service requires authentication.
API | Description |
---|---|
POST AccountantNote/Save |
Saves the specified Accountant Note. |
DELETE AccountantNote/Delete/{id} |
No documentation available. |
GET AccountantNote/Get |
No documentation available. |
GET AccountantNote/Get/{id} |
No documentation available. |
GET AccountantNote/GetLatest?count={count} |
No documentation available. |
Accountant Note Attachment
The Accountant Note Attachment provides methods that allow for the creation of Accountant Note Attachment. This service requires authentication.
API | Description |
---|---|
POST AccountantNoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a AccountantNoteId is required. An AccountantNoteId is the ID of the AccountantNote that this attachment must be linked to. This is Required and is not optional. |
GET AccountantNoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET AccountantNoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET AccountantNoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE AccountantNoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE AccountantNoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST AccountantNoteAttachment/Validate |
Validates the specified Entity. |
Accountant Task
The Account Task Service provides methods that allow for the retrieval and deletion of Accountant Tasks. This service requires authentication.
API | Description |
---|---|
DELETE AccountantTask/Delete/{id} |
Deletes the specified Accountant Task. |
GET AccountantTask/Get |
Gets a list Accountant Tasks. |
GET AccountantTask/Get/{id} |
Gets the specified Accountant Task based on the identifier. |
POST AccountantTask/Save |
Saves the specified Accountant Task. |
POST AccountantTask/GetTasksForSpecificDate |
Gets a list Accountant Tasks for the specified date. |
POST AccountantTask/GetTasksDueSpecificDate |
Gets a list Accountant Tasks due on the specific date. |
POST AccountantTask/GetTasksDueInDateRange |
Gets a list Accountant Tasks due in the specified date range. |
GET AccountantTask/GetLatest?count={count} |
Gets a specified number of Accountant Tasks. |
POST AccountantTask/UpdateTaskStatus |
Update the status of the Accountant Task. |
Accountant Task Recurrence
The Account Task Recurrence Service provides methods that allow for the retrieval and deletion of Accountant Task Recurrences. This service requires authentication.
API | Description |
---|---|
DELETE AccountantTaskRecurrence/Delete/{id} |
Deletes the specified Accountant Task Recurrence. |
GET AccountantTaskRecurrence/Get |
Gets a list Accountant Tasks Recurrences. |
GET AccountantTaskRecurrence/Get/{id} |
Gets the specified Accountant Task Recurrence based on the identifier. |
Account Balance
This service requires authentication.
API | Description |
---|---|
POST AccountBalance/Get |
No documentation available. |
GET AccountBalance/GetAccountBudgetsById?budgetId={budgetId} |
No documentation available. |
GET AccountBalance/GetAccountBudgets |
No documentation available. |
Account Category
The Account Category Service provides methods that allow for the retrieval of Account Categories. This service requires authentication.
API | Description |
---|---|
GET AccountCategory/Get |
Gets a list of Account Categories. |
GET AccountCategory/Get/{id} |
Gets the specified Account Category based on the identifier. |
Account Note
The Account Note service provides methods that allow for the retrieval, creation and deletion of Account Notes. This service requires authentication.
API | Description |
---|---|
POST AccountNote/Save |
Saves the specified Account Note. |
GET AccountNote/Get |
Gets a list of Account Notes. |
GET AccountNote/Get/{id} |
Gets the specified Account Note based on the identifier. |
DELETE AccountNote/Delete/{id} |
Deletes the specified Account Note. |
Account Note Attachment
The Account Note Attachment provides methods that allow for the creation of Account Note Attachment. This service requires authentication.
API | Description |
---|---|
POST AccountNoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a AccountNoteId is required. An AccountNoteId is the ID of the AccountNote that this attachment must be linked to. This is Required and is not optional. |
GET AccountNoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET AccountNoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET AccountNoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE AccountNoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE AccountNoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST AccountNoteAttachment/Validate |
Validates the specified Entity. |
Account Opening Balance
The Account Opening Balance Service provides methods that allow for the retrieval and creation of Account Opening Balance. This service requires authentication.
API | Description |
---|---|
POST AccountOpeningBalance/Save |
Saves the specified Account Opening Balance. |
GET AccountOpeningBalance/Get |
Gets a list of Account Opening Balances. |
GET AccountOpeningBalance/Get/{id} |
Gets the specified Account Opening Balance based on the identifier. |
GET AccountOpeningBalance/GetByAccountId/{id} |
Gets the specified Account Opening Balance based on the AccountId. |
Account Payment
The Account Payment Service provides methods that allow for the retrieval and creation of Account Payments This service requires authentication.
API | Description |
---|---|
GET AccountPayment/Get |
Gets a list of Account Payments. |
POST AccountPayment/Save |
Saves the specified Account Payment. |
Account Receipt
The Account Receipt Service provides methods that allow for the retrieval and creation of Account Receipts. This service requires authentication.
API | Description |
---|---|
GET AccountReceipt/Get |
Gets a list of Account Receipts. |
POST AccountReceipt/Save |
Saves the specified Account Receipt. |
Additional Item Price
The Additional Item Price Service provides methods that allow for the retrieval, creation and deletion of Additional Item Prices. This service requires authentication.
API | Description |
---|---|
GET AdditionalItemPrice/Get |
Gets a list of Additional Item Prices. This excludes items connected to the default price list or with a price of zero. Default price list is the pricing on the Items. |
GET AdditionalItemPrice/Get/{id} |
Gets the specified Additional Item Price based on the identifier. |
POST AdditionalItemPrice/Save |
Saves the specified Additional Item Price. |
DELETE AdditionalItemPrice/Delete/{id} |
Deletes the specified Additional Item Price based on the identifier. |
Additional Price List
The Additional Price List Service provides methods that allow for the retrieval, creation and deletion of Additional Price Lists. This service requires authentication.
API | Description |
---|---|
GET AdditionalPriceList/Get |
Gets a list of Additional Price Lists. This includes the default price list. |
GET AdditionalPriceList/Get/{id} |
Gets the specified Additional Price List based on the identifier. |
POST AdditionalPriceList/Get |
Gets a list of Additional Price Lists based on the list of identifiers. |
POST AdditionalPriceList/Save |
Saves the specified Additional Price List. |
DELETE AdditionalPriceList/Delete/{id} |
Deletes the specified Additional Price List based on the identifier. If the Additional Price List is not in use. The default price list cannot be deleted. |
POST AdditionalPriceList/AllowDelete |
Confirms if Additional Price List is in use by an Additional Item Price or a Customer. |
Allocation
The Allocation Service provides methods that allow for the retrieval, creation and deletion of Allocations. This service requires authentication.
API | Description |
---|---|
GET Allocation/Get |
Gets a list of Allocations. |
GET Allocation/Get/{id} |
Gets the specified Allocation based on the identifier. |
DELETE Allocation/Delete/{id} |
Deletes the specified Allocation. |
POST Allocation/GetCustomerAllocationsAndOutstandingDocuments |
Gets the customer Allocations and outstanding documents. |
POST Allocation/GetSupplierAllocationsAndOutstandingDocuments |
Gets the supplier Allocations and outstanding documents. |
POST Allocation/Save |
Saves the specified Allocation. |
POST Allocation/SaveBatch |
Saves the batch of Allocations. |
Analysis Category
The Analysis Category Service provides methods that allow for the retrieval, creation and deletion of Analysis Categories. This service requires authentication.
API | Description |
---|---|
GET AnalysisCategory/Get |
Gets a list of Analysis Categories. |
GET AnalysisCategory/Get/{id} |
Gets the specified Analysis Category based on the identifier. |
DELETE AnalysisCategory/Delete/{id} |
Deletes the specified Analysis Category. |
POST AnalysisCategory/Save |
Saves the specified Analysis Category. |
POST AnalysisCategory/AllowDelete |
Confirms if Delete is Allowed. |
Analysis Type
The Analysis Type Service provides methods that allow for the retrieval, creation and deletion of Analysis Types. This service requires authentication.
API | Description |
---|---|
GET AnalysisType/Get |
Retrieves a collection of Analysis Types. |
GET AnalysisType/Get/{id} |
Retrieves a specific Analysis Type. |
DELETE AnalysisType/Delete/{id} |
Deletes a specified Analysis Type. |
POST AnalysisType/Save |
Saves a specified Analysis Type. |
POST AnalysisType/SaveBatch |
Saves a collection of Analysis Types. |
Asset
The Asset Service provides methods that allow for the retrieval, creation and deletion of Assets. This service requires authentication.
API | Description |
---|---|
POST Asset/Save |
Saves a specified Asset. |
GET Asset/Get |
Retrieves a collection of Assets. |
GET Asset/Get/{id} |
Retrieves a specific Asset. |
DELETE Asset/Delete/{id} |
Deletes a specified Asset. |
Asset Category
The Asset Category Service provides methods that allow for the retrieval, creation and deletion of Asset Category. This service requires authentication.
API | Description |
---|---|
POST AssetCategory/Save |
Saves the specified Asset Category. |
GET AssetCategory/Get |
Gets a list of Asset Categories. |
GET AssetCategory/Get/{id} |
Gets the specified Asset Category based on the identifier. |
DELETE AssetCategory/Delete/{id} |
Deletes the specified Asset Category. Only succeeds if the Asset Category is not in use. |
Asset Location
The Asset Location Service provides methods that allow for the retrieval, creation and deletion of Asset Locations. This service requires authentication.
API | Description |
---|---|
POST AssetLocation/Save |
Saves the specified Asset Location. |
GET AssetLocation/Get |
Gets a list of Asset Locations. |
GET AssetLocation/Get/{id} |
Gets the specified Asset Location based on the identifier. |
DELETE AssetLocation/Delete/{id} |
Deletes the specified Asset Location. |
Asset Note
The Asset Note Service provides methods that allow for the creation, retrieval and deletion of Asset Notes. This service requires authentication.
API | Description |
---|---|
POST AssetNote/Save |
Saves the specified Asset Note. |
GET AssetNote/Get |
Gets a list of Asset Notes. |
GET AssetNote/Get/{id} |
Gets the specified Asset Note based on the identifier. |
DELETE AssetNote/Delete/{id} |
Deletes the specified Asset Note. |
Attachment
The Attachment Service provides methods that allow for the retrieval of the Company Storage Information This service requires authentication.
API | Description |
---|---|
GET Attachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
Balance Sheet
The Balance Sheet returns the financial position of your company This service requires authentication.
API | Description |
---|---|
POST BalanceSheet/Get |
Retrieves the Balance Sheet report |
Bank Account
The Bank Account Service provides methods that allow for the retrieval, creation and deletion of Bank Accounts. This service requires authentication.
API | Description |
---|---|
GET BankAccount/Get |
Gets a list of Bank Accounts. |
GET BankAccount/Get/{id} |
Gets the specified Bank Account based on the identifier. |
POST BankAccount/Save |
Saves the specified bank account. |
DELETE BankAccount/Delete/{id} |
Deletes the specified Bank Account. Only succeeds if the Bank Account is not in use. |
POST BankAccount/Validate |
Validates the specified Bank Account. |
Bank Account Category
The Bank Account Category Service provides methods that allow for the retrieval, creation and deletion of Bank Account Categories. This service requires authentication.
API | Description |
---|---|
POST BankAccountCategory/Save |
Saves the specified Bank Account Category. |
GET BankAccountCategory/Get |
Gets a list of Bank Account Categories. |
GET BankAccountCategory/Get/{id} |
Gets the specified Bank Account Category based on the identifier. |
DELETE BankAccountCategory/Delete/{id} |
Deletes the specified Bank Account Category. |
Bank Account Note
The Bank Account Note service provides methods that allow for the retrieval, creation and deletion of Bank Account Notes. This service requires authentication.
API | Description |
---|---|
POST BankAccountNote/Save |
Saves the specified Bank Account Note. |
GET BankAccountNote/Get |
Gets a list of Bank Account Notes. |
GET BankAccountNote/Get/{id} |
Gets the specified Bank Account Note based on the identifier. |
DELETE BankAccountNote/Delete/{id} |
Deletes the specified Bank Account Note. |
Bank Account Note Attachment
The Bank Account Note Attachment Service provides a method that allows for the creation of Bank Account Note Attachments. This service requires authentication.
API | Description |
---|---|
POST BankAccountNoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a BankAccountNoteId is required. A BankAccountNoteId is the ID of the BankAccountNote that this attachment must be linked to. This is Required and is not optional. |
GET BankAccountNoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET BankAccountNoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET BankAccountNoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE BankAccountNoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE BankAccountNoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST BankAccountNoteAttachment/Validate |
Validates the specified Entity. |
Bank Account Opening Balance
The Bank Account Opening Balance Service provides methods that allow for the retrieval and creation of Bank Account Opening Balances. This service requires authentication.
API | Description |
---|---|
POST BankAccountOpeningBalance/Save |
Saves the specified Bank Account Opening Balance. |
GET BankAccountOpeningBalance/Get |
Gets a list of Bank Account Opening Balances. |
GET BankAccountOpeningBalance/Get/{id} |
Gets the specified Bank Account Opening Balance based on the identifier. |
GET BankAccountOpeningBalance/GetByBankAccountId/{id} |
Gets the specified Bank Account Opening Balance based on the BankAccountId. |
Bank Account Transaction Listing
The Bank Account Transaction Listing Service provides methods to get a list of Bank Account Transactions. This service requires authentication.
API | Description |
---|---|
POST BankAccountTransactionListing/GetBankAccountTransactionListingReportingDetail |
Gets the Bank Account Transaction Listing. |
Bank Import Mapping
The Bank Import Mapping Service provides methods that allow for the retrieval, creation and deletion of Bank Import Mappings. This service requires authentication.
API | Description |
---|---|
DELETE BankImportMapping/Delete/{id} |
Deletes the specified Bank Import Mapping. |
GET BankImportMapping/Get |
Gets a list of Bank Import Mappings. |
GET BankImportMapping/Get/{id} |
Gets the specified Bank Import Mapping based on the identifier. |
POST BankImportMapping/Save |
Saves the specified Bank Import Mapping. |
POST BankImportMapping/SaveBatch |
Saves the batch of Bank Import Mappings. |
POST BankImportMapping/DeleteBatch |
Delete the batch of Bank Import Mappings. |
GET BankImportMapping/GetSettings |
Retrieves settings for Bank Import Mappings. |
POST BankImportMapping/SaveSettings |
Saves settings for Bank Import Mappings. |
Bank Statement Transaction
The Bank Statement Transaction Service provides methods that allow for the retrieval of Bank Statement Transactions. This service requires authentication.
API | Description |
---|---|
GET BankStatementTransaction/Get |
Retrieves a collection of Bank Statement Transactions. |
Bank Transaction
The Bank Transaction Service provides methods that allow for the retrieval, creation, and deletion of Bank Transactions This service requires authentication.
API | Description |
---|---|
GET BankTransaction/Get |
Gets a list of Bank Transactions. |
GET BankTransaction/Get/{id} |
Gets the specified Bank Transaction based on the identifier. |
POST BankTransaction/ProcessBankStatementsAsUnacceptedTransactions |
Process Bank Statements As Unaccepted Transactions |
DELETE BankTransaction/Delete/{id} |
Deletes the specified Bank Transaction based on the identifier. |
POST BankTransaction/DeleteBatch |
Deletes the batch of Bank Transactions. |
POST BankTransaction/SaveBatch |
Saves the list of Bank Transactions. |
POST BankTransaction/Save |
Saves the specified Bank Transaction. |
Bank Transaction Attachment
The Bank Transaction Attachment provides methods that allow for the creation of Bank Transaction Attachment. This service requires authentication.
API | Description |
---|---|
POST BankTransactionAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a BankTransactionId is required. A BankTransactionId is the ID of the BankTransaction that this attachment must be linked to. This is Required and is not optional. |
GET BankTransactionAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET BankTransactionAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET BankTransactionAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE BankTransactionAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE BankTransactionAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST BankTransactionAttachment/Validate |
Validates the specified Entity. |
BAS Report
The BAS Report Service provides a method that allows for the retrieval of the BAS Report. This service requires authentication.
API | Description |
---|---|
POST BASReport/Get |
Gets the BAS Report based on the request model. |
Budget
The Budget Service provides methods that allow for the retrieval, creation, deletion and validation of Budgets. This service requires authentication.
API | Description |
---|---|
GET Budget/Get?includeDetail={includeDetail} |
Gets a list of Budgets. |
GET Budget/Get/{id} |
Gets the specified identifier. |
GET Budget/GetBudgetReport/{id}?removeZeroValues={removeZeroValues} |
Gets the budget report. |
POST Budget/GetDefaultBudget |
Gets the default Budget. |
POST Budget/Save |
Saves the specified Budget. |
DELETE Budget/Delete/{id} |
Deletes the specified Budget. |
POST Budget/Validate |
Validates the specified Budget. |
Cash Movement
The Cash Movement Service provides methods that allow for the retrieval of Cash Movements. This service requires authentication.
API | Description |
---|---|
POST CashMovement/Get |
Gets the specified Cash Movement. |
City
The City Service provides methods that allow for the retrieval, creation, deletion and validation of Cities. This service requires authentication.
API | Description |
---|---|
GET City/Get |
Gets a list of Cities. |
GET City/Get/{id} |
Gets the specified identifier. |
Company
The Company Service provides methods that allow for the retrieval of Companies. This service requires authentication.
API | Description |
---|---|
GET Company/Get?includeStatus={includeStatus} | |
GET Company/Get/{id} |
Retrieves a specific Company. |
GET Company/GetUserCompanyCount |
Retrieves a count of the companies the current user owns |
GET Company/Current |
Retrieves the current Company. |
Company Entity Type
The Company Entity Type Service provides methods that allow for the retrieval Company Entity Types This service requires authentication.
API | Description |
---|---|
GET CompanyEntityType/Get |
Gets a list of Company Entity Types. |
GET CompanyEntityType/Get/{id} |
Gets a specified Company's Entity Type based on the identifier. |
Company Note
The Company Note Service provides methods that allow for the retrieval, creation and deletion of Company Notes. This service requires authentication.
API | Description |
---|---|
POST CompanyNote/Save |
Saves the specified Company Note. |
GET CompanyNote/Get |
Gets a list of Company Notes. |
GET CompanyNote/Get/{id} |
Gets the specified Company Note based on the identifier. |
GET CompanyNote/GetCompanyNotes/{id} |
Gets a list of Company Notes. |
DELETE CompanyNote/Delete/{id} |
Deletes the specified Company Note. |
Core Events
API | Description |
---|---|
PUT CoreEvents/Subscribe |
No documentation available. |
Core Tokens
API | Description |
---|---|
DELETE CoreTokens/Delete?token={token} |
No documentation available. |
CRM Activity
The CRMActivity Service provides methods that allow for the retrieval, creation and deletion of CRMActivitys. This service requires authentication.
API | Description |
---|---|
POST CRMActivity/Save |
Saves the specified CRMActivity. |
GET CRMActivity/Get |
Gets a list of CRMActivitys. |
GET CRMActivity/Get/{id} |
Gets the specified CRMActivity based on the identifier. |
DELETE CRMActivity/Delete/{id} |
Deletes the specified CRMActivity. Only succeeds if the CRMActivity is not in use. |
CRM Activity Category
The CRMActivity Category Service provides methods that allow for the retrieval, creation and deletion of CRMActivity Categories. This service requires authentication.
API | Description |
---|---|
POST CRMActivityCategory/Save |
Saves the specified CRMActivity Category. |
GET CRMActivityCategory/Get |
Gets a list of CRMActivity Categories. |
GET CRMActivityCategory/Get/{id} |
Gets the specified CRMActivity Category based on the identifier. |
DELETE CRMActivityCategory/Delete/{id} |
Deletes the specified CRMActivity Category based on the identifier. If the CRMActivity Category is not in use. |
Currency
This service requires authentication.
API | Description |
---|---|
GET Currency/Get |
Get all currencies for the company. |
GET Currency/Get/{id} |
Gets the specified Currency based on the identifier. |
Customer
The Customer Service provides methods that allow for the retrieval, creation and deletion of Customers. This service requires authentication.
API | Description |
---|---|
POST Customer/Save |
Saves the specified Customer. |
GET Customer/Get?includeSalesRepDetails={includeSalesRepDetails} |
Gets a list of Customers. Excludes records where Personal Information was cleared. |
GET Customer/Get/{id} |
Gets the specified Customer based on the identifier. Excludes records where Personal Information was cleared. |
DELETE Customer/Delete/{id} |
Deletes the specified Customer. Only succeeds if the Customer is not in use. |
Customer Additional Contact Detail
The Customer Additional Contact Detail Service provides methods that allow for the retrieval, creation and deletion of Customer Additional Contact Detail. This service requires authentication.
API | Description |
---|---|
DELETE CustomerAdditionalContactDetail/Delete/{id} |
Deletes the specified Customer Additional Contact Detail. |
GET CustomerAdditionalContactDetail/Get |
Gets a list of Customer Additional Contact Details. |
GET CustomerAdditionalContactDetail/Get/{id} |
Gets the specified Customer Additional Contact Detail based on the identifier. |
POST CustomerAdditionalContactDetail/Save |
Saves the specified Customer Additional Contact Detail. |
GET CustomerAdditionalContactDetail/GetAdditionalContactDetails/{id} |
Gets the Additional Contacts Listing for a specific Customer. |
Customer Additional Contact Options
This service requires authentication.
API | Description |
---|---|
GET CustomerAdditionalContactOptions/Get |
No documentation available. |
GET CustomerAdditionalContactOptions/Get/{id} |
No documentation available. |
POST CustomerAdditionalContactOptions/SaveList |
No documentation available. |
Customer Adjustment
The Customer Adjustment Service provides methods that allow for the retrieval and creation of Customer Adjustments. This service requires authentication.
API | Description |
---|---|
GET CustomerAdjustment/Get |
Gets a List of Customer Adjustments. |
GET CustomerAdjustment/Get/{id} |
Gets the specified Customer Adjustment based on the identifier. |
POST CustomerAdjustment/Save |
Saves the specified Customer Adjustment. |
POST CustomerAdjustment/Calculate |
Calculates the specified Customer Adjustment total fields. |
Customer Ageing
The Customer Ageing Service provides methods that allow for the retrieval of Customer Ageing statements. This service requires authentication.
API | Description |
---|---|
POST CustomerAgeing/GetSummary |
Gets the specified Customer Ageing Summary statement based on the request. |
POST CustomerAgeing/GetDetail |
Gets a list of Customer Ageing statements based on the request. |
Customer Category
The Customer Category Service provides methods that allow for the retrieval, creation and deletion of Customer Categories. This service requires authentication.
API | Description |
---|---|
POST CustomerCategory/Save |
Saves the specified Customer Category. |
GET CustomerCategory/Get |
Gets a list of Customer Categories. |
GET CustomerCategory/Get/{id} |
Gets the specified Customer Category based on the identifier. |
DELETE CustomerCategory/Delete/{id} |
Deletes the specified Customer Category based on the identifier. If the Customer Category is not in use. |
Customer Note
The Customer Note Service provides methods that allow for the retrieval, creation and deletion of Customer Notes. This service requires authentication.
API | Description |
---|---|
POST CustomerNote/Save |
Saves the specified Customer Note. |
GET CustomerNote/Get |
Gets a list of Customer Notes. |
GET CustomerNote/Get/{id} |
Gets the specified Customer Note based on the identifier. |
DELETE CustomerNote/Delete/{id} |
Deletes the specified Customer Note |
Customer Note Attachment
The Customer Note Attachment Service provides methods that allow for the retrieval of Customer Note Attachments. This service requires authentication.
API | Description |
---|---|
POST CustomerNoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a CustomerNoteId is required. A CustomerNoteId is the ID of the CustomerNote that this attachment must be linked to. This is Required and is not optional. |
GET CustomerNoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET CustomerNoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET CustomerNoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE CustomerNoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE CustomerNoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST CustomerNoteAttachment/Validate |
Validates the specified Entity. |
Customer Opening Balance
The Customer Opening Balance Service provides methods that allow for the retrieval and creation of Customer Opening Balance. This service requires authentication.
API | Description |
---|---|
POST CustomerOpeningBalance/Save |
Saves the specified Customer Opening Balance. |
GET CustomerOpeningBalance/Get |
Gets a list of Customer Opening Balances. |
GET CustomerOpeningBalance/Get/{id} |
Gets the specified Customer Opening Balance based on the identifier. |
GET CustomerOpeningBalance/GetByCustomerId/{id} |
Gets the specified Customer Opening Balance based on the CustomerId. |
Customer Receipt
The Customer Receipt Service provides methods that allow for the retrieval and saving of Customer Receipts This service requires authentication.
API | Description |
---|---|
GET CustomerReceipt/Get?includeCustomerDetails={includeCustomerDetails}&includeBankAccountDetails={includeBankAccountDetails} |
Gets a list of Customer Receipts. |
GET CustomerReceipt/Get/{id} |
Gets the specified Customer Receipt based on the identifier. |
POST CustomerReceipt/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Customer Receipt. |
GET CustomerReceipt/Export/{id} |
Gets a Customer Receipt generated as a PDF. |
POST CustomerReceipt/Delete/{id} |
Deletes the specified Customer Receipt based on the identifier. If the Customer Receipt is not in use. |
Customer Return
The Customer Return Service provides methods that allow for the retrieval, creation, and deletion of Customer Returns. This service requires authentication.
API | Description |
---|---|
GET CustomerReturn/Get?includeDetail={includeDetail}&includeCustomerDetails={includeCustomerDetails} |
Gets a list of Customer Returns. |
GET CustomerReturn/Get/{id} |
Gets the specified Customer Return based on the identifier. |
POST CustomerReturn/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Customer Return. |
POST CustomerReturn/Calculate |
Calculates the specified Customer Return total fields. |
POST CustomerReturn/Email |
Emails the specified Customer Return. |
GET CustomerReturn/Export/{id} |
Downloads a copy of a Customer Return as a PDF file. |
Customer Return Attachment
The Customer Return Attachment provides methods that allow attachments for customer returns. This service requires authentication.
API | Description |
---|---|
POST CustomerReturnAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the CustomerReturn that this attachment must be linked to. This is Required and is not optional. |
GET CustomerReturnAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET CustomerReturnAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET CustomerReturnAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE CustomerReturnAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE CustomerReturnAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST CustomerReturnAttachment/Validate |
Validates the specified Entity. |
Customer Sales History
The Customer Sales History service returns the sales history for customers. This service requires authentication.
API | Description |
---|---|
POST CustomerSalesHistory/Get |
Gets the specified Customer Sales History. |
Customer Statement
The Customer Statement Service provides a method that allows for the retrieval of a Customer Statement. This service requires authentication.
API | Description |
---|---|
POST CustomerStatement/Get |
Gets a Customer Statement based on the request model. |
POST CustomerStatement/Export |
Export a customer statement as a PDF. This is sent as an application/octet-stream |
Customer Transaction Listing
The Customer Transaction Listing Service provides methods to get a list of Customer Transactions. This service requires authentication.
API | Description |
---|---|
POST CustomerTransactionListing/GetCustomerTransactionListingReportingDetail |
Gets the Customer Transaction Listing. |
Customer Write Off
The Customer Write Off Service provides methods that allow for the retrieval and creation of Customer Write Offs. This service requires authentication.
API | Description |
---|---|
GET CustomerWriteOff/Get |
Gets a List of Customer Write Offs. |
POST CustomerWriteOff/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Customer Write Off. |
Customer Zone
This service requires authentication.
API | Description |
---|---|
POST CustomerZone/GetCustomerZoneInvoiceUrl |
Gets the Customer Zone URL of a specified Invoice |
POST CustomerZone/GetCustomerZoneQuoteUrl |
Gets the Customer Zone URL of a specified Quote |
Dashboard Debtors Manager
This service requires authentication.
API | Description |
---|---|
GET DashboardDebtorsManager/GetDashboardTiles |
No documentation available. |
GET DashboardDebtorsManager/GetDashboardReminders |
No documentation available. |
GET DashboardDebtorsManager/GetLongestOverdue |
No documentation available. |
Date Format
The Date Format Service provides methods that allow for the retrieval of the different Date Formats This service requires authentication.
API | Description |
---|---|
GET DateFormat/Get |
Gets a list of Date Formats. |
GET DateFormat/Get/{id} |
Gets a specified Date Format. |
Detailed Ledger Transaction
The Detailed Ledger Service provides methods that allow for the retrieval of Detailed Ledger Transactions. This service requires authentication.
API | Description |
---|---|
POST DetailedLedgerTransaction/Get |
Retrieves a collection of Detailed Ledger Transactions |
Developer Data
This service requires authentication.
API | Description |
---|---|
POST DeveloperData/SaveUserData |
No documentation available. |
POST DeveloperData/SaveRegistrationData |
No documentation available. |
POST DeveloperData/SaveCompanyData |
No documentation available. |
GET DeveloperData/GetUserData |
No documentation available. |
GET DeveloperData/GetUserData/{id} |
No documentation available. |
GET DeveloperData/GetRegistrationData |
No documentation available. |
GET DeveloperData/GetRegistrationData/{id} |
No documentation available. |
GET DeveloperData/GetCompanyData |
No documentation available. |
GET DeveloperData/GetCompanyData/{id} |
No documentation available. |
DELETE DeveloperData/DeleteUserData/{id} |
No documentation available. |
DELETE DeveloperData/DeleteRegistrationData/{id} |
No documentation available. |
DELETE DeveloperData/DeleteCompanyData/{id} |
No documentation available. |
Document File Attachment
This service requires authentication.
API | Description |
---|---|
POST DocumentFileAttachment/GetWithFilter |
No documentation available. |
DELETE DocumentFileAttachment/Delete |
No documentation available. |
Document Header Note
The Document Header Note Service provides methods that allow for the retrieval and creation of Document Header Notes. This service requires authentication.
API | Description |
---|---|
POST DocumentHeaderNote/Save |
Saves the specified Document Header Note. |
GET DocumentHeaderNote/Get |
Gets a list of Document Header Notes. |
GET DocumentHeaderNote/Get/{id} |
Gets the specified Document Header Note based on the identifier. |
Document History
The Document History controller returns the history for a transaction This service requires authentication.
API | Description |
---|---|
GET DocumentHistory/Get?documentHeaderId={documentHeaderId}&documentTypeId={documentTypeId} |
Gets the specified Transactions Document History. |
Document Message
The Document Message Service provides methods that allow for the retrieval of Document Messages. This service requires authentication.
API | Description |
---|---|
GET DocumentMessage/Get |
Gets a List of Document Messages. |
GET DocumentMessage/Get/{id} |
Gets the specified Document Message based on the identifier. |
POST DocumentMessage/Save |
Saves the specified Customer. |
Document Number
The Document Number Service provides methods that allow for the retrieval and updating of Document Number. This service requires authentication.
API | Description |
---|---|
GET DocumentNumber/Get |
Gets a List of Document Numbers. |
GET DocumentNumber/Get/{id} |
Gets the specified Document Number based on the identifier. |
POST DocumentNumber/Save |
Updates existing Document Number. |
Document User Defined Fields
The Document User Defined Field Service provides methods that allow for the retrieval of Document User Defined Fields. This service requires authentication.
API | Description |
---|---|
GET DocumentUserDefinedFields/Get |
Gets a list of Document User Defined Fields |
GET DocumentUserDefinedFields/GetEntries |
Gets a list of Document User Defined Field Entries |
GET DocumentUserDefinedFields/GetEntryByDocumentId?documentId={documentId} |
Gets a specific Document User Defined Field Entry |
POST DocumentUserDefinedFields/Save |
Saves a specific Document User Defined Field Entry |
Email Signature Template
The Email Signature Template Service provides methods that allow for the retrieval, deletion, saving of Email Signature Templates. Additional methods assist in confirming if Email Templates are in use. This service requires authentication.
API | Description |
---|---|
DELETE EmailSignatureTemplate/Delete/{id} |
Deletes the specified Email Signature based on the identifier. |
GET EmailSignatureTemplate/Get?includeDefaults={includeDefaults} |
Gets a list of the Email Signature Templates. |
GET EmailSignatureTemplate/Get/{id} |
Gets the Email Signature Template based on the identifier. |
GET EmailSignatureTemplate/EmailSignatureTemplateInUse/{id} |
Checks if the Email Signature Template based on the identifier is currently being used. |
POST EmailSignatureTemplate/Save |
Saves the specified Email Signature Template. |
GET EmailSignatureTemplate/GetPopulatedSignatureByDocumentId/{id} |
Gets the default Email Signature Template with placeholders replaced. |
Email Template Place Holder
The Email Template Place Holder Service provides a method that allows for the retrieval of the Email Template Place Holders. This service requires authentication.
API | Description |
---|---|
GET EmailTemplatePlaceHolder/Get |
Gets a list of Email Template Place Holders. |
Exchange Rates
This service requires authentication.
API | Description |
---|---|
GET ExchangeRates/Get?date={date}¤cyIds={currencyIds} |
Gets the Exchange Rates for the Date and comma seperated Currency IDs (if supplied). If not it returns all currencies with today's exchange rate. |
Final Accounts
This service requires authentication.
API | Description |
---|---|
GET FinalAccounts/Get?accountId={accountId} |
No documentation available. |
GET FinalAccounts/Get |
No documentation available. |
GET FinalAccounts/GetByCompanyId?companyId={companyId} |
No documentation available. |
POST FinalAccounts/Delete?accountId={accountId} |
No documentation available. |
POST FinalAccounts/DeleteBatch |
No documentation available. |
POST FinalAccounts/LinkToFinalAccountsOnlineByCompanyId?companyId={companyId} |
No documentation available. |
POST FinalAccounts/LinkToFinalAccountsOnline |
No documentation available. |
Financial Year
The Financial Year Service provides methods that allow for the retrieval and updating of Financial Years. This service requires authentication.
API | Description |
---|---|
GET FinancialYear/Get |
Gets a list of Financial Years. |
GET FinancialYear/Get/{id} |
Gets a specific Financial Year based on the identifier sent through. |
GET FinancialYear/GetCurrent |
Gets the current Financial Year. |
POST FinancialYear/Save |
Saves the specified Financial Year. |
POST FinancialYear/AddNextFinancialYear |
Adds the next Financial Year after the provided Financial Year if possible. |
DELETE FinancialYear/Delete/{id} |
Deletes the specified Financial Year based on the identifier. |
Income Vs Expense
The Income Vs Expense service provides methods that allow for the retrieval of Income Vs Expense models. This service requires authentication.
API | Description |
---|---|
POST IncomeVsExpense/Get |
Gets the specified Item Category based on the identifier. |
Item
The Item Service provides methods that allow for the retrieval, creation and deletion of Items. This service requires authentication.
API | Description |
---|---|
GET Item/Get?includeAdditionalItemPrices={includeAdditionalItemPrices}&includeAttachments={includeAttachments} |
Gets a list of Items. |
GET Item/Get/{id} |
Gets the specified Item based on the identifier. |
POST Item/Save |
Saves the specified Item. |
DELETE Item/Delete/{id} |
Deletes the specified Item based on the identifier. If the Item is not in use. |
Item Adjustment
The Item Adjustment Service provides methods to get a list of Item Adjustments, get a specific Item Adjustment and to Save an Item Adjustment. This service requires authentication.
API | Description |
---|---|
GET ItemAdjustment/Get |
Gets a list of Item Adjustments. |
GET ItemAdjustment/Get/{id} |
Gets the specified Item Adjustment based on the identifier sent through. |
POST ItemAdjustment/Save |
Saves a Item Adjustment based on the Item Adjustment object sent through. |
Item Attachment
The Item Attachment Service provides methods that allow for the retrieval, creation, download and deletion of Item Attachments. This service requires authentication.
API | Description |
---|---|
GET ItemAttachment/Get/{id} |
Gets a list of Item Attachments for the specified Item. |
GET ItemAttachment/Download/{id} |
Downloads the specified Item Attachment based on file identifier (GUID). |
GET ItemAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
POST ItemAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a ItemId is required. An ItemId is the ID of the Item that this attachment must be linked to. This is Required and is not optional. |
DELETE ItemAttachment/Delete/{id} |
Deletes the specified Item Attachment based on file identifier (GUID). |
POST ItemAttachment/Validate |
Validates the specified Item. |
Item Bundle
The Item Bundle Service provides methods to get a list of Item Bundles, a specific Item Bundle, saving of a specific Item Bundle, deletion of a specific Item Bundle. This service requires authentication.
API | Description |
---|---|
GET ItemBundle/Get/{id} |
Gets a specific Item Bundle based on the identifier. |
GET ItemBundle/Get?includeDetail={includeDetail} |
Gets a list of Item Bundles. |
POST ItemBundle/Save |
Saves the specified Item Bundle. |
DELETE ItemBundle/Delete/{id} |
Deletes the specified Item Bundle. |
Item Category
The Item Category Service provides methods that allow for the retrieval, creation and deletion of Item Categories. This service requires authentication.
API | Description |
---|---|
POST ItemCategory/Save |
Saves the specified Item Category. |
GET ItemCategory/Get |
Gets a list of Item Categories. |
GET ItemCategory/Get/{id} |
Gets the specified Item Category based on the identifier. |
DELETE ItemCategory/Delete/{id} |
Deletes the specified Item Category based on the identifier. If the Item Category is not in use. |
Item Movement
The Item Movement Service provides methods that allow for the retrieval of Item Movement Transactions. This service requires authentication.
API | Description |
---|---|
POST ItemMovement/Get |
Retrieves a collection of Item Movement Transactions |
Item Note
The Item Note Service provides methods that allow for the retrieval, deletion, saving of Item Notes This service requires authentication.
API | Description |
---|---|
POST ItemNote/Save |
Saves the specified Item Note. |
GET ItemNote/Get |
Gets a list of all the Item Notes. |
GET ItemNote/Get/{id} |
Gets the specified Item Note based on the identifier. |
DELETE ItemNote/Delete/{id} |
Deletes the specified Item Note based on the identifier. |
Item Note Attachment
The Item Note Attachment Service provides a method that allows for the creation of Item Note Attachments. This service requires authentication.
API | Description |
---|---|
POST ItemNoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. An ItemNoteId is the ID of the ItemNote that this attachment must be linked to. This is Required and is not optional. |
GET ItemNoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET ItemNoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET ItemNoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE ItemNoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE ItemNoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST ItemNoteAttachment/Validate |
Validates the specified Entity. |
Item Opening Balance
The Item Opening Balance Service provides methods that allow for the retrieval and creation of Item Opening Balance. This service requires authentication.
API | Description |
---|---|
POST ItemOpeningBalance/Save |
Saves the specified Item Opening Balance. |
GET ItemOpeningBalance/Get |
Gets a list of Opening Balances. |
GET ItemOpeningBalance/Get/{id} |
Gets the specified Opening Balance based on the identifier. |
GET ItemOpeningBalance/GetByItemId/{id} |
Gets the specified Opening Balance based on the ItemId. |
Item Report Group
The Item Report Group Service provides methods that allow for the retrieval and deletion of Item Report Groups. This service requires authentication.
API | Description |
---|---|
DELETE ItemReportGroup/Delete/{id} |
Deletes a specified Item Report Group. |
GET ItemReportGroup/Get |
Retrieves a collection of Item Report Groups. |
GET ItemReportGroup/Get/{id} |
Retrieves a specific Item Report Group. |
POST ItemReportGroup/Save |
Saves the specified Item Report Group. |
Journal Entry
The Journal Entry Service provides methods to get a list of Journal Entries, a specific Journal Entry, saving of a specific Journal Entry, saving of a batch of Journal Entries and a method to calculate the totals of the Journal Entry. This service requires authentication.
API | Description |
---|---|
GET JournalEntry/Get |
Gets a list of Journal Entries. |
GET JournalEntry/Get/{id} |
Gets a specific Journal Entry based on the identifier sent through. |
DELETE JournalEntry/DeleteOpenBatchJournalTransaction/{id} |
No documentation available. |
POST JournalEntry/Save |
Saves the specified Journal Entry. |
POST JournalEntry/SaveBatch |
Saves a batch of Journal Entries. |
POST JournalEntry/Calculate |
Calculates the totals of the Journal Entry sent through. |
DELETE JournalEntry/Delete/{id} |
Deletes the specified Journal Entry. |
POST JournalEntry/DeleteBatch |
Deletes the batch of Journal Entry. |
Localization
This service requires authentication.
API | Description |
---|---|
POST Localization/Get |
No documentation available. |
Login
The Login Service provides a method that allows for the validation of user login credentials.
API | Description |
---|---|
POST Login/Validate |
Validate the user credentials based on the Authentication Credentials request model. |
Outstanding Customer Document
The Outstanding Customer Document Service provides methods that allow for the retrieval of Outstanding Customer Documents. This service requires authentication.
API | Description |
---|---|
POST OutstandingCustomerDocument/Get |
Gets a list of Outstanding Customer Documents based on the request. |
Outstanding Supplier Document
The Outstanding Supplier Document Service provides a method that allows for the retrieval of Outstanding Supplier Documents. This service requires authentication.
API | Description |
---|---|
POST OutstandingSupplierDocument/Get |
Gets a list of Outstanding Supplier Documents based on the request model. |
Payroll
API | Description |
---|---|
POST Payroll/ReceivePayrollWebhook |
No documentation available. |
Price Listing Report
This service requires authentication.
API | Description |
---|---|
POST PriceListingReport/Get |
No documentation available. |
Process Bank And Credit Card Mapping
The Process Bank and Credit Card Mapping Service provides methods that allow for the retrieval, creation and deletion of Process Bank And Credit Card Mappings. This service requires authentication.
API | Description |
---|---|
DELETE ProcessBankAndCreditCardMapping/Delete/{id} |
Deletes a specified Process Bank and Credit Card Mapping. |
GET ProcessBankAndCreditCardMapping/Get |
Retrieves a collection of Process Bank and Credit Card Mappings. |
GET ProcessBankAndCreditCardMapping/Get/{id} |
Retrieves a specific Process Bank and Credit Card Mapping. |
POST ProcessBankAndCreditCardMapping/Save |
Saves a specified Process Bank and Credit Card Mapping. |
POST ProcessBankAndCreditCardMapping/SaveBatch |
Saves a collection of Process Bank and Credit Card Mappings. |
POST ProcessBankAndCreditCardMapping/DeleteBatch |
Deletes a collection of Process Bank and Credit Card Mappings. |
GET ProcessBankAndCreditCardMapping/GetSettings |
Retrieves settings for Process Bank and Credit Card Mappings. |
POST ProcessBankAndCreditCardMapping/SaveSettings |
Saves settings for Process Bank and Credit Card Mappings. |
Profit And Loss
The Profit And Loss Statement service provides methods that allow for the retrieval of Profit And Loss Reports. This service requires authentication.
API | Description |
---|---|
POST ProfitAndLoss/Get |
Retrieves a Profit And Loss report. |
Purchase Order
The Purchase Order Service provides methods that allow for the retrieval and creation of Purchase Orders. Additional methods assist in calculating the total values of a Purchase Order and emailing Purchase Orders. This service requires authentication.
API | Description |
---|---|
GET PurchaseOrder/Get?includeDetail={includeDetail}&includeSupplierDetails={includeSupplierDetails} |
Gets a list of Purchase Orders. |
GET PurchaseOrder/Get/{id} |
Gets the specified Purchase Order based on the identifier. |
POST PurchaseOrder/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Purchase Order. |
POST PurchaseOrder/Calculate |
Calculates the specified Purchase Order total fields. |
DELETE PurchaseOrder/Delete/{id} |
Gets the specified Purchase Order based on the identifier. |
GET PurchaseOrder/Export/{id} |
Downloads a copy of a Purchase Order as a PDF file. |
POST PurchaseOrder/Email |
Emails the specified Purchase Order. |
Purchase Order Attachment
The Purchase Order Attachment provides methods that allow attachments for purchase orders. This service requires authentication.
API | Description |
---|---|
POST PurchaseOrderAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the PurchaseOrder that this attachment must be linked to. This is Required and is not optional. |
GET PurchaseOrderAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET PurchaseOrderAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET PurchaseOrderAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE PurchaseOrderAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE PurchaseOrderAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST PurchaseOrderAttachment/Validate |
Validates the specified Entity. |
Purchases By Item
The Purchases By Item Service provides methods that allow for the retrieval of Purchases by Item. This service requires authentication.
API | Description |
---|---|
POST PurchasesByItem/Get |
Gets the specified request. |
Quote
The Quote Service provides methods that allow for the creation, retrieval and deletion of Quotes. Additional methods assist in calculating the total values of a Quote, emailing Quotes and summary views of Quotes. This service requires authentication.
API | Description |
---|---|
GET Quote/Get?includeDetail={includeDetail}&includeCustomerDetails={includeCustomerDetails} |
Gets a list of quotes. |
GET Quote/Get/{id} |
Gets the specified Quote based on the identifier. |
POST Quote/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Quote. |
POST Quote/Calculate |
Calculates the totals for the Quote, based on the document lines. |
GET Quote/Summary |
Summarize the information on all the outstanding quotes for all customers. |
GET Quote/Summary/{id} |
Summarize the information on all the outstanding quotes for a Customer based on the identifier passed through. |
DELETE Quote/Delete/{id} |
Deletes the specified Quote based on the identifier. |
POST Quote/Email |
Emails the specified Quote based on the Email Request Model sent through. |
GET Quote/Export/{id} |
Downloads a copy of a Quote as a PDF file. |
Quote Attachment
The Quote Attachment provides methods that allow attachments for quotes. This service requires authentication.
API | Description |
---|---|
POST QuoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the Quote that this attachment must be linked to. This is Required and is not optional. |
GET QuoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET QuoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET QuoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE QuoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE QuoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST QuoteAttachment/Validate |
Validates the specified Entity. |
Recurring Invoice
This service requires authentication.
API | Description |
---|---|
GET RecurringInvoice/Get?includeDetail={includeDetail} |
Gets a list of Recurring Invoices. |
GET RecurringInvoice/Get/{id} |
Gets the specified Recurring Invoice based on the identifier. |
POST RecurringInvoice/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified recurring Invoice. |
POST RecurringInvoice/Delete/{id} |
Deletes the specified Recurring Invoice based on the identifier. If the Recurring Invoice is not in use. |
Recurring Journal
The Recurring Journal Service provides methods to get a list of Recurring Journals, a specific Recurring Journal, saving of a specific Recurring Journal, deletion of a specific Recurring Journal. This service requires authentication.
API | Description |
---|---|
GET RecurringJournal/Get/{id} |
Gets a specific Recurring Journal based on the identifier. |
GET RecurringJournal/Get?includeDetail={includeDetail} |
Gets a list of Recurring Journals. |
POST RecurringJournal/Save |
Saves the specified Recurring Journal. |
POST RecurringJournal/RunRecurrenceNow |
Runs the active Recurring Journal's Recurrence and creates the Journal Entries and Open Batch Journals if valid. |
GET RecurringJournal/SkipRecurrenceNextRunDate/{id} |
Skips the current Next Run Date of the Recurring Journal Recurrence without processing new Journal Entries or Open Batch Journals. |
DELETE RecurringJournal/Delete/{id} |
Deletes the specified Recurring Journal. |
POST RecurringJournal/DeleteBatch |
Deletes the batch of Recurring Journal Entries. |
Reporting Group
The Reporting Group Service provides a method that allows for the retrieval of Reporting Groups. This service requires authentication.
API | Description |
---|---|
GET ReportingGroup/Get |
Gets a list of Reporting Groups. |
Sales By Item
The Sales By Item Service provides methods that allow for the retrieval of Sales by Item. This service requires authentication.
API | Description |
---|---|
POST SalesByItem/Get |
Gets the specified request. |
Sales By Sales Representative
The Sales by Sales Representative Service provides methods that allow for the retrieval of Sales by Sales Representatives. This service requires authentication.
API | Description |
---|---|
POST SalesBySalesRepresentative/Get |
Gets a List of Sales by Sales Representatives. |
Sales Order
The Sales Order Service provides methods that allow for the creation, retrieval and deletion of Sales Orders. Additional methods assist in calculating the total values of a Sales Order, emailing Sales Orders and summary views of Sales Orders. This service requires authentication.
API | Description |
---|---|
GET SalesOrder/Get?includeDetail={includeDetail}&includeCustomerDetails={includeCustomerDetails} |
Gets a list of sales orders. |
GET SalesOrder/Get/{id} |
Gets the specified SalesOrder based on the identifier. |
POST SalesOrder/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Sales Order. |
POST SalesOrder/Calculate |
Calculates the totals for the Sales Order, based on the document lines. |
DELETE SalesOrder/Delete/{id} |
Deletes the specified Sales Order based on the identifier. |
POST SalesOrder/Email |
Emails the specified Sales Order based on the Email Request Model sent through. |
GET SalesOrder/Export/{id} |
Downloads a copy of a Sales Order as a PDF file. |
Sales Order Attachment
The Sales Order Attachment provides methods that allow attachments for sales orders. This service requires authentication.
API | Description |
---|---|
POST SalesOrderAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the Sales Order that this attachment must be linked to. This is Required and is not optional. |
GET SalesOrderAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET SalesOrderAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET SalesOrderAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE SalesOrderAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE SalesOrderAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST SalesOrderAttachment/Validate |
Validates the specified Entity. |
Sales Representative
The Sales Representative Service provides methods that allow for the retrieval, deletion, saving, activity check of Sales Representatives. This service requires authentication.
API | Description |
---|---|
POST SalesRepresentative/Save |
Saves the specified Sales Representative. |
GET SalesRepresentative/Get |
Gets a list of Sales Representatives. |
GET SalesRepresentative/Get/{id} |
Gets the specified Sales Representative based on the identifier. |
DELETE SalesRepresentative/Delete/{id} |
Deletes the specified Sales Representative based on the identifier. |
GET SalesRepresentative/HasActivity/{id} |
Determines whether the specified Sales Representative has activity. |
Sales Representative Note
The Sales Representative Note Service provides methods that allow for the retrieval, creation and deletion of Sales Representative Notes. This service requires authentication.
API | Description |
---|---|
POST SalesRepresentativeNote/Save |
Saves the specified Sales Representative Note. |
GET SalesRepresentativeNote/Get |
Gets a list of Sales Representative Notes. |
GET SalesRepresentativeNote/Get/{id} |
Gets the specified Sales Representative Note based on the identifier. |
GET SalesRepresentativeNote/RefreshHasAttachments/{id} |
Refreshes Has Attachment status of the specified Sales Representative Note based on the identifier. |
DELETE SalesRepresentativeNote/Delete/{id} |
Deletes the specified Sales Representative Note based on the identifier. |
Schedule Frequency
The Schedule Frequency Service provides methods that allow for the retrieval of Schedule Frequencies. This service requires authentication.
API | Description |
---|---|
GET ScheduleFrequency/Get |
Retrieves a collection of Schedule Frequencies. |
Secretarial Company Role
The Secretarial Company Role Service provides methods that allow for the retrieval and deletion of Secretarial Company Roles This service requires authentication.
API | Description |
---|---|
DELETE SecretarialCompanyRole/Delete/{id} |
Deletes the specified Secretarial Company Role based on the identifier. |
GET SecretarialCompanyRole/Get |
Gets a list of all the Secretarial Company Roles. |
GET SecretarialCompanyRole/Get/{id} |
Gets the specified Secretarial Company Role based on the identifier. |
Secretarial Share Class
The Secretarial Share Class Service provides methods that allow for the retrieval and deletion of Secretarial Share Classes. This service requires authentication.
API | Description |
---|---|
DELETE SecretarialShareClass/Delete/{id} |
Deletes the specified Secretarial Share Class based on the identifier. If the Secretarial Share Class is not in use. |
GET SecretarialShareClass/Get |
Gets a list of Secretarial Share Classes. |
Secretarial Shareholder
The Secretarial Shareholder Service provides methods that allow for the retrieval of Secretarial Shareholders. This service requires authentication.
API | Description |
---|---|
GET SecretarialShareholder/Get |
Gets a list of Secretarial Shareholders. |
Secretarial Stake Holder
The Secretarial Stake Holder Service provides methods that allow for the retrieval and deletion of Secretarial Stake Holders. This service requires authentication.
API | Description |
---|---|
DELETE SecretarialStakeHolder/Delete/{id} |
Deletes the specified Secretarial Stake Holder. |
GET SecretarialStakeHolder/Get |
Gets a list of Secretarial Stake Holders. |
Supplier
The Supplier Service provides methods that allow for the retrieval, creation and deletion of Suppliers. This service requires authentication.
API | Description |
---|---|
POST Supplier/Save |
Saves the specified Supplier. |
GET Supplier/Get |
Gets a List of Suppliers. Excludes records where Personal Information was cleared. |
GET Supplier/Get/{id} |
Gets the specified Supplier based on the identifier. Excludes records where Personal Information was cleared. |
DELETE Supplier/Delete/{id} |
Deletes the specified Supplier, when not in use. |
Supplier Additional Contact Detail
The Supplier Additional Contact Detail Service provides methods that allow for the retrieval, creation and deletion of Supplier Additional Contact Detail. This service requires authentication.
API | Description |
---|---|
DELETE SupplierAdditionalContactDetail/Delete/{id} |
Deletes the specified Supplier Additional Contact Detail. |
GET SupplierAdditionalContactDetail/Get |
Gets a list of Supplier Additional Contact Details. |
GET SupplierAdditionalContactDetail/Get/{id} |
Gets the specified Supplier Additional Contact Detail based on the identifier. |
POST SupplierAdditionalContactDetail/Save |
Saves the specified Supplier Additional Contact Detail. |
GET SupplierAdditionalContactDetail/GetAdditionalContactDetails/{id} |
Gets the Additional Contacts listing for a specific Supplier. |
Supplier Adjustment
The Supplier Adjustment Service provides methods that allow for the retrieval and creation of Supplier Adjustment. Additional methods assist in calculating the total values of a Supplier Adjustment. This service requires authentication.
API | Description |
---|---|
GET SupplierAdjustment/Get |
Gets a list of Supplier Adjustments. |
GET SupplierAdjustment/Get/{id} |
Gets the specified Supplier Adjustment based on the identifier. |
POST SupplierAdjustment/Save |
Saves the specified Supplier Adjustment object. |
POST SupplierAdjustment/Calculate |
Calculates the total, exclusive, tax and inclusive value of the Supplier Adjustment for the Document Header. |
Supplier Ageing
The Supplier Ageing Service provides methods that allow for the retrieval of Supplier Ageing statements. This service requires authentication.
API | Description |
---|---|
POST SupplierAgeing/GetSummary |
Gets the specified Supplier Ageing Summary statement based on the request. |
POST SupplierAgeing/GetDetail |
Gets a list of Supplier Ageing statements based on the request. |
Supplier Bank Detail
The Supplier Bank Detail Service provides methods that allow for the retrieval, creation and deletion of Supplier Bank Details. This service requires authentication.
API | Description |
---|---|
POST SupplierBankDetail/Save |
Saves the specified Supplier Bank Detail. |
GET SupplierBankDetail/Get |
Gets a List of Supplier Bank Details. |
GET SupplierBankDetail/Get/{id} |
Gets the specified Supplier Bank Detail based on the identifier. |
DELETE SupplierBankDetail/Delete/{id} |
Deletes the specified Supplier Bank Detail, when not in use. |
Supplier Category
The Supplier Category Service provides methods that allow for the retrieval, creation and deletion of Supplier Categories. This service requires authentication.
API | Description |
---|---|
POST SupplierCategory/Save |
Saves the specified Supplier Category. |
GET SupplierCategory/Get |
Gets a list of Supplier Categories. |
GET SupplierCategory/Get/{id} |
Gets the specified Supplier Category based on the identifier. |
DELETE SupplierCategory/Delete/{id} |
Deletes the specified Supplier Category. Only succeeds if the Supplier Category is not in use. |
Supplier Invoice
The Supplier Invoice Service provides methods that allow for the retrieval, creation, calculation and email of Supplier Invoices. This service requires authentication.
API | Description |
---|---|
GET SupplierInvoice/Get?includeDetail={includeDetail}&includeSupplierDetails={includeSupplierDetails} |
Gets a list of Supplier Invoices. |
GET SupplierInvoice/Get/{id} |
Gets the specified Supplier Invoice based on the identifier. |
POST SupplierInvoice/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Supplier Invoice. |
POST SupplierInvoice/Calculate |
Calculates the specified Supplier Invoice. |
POST SupplierInvoice/Email |
Emails the specified Supplier Invoice. |
GET SupplierInvoice/Export/{id} |
Downloads a copy of a Supplier Invoice as a PDF file. |
Supplier Invoice Attachment
The Supplier Invoice Attachment provides methods that allow attachments for supplier invoices. This service requires authentication.
API | Description |
---|---|
POST SupplierInvoiceAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the SupplierInvoice that this attachment must be linked to. This is Required and is not optional. |
GET SupplierInvoiceAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET SupplierInvoiceAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET SupplierInvoiceAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE SupplierInvoiceAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE SupplierInvoiceAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST SupplierInvoiceAttachment/Validate |
Validates the specified Entity. |
Supplier Note
The Supplier Note service provides methods that allow for the retrieval, creation and deletion of Supplier Notes. This service requires authentication.
API | Description |
---|---|
POST SupplierNote/Save |
Saves the specified Supplier Note. |
GET SupplierNote/Get |
Gets a list of Supplier Notes. |
GET SupplierNote/Get/{id} |
Gets the specified Supplier Note based on the identifier. |
DELETE SupplierNote/Delete/{id} |
Deletes the specified Supplier Note. |
Supplier Note Attachment
The Supplier Note Attachment Service provides a method that allows for the creation of Supplier Note Attachments. This service requires authentication.
API | Description |
---|---|
POST SupplierNoteAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a SupplierNoteId is required. A SupplierNoteId is the ID of the SupplierNote that this attachment must be linked to. This is Required and is not optional. |
GET SupplierNoteAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET SupplierNoteAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET SupplierNoteAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE SupplierNoteAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE SupplierNoteAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST SupplierNoteAttachment/Validate |
Validates the specified Entity. |
Supplier Opening Balance
The Supplier Opening Balance Service provides methods that allow for the retrieval and creation of Supplier Opening Balances. This service requires authentication.
API | Description |
---|---|
POST SupplierOpeningBalance/Save |
Saves the specified Supplier Opening Balance. |
GET SupplierOpeningBalance/Get |
Gets a list of Supplier Opening Balances. |
GET SupplierOpeningBalance/Get/{id} |
Gets the specified Supplier Opening Balance based on the identifier. |
GET SupplierOpeningBalance/GetBySupplierId/{id} |
Gets the specified Supplier Opening Balance based on the SupplierId. |
Supplier Payment
The Supplier Payment Service provides methods that allow for the retrieval and creation of Supplier Payments. This service requires authentication.
API | Description |
---|---|
GET SupplierPayment/Get?includeSupplierDetails={includeSupplierDetails}&includeBankAccountDetails={includeBankAccountDetails} |
Gets a list of Supplier Payments. |
GET SupplierPayment/Get/{id} |
Gets the specified Supplier Payment based on the identifier. |
POST SupplierPayment/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Supplier Payment. |
POST SupplierPayment/SaveBatch |
Saves the list of Supplier Payments. |
GET SupplierPayment/Export/{id} |
Gets a Supplier Payments generated as a PDF. |
POST SupplierPayment/Delete/{id} |
Deletes a specified Supplier Payment. |
Supplier Purchase History
The Supplier Purchase History Service provides methods that allow for the retrieval of Supplier Purchase History. This service requires authentication.
API | Description |
---|---|
POST SupplierPurchaseHistory/Get |
Gets a list of Supplier Purchase History. |
Supplier Return
The Supplier Return Service provides methods that allow for the retrieval and creation of Supplier Returns. Additional methods assist in calculating the total values of a Supplier Return and emailing Supplier Return. This service requires authentication.
API | Description |
---|---|
GET SupplierReturn/Get?includeDetail={includeDetail} |
Gets a List of Supplier Returns. |
GET SupplierReturn/Get/{id} |
Gets the specified Supplier Return based on the identifier. |
POST SupplierReturn/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Supplier Return. |
POST SupplierReturn/Calculate |
Calculates the specified Supplier Return total fields. |
POST SupplierReturn/Email |
Emails the specified Supplier Return. |
GET SupplierReturn/Export/{id} |
Downloads a copy of a Supplier Return as a PDF file. |
Supplier Return Attachment
The Supplier Return Attachment provides methods that allow attachments for supplier returns. This service requires authentication.
API | Description |
---|---|
POST SupplierReturnAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the SupplierReturn that this attachment must be linked to. This is Required and is not optional. |
GET SupplierReturnAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET SupplierReturnAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET SupplierReturnAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE SupplierReturnAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE SupplierReturnAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST SupplierReturnAttachment/Validate |
Validates the specified Entity. |
Supplier Statement
The Supplier Statement Controller provides a Get method to return the specified Supplier Statement based on the request model sent through. This service requires authentication.
API | Description |
---|---|
POST SupplierStatement/Get |
Gets the specified Supplier Statement based on the Supplier Statement Request Model passed through. |
Supplier Transaction Listing
The Supplier Transaction Listing Service provides methods to get a list of Supplier Transactions. This service requires authentication.
API | Description |
---|---|
POST SupplierTransactionListing/GetSupplierTransactionListingReportingDetail |
Gets the Supplier Transaction Listing. |
Support Login Audit
API | Description |
---|---|
POST SupportLoginAudit/Save |
No documentation available. |
Take On Balance
The Take On Balance Service provides methods that allow for the retrieval and creation of Take On Account Details. This service requires authentication.
API | Description |
---|---|
POST TakeOnBalance/Get |
Gets the specified Take On Account Detail based on the Take On Date. |
POST TakeOnBalance/Save |
Saves the specified Take On Account Detail. |
Tax Adjustment
The Tax Adjustment Service provides methods to get a list of Tax Adjustments, a specific Tax Adjustment, saving of a specific Tax Adjustment, saving of a batch of Tax Adjustments. This service requires authentication.
API | Description |
---|---|
GET TaxAdjustment/Get |
Gets a list of Tax Adjustments. |
GET TaxAdjustment/Get/{id} |
Gets a specific Tax Adjustment based on the identifier sent through. |
POST TaxAdjustment/Save |
Saves the specified Tax Adjustment. |
POST TaxAdjustment/SaveBatch |
Saves a batch of Tax Adjustments |
DELETE TaxAdjustment/Delete/{id} |
Deletes the specified Tax Adjustment. |
POST TaxAdjustment/DeleteBatch |
Deletes the batch of Journal Entry. |
Tax Invoice
The Tax Invoice Service provides methods that allow for the retrieval and creation of Tax Invoices. This service requires authentication.
API | Description |
---|---|
GET TaxInvoice/Get?includeDetail={includeDetail}&includeCustomerDetails={includeCustomerDetails} |
Gets a list of Tax Invoices. |
GET TaxInvoice/Get/{id} |
Gets the specified Tax Invoice based on the identifier. |
POST TaxInvoice/Save?useSystemDocumentNumber={useSystemDocumentNumber} |
Saves the specified Tax Invoice. |
POST TaxInvoice/Calculate |
Calculates the specified Tax Invoice total fields. |
POST TaxInvoice/Email |
Emails the specified Tax Invoice. |
POST TaxInvoice/EmailDeliveryNote |
Emails the delivery note for a specific Tax Invoice |
GET TaxInvoice/Export/{id} |
Downloads a copy of a Tax Invoice as a PDF file. |
Tax Invoice Attachment
The Tax Invoice Attachment provides methods that allow attachments for tax invoices. This service requires authentication.
API | Description |
---|---|
POST TaxInvoiceAttachment/Save |
Saves the Attachment. The file data is transmitted as a multipart/form-data POST. In the query string of the Url or a parameter in the form post, a TransactionId is required. A TransactionId is the ID of the TaxInvoice that this attachment must be linked to. This is Required and is not optional. |
GET TaxInvoiceAttachment/Get/{id} |
Gets the specified Attachment based on the identifier. |
GET TaxInvoiceAttachment/Download/{id} |
Downloads the specified Attachment based on file identifier (Guid). |
GET TaxInvoiceAttachment/GetCompanyStorageInformation |
Gets the Company Storage Information. |
DELETE TaxInvoiceAttachment/Delete/{id} |
Deletes the specified Attachment based on file identifier (Guid). |
DELETE TaxInvoiceAttachment/DeleteAll/{id} |
Deletes all Attachments based on the identifier. |
POST TaxInvoiceAttachment/Validate |
Validates the specified Entity. |
Tax Period
The Tax Period Service provides methods that allow for the retrieval of Tax Periods. Additional methods assist in deleting, opening and closing Tax Periods and several helper methods. This service requires authentication.
API | Description |
---|---|
POST TaxPeriod/CloseTaxPeriod |
Closes the specified Tax Period. |
POST TaxPeriod/AssignPaymentsRefundsToTaxPeriod |
Assigns the payments and refunds to a tax period. |
POST TaxPeriod/OpenTaxPeriod |
Opens the specified Tax Period. |
POST TaxPeriod/HasUnreportedTransactions |
Determines whether the specified tax period has unreported transactions. This can occur if a closed period was opened and transactions processed within this periods date range. |
POST TaxPeriod/HasPreviousTransactions |
Determines whether there are unreported transactions that occurred before this Tax Period. These transactions would then need to be included in this period when this period is closed. |
DELETE TaxPeriod/DeleteAllTaxPeriods |
Deletes all Tax Periods. Transactional data is not affected by this action. |
GET TaxPeriod/Get |
Gets a list of Tax Periods. |
GET TaxPeriod/Get/{id} |
Gets the specified Tax Period based on the identifier. |
Tax Rate Adjustment
The Tax Rate Adjustment Service provides methods to get a Tax Rate Adjustment. This service requires authentication.
API | Description |
---|---|
GET TaxRateAdjustment/Get |
Gets a specific tax rate adjustment based on the company. |
GET TaxRateAdjustment/GetAll |
Gets the tax rate adjustments based on the company. |
Tax Type
The Tax Type Service provides methods to get a list of Tax Types, get a specific Tax Type, save a Tax Type, and delete a specific Tax Type. This service requires authentication.
API | Description |
---|---|
POST TaxType/Save |
Saves the specified Tax Type based on the object sent through. |
GET TaxType/Get |
Gets a list of Tax Types. |
GET TaxType/Get/{id} |
Gets a specific Tax Type based on the identifier sent through. |
DELETE TaxType/Delete/{id} |
Deletes a specific Tax Type based on the identifier sent through. |
Time Tracking Customer
The Time Tracking Customer Service provides methods that allow for the retrieval of Time Tracking Customers. This service requires authentication.
API | Description |
---|---|
GET TimeTrackingCustomer/Get |
Retrieves Time Tracking Customers. |
Time Tracking Expense
The Time Tracking Expense Service provides methods that allow for the retrieval, creation and deletion of Time Tracking Expenses. This service requires authentication.
API | Description |
---|---|
GET TimeTrackingExpense/Get |
Gets a list of Time Tracking Expenses. |
GET TimeTrackingExpense/Get/{id} |
Gets the specified Time Tracking Expense based on the identifier. |
POST TimeTrackingExpense/Save |
Saves the specified Time Tracking Expense and updates it if it exists. |
GET TimeTrackingExpense/GetByDocumentHeader/{id} |
Gets the specified Time Tracking Expense based on the DocumentHeader linked to it. |
POST TimeTrackingExpense/Delete/{id} |
Deletes the specified Time Tracking Expense based on the identifier, if the TimeTrackingExpense is not in use. |
Time Tracking Project
The Time Tracking Project Service provides methods that allow for the retrieval, creation and deletion of Time Tracking Projects. This service requires authentication.
API | Description |
---|---|
GET TimeTrackingProject/Get?includeDetail={includeDetail} |
Gets a list of Time Tracking Projects. |
GET TimeTrackingProject/Get/{id} |
Gets the specified Time Tracking Project based on the identifier. |
POST TimeTrackingProject/GetByIdsWithTasks |
Gets Time Tracking Projects with Tasks based on provided ProjectId's |
GET TimeTrackingProject/GetProjectListingSummary |
Gets a list of Time Tracking Projects in summary form. |
GET TimeTrackingProject/GetActiveProjects |
Gets a list of active Time Tracking Projects. |
POST TimeTrackingProject/Save |
Saves the specified Time Tracking Project if it doesn't exist or updates it if it does. |
DELETE TimeTrackingProject/Delete/{id} |
Deletes the specified Time Tracking Project based on the identifier. If the TimeTrackingProject is not in use. |
POST TimeTrackingProject/Delete |
Deletes an array of Time Tracking Projects |
POST TimeTrackingProject/DeleteByIds |
Deletes Time Tracking Projects based on provided ProjectId's |
PUT TimeTrackingProject/RemoveProjectTasks/{id} |
Deletes an array of Project Tasks from a Project |
PUT TimeTrackingProject/RemoveProjectStaff/{id} |
Deletes an array of Project Staff from a Project |
GET TimeTrackingProject/GetUserProjects/{id} |
Retrieves an array of Time Tracking Projects for a User |
GET TimeTrackingProject/GetProjectsLookupListing/{id} |
Get custom project models that are used exclusively for the project combos. This include additional description entries that can be used in multi line combos. |
GET TimeTrackingProject/GetProjectsExpenseLookupListing/{id} |
Get custom project models that are used exclusivley for the project combos. This include additional description entries that can be used in multi line combos. |
GET TimeTrackingProject/GetProjectInvoices/{id} |
Get project invoices. |
GET TimeTrackingProject/GetProjectExpenses/{id} |
Get project expenses by project ID. |
GET TimeTrackingProject/GetProjectSummary/{id}?methodId={methodId} |
Get project summary by duration specified by the methodId. The methodId has options of 1 for daily, 2 for weekly and 3 for monthly. Currently only daily and monthly (i.e. 1 and 3 respectively) are supported. |
Time Tracking Task
The Time Tracking Task Service provides methods that allow for the retrieval, creation and deletion of Time Tracking Tasks. This service requires authentication.
API | Description |
---|---|
GET TimeTrackingTask/Get?includeProjectTasks={includeProjectTasks} |
Gets a list of Time Tracking Tasks. |
GET TimeTrackingTask/Get/{id} |
Gets the specified Time Tracking Task based on the identifier. |
POST TimeTrackingTask/Save |
Saves the specified Time Tracking Task and does not update Project task Rates. |
POST TimeTrackingTask/Delete/{id} |
Deletes the specified Time Tracking Task based on the identifier. If the TimeTrackingTask is not in use. |
POST TimeTrackingTask/DeleteTasks |
Delete a list of Time Tracking Tasks |
PUT TimeTrackingTask/RemoveProjectsFromTask/{id} |
Deletes the specified list of project tasks from the Task. |
POST TimeTrackingTask/GetTasksFiltered |
Gets the filtered tasks by customer ID and project ID. |
POST TimeTrackingTask/GetUsersFiltered |
Gets the users filtered by the customer ID, project ID and Task ID. |
POST TimeTrackingTask/SaveAndUpdateProjectTaskRate |
Saves the Task and provides options to update project task rates for all projects making use of the task. |
GET TimeTrackingTask/CheckForRecurringInvoices/{id} |
Checks if the Task specified by the identifier is linked to any Recurring Invoices. |
POST TimeTrackingTask/CheckForRecurringInvoicesByTasksAndProject |
Checks all recurring invoices for occurences of the tasks from the task ID list with the given project ID from the request. |
Time Tracking Timesheet
The Time Tracking Timesheet Service provides methods that allow for the retrieval, creation and deletion of Time Tracking Timesheets. This service requires authentication.
API | Description |
---|---|
GET TimeTrackingTimesheet/Get |
Gets a list of Time Tracking Timesheets. |
GET TimeTrackingTimesheet/Get/{id} |
Gets the specified Time Tracking Timesheet based on the identifier. |
POST TimeTrackingTimesheet/Save |
Saves the specified Time Tracking Timesheet. |
POST TimeTrackingTimesheet/GetByDateAndUser |
Gets a list of Time Tracking Timesheets by Date and user. |
POST TimeTrackingTimesheet/GetWeeklyByDateAndUser |
Gets a list of Time Tracking Time Sheet entries for one week by Date and User. |
POST TimeTrackingTimesheet/GetWeeklyByDate |
Get a list of Time Tracking Time Sheet entries for one week by Date. |
POST TimeTrackingTimesheet/GetMonthlyByDateAndUser |
Get a list of Time Tracking Time Sheet entries for one month by Date and User. |
POST TimeTrackingTimesheet/GetMonthlyByDate |
Get a list of Time Tracking Time Sheet entries for one month by Date. |
POST TimeTrackingTimesheet/GetByProjects |
Get a list of Time Tracking Time Sheet entries for selected projects. |
POST TimeTrackingTimesheet/GetBilledByProjects |
Gets billed Timesheets by projects. |
POST TimeTrackingTimesheet/GetWrittenOffByProjects |
Gets list of written off time sheet entries for selected projects. Written off time is set when time on a time sheet is unbillable. |
POST TimeTrackingTimesheet/WriteOffHours |
Write off hours for selected timesheet entries. |
DELETE TimeTrackingTimesheet/Delete/{id} |
Deletes the specified Time Tracking Timesheet based on the identifier. If the TimeTrackingTimesheet is not in use. |
POST TimeTrackingTimesheet/GetTimesheetSummaryDetail |
Gets the timesheet summary detail. The request model type can be either Customers=1, Projects=2, Tasks=3 or Users=4. The dateRangeType can be either All=0, Monthly=1, Weekly=2 or Daily=3 |
Time Tracking User
The Time Tracking User Service provides methods that allow for the retrieval, creation and deletion of Time Tracking Users. This service requires authentication.
API | Description |
---|---|
GET TimeTrackingUser/Get |
Gets a list of Time Tracking Users. |
GET TimeTrackingUser/Get/{id} |
Gets the specified Time Tracking User based on the identifier. |
To Do List
The To Do List Service provides methods that allow for the retrieval of To Do list items. This service requires authentication.
API | Description |
---|---|
GET ToDoList/Get |
Gets a list of To Do list items. |
Top Customers By Outstanding Balance
The Top Customers By Outstanding Balance Service provides a method that allows for the retrieval of Top Customers By Outstanding Balance. This service requires authentication.
API | Description |
---|---|
POST TopCustomersByOutstandingBalance/Get |
Gets a list of Customers based on the request model. |
Top Customers By Sales
Gets the Top Customers by Sales. Used by the dashboard charts. This service requires authentication.
API | Description |
---|---|
POST TopCustomersBySales/Get |
Gets the Top Customers by Sales based on the request. |
Top Purchased Items
The Top Purchased Items Service provides methods that allow for the retrieval of Top Purchased Items. This service requires authentication.
API | Description |
---|---|
POST TopPurchasedItems/Get |
Gets a list of Top Purchased Items. |
Top Selling Items
The Top Selling Item Service provides methods that allow for the retrieval of the Top Selling Item. This service requires authentication.
API | Description |
---|---|
POST TopSellingItems/Get |
Gets the Top Selling Item. |
Top Selling Items By Value On Hand
The Top Selling Items by Value on Hand Controller return the list of the top items by the value on hand. This service requires authentication.
API | Description |
---|---|
POST TopSellingItemsByValueOnHand/Get |
Gets the Top Selling Items by Value based on the request model sent through. |
Top Suppliers By Outstanding Balance
The Top Suppliers By Outstanding Balance Service provides a method that allows for the retrieval of Top Suppliers By Outstanding Balance. This service requires authentication.
API | Description |
---|---|
POST TopSuppliersByOutstandingBalance/Get |
Gets a list of Suppliers based on the request model. |
Top Suppliers By Purchases
Gets the Top Suppliers by Purchases. Used by the dashboard charts. This service requires authentication.
API | Description |
---|---|
POST TopSuppliersByPurchases/Get |
Gets the Top Suppliers by Purchases based on the request. |
Trial Balance
The Trial Balance service provides a method to Export the Trial Balance. This service requires authentication.
API | Description |
---|---|
POST TrialBalance/Export |
Exports the Trial Balance based on the Trial Balance request model sent through. |
Trial Balance Export Mapping
The Trial Balance Export Mapping Service provides methods that allow for the retrieval of Trial Balance Export Mappings. This service requires authentication.
API | Description |
---|---|
GET TrialBalanceExportMapping/Get |
Retrieves a collection of Trial Balance Export Mappings. |
User Defined Field
This service requires authentication.
API | Description |
---|---|
GET UserDefinedField/Get |
Gets a list of User Defined Fields. |
GET UserDefinedField/Get/{id} |
Gets User Defined Field for the specified id |
VAT201 Report
The VAT201 Controller returns the List of values that is used to populate the VAT201 Report based on the codes. This service requires authentication.
API | Description |
---|---|
GET VAT201Report/Get |
Gets the VAT201 Model based on the request model sent through. |