Quantcast

Invoice Class

This is a class from the KashFlow Accounting Software SOAP API

Description

For representing sales invoices, receipts (purchase invoices) and quotes.

Note that properties relating to payments and totals are read-only.

The Net Amount and Vat Amount are calculated based on the total of the Lines.

The ‘Paid’ and ‘PaidAmount’ are set by adding  invoice payments or receipt payments.

Parameters

InvoiceDBID
Integer (read only)
TSystem-wide unique number for this invoice (used internally only)

InvoiceNumber
Integer
Unique invoice number

InvoiceDate
DateTime
Invoice date

DueDate
DateTime
Invoice due date

SuppressTotal
Integer
1 to suppress the total (only used on Quotes)

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
Integer (read only)
1 for Paid, 0 for Unpaid. Set to 0 on Insert calls

CustomerID
Integer
The ID of the customer (or supplier int he case of receipts)

CustomerReference
String

EstimateCategory
String (read only)
The category of the quote (only relevant when with Quotes)

NetAmount
Decimal (read only)
The total net amount of the invoice
Set to 0 for inset functions

VatAmount
Decimal (read only)
The total VAT amount of the invoice
Set to 0 for insert functions

AmountPaid
Decimal (read only)
The sum of all payments made to this invoice
Set to 0 for insert functions

Permalink
String
A permanent link to access a PDF of the invoice.

UseCustomDeliveryAddress
boolean
If value is True, custom delivery address will be used for this invoice packing slip. By default value will be False. If it is False, invoice address will be used on packing slip.

DeliveryAddress
DeliveryAddress
An object of type DeliveryAddress.

Lines
InvoiceLine
A collection of type InvoiceLine.

SOAP API Method