Manual Contents
Introduction
Methods and Arguments
Overview
Customers
GetCustomer
GetCustomerById
GetCustomerByEmail
GetCustomers
GetCustomersModifiedSince
InsertCustomer
UpdateCustomer
DeleteCustomer
GetCustomerSources
GetCustomerVATNumber
SetCustomerVATNumber
GetCustomerCurrency
SetCustomerCurrency
GetCustomersByPostcode
GetCustomerBalance
GetCustomerAdvancePayments
Quotes
DeleteQuote
DeleteQuoteByID
DeleteQuoteLine
DeleteQuoteLineWithQuoteID
GetQuoteByNumber
GetQuoteByID
GetQuotes
GetQuotes_Recent
GetQuotesForCustomer
InsertQuote
InsertQuoteLine
isStillQuote
UpdateQuote
UpdateQuoteHeader
ConvertQuoteToInvoice
Invoices
GetInvoice
GetInvoiceByID
GetInvoicesByDateRange
GetInvoicesForCustomer
GetInvoices_Overdue
GetInvoices_Recent
GetInvoices_Unpaid
InsertInvoice
InsertInvoiceLine
InsertInvoiceLineWithInvoiceNumber
UpdateInvoice
UpdateInvoiceHeader
DeleteInvoice
DeleteInvoiceByID
DeleteInvoiceLine
DeleteInvoiceLineWithInvoiceID
EmailInvoice
PrintInvoice
GetPaypalLink
InsertInvoiceNotes
GetInvoiceNotes
Invoice Payments
applyCreditNoteToInvoice
GetInvoicePayment
GetInvPayMethods
InsertInvoicePayment
DeleteInvoicePayment
AllocateAdvancePaymentToInvoice
Suppliers
GetSupplier
GetSuppliers
GetSupplierById
InsertSupplier
UpdateSupplier
GetSupplierVATNumber
SetSupplierVATNumber
GetSupplierCurrency
SetSupplierCurrency
Purchases
GetReceipt
GetReceipts
GetReceipts_Recent
GetReceiptsForSupplier
InsertReceipt
UpdateReceipt
UpdateReceiptHeader
DeleteReceipt
DeleteReceiptByID
InsertReceiptLine
InsertReceiptLineFromNumber
DeleteReceiptLine
DeleteReceiptLineWithReceiptID
AttachFileToReceipt
GetReceiptAttachments
DeleteReceiptAttachment
InsertReceiptNotes
GetReceiptNotes
Purchase Payments
GetReceiptPayment
GetRecPayMethods
InsertReceiptPayment
DeleteReceiptPayment
AllocateAdvancePaymentToReceipt
Bank
CreateBankAccount
GetBankAccounts
GetBankTXTypes
GetBankBalance
GetBankTransactions
InsertBankTransaction
UpdateBankTransaction
DeleteBankTransaction
Journals
InsertJournal
GetJournal
GetJournals
DeleteJournal
DeleteJournalByID
UpdateJournal
UpdateJournalHeader
Reports
GetAgedDebtors
GetAgedCreditors
GetBalanceSheet
GetDigitaCSVFile
GetIncomeByCustomer
GetKPIs
GetMonthlyProfitAndLoss
GetNominalLedger
GetProfitAndLoss
GetTrialBalance
GetVATReport
Projects
GetProjects
GetProjects_Full
InsertOrUpdateProject
GetProjectById
GetProjectByName
GetProjectByRef
Supplementary Functions
AddOrUpdateSubProduct
AutoAuthIP
createAccount
GetAccountOverview
GetBankOverview
GetCurrencies
GetRemoteLoginURL
GetProducts
GetProjects
GetNominalCodes
GetNominalCodesExtended
GetSubProducts
GetVATRates
InsertNominalCode
isUserVATRegistered
SetCustomerCurrency
SetSupplierCurrency
SetCustomerVATNumber
SetSupplierVATNumber
VCFToCustomerObjects
GetSubProductByID
GetSubProductByCode
GetCompanyDetails
Classes
AccountOverview
AgedDebtorsCreditors
BalanceSheet
BankAccount
BankOverview
BankTransaction
BankTXType
BasicDataset
CompanyDetails
Currencies
Customer
CustomerBalance
Invoice
InvoiceLine
InvoiceNote
JournalEntry
JournalLine
MonthlyPL
NominalCode
NominalCodeExtended
Payment
PaymentMethod
Product
ProfitAndLoss
Project
ReceiptAttachment
ReceiptNote
SubProduct
Supplier
TransactionInformation
VATReport
A user can restrict access to the API to a specified list of IP addresses.
Sometimes you may want to access the API via a device that has an IP address that changes regularly (typically a mobile device) and this makes the IP restrictions impractical.
Rather than suggesting users set the API settings to allow access from any IP address you should use this method to automatically add your IP address to the access list.
The user needs to enable "AutoAuth" by going to Settings -> API Settings and clicking the link to edit the IP address list.
They'll be given an AutoAuthKey which you will need to pass to us in the this method in order to add your IP to the authorised list.
You don't need to pass us your IP address. The API will automatically detect the IP address of the host that called this method.
| IN | appName String |
The name of your application. This is used in the comment for the IP listing so the user knows which application added the IP address |
| IN | AutoAuthKey String |
This is the AutoAuthKey mentioned above. It should be provided to you by the user. The AutoAuthKey is a hex string in the format: 1234ABCD-1234 |