付録C 課金データ

本付録では、Systemwalker Service Catalog Managerのアプリケーションサービス機能が出力する課金データについて説明します。

課金データの形式

課金データはXMLフォーマットで提供されます。各ファイルは、指定したカスタマーに対する指定した期間のデータが含まれています。ルート要素であるBillingdataには、複数のBillingDetails要素が含まれています。各BillingDetails要素には、1つのカスタマーに対する1つの請求期間における費用の情報が含まれます。

これらのデータ構造は、BillingResult.xsdファイルで定義されるXMLスキーマに従います。

課金データの厳密な定義については、BillingResult.xsdファイルを参照してください。BillingResult.xsdファイルはアプリケーション開発機能のインテグレーションパックに含まれています。インテグレーションパックの詳細については、“アプリケーション開発ガイド”を参照してください。

課金データのXMLの構成を以下に示します。

<Billingdata>
  <BillingDetails>
    <Period startDate="startDate" endDate="endDate"/>
    <OrganizationDetails>
      <Name>name</Name>
      <Address>address</Address>
      <Udas>
        <Uda id="id" value="value"/>
      </Udas>
    <Subscriptions>
      <Subscription id="id" purchaseOrderNumber="purchaseOrderNumber">
        <PriceModels>
          <PriceModel id="id">
            <UsagePeriod startDate="startDate" endDate="endDate"/>
            <GatheredEvents>
              <Event id="id">
                <SingleCost amount="amount"/>
                <SteppedPrices>
                  <SteppedPrice additionalPrice="additionalPrice" basePrice="basePrice"
                                freeAmount="freeAmount" limit="limit"/>
                </SteppedPrices>
                <NumberOfOccurrence amount="amount"/>
                <CostForEventType amount="amount"/>
              </Event>
            </GatheredEvents>
            <PeriodFee basePeriod="basePeriod" basePrice="basePrice" factor="factor" price="price"/>
            <UserAssignmentCosts basePeriod="basePeriod" basePrice="basePrice" factor="facetor"
                                 numberOfUsersTotal="numberOfusersTotal" price="price">
              <UserAssignmentCostsByUser factor="factor" userId="userId"/>
              <RoleCosts total=total>
                <RoleCost id="id" basePrice="basePrice" factor="factor" price="price"/>
              </RoleCosts>
              <SteppedPrices>
                <SteppedPrice additionalPrice="additionalPrice" basePrice="basePrice"
                              freeAmount="freeAmount" limit="limit"/>
              </SteppedPrices>
            </UserAssignmentConsts>
            <OneTimeFee amount="amount" baseAmount="baseAmount" factor="factor"/>
            <Parameters>
              <Parameter id="id">
                <ParameterValue amount="amount" parameterDataType="parameterDataType"/>
                <Options>
                  <Option id="id">
                    <PeriodFee basePeriod="basePeriod" basePrice="basePrice" factor="factor"
                               price="price" valueFactor="valueFactor"/>
                    <UserAssignmentCosts basePeriod="basePeriod" basePrice="basePrice"
                                         factor="factor" price="price"/>
                    <RoleCosts total="total">
                      <RoleCost id="id" basePrice="basePrice" factor="factor" price="price"/>
                    </RoleCosts>
                    <OptionCosts amount="amount"/>
                  </Option>
                </Options>
                <PeriodFee basePeriod="basePeriod" basePrice="basePrice" factor="factor"
                           price="price" valueFactor="valueFactor"/>
                <UserAssignmentCosts basePeriod="basePeriod" basePrice="basePrice" factor="factor"
                                     price="price" valueFactor="valueFactor"/>
                <RoleCosts total="total">
                  <RoleCost id="id" basePrice="basePrice" factor="factor" price="price"/>
                </RoleCosts>
                <ParameterCosts amount="amount"/>
              </Parameter>
            </Parameters>
            <PriceModelCosts amount="amount"/>
          </PriceModel>
        </PriceModels>
        <SubscriptionCosts amount="amount"/>
        <Udas>
          <Uda id="id" value="value"/>
        </Udas>
      </Subscription>
    </Subsriptions>
    <OverallCosts netAmount="netAmount" currency="currency">
      <Discount percent="percent" discountNetAmount="discountNetAmount"
                netAmountAfterDiscount="netAmountAfterDiscount"
                netAmountBeforeDiscount="netAmountBeforeDiscount"/>
    </OverallCosts>
  </BillingDetails>
