Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

請求調整の取得

get

/crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}

リクエスト

パス・パラメータ

BillAdjustmentRequestsNumber(required): string

請求修正リクエスト・レコードの一意の識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : billingAdjustments-item-response

タイプ: object

ソースを表示

AdditionalComments: string

タイトル: Additional Comments

最大長: 255

この修正の追加承認または否認コメント。
AdjustmentReason: string

タイトル: Adjustment Reason

最大長: 30

請求修正の事由です。
AdjustmentType: string

タイトル: Adjustment Type

最大長: 20

請求、品目またはイベント・レベルの調整など、調整リクエストのタイプ。
AdjustmentUnitOfMeasure: string

タイトル: Unit of Measure

最大長: 100

請求修正の単位。
AmountDue: number

タイトル: Amount Due

実際の支払金額。
ApproveAmount: number

タイトル: Approved Amount

調整が承認された金額。
ApprovedByPartyId: integer (int64)

タイトル: Approved by Party ID

修正リクエストを承認したユーザーの一意の識別子。
ApprovedByPartyName: string

タイトル: Approved By

読取り専用: true

最大長: 360

修正リクエストを承認したユーザーの名前。
ApprovedByPartyNumber: string

タイトル: Approved by Party Number

読取り専用: true

最大長: 30

修正リクエストを承認したユーザーの公開一意識別子。
ApprovePercent: number

タイトル: Approved Percentage

調整が承認された金額のパーセント。
AssigneePersonName: string

タイトル: Assigned To

読取り専用: true

最大長: 360

割当先の名前。
AssigneeResourceId: integer (int64)

タイトル: Assigned to Resource ID

サービス・リクエストに割り当てられたリソースの一意の識別子。
AssigneeResourceNumber: string

タイトル: Assigned to Resource Number

読取り専用: true

最大長: 30

割当先の公開一意識別子。
BillAdjustmentRequestsId: integer (int64)

タイトル: Bill Adjustment Request ID

読取り専用: true

請求修正リクエストの一意の識別子。
BillAdjustmentRequestsNumber: string

タイトル: Bill Adjustment Request Number

最大長: 30

請求修正リクエスト・レコードの一意の識別子。
billingAdjustmentEvents: array Billing Adjustment Events

タイトル: Billing Adjustment Events

請求修正イベント・リソースは、請求修正イベントの表示、作成、更新および削除に使用されます。
CategoryId: integer (int64)

タイトル: Category

読取り専用: true

請求修正に関連付けられたサービス・リクエスト・カテゴリ。
CategoryName: string

タイトル: Category Name

読取り専用: true

最大長: 400

請求修正に関連付けられたサービス・リクエスト・カテゴリ名。
CategoryShortName: string

タイトル: Category Short Name

読取り専用: true

最大長: 240

サービス・リクエスト・カテゴリの短縮名。
Comments: string

タイトル: Comments

最大長: 255

この修正のコメント。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

請求修正リクエストの企業通貨コード。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行の作成日時。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

通貨換算のレート・タイプ。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

請求修正リクエストの通貨コード。
DeleteFlag: boolean

タイトル: Delete Indicator

読取り専用: true

ユーザーがレコードを削除できるかどうかを示します。
ExternalAdjustmentId: string

タイトル: External Adjustment ID

最大長: 300

外部請求システムからの調整ID。
ExternalAdjustmentNumber: string

タイトル: External Adjustment Number

最大長: 300

外部請求システムからの修正の公開一意識別子。
ExternalBalanceGroupId: string

タイトル: External Balance Group ID

最大長: 300

外部請求システムからの非通貨の残高グループの一意の識別子。
ExternalBalanceGroupNumber: string

タイトル: External Balance Group Number

最大長: 300

外部請求システムからの非通貨の残高グループの公開一意識別子。
ExternalBillId: string

タイトル: External Bill ID

最大長: 300

外部請求システムからの請求ID。
ExternalBillItemId: string

タイトル: External Bill Item ID

最大長: 300

外部請求システムからの請求アイテムID。
ExternalBillItemNumber: string

タイトル: External Bill Item Number

最大長: 300

外部請求システムからの請求アイテムの公開一意識別子。
ExternalBillNumber: string

タイトル: External Bill Number

最大長: 300

外部請求システムからの請求の公開一意識別子。
ExternalBillUnitId: string

タイトル: External Bill Unit ID

最大長: 300

