SystemwalkerService Catalog Manager アプリケーション開発ガイド

B.5 サービス提供部門の売上配分データ

以下の節では、サービス提供部門の売上配分データを構成するXML要素と属性を説明します。

SupplierRevenueShareResult

サービス提供部門の売上配分データの最上位のコンテナ要素です。対象のサービス提供部門それぞれについて、売上配分データファイルにSupplierRevenueShareResult要素が追加されます。

SupplierRevenueShareResultには、以下の属性があります。

• organizationId - (必須。データ型： string) サービス提供部門のID。

• organizationKey - (必須。データ型： positiveInteger) サービス提供部門の内部数値キー。

SupplierRevenueShareResultには、以下の下位要素が格納されます。

• OrganizationData要素。この要素は、サービス提供部門の詳細を示します(“OrganizationData”を参照)。

• Period要素。この要素は、請求期間を示します(“Period”を参照)。

• Currency要素。この要素は、サービスポータル運用部門の売上配分データで使用されている各通貨を示しますCurrency要素 (“Currency”を参照)。

Example:

<SupplierRevenueShareResult organizationId="cd9ffaac" organizationKey="19000">
  <OrganizationData> ... </OrganizationData>
  <Period> ... </Period>
  <Currency> ... </Currency>
</SupplierRevenueShareResult>

Currency

特定の通貨についてのサービス提供部門の売上配分データが格納されます。

Currency要素には、以下の属性があります。

• id - (必須。データ型： string) 通貨のISOコード。

Currency要素には、以下の下位要素が格納されます。

• Marketplace要素。この要素は、サービス提供部門の売上配分データの対象になっているサービスポータルを示します(“Marketplace”を参照)。

• SupplierRevenue要素。この要素は、サービス提供部門に対する売上データの詳細を示します。(“SupplierRevenue”を参照)。

例：

<Currency id="EUR">
  <Marketplace>...</Marketplace>
  <SupplierRevenue>...</SupplierRevenue>
</Currency>

Marketplace

特定のサービスポータルに対する売上配分データが格納されます。

Marketplace要素には、以下の属性があります。

• id - (必須。データ型： string) サービスポータルのID。

• key - (必須。データ型： positiveInteger) サービスポータルの内部数値キー。

Marketplace要素には、以下の下位要素が格納されます。

• MarketplaceOwner要素。この要素の下位要素であるOrganizationData要素にサービスポータル管理部門が示されます (“OrganizationData”参照)。

• Service要素。この要素は、サービス提供部門の売上配分データの対象になっているサービスポータル上のサービスを示します(“Service”を参照).

• RevenuesPerMarketplace要素。この要素は、関係するすべての組織への売上配分を集約します(RevenuesPerMarketplaceを参照)。

例：

<Marketplace id="e1828fba" key="17021">
  <MarketplaceOwner>
    <OrganizationData> ... </OrganizationData>
  </MarketplaceOwner>
  <Service>...</Service>
  <RevenuePerMarketplace> ... </RevenuePerMarketplace>
</Marketplace>

SupplierRevenue

対象のサービス提供部門に対する売上配分データが格納されます。

SupplierRevenue要素には、以下の属性があります。

• amount - (必須。データ型： decimal, scale 2) サービス提供部門の売上の全体。

SupplierRevenue要素には、サービス提供部門のサービスを提供している組織に応じて、以下の下位要素が格納されます。

• DirectRevenue要素。この要素は、サービス提供部門が直接提供しているサービスに対する売上を示します。

• BrokerRevenue要素。この要素は、サービス仲介部門が提供しているサービス提供部門のサービスに対する売上を示します。

• ResellerRevenue要素。この要素は、サービス提供代行部門が提供しているサービス提供部門のサービスに対する売上を示します。

例：

<SupplierRevenue amount="1500.00">
  <DirectRevenue> ... </DirectRevenue>
  <BrokerRevenue> ... </BrokerRevenue>
  <ResellerRevenue> ... </ResellerRevenue>
</SupplierRevenue>

DirectRevenue

サービス提供部門が提供しているサービスに対する売上データが格納されます。

DirectRevenue要素には、以下の属性があります。

• serviceRevenue - (必須。データ型： decimal, scale 2) サービス提供部門が提供しているサービスに対する売上全体。

• marketplaceRevenue - (必須。データ型： decimal, scale 2) サービス提供部門が提供しているサービスに対するサービスポータル管理部門の売上全体。

例：

