Skip to content

Class: BillingRecord

Specifies individual records within a billing invoice.

URI: common_domain_model:BillingRecord

 classDiagram
    class BillingRecord
    click BillingRecord href "../BillingRecord/"
      BillingRecord : minimumFee





        BillingRecord --> "0..1" Money : minimumFee
        click Money href "../Money/"



      BillingRecord : recordEndDate

      BillingRecord : recordStartDate

      BillingRecord : recordTransfer





        BillingRecord --> "1" Transfer : recordTransfer
        click Transfer href "../Transfer/"



      BillingRecord : tradeState





        BillingRecord --> "1" TradeState : tradeState
        click TradeState href "../TradeState/"



Slots

Name Cardinality and Range Description Inheritance
tradeState 1
TradeState
The trade for the individual billing record direct
recordTransfer 1
Transfer or 
ScheduledTransfer or 
UnscheduledTransfer
The settlement terms for the billing record direct
recordStartDate 1
date
The starting date of the period described by this record direct
recordEndDate 1
date
The ending date of the period described by this record direct
minimumFee 0..1
Money
Indicates the minimum fee amount applied to the billing record, if any direct

Usages

used by used in type used
SecurityLendingInvoice billingRecord range BillingRecord

In Subsets

Comments

  • Rosetta func: Create_BillingRecords — Creates for each billing instruction an individual billing record to be included in a Security Lending Billing Invoice
  • Rosetta func: Create_BillingRecord — Creates an individual billing record to be included in a Security Lending Billing Invoice
  • 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_BillingRecords","description":"Creates for each billing instruction an individual billing record to be included in a Security Lending Billing Invoice","inputs":[{"name":"billingInstruction","type":"BillingRecordInstruction","cardinality":"1.."}],"output":{"name":"billingRecord","type":"BillingRecord","cardinality":"1.."}},{"name":"Create_BillingRecord","description":"Creates an individual billing record to be included in a Security Lending Billing Invoice","inputs":[{"name":"billingInstruction","type":"BillingRecordInstruction","cardinality":"1..1"}],"output":{"name":"billingRecord","type":"BillingRecord","cardinality":"1..1"}},{"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:BillingRecord
native common_domain_model:BillingRecord
close fpml_5_10:BillingRecord

LinkML Source

Direct

name: BillingRecord
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_BillingRecords","description":"Creates for each billing
      instruction an individual billing record to be included in a Security Lending
      Billing Invoice","inputs":[{"name":"billingInstruction","type":"BillingRecordInstruction","cardinality":"1..*"}],"output":{"name":"billingRecord","type":"BillingRecord","cardinality":"1..*"}},{"name":"Create_BillingRecord","description":"Creates
      an individual billing record to be included in a Security Lending Billing Invoice","inputs":[{"name":"billingInstruction","type":"BillingRecordInstruction","cardinality":"1..1"}],"output":{"name":"billingRecord","type":"BillingRecord","cardinality":"1..1"}},{"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 records within a billing invoice.
comments:
- 'Rosetta func: Create_BillingRecords  Creates for each billing instruction an individual
  billing record to be included in a Security Lending Billing Invoice'
- 'Rosetta func: Create_BillingRecord  Creates an individual billing record to be
  included in a Security Lending Billing Invoice'
- '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:BillingRecord
slots:
- tradeState
- recordTransfer
- recordStartDate
- recordEndDate
- minimumFee
slot_usage:
  tradeState:
    name: tradeState
    description: The trade for the individual billing record.

Induced

name: BillingRecord
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_BillingRecords","description":"Creates for each billing
      instruction an individual billing record to be included in a Security Lending
      Billing Invoice","inputs":[{"name":"billingInstruction","type":"BillingRecordInstruction","cardinality":"1..*"}],"output":{"name":"billingRecord","type":"BillingRecord","cardinality":"1..*"}},{"name":"Create_BillingRecord","description":"Creates
      an individual billing record to be included in a Security Lending Billing Invoice","inputs":[{"name":"billingInstruction","type":"BillingRecordInstruction","cardinality":"1..1"}],"output":{"name":"billingRecord","type":"BillingRecord","cardinality":"1..1"}},{"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 records within a billing invoice.
comments:
- 'Rosetta func: Create_BillingRecords  Creates for each billing instruction an individual
  billing record to be included in a Security Lending Billing Invoice'
- 'Rosetta func: Create_BillingRecord  Creates an individual billing record to be
  included in a Security Lending Billing Invoice'
- '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:BillingRecord
slot_usage:
  tradeState:
    name: tradeState
    description: The trade for the individual billing record.
attributes:
  tradeState:
    name: tradeState
    description: The trade for the individual billing record.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.tradeState
    rank: 1000
    owner: BillingRecord
    domain_of:
    - CalculateTransferInstruction
    - BillingRecordInstruction
    - BillingRecord
    range: TradeState
    required: true
  recordTransfer:
    name: recordTransfer
    description: The settlement terms for the billing record
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecord.recordTransfer
    rank: 1000
    owner: BillingRecord
    domain_of:
    - BillingRecord
    range: Transfer
    required: true
    any_of:
    - range: ScheduledTransfer
    - range: UnscheduledTransfer
  recordStartDate:
    name: recordStartDate
    description: The starting date of the period described by this record
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecordInstruction.recordStartDate
    rank: 1000
    owner: BillingRecord
    domain_of:
    - BillingRecordInstruction
    - BillingRecord
    range: date
    required: true
  recordEndDate:
    name: recordEndDate
    description: The ending date of the period described by this record
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecordInstruction.recordEndDate
    rank: 1000
    owner: BillingRecord
    domain_of:
    - BillingRecordInstruction
    - BillingRecord
    range: date
    required: true
  minimumFee:
    name: minimumFee
    description: Indicates the minimum fee amount applied to the billing record, if
      any.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecord.minimumFee
    rank: 1000
    owner: BillingRecord
    domain_of:
    - BillingRecord
    - AssetPayout
    range: Money