修正リクエストの請求ユニットの一意の識別子。
ExternalBillUnitNumber: string

タイトル: External Bill Unit Number

最大長: 300

修正リクエストの請求ユニットの公開一意識別子です。
ExternalServiceId: string

タイトル: External Service ID

最大長: 300

外部請求システムのサービスID。
ExternalServiceNumber: string

タイトル: External Service Number

最大長: 300

外部請求システムからのサービスの公開一意識別子。
ExternalServiceType: string

タイトル: External Service Type

最大長: 300

非通貨修正リクエストの調整済リソースのタイプです。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

行に対して最後に行われた更新の日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

行を最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
NonCurrencyAdjustmentFlag: boolean

タイトル: Noncurrency Adjustment

最大長: 1

デフォルト値: false

修正リクエストが通貨値に対するものか、非通貨使用に対するものかを示します。
NonCurrencyAdjustmentType: string

タイトル: Noncurrency Adjustment Type

最大長: 30

非通貨修正の請求ユニットまたはイベント・レベルなど、修正リクエストのタイプ。
NonCurrencyUsageAmount: number

タイトル: Noncurrency Usage

調整前の実際の非通貨使用。
PartyName: string

タイトル: Assigned To

読取り専用: true

最大長: 360

サービス・リクエストに割り当てられたリソースの名前。
PrimaryContactPartyId: integer (int64)

タイトル: Primary Contact ID

調整リクエストを最初にレポートしたユーザーの一意の識別子。
PrimaryContactPartyName: string

タイトル: Primary Contact

読取り専用: true

最大長: 360

修正リクエスト・プライマリ担当者の名前。
PrimaryContactPartyNumber: string

タイトル: Primary Contact Number

読取り専用: true

最大長: 30

関連付けられたプライマリ担当者の公開一意識別子。
QueueId: integer (int64)

タイトル: Assigned Queue ID

サービス・リクエストに割り当てられたキューの一意の識別子。
QueueName: string

タイトル: Queue

読取り専用: true

最大長: 400

サービス・リクエスト・キューを示します。
QueueNumber: string

タイトル: Queue Number

読取り専用: true

最大長: 30

キュー識別子の代替キー。
RejectedByPartyId: integer (int64)

タイトル: Rejected by Party ID

修正リクエストを否認したユーザーの一意の識別子。
RejectedByPartyName: string

タイトル: Rejected By

読取り専用: true

最大長: 360

修正リクエストを否認したユーザーの名前。
RejectedByPartyNumber: string

タイトル: Rejected by Party Number

読取り専用: true

最大長: 30

修正リクエストを否認したユーザーの公開一意識別子。
RejectReason: string

タイトル: Rejection Reason

最大長: 255

修正を否認する事由です。
ReportedByPartyName: string

タイトル: Reported By

読取り専用: true

最大長: 360

調整リクエストをレポートした個人。
RequestAmount: number

タイトル: Requested Amount

調整がリクエストされる金額。
RequestPercent: number

タイトル: Requested Percentage

調整がリクエストされる金額のパーセント。
SrId: integer (int64)

タイトル: Service Request ID

サービス・リクエスト・レコードの一意の識別子。
SrNumber: string

タイトル: Reference Number

最大長: 30

請求修正に関連付けられているサービス・リクエスト参照番号。
StatusCode: string

タイトル: Status

最大長: 30

修正リクエストのステータスです。
SubmittedByPartyId: integer (int64)

タイトル: Submitted by Party ID

調整リクエストを送信したユーザーの一意のID。
SubmittedByPartyName: string

タイトル: Submitted By

読取り専用: true

最大長: 360

修正リクエストを発行したユーザー。
SubmittedByPartyNumber: string

タイトル: Submitted by Party ID

読取り専用: true

最大長: 30

修正リクエストを送信したユーザーの公開一意識別子。
TaxTreatment: string

タイトル: Tax Treatment

最大長: 30

税金が請求修正に含まれるかどうかを示します。
Title: string

タイトル: Title

読取り専用: true

最大長: 400

サービス・リクエストのタイトル。
UpdateFlag: boolean

タイトル: Update Indicator

読取り専用: true

ユーザーがレコードを更新できるかどうかを示します。
ValidFrom: 文字列(日付)

タイトル: Valid From

非通貨調整の有効性が開始される日付。
ValidTo: 文字列(日付)

タイトル: Valid To

