OSB_LIB::InvoiceInfo Struct Reference

Collaboration diagram for OSB_LIB::InvoiceInfo:

[legend]List of all members.

---

Detailed Description

InvoiceInfo is used as container for the invoice data to be written to the database.

The billing application populates the members and calls the InvoiceDir::close funtion. This in-turn calls the invoicedir gateway to insert this data into table STATEMENT_INFO.

Definition at line 87 of file invoicedir.h.

Public Types

• stInvoice = 'i'

  Invoice.
  

• stReconciliation = 'r'

  Reconciliation statement.
  

• stUnknown = '\0'

  Unknown statement type.
  

• enum StatementType { stInvoice = 'i', stReconciliation = 'r', stUnknown = '\0' }

  Indicator for invoice or reconciliation statements. More...
  

Public Member Functions

• InvoiceInfo ()

  Empty constructor.
  

• ~InvoiceInfo ()

  Empty destructor.
  

Static Public Member Functions

• static StatementType toStatementType (char st)

  Convert a character to a statement type.
  

• static char toChar (StatementType st)

  Convert a statement type to a character.
  

Public Attributes

• std::string invoiceNumber

  Invoice Number.
  

• BsPage::Oid bsPageId

  Unique id of the Balance sheet.
  

• Contract::Oid contractId

  Id of the contract to which this balance page belongs.
  

• StatementType statementType

  Indicator for invoice or reconciliation statements.
  

• Date billDate

  Bill date.
  

• Date dueDate

  Due date.
  

• Date startDate

  Start date of invoice period.
  

• Date endDate

  End date of invoice period.
  

• MoneyList invAmount

  Invoice amount as calculated.
  

• std::string hostName

  Hostname where the invoice files are stored.
  

• std::string fileInfo

  File name (with the full path) of the file.
  

---

Member Enumeration Documentation

enum OSB_LIB::InvoiceInfo::StatementType

Indicator for invoice or reconciliation statements.

Enumerator:

stInvoice	Invoice.
stReconciliation	Reconciliation statement.
stUnknown	Unknown statement type.

Definition at line 89 of file invoicedir.h.

---

Constructor & Destructor Documentation

OSB_LIB::InvoiceInfo::InvoiceInfo

(

)

[inline]

Empty constructor.

Definition at line 117 of file invoicedir.h.

OSB_LIB::InvoiceInfo::~InvoiceInfo

(

)

[inline]

Empty destructor.

Definition at line 119 of file invoicedir.h.

---

Member Function Documentation

static char OSB_LIB::InvoiceInfo::toChar

(

StatementType

st

)

[static]

Convert a statement type to a character.

Parameters:

st

Statement type to convert.

Returns:

The character value that corresponds to st, stUnknown in case of an unknown type.

static StatementType OSB_LIB::InvoiceInfo::toStatementType

(

char

st

)

[static]

Convert a character to a statement type.

Parameters:

st

Value to convert.

Returns:

The statement type that corresponds to st, stUnknown in case of an unknown type.

---

Member Data Documentation

Date OSB_LIB::InvoiceInfo::billDate

Bill date.

Definition at line 130 of file invoicedir.h.

BsPage::Oid OSB_LIB::InvoiceInfo::bsPageId

Unique id of the Balance sheet.

Definition at line 124 of file invoicedir.h.

Contract::Oid OSB_LIB::InvoiceInfo::contractId

Id of the contract to which this balance page belongs.

Definition at line 126 of file invoicedir.h.

Date OSB_LIB::InvoiceInfo::dueDate

Due date.

Definition at line 132 of file invoicedir.h.

Date OSB_LIB::InvoiceInfo::endDate

End date of invoice period.

Definition at line 136 of file invoicedir.h.

std::string OSB_LIB::InvoiceInfo::fileInfo

File name (with the full path) of the file.

Definition at line 142 of file invoicedir.h.

std::string OSB_LIB::InvoiceInfo::hostName

Hostname where the invoice files are stored.

Definition at line 140 of file invoicedir.h.

MoneyList OSB_LIB::InvoiceInfo::invAmount

Invoice amount as calculated.

Definition at line 138 of file invoicedir.h.

std::string OSB_LIB::InvoiceInfo::invoiceNumber

Invoice Number.

Definition at line 122 of file invoicedir.h.

Date OSB_LIB::InvoiceInfo::startDate

Start date of invoice period.

Definition at line 134 of file invoicedir.h.

StatementType OSB_LIB::InvoiceInfo::statementType

Indicator for invoice or reconciliation statements.

Definition at line 128 of file invoicedir.h.

---

The documentation for this struct was generated from the following file:

• invoicedir.h

---