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

請求プロファイルの更新

patch

/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}

リクエスト

パス・パラメータ

BillingProfileNumber(required): string

表の一意のユーザー・キー。
SubscrAccountNumber(required): string

サブスクリプション・アカウントの代替一意識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AddrElementAttribute1: string

タイトル: Additional Address Element 1

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute2: string

タイトル: Additional Address Element 2

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute3: string

タイトル: Additional Address Element 3

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute4: string

タイトル: Additional Address Element 4

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute5: string

タイトル: Additional Address Element 5

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddressLine1: string

タイトル: Address Line 1

最大長: 240

識別住所の最初の行。
AddressLine2: string

タイトル: Address Line 2

最大長: 240

識別住所の2行目。
AddressLine3: string

タイトル: Address Line 3

最大長: 240

識別住所の3行目。
AddressLine4: string

タイトル: Address Line 4

最大長: 240

識別住所の4行目。
AddressLinesPhonetic: string

タイトル: Address Lines Phonetic

最大長: 560

漢字住所行の表記(日本で使用)。
BillCycle: integer (int64)

タイトル: Bill Cycle

最小値: 0

請求サイクルが発生するタイミングを示します。
BillCycleDay: 整数(int32)

タイトル: Bill Cycle Day

最小値: 1

最大値: 31

請求サイクルが発生する日。
BillingAccountNumber: string

タイトル: Billing Account Number

最大長: 30

プロファイルの請求アカウント番号。
BillingEmailAddress: string

タイトル: Email Address

最大長: 100

請求プロファイルの電子メール・アドレス。
BillingFrequency: string

タイトル: Billing Frequency

最大長: 100

サービスに対して顧客が請求される間隔。
BillingProfileName: string

タイトル: Name

最大長: 30

請求プロファイルの名前。
BillingType: string

タイトル: Billing Type

最大長: 100

請求プロファイルの請求タイプ。
BillLanguage: string

タイトル: Language

最大長: 30

請求書で使用される言語。
BillMedia: string

タイトル: Bill Media

最大長: 100

請求プロファイルの請求の生成に使用されるメディア。
Building: string

タイトル: Building

最大長: 240

特定の住所の建物名または番号。
City: string

タイトル: City

最大長: 60

識別住所の市。
CollectionsFlag: boolean

タイトル: Collections

最大長: 1

デフォルト値: false

ユーザーがしばらくの間請求を支払っておらず、回収プロセスが開始された場合に収集される金額。
Comments: string

タイトル: Comments

最大長: 255

請求プロファイルの追加コメント。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

アプリケーション・コンポーザ拡張性スキーマ・フィールド。
Country: string

タイトル: Country

最大長: 2

識別住所の国。
County: string

タイトル: County

最大長: 60

識別住所の郡。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

アプリケーション・コンポーザ拡張性スキーマ・フィールド。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

アプリケーション・コンポーザ拡張性スキーマ・フィールド。
ExternalBillingAccount: string

タイトル: External Billing Account Number

最大長: 30

外部請求アカウント番号。
FloorNumber: string

タイトル: Floor

最大長: 40

建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
IdenAddrLocationId: integer (int64)

タイトル: Location ID

識別住所の事業所の一意の識別子。
InvoiceByEmailFlag: boolean

タイトル: Email Invoice

最大長: 1

デフォルト値: false

請求書の電子コピーが優先されるかどうかを示します。
InvoiceByMailFlag: boolean

タイトル: Mail Invoice

最大長: 1

デフォルト値: false

請求書の紙コピーが優先されるかどうかを示します。
PaymentMethod: string

タイトル: Payment Method

最大長: 100

請求プロファイルに使用される支払メソッド。
PostalCode: string

タイトル: Postal Code

最大長: 60

識別住所の郵便番号。
PostalPlus4Code: string

タイトル: Postal Code Extension

最大長: 20

アメリカ合衆国の郵便番号の4桁の拡張子。
PrepaidAutomaticTopupFlag: boolean

タイトル: Prepaid Automatic Top Up

最大長: 1

デフォルト値: false

顧客が請求プロファイルに前払自動トップ・アップを必要とするかどうかを示します。
PrepaidSMSNotificationFlag: boolean

タイトル: Prepaid SMS Notification

最大長: 1

デフォルト値: false