非通貨調整の有効期間が終了する日付。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the row creation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentUnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":100,
            "type":"string",
            "description":"The unit of measure for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Assigned To",
            "maxLength":360,
            "type":"string",
            "description":"The name of the resource assigned to the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The rate type of currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount for which adjustment is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the adjustment request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the bill adjustment request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalBillItemNumber":{
            "title":"External Bill Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of the bill item from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBillUnitId":{
            "title":"External Bill Unit ID",
            "maxLength":300,
            "type":"string",
            "description":"The unique identifier of the bill unit for the adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidFrom":{
            "title":"Valid From",
            "type":"string",
            "description":"The date when the validity for non-currency adjustment starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the user who initially reported the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the bill adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedByPartyName":{
            "title":"Submitted By",
            "maxLength":360,
            "type":"string",
            "description":"The user who submitted the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectedByPartyId":{
            "title":"Rejected by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AmountDue":{
            "title":"Amount Due",
            "type":"number",
            "description":"The actual due amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedByPartyName":{
            "title":"Reported By",
            "maxLength":360,
            "type":"string",
            "description":"The person who reported the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByPartyNumber":{
            "title":"Submitted by Party ID",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the user who submitted the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxTreatment":{
            "title":"Tax Treatment",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the tax is included in the bill adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryShortName":{
            "title":"Category Short Name",
            "maxLength":240,
            "type":"string",
            "description":"The service request category short name.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Assigned Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue assigned to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalBalanceGroupNumber":{
            "title":"External Balance Group Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of balance group of noncurrency from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalBillNumber":{
            "title":"External Bill Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of the bill from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the primary contact associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneePersonName":{
            "title":"Assigned To",
            "maxLength":360,
            "type":"string",
            "description":"The name of the assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeResourceNumber":{
            "title":"Assigned to Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedByPartyNumber":{
            "title":"Approved by Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the user who approved the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentRequestsNumber":{
            "title":"Bill Adjustment Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the bill adjustment request record.",
            "nullable":false,
            "x-queryable":true
        },
        "billingAdjustmentEvents":{
            "title":"Billing Adjustment Events",
            "type":"array",
            "description":"The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.",
            "items":{
                "$ref":"#/components/schemas/billingAdjustments-billingAdjustmentEvents-item-response"
            }
        },
        "ExternalBillUnitNumber":{
            "title":"External Bill Unit Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of the bill unit for the adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The service request category associated with the bill adjustment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalServiceType":{
            "title":"External Service Type",
            "maxLength":300,
            "type":"string",
            "description":"The type of the adjusted resource for a noncurrency adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalServiceId":{
            "title":"External Service ID",
            "maxLength":300,
            "type":"string",
            "description":"The service ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeResourceId":{
            "title":"Assigned to Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApproveAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount for which adjustment is approved.",
            "nullable":true,
            "x-queryable":true
        },
        "NonCurrencyAdjustmentFlag":{
            "title":"Noncurrency Adjustment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the adjustment request is for a currency value or non-currency usage.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AdditionalComments":{
            "title":"Additional Comments",
            "maxLength":255,
            "type":"string",
            "description":"The additional approval or rejection comments for this adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the adjustment request primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedByPartyName":{
            "title":"Approved By",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who approved the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByPartyId":{
            "title":"Submitted by Party ID",
            "type":"integer",
            "description":"The unique ID of the user who submitted the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalBillId":{
            "title":"External Bill ID",
            "maxLength":300,
            "type":"string",
            "description":"The bill ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentReason":{
            "title":"Adjustment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalBalanceGroupId":{
            "title":"External Balance Group ID",
            "maxLength":300,
            "type":"string",
            "description":"The unique identifier of balance group of noncurrency from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the service request queue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of a service request record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentRequestsId":{
            "title":"Bill Adjustment Request ID",
            "type":"integer",
            "description":"The unique identifier of the bill adjustment request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":255,
            "type":"string",
            "description":"The comments for this adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "RejectedByPartyName":{
            "title":"Rejected By",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who rejected the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalServiceNumber":{
            "title":"External Service Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of the service from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":400,
            "type":"string",
            "description":"The title of a service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedByPartyId":{
            "title":"Approved by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Reference Number",
            "maxLength":30,
            "type":"string",
            "description":"The service request reference number that is associated with the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":20,
            "type":"string",
            "description":"The type of the adjustment request, such as bill, item or event level adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalAdjustmentNumber":{
            "title":"External Adjustment Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of adjustment from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative key for the queue identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovePercent":{
            "title":"Approved Percentage",
            "type":"number",
            "description":"The percentage of amount for which adjustment is approved.",
            "nullable":true,
            "x-queryable":true
        },
        "RejectedByPartyNumber":{
            "title":"Rejected by Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the user who rejected the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalAdjustmentId":{
            "title":"External Adjustment ID",
            "maxLength":300,
            "type":"string",
            "description":"The adjustment ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidTo":{
            "title":"Valid To",
            "type":"string",
            "description":"The date when the validity for non-currency adjustment ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RejectReason":{
            "title":"Rejection Reason",
            "maxLength":255,
            "type":"string",
            "description":"The reason for rejecting the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":400,
            "type":"string",
            "description":"The service request category name associated with the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NonCurrencyUsageAmount":{
            "title":"Noncurrency Usage",
            "type":"number",
            "description":"The actual non currency usage before adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPercent":{
            "title":"Requested Percentage",
            "type":"number",
            "description":"The percentage of amount for which adjustment is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "NonCurrencyAdjustmentType":{
            "title":"Noncurrency Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment request, such as bill unit or event level for a non-currency adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalBillItemId":{
            "title":"External Bill Item ID",
            "maxLength":300,
            "type":"string",
            "description":"The bill item ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time of the last update made to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 請求修正イベント

タイプ: array

タイトル: Billing Adjustment Events

請求修正イベント・リソースは、請求修正イベントの表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object billingAdjustments-billingAdjustmentEvents-item-response

{
    "title":"Billing Adjustment Events",
    "type":"array",
    "description":"The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.",
    "items":{
        "$ref":"#/components/schemas/billingAdjustments-billingAdjustmentEvents-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : billingAdjustments-billingAdjustmentEvents-item-response

タイプ: object

ソースを表示

BillAdjustmentRequestEventsId: integer (int64)

タイトル: Adjustment Event ID

読取り専用: true

修正イベントの一意の識別子。
BillAdjustmentRequestEventsNumber: string

タイトル: Adjustment Event Number

最大長: 30

調整のイベント番号。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行の作成日時。
DeleteFlag: boolean

タイトル: Delete Indicator

読取り専用: true

ユーザーがレコードを削除できるかどうかを示します。
ExternalBillEventId: string

タイトル: External Bill Event ID

最大長: 300

外部請求イベントの一意の識別子。
ExternalBillEventNumber: string

タイトル: External Bill Event Number

最大長: 300

外部請求イベントの公開一意識別子。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

行に対して最後に行われた更新の日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

行を最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
UpdateFlag: boolean

タイトル: Update Indicator

読取り専用: true

ユーザーがレコードを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the row creation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentRequestEventsNumber":{
            "title":"Adjustment Event Number",
            "maxLength":30,
            "type":"string",
            "description":"The event number of the adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalBillEventNumber":{
            "title":"External Bill Event Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of the external bill event.",
            "nullable":true,
            "x-queryable":true
        },
        "BillAdjustmentRequestEventsId":{
            "title":"Adjustment Event ID",
            "type":"integer",
            "description":"The unique identifier of the adjustment event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time of the last update made to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalBillEventId":{
            "title":"External Bill Event ID",
            "maxLength":300,
            "type":"string",
            "description":"The unique identifier of the external bill event.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

NonCurrencyTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_NON_CURR_ADJ_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: NonCurrencyAdjustmentType;ターゲット属性: LookupCode
表示属性: 意味

RatedCurrenciesVA

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
表示属性: 名前

ReasonVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BILL_ADJ_REQ_REASON

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: AdjustmentReason;ターゲット属性: LookupCode
表示属性: 意味

StatusVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BILL_ADJ_REQ_STATUS

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StatusCode;ターゲット属性: LookupCode
表示属性: 意味

TaxTreatmentVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BILLAJ_REQ_TAX_TMNTS

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: TaxTreatment;ターゲット属性: LookupCode
表示属性: 意味

TypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BIL_ADJ_REQ_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: AdjustmentType;ターゲット属性: LookupCode
表示属性: 意味

billingAdjustmentEvents

操作: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents

パラメータ:

BillAdjustmentRequestsNumber: $request.path.BillAdjustmentRequestsNumber

請求修正イベント・リソースは、請求修正イベントの表示、作成、更新および削除に使用されます。

「トップに戻る」