Introduction
Methods and Arguments
Overview
Customers
GetCustomer
GetCustomerById
GetCustomerByEmail
GetCustomers
InsertCustomer
UpdateCustomer
GetCustomerSources
Invoices
GetInvoice
GetInvoicesByDateRange
GetInvoicesForCustomer
InsertInvoice
UpdateInvoice
EmailInvoice
PrintInvoice
GetPaypalLink
Invoice Payments
GetInvoicePayment
GetInvPayMethods
InsertInvoicePayment
DeleteInvoicePayment
Suppliers
GetSupplier
GetSupplierById
InsertSupplier
Bank
GetBankAccounts
GetBankTXTypes
InsertBankTransaction
Reports
GetBalanceSheet
GetDigitaCSVFile
GetMonthlyProfitAndLoss
GetNominalLedger
GetProfitAndLoss
GetTrialBalance
GetVATReport
Supplementary Functions
GetProducts
GetNominalCodes
isUserVATRegistered
Classes
BalanceSheet
BankAccount
BankTransaction
BankTXType
BasicDataset
Customer
Invoice
InvoiceLine
MonthlyPL
NominalCode
Payment
PaymentMethod
Product
ProfitAndLoss
Supplier
TransactionInformation
VATReport
In addition to the variables/arguments shown for each method, the following variables/arguments are common to ALL methods:
| IN | Username String |
The registered username for the account being Accessed |
| IN | Password String |
The password for the account being accessed |
| OUT | Status String |
Contains 'OK' if the function executed successfully Or 'NO' if there was a problem |
| OUT | StatusDetail String |
Blank if Status is 'OK', details of error if Status is 'NO' |
All methods will first validate the credentials supplied before taking any other action.
If the credentials are valid then the IP address of the consumer is checked against the list of IP addresses assigned to the user account (see Introduction).
Assuming the credentials and the IP address validate then the method will execute. If the method executed successfully then the Status will be set to "OK". If for any reason the method does not execute successfully then the Status is set to "NO". More information about the error can be found by inspecting the StatusDetail variable.