MARINA
Invoice Class Reference

This class is really a transaction class. More...

Inheritance diagram for Invoice:
Inheritance graph

Public Member Functions

_.Library.String AllocateInvoiceNumber ()
 If the Transaction is a Receipt the method checks whether the Receipt numbers are from a. More...
 
- Public Member Functions inherited from AuditHistory
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 If this method is overridden then you must call ..UpdateAudit() yourself.
 

Static Public Member Functions

_.Library.Integer CreateServiceInvoice (_.Library.String contractid)
 Create an invoice for the billable amouunts in contract charges fro this contract.
 
_.Library.Integer SageExport (_.Library.String WorkFileKey)
 Export CSV file of Audit Trail Transactions for import into Sage line 50 Accounting software.
 

Public Attributes

 AdditionalNotes
   More...
 
 AllocationForBouncedReceipt
   More...
 
 AmountAllocated
   More...
 
 Area
   More...
 
 AssociatedBoats
 Comma separated list of Boat Names (Derived mainly for Receipts, Credit Notes using Allocations) More...
 
 AssociatedMoorings
 Comma separated list of Moorings (Derived mainly for Receipts, Credit Notes using Allocations) More...
 
 AssociatedTransactions
 Comma separated list of Transactions (Derived mainly for Receipts, Credit Notes using Allocations) More...
 
 Balance
 ** Deprecated use UnAllocatedAmount instead ** More...
 
 BankDetails
   More...
 
 Banking
   More...
 
 BankingReference
   More...
 
 Boat
   More...
 
 ChequeNumber
   More...
 
 Contract
   More...
 
 ContractDate
 If an invoice is generated from a contract this is the payment date (for phased\ncontracts) or the contracts start date (for advanced contracts) for which the \ninvoice was generated. More...
 
 CopiesPrinted
   More...
 
 Currency
   More...
 
 DeleteMe
   More...
 
 ExchangeRate
   More...
 
 Exported
   More...
 
 ExportedDate
   More...
 
 Invoice
 To allow receipts to be linked to invoices. More...
 
 InvoiceDate
   More...
 
 InvoiceID
   More...
 
 InvoiceLines
   More...
 
 InvoiceNarrative
   More...
 
 InvoiceNotes
   More...
 
 InvoiceNumber
   More...
 
 InvoiceNumberInt
 Internal invoice number. More...
 
 InvoiceType
 Possible values: More...
 
 InvoiceTypeDesc
   More...
 
 Licensee
   More...
 
 MayBeReversed
 Can this transaction be reversed. More...
 
 PaymentMethod
 ******For Invoices******* More...
 
 PhasedSequenceNumber
   More...
 
 Prefix
   More...
 
 PrintDocument
   More...
 
 ReasonForRefund
   More...
 
 ReceiptBounced
 The original receipt record that is being bounced. More...
 
 ReceiptVector
   More...
 
 RevenueType
 This field indicates the type of revenue associated to the transaction e.g. More...
 
 Revision
   More...
 
 Saved
   More...
 
 TemplateName
 If not Invoice.doc store the template name here. More...
 
 Terms
 Terms of Payment. More...
 
 TotalExclVat
   More...
 
 TotalExclVatVector
 Total Excluding Vat with + or -. More...
 
 TotalIncVatVector
 If its receipt or credit then returns -TotalInvVat. More...
 
 TotalInclVat
   More...
 
 TotalVat
   More...
 
 TotalVatVector
   More...
 
 TrueInvoiceType
 Usually the same as Invoice type. More...
 
 UnallocatedAmount
   More...
 
 UnallocatedAmountVector
   More...
 
 VatAmountAnalysis1
   More...
 
 VatAmountAnalysis2
   More...
 
 VatAmountAnalysis3
   More...
 
 VatAmountAnalysis4
   More...
 
 VatAnalyses
   More...
 
 VatCodeAnalysis1
   More...
 
 VatCodeAnalysis2
   More...
 
 VatCodeAnalysis3
   More...
 
 VatCodeAnalysis4
   More...
 
- Public Attributes inherited from AuditHistory
 creationDateTime
   More...
 
 creationUserId
   More...
 
 lastChangedDateTime
   More...
 
 lastChangedUserId
   More...
 
 version
   More...
 

Detailed Description

This class is really a transaction class.

It contains Invoices,Credit Notes,Receipts....

Deltanji status:

ObjectClearWater.Invoice.CLS/MARINA.0
ComponentCLS.ClearWater.Invoice
LocationMARINA.test2
Date/Time15-May-20 21:21
Userjohnm

Member Function Documentation

◆ AllocateInvoiceNumber()

_.Library.String AllocateInvoiceNumber ( )

If the Transaction is a Receipt the method checks whether the Receipt numbers are from a.

separate file, if so the ReceiptNumber.AllocateReceiptNumber method is called.

Reimplemented in EInvoice.

Member Data Documentation

◆ AdditionalNotes

AdditionalNotes

 

 

◆ AllocationForBouncedReceipt

AllocationForBouncedReceipt

 

 

◆ AmountAllocated

AmountAllocated

 

 

◆ Area

 

 

◆ AssociatedBoats

AssociatedBoats

Comma separated list of Boat Names (Derived mainly for Receipts, Credit Notes using Allocations)

 

◆ AssociatedMoorings

AssociatedMoorings