顧客が前払請求プロファイルに対してショート・メッセージ・サービス通知を必要とするかどうかを示します。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

請求プロファイルがサブスクリプション・アカウントのプライマリ請求プロファイルかどうかを示します。
Province: string

タイトル: Province

最大長: 60

識別住所の州。
State: string

タイトル: State

最大長: 60

識別住所の状態。
StatementFlag: boolean

タイトル: Statement

最大長: 1

デフォルト値: false

顧客が請求プロファイルの明細書を必要とするかどうかを示します。
Status: string

タイトル: Status

最大長: 30

請求プロファイルのステータス。

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The specific building name or number of a given address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicate whether the billing profile is the primary billing profile for the subscription account.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true
        },
        "CollectionsFlag":{
            "title":"Collections",
            "maxLength":1,
            "type":"boolean",
            "description":"The amount collected when users have not paid their bills for some time, and a collection process has been initiated.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "StatementFlag":{
            "title":"Statement",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the customer requires a statement for the billing profile.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillCycleDay":{
            "title":"Bill Cycle Day",
            "maximum":31,
            "minimum":1,
            "type":"integer",
            "description":"The day on which the bill cycle occurs.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true
        },
        "BillingEmailAddress":{
            "title":"Email Address",
            "maxLength":100,
            "type":"string",
            "description":"The email address of the billing profile.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true
        },
        "BillingType":{
            "title":"Billing Type",
            "maxLength":100,
            "type":"string",
            "description":"The billing type for a billing profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of a billing profile.",
            "nullable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":100,
            "type":"string",
            "description":"The interval in which customer is billed for a service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillMedia":{
            "title":"Bill Media",
            "maxLength":100,
            "type":"string",
            "description":"The media used to generate a bill for a billing profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":255,
            "type":"string",
            "description":"The additional comments for billing profile.",
            "nullable":true
        },
        "ExternalBillingAccount":{
            "title":"External Billing Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The external billing account number.",
            "nullable":true
        },
        "BillingProfileName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the billing profile.",
            "nullable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "BillCycle":{
            "title":"Bill Cycle",
            "minimum":0,
            "type":"integer",
            "description":"Indicates when the bill cycle occurs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "InvoiceByEmailFlag":{
            "title":"Email Invoice",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an electronic copy of the invoice is preferred.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "InvoiceByMailFlag":{
            "title":"Mail Invoice",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a paper copy of the invoice is preferred.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "PrepaidAutomaticTopupFlag":{
            "title":"Prepaid Automatic Top Up",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the customer requires a prepaid automatic top up for a billing profile.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":100,
            "type":"string",
            "description":"The method of payment used for a billing profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the identifying address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingAccountNumber":{
            "title":"Billing Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The billing account number of the profile.",
            "nullable":true
        },
        "PrepaidSMSNotificationFlag":{
            "title":"Prepaid SMS Notification",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the customer requires a short message service notification for a prepaid billing profile.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "BillLanguage":{
            "title":"Language",
            "maxLength":30,
            "type":"string",
            "description":"The language that is used in an invoice.",
            "nullable":true
        },
        "IdenAddrLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the location of the identifying address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : subscriptionAccounts-billingProfiles-item-response

タイプ: object

ソースを表示

AddrElementAttribute1: string

タイトル: Additional Address Element 1

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute2: string

タイトル: Additional Address Element 2

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute3: string

タイトル: Additional Address Element 3

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute4: string

タイトル: Additional Address Element 4

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddrElementAttribute5: string

タイトル: Additional Address Element 5

最大長: 150

柔軟な住所書式をサポートするための追加住所要素。
AddressLine1: string

タイトル: Address Line 1

最大長: 240

識別住所の最初の行。
AddressLine2: string

タイトル: Address Line 2

最大長: 240

識別住所の2行目。
AddressLine3: string

タイトル: Address Line 3

最大長: 240

識別住所の3行目。
AddressLine4: string

タイトル: Address Line 4

最大長: 240

識別住所の4行目。
AddressLinesPhonetic: string

タイトル: Address Lines Phonetic

最大長: 560

漢字住所行の表記(日本で使用)。
BillCycle: integer (int64)

タイトル: Bill Cycle

最小値: 0

請求サイクルが発生するタイミングを示します。
BillCycleDay: 整数(int32)

タイトル: Bill Cycle Day

最小値: 1

最大値: 31

請求サイクルが発生する日。
BillingAccountNumber: string

タイトル: Billing Account Number

最大長: 30

プロファイルの請求アカウント番号。
BillingEmailAddress: string

タイトル: Email Address

最大長: 100

請求プロファイルの電子メール・アドレス。
BillingFrequency: string

タイトル: Billing Frequency

最大長: 100

サービスに対して顧客が請求される間隔。
BillingProfileId: integer (int64)

タイトル: Billing Profile ID

読取り専用: true

請求プロファイルの一意の識別子。
BillingProfileName: string

タイトル: Name

最大長: 30

請求プロファイルの名前。
BillingProfileNumber: string

タイトル: Billing Profile Number

最大長: 30

表の一意のユーザー・キー。
BillingType: string

タイトル: Billing Type

最大長: 100

請求プロファイルの請求タイプ。
BillLanguage: string

タイトル: Language

最大長: 30

請求書で使用される言語。
BillMedia: string

タイトル: Bill Media

最大長: 100

請求プロファイルの請求の生成に使用されるメディア。
Building: string

タイトル: Building

最大長: 240

特定の住所の建物名または番号。
City: string

タイトル: City

最大長: 60

識別住所の市。
CollectionsFlag: boolean

タイトル: Collections

最大長: 1

デフォルト値: false

ユーザーがしばらくの間請求を支払っておらず、回収プロセスが開始された場合に収集される金額。
Comments: string

タイトル: Comments

最大長: 255

請求プロファイルの追加コメント。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

アプリケーション・コンポーザ拡張性スキーマ・フィールド。
Country: string

タイトル: Country

最大長: 2

識別住所の国。
County: string

タイトル: County

最大長: 60

識別住所の郡。
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

読取り専用: true

請求プロファイルを削除できるかどうかを示します。
ExternalBillingAccount: string

タイトル: External Billing Account Number

最大長: 30

外部請求アカウント番号。
FloorNumber: string

タイトル: Floor

最大長: 40

建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
FormattedAddress: string

タイトル: Address

読取り専用: true

識別住所の書式付き住所。
FormattedMultilineAddress: string

タイトル: Address

読取り専用: true

識別住所の複数行フォーマット住所。
IdenAddrLocationId: integer (int64)

タイトル: Location ID

識別住所の事業所の一意の識別子。
InvoiceByEmailFlag: boolean

タイトル: Email Invoice

最大長: 1

デフォルト値: false

請求書の電子コピーが優先されるかどうかを示します。
InvoiceByMailFlag: boolean

タイトル: Mail Invoice

最大長: 1

デフォルト値: false

請求書の紙コピーが優先されるかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

行を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Payment Method

最大長: 100

請求プロファイルに使用される支払メソッド。
PostalCode: string

タイトル: Postal Code

最大長: 60

識別住所の郵便番号。
PostalPlus4Code: string

タイトル: Postal Code Extension

最大長: 20

アメリカ合衆国の郵便番号の4桁の拡張子。
PrepaidAutomaticTopupFlag: boolean

タイトル: Prepaid Automatic Top Up

最大長: 1

デフォルト値: false

顧客が請求プロファイルに前払自動トップ・アップを必要とするかどうかを示します。
PrepaidSMSNotificationFlag: boolean

タイトル: Prepaid SMS Notification

最大長: 1

デフォルト値: false

顧客が前払請求プロファイルに対してショート・メッセージ・サービス通知を必要とするかどうかを示します。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

請求プロファイルがサブスクリプション・アカウントのプライマリ請求プロファイルかどうかを示します。
Province: string

タイトル: Province

最大長: 60

識別住所の州。
State: string

タイトル: State

最大長: 60

識別住所の状態。
StatementFlag: boolean

タイトル: Statement

最大長: 1

デフォルト値: false

顧客が請求プロファイルの明細書を必要とするかどうかを示します。
Status: string

タイトル: Status

最大長: 30

請求プロファイルのステータス。
SubscrAccountNumber: string

タイトル: Subscription Account Number

読取り専用: true

最大長: 30

サブスクリプション・アカウントの一意のユーザー・キー。
SubscriptionAccountId: integer (int64)

タイトル: Subscription Account ID

サブスクリプション・アカウントの一意の識別子。
UpdateFlag: boolean

読取り専用: true

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true,
            "x-queryable":true
        },
        "StatementFlag":{
            "title":"Statement",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the customer requires a statement for the billing profile.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique user key of the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":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
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of a billing profile.",
            "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
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":100,
            "type":"string",
            "description":"The interval in which customer is billed for a service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillMedia":{
            "title":"Bill Media",
            "maxLength":100,
            "type":"string",
            "description":"The media used to generate a bill for a billing profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "BillCycle":{
            "title":"Bill Cycle",
            "minimum":0,
            "type":"integer",
            "description":"Indicates when the bill cycle occurs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingProfileId":{
            "title":"Billing Profile ID",
            "type":"integer",
            "description":"The unique identifier of the billing profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline formatted address of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing profile can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "InvoiceByMailFlag":{
            "title":"Mail Invoice",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a paper copy of the invoice is preferred.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "PrepaidAutomaticTopupFlag":{
            "title":"Prepaid Automatic Top Up",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the customer requires a prepaid automatic top up for a billing profile.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":100,
            "type":"string",
            "description":"The method of payment used for a billing profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the identifying address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillingAccountNumber":{
            "title":"Billing Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The billing account number of the profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BillLanguage":{
            "title":"Language",
            "maxLength":30,
            "type":"string",
            "description":"The language that is used in an invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The specific building name or number of a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicate whether the billing profile is the primary billing profile for the subscription account.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "CollectionsFlag":{
            "title":"Collections",
            "maxLength":1,
            "type":"boolean",
            "description":"The amount collected when users have not paid their bills for some time, and a collection process has been initiated.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the identifying address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BillCycleDay":{
            "title":"Bill Cycle Day",
            "maximum":31,
            "minimum":1,
            "type":"integer",
            "description":"The day on which the bill cycle occurs.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "BillingEmailAddress":{
            "title":"Email Address",
            "maxLength":100,
            "type":"string",
            "description":"The email address of the billing profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingType":{
            "title":"Billing Type",
            "maxLength":100,
            "type":"string",
            "description":"The billing type for a billing profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":255,
            "type":"string",
            "description":"The additional comments for billing profile.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBillingAccount":{
            "title":"External Billing Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The external billing account number.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingProfileName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the billing profile.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceByEmailFlag":{
            "title":"Email Invoice",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an electronic copy of the invoice is preferred.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BillingProfileNumber":{
            "title":"Billing Profile Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique user key for the table.",
            "nullable":false,
            "x-queryable":true
        },
        "PrepaidSMSNotificationFlag":{
            "title":"Prepaid SMS Notification",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the customer requires a short message service notification for a prepaid billing profile.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "IdenAddrLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the location of the identifying address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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."
        }
    }
}

リンク

BillFrequencyListVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

請求プロファイルの請求を生成する間隔を示す値リスト。

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

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

BillMediaListVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

請求プロファイルの請求の生成に使用されるメディアを示す値リスト。次に例を示します : CD, disc, paper.

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

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

BillTypeListVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

請求プロファイルの請求タイプを示す値リスト。次に例を示します : detail, summary.

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

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

CountryVA

操作: /crmRestApi/resources/11.13.18.05/fndTerritories

パラメータ:

ファインダ: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN

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

ソース属性: 国、ターゲット属性: TerritoryCode
表示属性: TerritoryShortName

PaymentMethodListVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

請求プロファイルに使用される支払方法を示す値リスト。たとえば、請求先、現金、小切手などです。

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

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

RatedCurrenciesVA

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

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

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

YesNoCollectionVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

はいまたはいいえを示す値リスト。

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

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

YesNoEmailInvoiceVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

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

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

YesNoMailInvoiceVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

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

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

YesNoPrepaidAutomaticTopupVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

はいまたはいいえを示す値リスト。

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

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

YesNoPrepaidSMSNotificationVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

はいまたはいいえを示す値リスト。

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

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

YesNoPrimaryVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

はいまたはいいえを示す値リスト。

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

ソース属性: PrimaryFlag;ターゲット属性: LookupCode
表示属性: LookupCode

YesNoStatementVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

はいまたはいいえを示す値リスト。

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

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

「トップに戻る」