Calculation
Specifies details for and the names and descriptions as to how a Charge or Allowance was calculated.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: CalculationType
Properties: Global, Qualified, ID: oagis-id-1f613737cb4440e89749cee56c573f2d
Content
- Sequence [1..1]
- Formula [0..1]
- RateNumber [0..1] Is the multiplier to convert the source units to the target units. (e.g.) The conversion of one currency to another currency monitary amount in the from currency is multiplied by the CalculationRateNumeric to calcultate the monitary amount in the to currency. Another example maybe the conversion between units of measure.
- Description [0..*]
- ApplicableTimePeriod [0..1]
- Extension [0..1] Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.
from type IdentificationTypefrom type CalculationABIEType
Attributes
Name | Occ | Type | Description | Notes |
---|---|---|---|---|
typeCode | [0..1] | CodeType_1E7368 | from type IdentificationType | |
actionCode | [0..1] | ActionCodeContentType | from type IdentificationType |
Used in
- Type AllowanceBaseType via extension of AllowanceChargeABIEType
- Type AllowanceChargeABIEType
- Type AllowanceType via extension of AllowanceChargeABIEType (Element Allowance)
- Type ChargeBaseType via extension of AllowanceChargeABIEType
- Type ChargeType via extension of AllowanceChargeABIEType (Element Charge)
- Type DistributeChargeBaseType via extension of AllowanceChargeABIEType
- Type DistributeChargeType via extension of AllowanceChargeABIEType (Element DistributeCharge)
- Type DistributeTaxBaseType via extension of TaxABIEType
- Type DistributeTaxType via extension of TaxABIEType (Element DistributeTax)
- Type InvoiceAllowanceChargeBaseType via extension of AllowanceChargeABIEType
- Type InvoiceAllowanceChargeType via extension of AllowanceChargeABIEType (Elements InvoiceCharge, InvoiceAllowance)
- Type TaxABIEType
- Type TaxBaseType via extension of TaxABIEType
- Type TaxType via extension of TaxABIEType (Elements Tax, TotalTax)
Sample instance
<Calculation> <ID/> <IDSet> <ID/> </IDSet> <Formula/> <RateNumber>1.0</RateNumber> <Description/> <ApplicableTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </ApplicableTimePeriod> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </Calculation>