<SupplierRevenue amount="1500.00">
  <DirectRevenue serviceRevenue="500.00" marketplaceRevenue="75.00" />
  <BrokerRevenue> ... </BrokerRevenue>
  <ResellerRevenue> ...</ResellerRevenue>
</SupplierRevenue>

BrokerRevenue

サービス仲介部門が提供しているサービス提供部門のサービスに対する売上データが格納されます。

BrokerRevenue要素には、以下の属性があります。

• serviceRevenue - (必須。データ型： decimal, scale 2) サービス提供部門が提供しているサービスに対する売上全体。

• marketplaceRevenue - (必須。データ型： decimal, scale 2) サービス仲介部門が提供しているサービスに対するサービスポータル管理部門の売上全体。

• brokerRevenue - (必須。データ型： decimal, scale 2) サービスを提供しているサービス仲介部門の売上全体。

例：

<SupplierRevenue amount="1500.00">
  <DirectRevenue> ... </DirectRevenue>
  <BrokerRevenue serviceRevenue="500.00" marketplaceRevenue="75.00" brokerRevenue="25.00" />
  <ResellerRevenue> ...</ResellerRevenue>
</SupplierRevenue>

ResellerRevenue

サービス提供代行部門が提供しているサービス提供部門のサービスに対する売上データが格納されます。

ResellerRevenue要素には、以下の属性があります。

• serviceRevenue - (必須。データ型： decimal, scale 2) サービス提供代行部門が提供しているサービスに対する売上全体。

• marketplaceRevenue - (必須。データ型： decimal, scale 2) サービス提供代行部門が提供しているサービスに対するサービスポータル管理部門の売上全体。

• resellerRevenue - (必須。データ型： decimal, scale 2) サービスを提供しているサービス提供代行部門の売上全体。

• overallRevenue - (必須。データ型： decimal, scale 2) サービス提供部門代行部門が提供しているサービスに対する売上全体から、サービスポータル運用部門の売上(marketplaceRevenue)とサービス仲介部門の売上(resellerRevenue)を差し引いた値。

Example:

<SupplierRevenue amount="1500.00">
  <DirectRevenue> ... </DirectRevenue>
  <BrokerRevenue> ... </BrokerRevenue>
  <ResellerRevenue serviceRevenue="500.00" marketplaceRevenue="75.00" resellerRevenue="25.00"
   overallRevenue="400.00" />
</SupplierRevenue>

Service

特定のサービスについての売上配分データを示します。

A Service element has the following attributes:

Service要素には、以下の属性があります。

• id - (必須。データ型： string) サービスの名称。

• key - (必須。データ型： positiveInteger) 公開されたサービスの内部数値キー。サービス仲介部門またはサービス提供代行部門が提供しているサービスでは、サービス提供部門によって定義された元のサービスの値の複製になります。サービス提供部門が直接提供しているサービスでは、元のサービスのキーになります。

• model - (必須。データ型： string) サービスを提供している組織の種類を示す文字列。以下の値のいずれかです。

  • DIRECT : サービス提供部門が提供しているサービス。

  • BROKER : サービス仲介部門が提供しているサービス。

  • RESELLER : サービス提供代行部門が提供しているサービス。

• templateKey - (選択。データ型： positiveInteger) サービス提供部門によって定義された元々のサービスの内部数値キー（サービスがサービス仲介部門またはサービス提供代行部門が公開しているサービスの場合）。

Service要素には、以下の下位要素が格納されます。

• サービス提供部門が直接提供しているサービスの場合：

  • Subscription要素。この要素は、売上配分データの対象になっている各購入済みサービスを示します。(“Subscription”を参照)。

• サービス仲介部門が提供しているサービスの場合：

  • Subscription要素。この要素は、売上配分データの対象になっている各購入済みサービスを示します。(“Subscription”を参照)。

  • Broker要素。この要素は、下位要素のOrganizationData内のサービス仲介部門を示します(“OrganizationData”を参照)。

• サービス提供代行部門が提供しているサービスの場合：

  • SubscriptionsRevenue要素。この要素のamount属性(必須。データ型： positive decimal, scale 2)に、すべての購入済みサービスに対する売上の合計が集計されます。

  • Reseller要素。この要素は、下位要素のOrganizationData内のサービス提供代行部門を示します(“OrganizationData”を参照)。

• RevenueShareDetails要素。この要素は、サービスに対する売上配分を示します (“RevenueShareDetails”を参照)。

例：

サービス提供部門が直接提供しているサービスの場合:

<Service id="Mega Office" key="17005" model="DIRECT">
  <Subscription> ... </Subscription>
  <RevenueShareDetails> ... </RevenueShareDetails>
</Service>

サービス仲介部門が提供しているサービスの場合:

<Service id="Mega Office" key="17005" model="BROKER" templateKey="10501">
  <Subscription> ... </Subscription>
  <Broker> <OrganizationData> ... </OrganizationData> </Broker>
  <RevenueShareDetails> ... </RevenueShareDetails>
</Service>

サービス提供代行部門が提供しているサービスの場合:

<Service id="Mega Office" key="17005" model="RESELLER" templateKey="10501">
  <SubscriptionsRevenue amount="6000.00" />
  <Reseller> <OrganizationData> ... </OrganizationData> </Reseller>
  <RevenueShareDetails> ... </RevenueShareDetails>
</Service>

Subscription

特定の購入済みサービスに対する売上を示します。

Subscriptionには、以下の属性があります。

• id - (必須。データ型： string) 購入済みサービスの名称。

• key - (必須。データ型： positiveInteger) 購入済みサービスの内部数値キー。

• billingKey - (必須。データ型： positiveInteger) 一意の識別子。例えば、会計システムで請求データと請求書を関連付けるために使用できます。請求データキーは請求書に印刷されます。

• revenue - (必須。データ型： positive decimal, scale 2) 請求期間における購入済みサービスに対する売上の合計。

Subscription要素には、下位要素としてPeriod要素が格納されます。この要素は適用される適用される請求期間を示します(“Period”を参照)。

例：

<Subscription id="Mega Office Basic" key="17005" billingKey="19032" revenue="600.00">
  <Period>... </Period>
</Subscription>

RevenueShareDetails

特定のサービスの売上と、サービスの販売に関係しているすべての組織に対する売上配分を示します。

RevenueShareDetails要素には、以下の属性があります。

• serviceRevenue - (必須。データ型： scale 2) 請求期間におけるサービスに対する売上全体。

• marketplaceRevenueSharePercentage - (必須。データ型： decimal, scale 2) サービスポータル運用部門が受け取ることができる売上のパーセント率。

• brokerRevenueSharePercentage - (オプション。データ型： decimal, scale 2) サービス仲介部門が受け取ることができる売上のパーセント率（サービス仲介部門が提供するサービスの場合）。

• resellerRevenueSharePercentage - (オプション。データ型： decimal, scale 2) サービス提供代行部門が受け取ることができる売上のパーセント率（サービス提供代行部門が提供するサービスの場合）。

• marketplaceRevenue - (必須。データ型： decimal, scale 2) 請求期間におけるこのサービスに対するサービスポータル運用部門の配分率。

• brokerRevenue - (オプション。データ型： decimal, scale 2) 請求期間におけるこのサービスに対するサービス仲介部門の売上配分（サービス仲介部門が提供するサービスの場合）。

• resellerRevenue - (オプション。データ型： decimal, scale 2) 請求期間におけるこのサービスに対するサービス提供代行部門の売上配分（サービス提供代行部門が提供するサービスの場合）。

• amountForSupplier - (必須。データ型： data type decimal, scale 2) 請求期間におけるこのサービスに対するサービス提供部門の売上配分。これは、サービスの売上の合計から、サービスポータル運用部門およびサービス仲介部門、サービス提供代行部門の売上配分を差し引いた残りの値になります。

RevenueShareDetails要素には、サービスを利用しているサービス利用部門ごとに、下位要素としてCustomerRevenueShareDetails要素が格納されます(“CustomerRevenueShareDetails”を参照).

例：

サービス提供部門が直接提供しているサービスの場合:

<RevenueShareDetails serviceRevenue="16.92" marketplaceRevenueSharePercentage="10.00" marketplaceRevenue="1.69"
 amountForSupplier="15.23">
  <CustomerRevenueShareDetails> ... </CustomerRevenueShareDetails>
</RevenueShareDetails>

サービス仲介部門が提供しているサービスの場合:

<RevenueShareDetails serviceRevenue="4000.00" marketplaceRevenueSharePercentage="21.00" marketplaceRevenue="840.00"
 amountForSupplier="2800.00" brokerRevenue="360.00" brokerRevenueSharePercentage="9.00">
  <CustomerRevenueShareDetails> ... </CustomerRevenueShareDetails>
</RevenueShareDetails>

サービス提供代行部門が提供しているサービスの場合:

<RevenueShareDetails serviceRevenue="4000.00" marketplaceRevenueSharePercentage="16.00" marketplaceRevenue="640.00"
 resellerRevenueSharePercentage="20.00" resellerRevenue="800.00" amountForSupplier="2560.00">
  <CustomerRevenueShareDetails> ... </CustomerRevenueShareDetails>
</RevenueShareDetails>

CustomerRevenueShareDetails

特定のサービス利用部門に対する特定のサービスの売上と、サービスの販売に関係しているすべての組織に対する売上配分を示します。

CustomerRevenueShareDetails要素には、以下の属性があります。

• customerName - (必須。データ型： string) サービス利用部門の名称。

• customerId - (required, data type string) サービス利用部門のID。

• serviceRevenue - (必須。データ型： scale 2) 請求期間におけるサービスに対する売上の合計。

• marketplaceRevenueSharePercentage - (必須。データ型： decimal, scale 2) サービスポータル運用部門が受け取ることができる売上のパーセント率。

• marketplaceRevenue - (必須。データ型： decimal, scale 2) 請求期間におけるこのサービスに対するサービスポータル運用部門の売上配分。

• amountForSupplier - (必須。データ型： data type decimal, scale 2) 請求期間におけるこのサービスに対するサービス提供部門の売上配分。これは、サービスの売上の合計から、サービスポータル運用部門およびサービス仲介部門、サービス提供代行部門の売上配分を差し引いた残りの値になります。

• brokerRevenueSharePercentage - (オプション。データ型： decimal, scale 2) サービス仲介部門が受け取ることができる売上のパーセント率（サービス仲介部門が提供するサービスの場合）。

• brokerRevenue - (オプション。データ型： decimal, scale 2) 請求期間におけるこのサービスに対するサービス仲介部門の売上配分（サービス仲介部門が提供するサービスの場合）。

• resellerRevenueSharePercentage - (オプション。データ型： decimal, scale 2) サービス提供代行部門が受け取ることができる売上のパーセント率（サービス提供代行部門が提供するサービスの場合）。

• resellerRevenue - (オプション。データ型： decimal, scale 2) 請求期間におけるこのサービスに対するサービス提供代行部門の売上配分（サービス提供代行部門が提供するサービスの場合）。

例：

サービス提供部門が直接提供しているサービスの場合:

<CustomerRevenueShareDetails customerName="MyCompany" customerId="8dac00a0" serviceRevenue="16.92"
 marketplaceRevenueSharePercentage="10.00" marketplaceRevenue="1.69" amountForSupplier="15.23"/>

サービス仲介部門が提供しているサービスの場合:

<CustomerRevenueShareDetails customerName="ITCompany" customerId="ff48ae0b" serviceRevenue="4000.00"
 marketplaceRevenueSharePercentage="21.00" marketplaceRevenue="840.00" amountForSupplier="2800.00"
 brokerRevenue="360.00" brokerRevenueSharePercentage="9.00"/>

サービス提供代行部門が提供しているサービスの場合:

CustomerRevenueShareDetails customerName="ITCompany" customerId="ff48ae0b" serviceRevenue="4000.00" marketplaceRevenueSharePercentage="21.00" marketplaceRevenue="840.00" amountForSupplier="2800.00" brokerRevenue="360.00" brokerRevenueSharePercentage="9.00"/>

RevenuePerMarketplace

サービス提供部門が特定のサービスポータル上で販売しているサービスに関係する各組織に対する売上配分の概要を提供します。

RevenuePerMarketplace要素には、以下の下位要素が格納されます。

• serviceRevenue - (必須。データ型： decimal, scale 2) 請求期間における該当するすべてのサービスに対する売上の合計。

• marketplaceRevenue - (必須。データ型： decimal, scale 2) サービスポータル運用部門に対する売上配分の合計。

• brokerRevenue - (オプション。データ型： decimal, scale 2) サービス仲介部門に対する売上配分の合計。

• resellerRevenue - (オプション。データ型： decimal, scale 2) サービス提供代行部門に対する売上配分の合計。

• overallRevenue - (必須。データ型： decimal, scale 2) サービス提供部門に対する売上配分の合計。これは、全サービスについての売上の合計から、サービスポータル運用部門およびサービス仲介部門、サービス提供代行部門の売上配分を差し引いた残りの値になります。

例：

<RevenuePerMarketplace serviceRevenue="1010.00" marketplaceRevenue="126.25" resellerRevenue="0.00"
 brokerRevenue="121.20" overallRevenue="762.55"/>