Skip to content

Class: MarketInvoice

_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. _

__

URI: cim:MarketInvoice

 classDiagram
    class MarketInvoice
      MarketInvoice : amount

          MarketInvoice --> Money : amount

      MarketInvoice : bill_media_kind

          MarketInvoice --> MktBillMediaKind : bill_media_kind

      MarketInvoice : due_date

      MarketInvoice : kind

          MarketInvoice --> MktAccountKind : kind

      MarketInvoice : mailed_date

      MarketInvoice : major_charge_group

          MarketInvoice --> MajorChargeGroup : major_charge_group

      MarketInvoice : market_invoice_line_items

          MarketInvoice --> MarketInvoiceLineItem : market_invoice_line_items

      MarketInvoice : pro_forma

      MarketInvoice : reference_number

      MarketInvoice : transaction_date_time

      MarketInvoice : transfer_type

Slots

Name Cardinality and Range Description Inheritance
amount 0..1
Money		 Total amount due on this invoice based on line items and applicable adjustmen... direct
bill_media_kind 0..1
MktBillMediaKind		 Kind of media by which the CustomerBillingInfo was delivered direct
due_date 0..1
date		 Calculated date upon which the Invoice amount is due direct
kind 0..1
MktAccountKind		 Kind of invoice (default is 'sales') direct
mailed_date 0..1
date		 Date on which the customer billing statement/invoice was printed/mailed direct
pro_forma 0..1
Boolean		 True if payment is to be paid by a Customer to accept a particular ErpQuote (... direct
reference_number 0..1
String		 Number of an invoice to be reference by this invoice direct
transaction_date_time 0..1
date		 Date and time when the invoice is issued direct
transfer_type 0..1
String		 Type of invoice transfer direct
major_charge_group 1..*
MajorChargeGroup		 direct
market_invoice_line_items 0..*
MarketInvoiceLineItem		 direct

Usages

used by used in type used
MajorChargeGroup market_invoice range MarketInvoice
MarketInvoiceLineItem market_invoice range MarketInvoice

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:MarketInvoice
native cim:MarketInvoice

LinkML Source

Direct

name: MarketInvoice
description: "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.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  amount:
    name: amount
    description: Total amount due on this invoice based on line items and applicable
      adjustments.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.amount
    multivalued: false
    domain_of:
    - ErpJournalEntry
    - WorkCostDetail
    - LineDetail
    - ErpLedgerEntry
    - Tender
    - AccountMovement
    - ErpInvoice
    - CRRSegment
    - MarketInvoice
    - PassThroughBill
    - MarketLedgerEntry
    - Price
    - NonStandardItem
    range: Money
    required: false
  bill_media_kind:
    name: bill_media_kind
    description: "Kind of media by which the CustomerBillingInfo was delivered.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.billMediaKind
    multivalued: false
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: MktBillMediaKind
    required: false
  due_date:
    name: due_date
    description: Calculated date upon which the Invoice amount is due.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.dueDate
    multivalued: false
    domain_of:
    - CustomerBillingInfo
    - ErpInvoice
    - MarketInvoice
    range: date
    required: false
  kind:
    name: kind
    description: "Kind of invoice (default is 'sales').\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.kind
    multivalued: false
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: MktAccountKind
    required: false
  mailed_date:
    name: mailed_date
    description: Date on which the customer billing statement/invoice was printed/mailed.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.mailedDate
    multivalued: false
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: date
    required: false
  pro_forma:
    name: pro_forma
    description: 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.proForma
    multivalued: false
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: boolean
    required: false
  reference_number:
    name: reference_number
    description: Number of an invoice to be reference by this invoice.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.referenceNumber
    multivalued: false
    domain_of:
    - ErpInvoice
    - MarketInvoice
    - MarketStatement
    - Regulation
    range: string
    required: false
  transaction_date_time:
    name: transaction_date_time
    description: Date and time when the invoice is issued.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.transactionDateTime
    multivalued: false
    domain_of:
    - ErpJournalEntry
    - WorkCostDetail
    - ErpLedgerEntry
    - ErpInvoice
    - MarketInvoice
    - MarketLedgerEntry
    range: date
    required: false
  transfer_type:
    name: transfer_type
    description: Type of invoice transfer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.transferType
    multivalued: false
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: string
    required: false
  major_charge_group:
    name: major_charge_group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.MajorChargeGroup
    multivalued: true
    domain_of:
    - Settlement
    - MarketInvoice
    - MarketScheduledEvent
    - ChargeType
    range: MajorChargeGroup
    required: true
  market_invoice_line_items:
    name: market_invoice_line_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketInvoice.MarketInvoiceLineItems
    multivalued: true
    domain_of:
    - MarketInvoice
    range: MarketInvoiceLineItem
    required: false
class_uri: cim:MarketInvoice

Induced

name: MarketInvoice
description: "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.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
attributes:
  amount:
    name: amount
    description: Total amount due on this invoice based on line items and applicable
      adjustments.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.amount
    multivalued: false
    alias: amount
    owner: MarketInvoice
    domain_of:
    - ErpJournalEntry
    - WorkCostDetail
    - LineDetail
    - ErpLedgerEntry
    - Tender
    - AccountMovement
    - ErpInvoice
    - CRRSegment
    - MarketInvoice
    - PassThroughBill
    - MarketLedgerEntry
    - Price
    - NonStandardItem
    range: Money
    required: false
  bill_media_kind:
    name: bill_media_kind
    description: "Kind of media by which the CustomerBillingInfo was delivered.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.billMediaKind
    multivalued: false
    alias: bill_media_kind
    owner: MarketInvoice
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: MktBillMediaKind
    required: false
  due_date:
    name: due_date
    description: Calculated date upon which the Invoice amount is due.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.dueDate
    multivalued: false
    alias: due_date
    owner: MarketInvoice
    domain_of:
    - CustomerBillingInfo
    - ErpInvoice
    - MarketInvoice
    range: date
    required: false
  kind:
    name: kind
    description: "Kind of invoice (default is 'sales').\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.kind
    multivalued: false
    alias: kind
    owner: MarketInvoice
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: MktAccountKind
    required: false
  mailed_date:
    name: mailed_date
    description: Date on which the customer billing statement/invoice was printed/mailed.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.mailedDate
    multivalued: false
    alias: mailed_date
    owner: MarketInvoice
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: date
    required: false
  pro_forma:
    name: pro_forma
    description: 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.proForma
    multivalued: false
    alias: pro_forma
    owner: MarketInvoice
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: boolean
    required: false
  reference_number:
    name: reference_number
    description: Number of an invoice to be reference by this invoice.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.referenceNumber
    multivalued: false
    alias: reference_number
    owner: MarketInvoice
    domain_of:
    - ErpInvoice
    - MarketInvoice
    - MarketStatement
    - Regulation
    range: string
    required: false
  transaction_date_time:
    name: transaction_date_time
    description: Date and time when the invoice is issued.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.transactionDateTime
    multivalued: false
    alias: transaction_date_time
    owner: MarketInvoice
    domain_of:
    - ErpJournalEntry
    - WorkCostDetail
    - ErpLedgerEntry
    - ErpInvoice
    - MarketInvoice
    - MarketLedgerEntry
    range: date
    required: false
  transfer_type:
    name: transfer_type
    description: Type of invoice transfer.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.transferType
    multivalued: false
    alias: transfer_type
    owner: MarketInvoice
    domain_of:
    - ErpInvoice
    - MarketInvoice
    range: string
    required: false
  major_charge_group:
    name: major_charge_group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketInvoice.MajorChargeGroup
    multivalued: true
    alias: major_charge_group
    owner: MarketInvoice
    domain_of:
    - Settlement
    - MarketInvoice
    - MarketScheduledEvent
    - ChargeType
    range: MajorChargeGroup
    required: true
  market_invoice_line_items:
    name: market_invoice_line_items
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MarketInvoice.MarketInvoiceLineItems
    multivalued: true
    alias: market_invoice_line_items
    owner: MarketInvoice
    domain_of:
    - MarketInvoice
    range: MarketInvoiceLineItem
    required: false
class_uri: cim:MarketInvoice