Skip to content

Class: BillingSummary

Specifies individual summaries within a billing invoice.

URI: common_domain_model:BillingSummary

 classDiagram
    class BillingSummary
    click BillingSummary href "../BillingSummary/"
      BillingSummary : summaryAmountType





        BillingSummary --> "1" RecordAmountTypeEnum : summaryAmountType
        click RecordAmountTypeEnum href "../RecordAmountTypeEnum/"



      BillingSummary : summaryTransfer





        BillingSummary --> "0..1" Transfer : summaryTransfer
        click Transfer href "../Transfer/"

Slots

Name Cardinality and Range Description Inheritance
summaryTransfer 0..1
Transfer or 
ScheduledTransfer or 
UnscheduledTransfer		 The settlement terms for the billing summary direct
summaryAmountType 1
RecordAmountTypeEnum		 The account level for the billing summary direct

Usages

used by used in type used
SecurityLendingInvoice billingSummary range BillingSummary

In Subsets

Comments

  • Rosetta condition: GrandTotal — if summaryAmountType = RecordAmountTypeEnum -> GrandTotal then summaryTransfer exists and summaryTransfer ->> payerReceiver is absent
  • Rosetta condition: ParentTotal — if summaryAmountType = RecordAmountTypeEnum -> ParentTotal then summaryTransfer ->> payerReceiver exists and summaryTransfer ->> payerReceiver -> payerAccountReference is absent and summaryTransfer ->> payerReceiver -> receiverAccountReference is absent
  • Rosetta condition: AccountTotal — if summaryAmountType = RecordAmountTypeEnum -> AccountTotal then summaryTransfer ->> payerReceiver -> payerAccountReference exists and summaryTransfer ->> payerReceiver -> receiverAccountReference exists
  • Rosetta func: Create_BillingSummary — Creates a billing summary to be included in a Security Lending Billing Invoice.

Identifier and Mapping Information

Annotations

property value
rosetta_functions [{"name":"Create_BillingSummary","description":"Creates a billing summary to be included in a Security Lending Billing Invoice.","inputs":[{"name":"billingRecord","type":"BillingRecord","cardinality":"1..*"}],"output":{"name":"billingSummary","type":"BillingSummary","cardinality":"1..1"},"code_implementation":true}]

Schema Source

Mappings

Mapping Type Mapped Value
self common_domain_model:BillingSummary
native common_domain_model:BillingSummary
close fpml_5_10:BillingSummary

LinkML Source

Direct

name: BillingSummary
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_BillingSummary","description":"Creates a billing summary
      to be included in a Security Lending Billing Invoice.","inputs":[{"name":"billingRecord","type":"BillingRecord","cardinality":"1..*"}],"output":{"name":"billingSummary","type":"BillingSummary","cardinality":"1..1"},"code_implementation":true}]'
description: Specifies individual summaries within a billing invoice.
comments:
- 'Rosetta condition: GrandTotal — if summaryAmountType = RecordAmountTypeEnum ->
  GrandTotal then summaryTransfer exists and summaryTransfer ->> payerReceiver is
  absent'
- 'Rosetta condition: ParentTotal — if summaryAmountType = RecordAmountTypeEnum ->
  ParentTotal then summaryTransfer ->> payerReceiver exists and summaryTransfer ->>
  payerReceiver -> payerAccountReference is absent and summaryTransfer ->> payerReceiver
  -> receiverAccountReference is absent'
- 'Rosetta condition: AccountTotal — if summaryAmountType = RecordAmountTypeEnum ->
  AccountTotal then summaryTransfer ->> payerReceiver -> payerAccountReference exists
  and summaryTransfer ->> payerReceiver -> receiverAccountReference exists'
- 'Rosetta func: Create_BillingSummary — Creates a billing summary to be included
  in a Security Lending Billing Invoice.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:BillingSummary
slots:
- summaryTransfer
- summaryAmountType

Induced

name: BillingSummary
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_BillingSummary","description":"Creates a billing summary
      to be included in a Security Lending Billing Invoice.","inputs":[{"name":"billingRecord","type":"BillingRecord","cardinality":"1..*"}],"output":{"name":"billingSummary","type":"BillingSummary","cardinality":"1..1"},"code_implementation":true}]'
description: Specifies individual summaries within a billing invoice.
comments:
- 'Rosetta condition: GrandTotal — if summaryAmountType = RecordAmountTypeEnum ->
  GrandTotal then summaryTransfer exists and summaryTransfer ->> payerReceiver is
  absent'
- 'Rosetta condition: ParentTotal — if summaryAmountType = RecordAmountTypeEnum ->
  ParentTotal then summaryTransfer ->> payerReceiver exists and summaryTransfer ->>
  payerReceiver -> payerAccountReference is absent and summaryTransfer ->> payerReceiver
  -> receiverAccountReference is absent'
- 'Rosetta condition: AccountTotal — if summaryAmountType = RecordAmountTypeEnum ->
  AccountTotal then summaryTransfer ->> payerReceiver -> payerAccountReference exists
  and summaryTransfer ->> payerReceiver -> receiverAccountReference exists'
- 'Rosetta func: Create_BillingSummary — Creates a billing summary to be included
  in a Security Lending Billing Invoice.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:BillingSummary
attributes:
  summaryTransfer:
    name: summaryTransfer
    description: The settlement terms for the billing summary
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingSummary.summaryTransfer
    rank: 1000
    owner: BillingSummary
    domain_of:
    - BillingSummary
    range: Transfer
    any_of:
    - range: ScheduledTransfer
    - range: UnscheduledTransfer
  summaryAmountType:
    name: summaryAmountType
    description: The account level for the billing summary.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: BillingSummary
    domain_of:
    - BillingSummaryInstruction
    - BillingSummary
    range: RecordAmountTypeEnum
    required: true