</BillingData>

課金データの要素および属性

課金データのXMLの要素および属性を以下には以下の通りです。

要素												属性	説明
Billingdata													課金データ。
	BillingDetails												1つのカスタマーの1つの請求期間についての課金情報。請求期間の省略値は1ヶ月です。
		Period											課金データの計算対象の月。
												startDate	課金処理の対象となる最初の月(0:00)。1970年1月1日を基点としたミリ秒です。
												endDate	課金処理の対象となる最後の月の次の日(0:00)。1970年1月1日を基点としたミリ秒です。
		OrganizationDetails											課金データの計算の対象となる組織の名称、住所、およびカスタム属性。
			Name										組織名。
			Address										請求書に印刷される組織の住所。
			Udas										組織についての追加の情報を格納するカスタム属性。たとえば、収入を計上する組織内の部署など。
				Uda									カスタム属性。
												id	カスタム属性のID。
												value	カスタム属性の値。
		Subscriptions											現在の請求期間に関係するすべてのサービス利用のリスト。
			Subscription										カスタマーの個々のサービス利用は、それぞれ別セクションとなります。
												id	サービス利用を一意に特定するサービス利用名。
												purchaseOrderNumber	サービスを利用申請する際に指定された内部参照用の番号。
				PriceModels									サービス利用に対する使用料を計算するために使用する価格モデルのリスト。
					PriceModel								価格モデル。
					PriceModel							id	適用された価格モデルを一意に特定する価格モデル名。
						UsagePeriod							サービス利用の合計使用時間のミリ秒数。
												startDate	課金処理の対象となる最初の月(0:00)。1970年1月1日を基点としたミリ秒です。
												endDate	課金処理の対象となる最後の月の次の日(0:00)。1970年1月1日を基点としたミリ秒です。
						GatheredEvents							サービス利用中に発生したすべてのイベントのリスト。
							Event						イベント。
							Event					id	イベントのID。
							SingleCost						価格モデルで定義されたイベントの価格。
							SingleCost					amount	価格。
							SteppedPrices						イベントに対する段階的な価格。
								SteppedPrice					段階的な価格。
												additionalPrice	1つ前の段階までの価格。
												basePrice	各段階の上限値についての、価格モデルに従って計算した価格。
												freeAmount	固定の割引とみなす段階ごとの価格。
												limit	価格モデルで定義されたこの段階の上限値。
								NumberOfOccurrence					イベントの発生回数。
								NumberOfOccurrence				amount	発生回数。
								CostForEventType					イベントに対する料金の全体の合計(単価×発生回数)。イベントに対する段階的な価格も考慮されます。
								CostForEventType				amount	料金。
						PeriodFee							サービスを利用するための料金。
												basePeriod	料金計算の期間の単位(MONTH, WEEK, DAY, HOUR)。
												basePrice	価格モデルで定義された単価。
												factor	サービス利用の価格計算に使用する係数。
												price	サービス単価にも基づくサービス利用の料金。
						UserAssignmentCosts							サービスに割り当てたユーザーについての料金。
												basePeriod	料金計算の期間の単位(MONTH, WEEK, DAY, HOUR)
												basePrice	価格モデルで定義されたユーザー単価。
												factor	料金計算の期間の単位に基づいて、サービスに割り当てられた全ユーザーの実際の使用時間を計算することにより得られた係数。
												numberOfUsersTotal	請求期間中にサービスに割り当てられた全ユーザー数。
												price	ユーザーの割り当てによる料金。
							UserAssignmentCostsByUser						サービスに割り当てた一人のユーザーについての料金。
												factor	請求期間中、ユーザーがサービスに割り当てられた期間の割合。
												userId	ユーザーID。
							RoleCosts						ユーザーロールに対する追加の料金のリスト。
							RoleCosts					total	ユーザーロールについての料金の合計。
								RoleCost					ユーザーロールに対する料金。
												id	ユーザーロールのID。
												basePrice	価格モデルで定義されたユーザーロールに対する追加の料金。
												factor	ユーザーロールについての料金計算に使用する係数。
												price	ユーザーロールの価格。
							SteppedPrices						イベントに対する段階的な価格のリスト。
								SteppedPrice					段階的な価格。
												additionalPrice	1つ前の段階までの価格。
												basePrice	各段階の上限値についての、価格モデルに従って計算した価格。
												freeAmount	固定の割引とみなす段階ごとの価格。
												limit	価格モデルで定義されたこの段階の上限値。
						OneTimeFee							サービスを利用する際の初期サービス価格。この価格は最初の請求期間に対する使用料金に追加されます。