Comma separated list of Moorings (Derived mainly for Receipts, Credit Notes using Allocations)

 

◆ AssociatedTransactions

AssociatedTransactions

Comma separated list of Transactions (Derived mainly for Receipts, Credit Notes using Allocations)

 

◆ Balance

Balance

** Deprecated use UnAllocatedAmount instead **

Balance of settlement for this invoice

Takes into account Rceipts matched against this invoice  

◆ BankDetails

 

 

◆ Banking

Banking

 

 

◆ BankingReference

BankingReference

 

 

◆ Boat

 

 

◆ ChequeNumber

ChequeNumber

 

 

◆ Contract

 

 

◆ ContractDate

ContractDate

If an invoice is generated from a contract this is the payment date (for phased\ncontracts) or the contracts start date (for advanced contracts) for which the \ninvoice was generated.

\nIt is used to prevent two invoices from eing generated for the same contract.

 

◆ CopiesPrinted

CopiesPrinted

 

 

◆ Currency

 

 

◆ DeleteMe

DeleteMe

 

 

◆ ExchangeRate

 

 

◆ Exported

Exported

 

 

◆ ExportedDate

ExportedDate

 

 

◆ Invoice

To allow receipts to be linked to invoices.

 

◆ InvoiceDate

InvoiceDate

 

 

◆ InvoiceID

InvoiceID

 

 

◆ InvoiceLines

InvoiceLines

 

 

◆ InvoiceNarrative

InvoiceNarrative

 

 

◆ InvoiceNotes

InvoiceNotes

 

 

◆ InvoiceNumber

InvoiceNumber

 

 

◆ InvoiceNumberInt

InvoiceNumberInt

Internal invoice number.

 

◆ InvoiceType

InvoiceType

Possible values:

Invoice Credit PrePayment Pro-Forma Invoice Receipt Revenue  

◆ InvoiceTypeDesc

InvoiceTypeDesc

 

 

◆ Licensee

 

 

◆ MayBeReversed

MayBeReversed

Can this transaction be reversed.

No if any of the following is true:

Printed=1 AllocatedAmount not=0  

◆ PaymentMethod

******For Invoices*******

' ie Direct debit for mooring fees. so although a contract may be direct debit ' ad hoc invoices won't be direct debit so we need to know which invoices are which

*****For Receipts******** How was the Receipt paid for

Cheque,Credit Card,Cashh...  

◆ PhasedSequenceNumber

PhasedSequenceNumber

 

 

◆ Prefix

Prefix

 

 

◆ PrintDocument

PrintDocument

 

 

◆ ReasonForRefund

ReasonForRefund

 

 

◆ ReceiptBounced

ReceiptBounced

The original receipt record that is being bounced.

 

◆ ReceiptVector

ReceiptVector

 

 

◆ RevenueType

RevenueType

This field indicates the type of revenue associated to the transaction e.g.

'M' for Mooring Fees, 'S' for Services or 'O' for Other.

Functions that create invoices should use this code structure when creating a transaction. The 'Single Invoice', 'Advanced Invoice' and 'Phased Payments' should set this value on the Invoice to 'M'. Service payment Invoices should set-it to 'S'.

As of 14/03/2003 this has not yet been fully implemented. Using this indicator the 'Advanced Invoice' and 'Phased Payments' functions can determine if an Invoice has already been created for the contract as at present they look at the text in the Invoice Narrative. The change is also needed in order to build in the functionality to create a Pro-Forma for Outstanding mooring fees i.e. Total - (Sum of Receipts) as part payments are often made.  

◆ Revision

Revision

 

 

◆ Saved

Saved

 

 

◆ TemplateName

TemplateName

If not Invoice.doc store the template name here.

 

◆ Terms

Terms

Terms of Payment.

ie no of days within which invoice must be paid  

◆ TotalExclVat

TotalExclVat

 

 

◆ TotalExclVatVector

TotalExclVatVector

Total Excluding Vat with + or -.

 

◆ TotalIncVatVector

TotalIncVatVector

If its receipt or credit then returns -TotalInvVat.

if invoice +TotalInclVat  

◆ TotalInclVat

TotalInclVat

 

 

◆ TotalVat

TotalVat

 

 

◆ TotalVatVector

TotalVatVector

 

 

◆ TrueInvoiceType

TrueInvoiceType

Usually the same as Invoice type.

but if an invoice is created and not saved by the user then it may be created as a Pro-Forma Invoice and then when saved the Invoice type is changed to the TrueInvoiceType ie Invoice  

◆ UnallocatedAmount

UnallocatedAmount

 

 

◆ UnallocatedAmountVector

UnallocatedAmountVector

 

 

◆ VatAmountAnalysis1

VatAmountAnalysis1

 

 

◆ VatAmountAnalysis2

VatAmountAnalysis2

 

 

◆ VatAmountAnalysis3

VatAmountAnalysis3

 

 

◆ VatAmountAnalysis4

VatAmountAnalysis4

 

 

◆ VatAnalyses

VatAnalyses

 

 

◆ VatCodeAnalysis1

VatCodeAnalysis1

 

 

◆ VatCodeAnalysis2

VatCodeAnalysis2

 

 

◆ VatCodeAnalysis3

VatCodeAnalysis3

 

 

◆ VatCodeAnalysis4

VatCodeAnalysis4