Gets or sets the purpose code for this document.

Namespace:  BargeEx.Internal
Assembly:  BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)

Syntax

C#
public virtual CicaTransactionPurposeCode PurposeCode { get; set; }
Visual Basic (Declaration)
Public Overridable Property PurposeCode As CicaTransactionPurposeCode
Visual C++
public:
virtual property CicaTransactionPurposeCode PurposeCode {
	CicaTransactionPurposeCode get ();
	void set (CicaTransactionPurposeCode value);
}

Property Value

The purpose code for this transaction indicating if this is a new transaction, an update to a previously sent transaction, or if the transaction indicated by this document should be disregarded. The default value is Invalid.

Remarks

If this property is set to UpdateTransaction or VoidTransaction, the Revision property should be set and the TransactionIdentifier property should be set to the application header's transaction identifier for the document that is being updated or voided.

The PurposeCodeSpecified property indicates whether or not this property will be included in the serialized class or generated document. The PurposeCodeSpecified property is automatically set to true when this property is set.

See Also