Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfERPSupport :: Module ErpInvoice' :: Class ErpInvoice

[frames] | no frames]

Class ErpInvoice

                         object --+            
                                  |            
                   Element'.Element --+        
                                      |        
Core.IdentifiedObject'.IdentifiedObject --+    
                                          |    
         IEC61968.Common.Document'.Document --+
                                              |
                                             ErpInvoice

A roll up of invoice line items. The whole invoice has a due date and amount to be paid, with information such as customer, banks etc. being obtained through associations. The invoice roll up is based on individual line items that each contain amounts and descriptions for specific services or products.A roll up of invoice line items. The whole invoice has a due date and amount to be paid, with information such as customer, banks etc. being obtained through associations. The invoice roll up is based on individual line items that each contain amounts and descriptions for specific services or products.

Instance Methods

[hide private]

__init__(self, mailedDate='', transactionDateTime='', amount=0.0, dueDate='', billMediaKind='other', referenceNumber='', kind='sales', transferType='', proForma=False, ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args)
Initialises a new 'ErpInvoice' instance.

addErpInvoiceLineItems(self, *ErpInvoiceLineItems)

getCustomerAccount(self)

getErpInvoiceLineItems(self)

removeErpInvoiceLineItems(self, *ErpInvoiceLineItems)

setCustomerAccount(self, value)

setErpInvoiceLineItems(self, value)

Inherited from IEC61968.Common.Document'.Document: addActivityRecords, addAssetRoles, addChangeItems, addChangeSets, addErpOrganisationRoles, addErpPersonRoles, addFromDocumentRoles, addMeasurements, addNetworkDataSets, addPowerSystemResourceRoles, addScheduleParameterInfos, addScheduledEvents, addToDocumentRoles, getActivityRecords, getAssetRoles, getChangeItems, getChangeSets, getErpOrganisationRoles, getErpPersonRoles, getFromDocumentRoles, getMeasurements, getNetworkDataSets, getPowerSystemResourceRoles, getScheduleParameterInfos, getScheduledEvents, getToDocumentRoles, removeActivityRecords, removeAssetRoles, removeChangeItems, removeChangeSets, removeErpOrganisationRoles, removeErpPersonRoles, removeFromDocumentRoles, removeMeasurements, removeNetworkDataSets, removePowerSystemResourceRoles, removeScheduleParameterInfos, removeScheduledEvents, removeToDocumentRoles, setActivityRecords, setAssetRoles, setChangeItems, setChangeSets, setErpOrganisationRoles, setErpPersonRoles, setFromDocumentRoles, setMeasurements, setNetworkDataSets, setPowerSystemResourceRoles, setScheduleParameterInfos, setScheduledEvents, setToDocumentRoles

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

_attr_types = {'amount': <type 'float'>, 'billMediaKind': <typ...

_attrs = ['mailedDate', 'transactionDateTime', 'amount', 'dueD...

_defaults = {'amount': 0.0, 'billMediaKind': 'other', 'dueDate...

_enums = {'billMediaKind': 'BillMediaKind', 'kind': 'ErpInvoic...

_many_refs = ['ErpInvoiceLineItems']

_refs = ['ErpInvoiceLineItems', 'CustomerAccount']

Inherited from IEC61968.Common.Document'.Document: docStatus, electronicAddress, status

Properties

[hide private]

CustomerAccount

ErpInvoiceLineItems

Inherited from IEC61968.Common.Document'.Document: ActivityRecords, AssetRoles, ChangeItems, ChangeSets, ErpOrganisationRoles, ErpPersonRoles, FromDocumentRoles, Measurements, NetworkDataSets, PowerSystemResourceRoles, ScheduleParameterInfos, ScheduledEvents, ToDocumentRoles

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details

[hide private]

init(self, mailedDate=`''`, transactionDateTime=`''`, amount=0.0, dueDate=`''`, billMediaKind=`'other'`, referenceNumber=`''`, kind=`'sales'`, transferType=`''`, proForma=False, ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args)
(Constructor)

Initialises a new 'ErpInvoice' instance.

Parameters:

mailedDate - Date on which the customer billing statement/invoice was printed/mailed.
transactionDateTime - Date and time when the invoice is issued.
amount - Total amount due on this invoice based on line items and applicable adjustments.
dueDate - Calculated date upon which the Invoice amount is due.
billMediaKind - Kind of media by which the CustomerBillingInfo was delivered. Values are: "other", "paper", "electronic"
referenceNumber - Number of an invoice to be reference by this invoice.
kind - Kind of invoice (default is 'sales'). Values are: "sales", "purchase"
transferType - Type of invoice transfer.
proForma - True if payment is to be paid by a Customer to accept a particular ErpQuote (with associated Design) and have work initiated, at which time an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus satisfies terms specificed in the ErpQuote.
ErpInvoiceLineItems
CustomerAccount

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'amount': <type 'float'>,
 'billMediaKind': <type 'str'>,
 'dueDate': <type 'str'>,
 'kind': <type 'str'>,
 'mailedDate': <type 'str'>,
 'proForma': <type 'bool'>,
 'referenceNumber': <type 'str'>,
 'transactionDateTime': <type 'str'>,
...

_attrs

Value:

['mailedDate',
 'transactionDateTime',
 'amount',
 'dueDate',
 'billMediaKind',
 'referenceNumber',
 'kind',
 'transferType',
...

_defaults

Value:

{'amount': 0.0,
 'billMediaKind': 'other',
 'dueDate': '',
 'kind': 'sales',
 'mailedDate': '',
 'proForma': False,
 'referenceNumber': '',
 'transactionDateTime': '',
...

_enums

Value:

{'billMediaKind': 'BillMediaKind', 'kind': 'ErpInvoiceKind'}

Property Details

[hide private]

CustomerAccount

Get Method:: getCustomerAccount(self)
Set Method:: setCustomerAccount(self, value)

ErpInvoiceLineItems

Get Method:: getErpInvoiceLineItems(self)
Set Method:: setErpInvoiceLineItems(self, value)

Class ErpInvoice

__init__(self, mailedDate='', transactionDateTime='', amount=0.0, dueDate='', billMediaKind='other', referenceNumber='', kind='sales', transferType='', proForma=False, ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_enums

CustomerAccount

ErpInvoiceLineItems

init(self, mailedDate=`''`, transactionDateTime=`''`, amount=0.0, dueDate=`''`, billMediaKind=`'other'`, referenceNumber=`''`, kind=`'sales'`, transferType=`''`, proForma=False, ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args)
(Constructor)