amount												初期サービス価格。
baseAmount	価格モデルに定義された初期サービス価格。
factor	初期サービス価格の計算に使用する係数。この料金は一度しか発生しないため、この係数は、最初の請求期間については1、それ以降の月については0となります。
Parameters							パラメーターについての料金のリスト。つまり、サービス仕様に定義されたオプションのリストです。
	Parameter						パラメーター。
	Parameter					id	パラメーターのID。
		ParameterValue					パラメーターについての価格。
						amount	価格モデルに定義されたパラメーターの価格。
						parameterDataType	パラメーターのデータ型(LONG, STRING, BOOLEAN, ENUMERATION, INTEGER, DURATION)。
		Options					パラメーターオプションのリスト。
			Option				パラメーターオプション。
			Option			id	オプションのID。
				PeriodFee			使用時間に基づくパラメーターオプションの料金。
						basePeriod	料金計算の単位になる期間。
						basePrice	価格モデルで定義されたユーザー単価。
						factor	パラメーターの使用料の計算に使用する係数。
						price	パラメーターの使用に対する料金。
						valueFactor	数値パラメーターの値。論理値を示すパラメーターについては、値が真の場合は1、そうでない場合は0となります。
				UserAssignmentCosts			サービスにユーザーを割り当てることにより発生するオプション関連の料金。
						basePeriod	料金計算の単位になる期間。
						basePrice	価格モデルで定義されたパラメーターオプションについてのユーザー単価。
						factor	パラメーターオプションの使用料の計算に使用する係数。
						price	ユーザーの割り当てによって発生する料金に関係するパラメーターオプションの使用料。
				RoleCosts			ユーザーロールについてのオプション関連の料金のリスト。
				RoleCosts		total	ユーザーロールについての料金の合計。
					RoleCost		ユーザーロールに対する料金。
						id	ユーザーロールのID。
						basePrice	価格モデルで定義されたユーザーロールに対する追加の料金。
						factor	ユーザーロールについての料金計算に使用する係数。
						price	ユーザーロールの価格。
				ParameterCosts			価格モデルの定義に基づく料金の合計。
				ParameterCosts		amount	料金。
	PriceModelCosts						価格モデルの定義に基づく料金の合計。
	PriceModelCosts					amount	料金の合計。
SubscriptionCosts									サービス利用の料金の合計。
SubscriptionCosts								amount	料金の合計。
Udas									サービス利用についての情報を格納するカスタム属性のリスト。
	Uda								カスタム属性。
								id	カスタム属性のID。
								value	カスタム属性の値。
OverallCosts											カスタマーが支払う料金の合計。
										netAmount	料金の合計。
										currency	料金計算に使用する通貨のISOコード。
	Discount										カスタマーに適用する割引。
										percent	全体の料金からの割引率。
										discountNetAmount	料金の合計から差し引く割引額。
										netAmountAfterDiscount	割引後の料金の合計。
										netAmountBeforeDiscount	割引前の料金の合計。