機械翻訳について

収益プランの取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan

リクエスト

パス・パラメータ
  • これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定した収益プランIDとメジャー・バージョンの収益プランを検索します。
      ファインダ変数:
      • BillPlanId; integer;収益プラン識別子。
      • MajorVersion; integer;収益プラン・メジャー・バージョン。
    • RevenuePlanExtAltKey : 外部代替キーを持つ収益プランを検索します。
      ファインダ変数:
      • ExternalReferenceKey; string.
      • ExternalSourceKey; string.
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BillMethodId; integer; Revenueメソッドの識別子
    • BillMethodName;文字列;収益メソッド名
    • BillPlanId; integer;収益プラン識別子
    • BillPlanName;文字列;収益プラン名
    • BurdenSchFixedDate;文字列;間接費スケジュールの有効レートの決定に使用される固定日。
    • BurdenSchId; integer;間接費スケジュールの識別子
    • BurdenSchedule;文字列;収益プランの間接費スケジュール
    • EnableLbrBillXtnsnFlag; boolean;労務請求拡張の使用を許可するフラグ
    • EnableNlBillXtnsnFlag; boolean;非労務請求拡張の使用を許可するフラグ
    • ExternalReferenceKey; string;外部ソース内の参照キー
    • ExternalSourceKey; string;外部ソース・キー
    • JobBillRateSchId; integer;ジョブ請求レート・スケジュールの識別子
    • JobRateSchedule;文字列;ジョブ請求レート・スケジュール
    • LaborBillBasisCode;文字列;コスト払戻可能な労務費基準コード
    • LaborCostBasis;文字列;コスト払戻可能な労務費基準
    • LaborDiscountPercentage; number;標準労務請求レート・スケジュールから割引されるパーセント。
    • LaborDiscountReasonCode;文字列;労務レート変更理由コード
    • LaborMarkupPercentage;数値;労務値入れ率
    • LaborRateChangeReason;文字列;労務レート変更理由
    • LaborSchFixedDate; string; 標準労務請求レート・スケジュールの有効請求レートを決定するために使用される固定日。
    • LaborTpSchFixedDate; string; 会社間労務振替価格予定表の有効レートの決定に使用される固定日。
    • LaborTpScheduleId; integer;会社間振替価格の労務スケジュール識別子。
    • LaborTransferPriceSchedule; string; Labor Schedule for Inter Company Transfer Price.
    • MajorVersion; integer; 収益プランが定義されている契約メジャー・バージョン
    • NlBillBasisCode;文字列;コスト払戻可能な非労務費基準コード
    • NlBillRateSchId; integer;非労務請求レート・スケジュールの識別子
    • NlDiscountPercentage; number;標準非労務請求レート・スケジュールから割引されるパーセント。
    • NlDiscountReasonCode;文字列;非労務レート変更事由コード
    • NlMarkupPercentage;数値;非労務値入れ率
    • NlSchFixedDate; string; 標準非労務請求レート・スケジュールの有効請求レートを決定するために使用される固定日。
    • NlTpSchFixedDate; string; 会社間労務振替価格予定表の有効レートの決定に使用される固定日。
    • NlTpScheduleId;整数;会社間振替価格の非労務スケジュール識別子。
    • NonlaborCostBasis;文字列;コスト払戻可能な非労務コスト基準
    • NonlaborRateChangeReason;文字列;非労務レート変更事由
    • NonlaborRateSchedule;文字列;非労務請求レート・スケジュール
    • NonlaborTransferPriceSchedule; string; Non Labor Schedule for Inter Company Transfer Price.
    • OnHoldFlag; boolean;収益プランを使用して収益を認識できるかどうかをチェックするフラグ。
    • PersonBillRateSchId; integer;従業員請求レート・スケジュールの識別子
    • PersonRateSchedule;文字列;従業員請求レート・スケジュール
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : contracts-RevenuePlan
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : contracts-RevenuePlan-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 職務割当上書き
タイプ: array
タイトル: Job Assignment Overrides
リソースは、ジョブ割当上書き詳細の表示、作成、更新、削除に使用されます
ソースを表示
ネストされたスキーマ : ジョブ・レート上書き
タイプ: array
タイトル: Job Rate Overrides
リソースは、ジョブ・レート上書き詳細の表示、作成、更新、削除に使用されます。
ソースを表示
ネストされたスキーマ : 労務乗数上書き
タイプ: array
タイトル: Labor Multiplier Overrides
リソースは、労務乗数上書き詳細の表示、作成、更新、削除に使用されます。
ソースを表示
ネストされたスキーマ : 非労務レート上書き
タイプ: array
タイトル: Non Labor Rate Overrides
リソースは、非労務乗数上書き詳細の表示、作成、更新、削除に使用されます。
ソースを表示
ネストされたスキーマ : 個人レート上書き
タイプ: array
タイトル: Person Rate Overrides
このリソースは、個人レート上書き詳細の表示、作成、更新、削除に使用されます。
ソースを表示
ネストされたスキーマ : 収益プラン・フレックスフィールド
タイプ: array
タイトル: Revenue Plan Flexfields
収益プラン・フレックスフィールド・リソースは、契約収益プラン・フレックスフィールド情報を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 収益プラン翻訳
タイプ: array
タイトル: Revenue Plan Translations
収益プラン・トランザクション・リソースは、契約収益プラン翻訳情報を表示および更新するために使用されます。
ソースを表示
ネストされたスキーマ : contracts-RevenuePlan-JobAssignmentOverride-item-response
タイプ: object
ソースを表示
  • タイトル: Billing Title Override
    最大長: 80
    この請求プランの個人に割り当てられている上書きジョブ・タイトルの名前。 顧客への請求書の表示に使用されます。
  • タイトル: Contract Line ID
    ジョブ割当上書きが定義されている契約明細の一意識別子です。
  • タイトル: Contract Line Number
    最大長: 150
    ジョブ割当上書きが定義されている契約明細。
  • タイトル: Email
    最大長: 240
    職務割当上書きが定義されている電子メール・アドレス。
  • タイトル: End Date
    ジョブ・アサイメントの上書きが適用される日付。
  • タイトル: External Reference Key
    最大長: 150
    ソース・アプリケーションでのジョブ割当上書きの一意識別子です。 外部webサービスを介して作成されたジョブ割当上書きを識別するために使用されます。
  • タイトル: External Source Key
    最大長: 150
    ジョブ割当上書きが発生したソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたジョブ割当上書きを識別するために使用されます。
  • タイトル: Job Assignment Override ID
    請求プランのジョブ割当上書きの一意の識別子で、その個人の通常のジョブではなく、特定の個人に割り当てられたネゴシエーション済ジョブを識別します。
  • タイトル: Job Code
    この請求または収益プランの個人に割り当てられている上書きのジョブ・コード。
  • タイトル: Job ID
    この請求または収益プランの個人に割り当てられている上書きジョブの一意識別子です。
  • タイトル: Job Name
    最大長: 240
    この請求または収益プランの個人に割り当てられている上書きのジョブ名。
  • Links
  • タイトル: Version
    デフォルト値: 1
    この特定のジョブ割当セット上書き詳細を含む契約のバージョン。
  • タイトル: Person ID
    ジョブ・アサイメント上書きが定義されている個人の一意の識別子。
  • タイトル: Person
    最大長: 2000
    ジョブ・アサイメント上書きが定義されている個人。
  • タイトル: Person Number
    最大長: 30
    ジョブ・アサイメント上書きが定義されている個人番号。
  • タイトル: Start Date
    ジョブ・アサイメントの上書きが適用される開始日。
