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
Manual - Classes - Invoice
For Sales Invoices:
(see below for Purchase Invoices (Receipts)
Note that properties relating to payments and totals are read-only.
The Net Amount and Vat Amount are calculated based on the Lines.
The 'Paid' status is set by adding an invoice payments.
| Member | Data Type | Content |
|---|---|---|
| InvoiceDBID (Read Only) |
Integer | System-wide unique number for this invoice (used internally only) |
| InvoiceNumber | Integer | Unique invoice Reference Number |
| InvoiceDate | DateTime | Invoice Date |
| DueDate | DateTime | Payment Due Date |
| SuppressTotal | Integer | 1 to suppress the quote/estimate total |
| ProjectID | Integer | The project ID for this invoice. See GetProjects |
| CurrencyCode | String | The currency code to be used for the invoice e.g. USD, GBP, ZAR |
| ExchangeRate | Decimal | The exchange rate for the currency used. |
| Paid (Read Only) |
Integer | 1 for Paid, 0 for Unpaid (Please set default to 0 when calling insert functions) |
| CustomerID | Integer | CustomerID of Customer |
| CustomerReference | String | Customer Reference |
| EstimateCategory | String | The name of the estimate category |
| NetAmount (Read Only) |
Decimal | The total net amount of the invoice (Please set default to 0 when calling insert functions) |
| VatAmount (Read Only) |
Decimal | The total VAT amount of the invoice (Please set default to 0 when calling insert functions) |
| AmountPaid (Read Only) |
Decimal | The sum of all payments made to this invoice (Please set default to 0 when calling insert functions) |
| PermaLink (Read Only) |
String | A read-only element which returns a permanent link to the invoice print out. |
| Collections | Data Type | Content |
|---|---|---|
| Lines | InvoiceLine | Collection. Click here for full details. |
For Purchase Invoices (Receipts):
(see above for Sales Invoices)
Note that properties relating to payments and totals are read-only.
The Net Amount and Vat Amount are calculated based on the Lines.
| Member | Data Type | Content |
|---|---|---|
| InvoiceDBID (Read Only) |
Integer | System-wide unique number for this receipt (used internally only) |
| InvoiceNumber (Read Only) |
Integer | Unique Reference Number for this Receipt |
| InvoiceDate | DateTime | Receipt Date |
| DueDate | DateTime | Payment Due Date |
| Paid (Read Only) |
Integer | 1 for Paid, 0 for Unpaid |
| CustomerID | Integer | SupplierID of Supplier |
| CustomerReference | String | Supplier Reference |
| NetAmount | Decimal | The total net amount of the receipt |
| VatAmount | Decimal | The total VAT amount of the receipt |
| AmountPaid | Decimal | The sum of all payments made to this receipt |
| Collections | Data Type | Content |
|---|---|---|
| Lines | InvoiceLine | Collection. Click here for full details. |