ネストされたスキーマ : contracts-RevenuePlan-JobRateOverride-item-response
タイプ: object
ソースを表示
  • タイトル: Job Rate Override ID
    請求レート上書きの一意識別子です。
  • タイトル: Unit of Measure
    読取り専用: true
    最大長: 30
    デフォルト値: HOURS
    請求レート・ユニット・コード。
  • タイトル: Contract Line ID
    請求レート上書きが適用される契約明細の一意識別子です。
  • タイトル: Contract Line Number
    最大長: 150
    請求レート上書きが適用される契約明細番号。
  • タイトル: Discount Percentage
    請求レートに適用された割引率。
  • タイトル: End Date
    請求レート上書きが有効になる日付。
  • タイトル: External Reference Key
    最大長: 150
    ソース・アプリケーションでの上書きの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
  • タイトル: External Source Key
    最大長: 150
    オーバーライドが作成されるソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
  • タイトル: Job Code
    請求レートが上書きされるジョブのコード。
  • タイトル: Job ID
    請求レートが上書きされるジョブの一意識別子です。
  • タイトル: Job
    最大長: 240
    請求レートが上書きされるジョブの名前。
  • Links
  • タイトル: Version
    デフォルト値: 1
    レコードの現在のバージョン。
  • タイトル: Rate
    品目の顧客に請求される金額。
  • タイトル: Currency
    最大長: 80
    請求レート上書きの通貨。
  • タイトル: Currency Code
    最大長: 30
    請求レート上書きの通貨コード。
  • タイトル: Discount Reason
    最大長: 80
    割引を適用する事由です。
  • タイトル: Discount Reason
    最大長: 30
    割引を適用する事由コード。
  • タイトル: Start Date
    請求レート上書きが有効になる日付です。
ネストされたスキーマ : contracts-RevenuePlan-LaborMultiplierOverride-item-response
タイプ: object
ソースを表示
  • タイトル: Contract Line ID
    労務乗数上書きが適用される契約明細の一意識別子です。
  • タイトル: Contract Line Number
    最大長: 150
    労務相互階層上書きが適用される契約明細番号。
  • タイトル: End Date
    労務乗数上書きが適用される日付。
  • タイトル: External Reference Key
    最大長: 150
    オーバーライドが作成されるソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
  • タイトル: External Source Key
    最大長: 150
    オーバーライドが作成されるソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
  • タイトル: Multiplier
    労務乗数
  • タイトル: Labor Multiplier ID
    請求プランまたは収益プランの労務乗数上書きの一意識別子で、ネゴシエーション済値に労務のコスト・レートを乗算するように識別します。
  • Links
  • タイトル: Version
    デフォルト値: 1
    この特定の労務乗数上書き詳細セットを含む契約のバージョン。
  • タイトル: Start Date
    労務乗数上書きが適用される開始日。
ネストされたスキーマ : contracts-RevenuePlan-NonLaborRateOverride-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contracts-RevenuePlan-PersonRateOverride-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contracts-RevenuePlan-RevenuePlanDescriptiveFlexField-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contracts-RevenuePlan-RevenuePlanTranslation-item-response
タイプ: object
ソースを表示
「トップに戻る」