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

機械翻訳について

すべての請求プロファイルを取得

get

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

リクエスト

パス・パラメータ

SubscrAccountNumber(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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します:
- BillingProfileNumberRF : 指定されたユーザー・キーを持つ請求プロファイルを検索します。
  ファインダ変数:
  - BillingProfileNumber; string; 請求プロファイルの代替の一意の識別子。
- PrimaryKey : 指定した主キーを持つ請求プロファイルを検索します。
  ファインダ変数:
  - BillingProfileId; integer; 請求プロファイルの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

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

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

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

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AddrElementAttribute1; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute2; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute3; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute4; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute5; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddressLine1; string;識別アドレスの最初の行。
- AddressLine2; string;識別アドレスの2行目。
- AddressLine3; string;識別アドレスの3行目。
- AddressLine4; string; 識別アドレスの4行目。
- AddressLinesPhonetic; string;漢字アドレス行の表記(日本で使用)。
- BillCycle; integer; 請求サイクルが発生するタイミングを示します。
- BillCycleDay; integer; 請求サイクルが発生する日。
- BillLanguage; string; 請求書で使用される言語。
- BillMedia; string; 請求プロファイルの請求の生成に使用されるメディア。
- BillingAccountNumber; string;プロファイルの請求アカウント番号。
- BillingEmailAddress; string; 請求プロファイルの電子メール・アドレス。
- BillingFrequency; string;顧客がサービスに対して請求される間隔。
- BillingProfileId; integer; 請求プロファイルの一意の識別子。
- BillingProfileName; string;請求プロファイルの名前。
- BillingProfileNumber; string; 表の一意のユーザー・キー。
- BillingType; string;請求プロファイルの請求タイプ。
- 建物;文字列;指定された住所の特定の建物名または番号。
- City; string;識別住所の市区町村。
- CollectionsFlag; boolean;ユーザーがしばらく請求を支払っておらず、収集プロセスが開始された場合に収集される量。
- コメント;文字列;請求プロファイルの追加コメント。
- CorpCurrencyCode; string;アプリケーション・コンポーザ拡張性スキーマ・フィールド。
- 国;文字列;識別住所の国。
- 郡;文字列;識別住所の郡。
- CreatedBy; string; 行を作成したユーザー。
- CreationDate; string; 行が作成された日時。
- CurcyConvRateType; string;アプリケーション・コンポーザ拡張性スキーマ・フィールド。
- CurrencyCode; string;アプリケーション・コンポーザ拡張性スキーマ・フィールド。
- ExternalBillingAccount; string;外部請求アカウント番号。
- FloorNumber; string;建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
- IdenAddrLocationId; integer;識別住所のロケーションの一意の識別子。
- InvoiceByEmailFlag; boolean。請求書の電子コピーが優先されるかどうかを示します。
- InvoiceByMailFlag; boolean;請求書の紙コピーが優先されるかどうかを示します。
- LastUpdateDate; string; 行が最後に更新された日時。
- LastUpdateLogin; string; 行を最後に更新したユーザーのログイン。
- LastUpdatedBy; string; 行を最後に更新したユーザー。
- PaymentMethod; string; 請求プロファイルに使用される支払メソッド。
- PostalCode; string;識別住所の郵便番号。
- PostalPlus4Code; string; アメリカ合衆国の郵便番号の4桁の拡張子。
- PrepaidAutomaticTopupFlag; boolean;顧客が請求プロファイルに対して前払自動トップ・アップを必要とするかどうかを示します。
- PrepaidSMSNotificationFlag; boolean;顧客が前払請求プロファイルに対して短いメッセージ・サービス通知を必要とするかどうかを示します。
- PrimaryFlag; boolean。請求プロファイルがサブスクリプション・アカウントのプライマリ請求プロファイルかどうかを示します。
- 州;文字列;識別住所の州。
- State; string;識別するアドレスの状態。
- StatementFlag; boolean;顧客が請求プロファイルの明細書を必要とするかどうかを示します。
- ステータス、文字列。請求プロファイルのステータス。
- SubscrAccountNumber; string; サブスクリプション・アカウントの一意のユーザー・キー。
- SubscriptionAccountId; integer; サブスクリプション・アカウントの一意の識別子。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-billingProfiles-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object subscriptionAccounts-billingProfiles-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-billingProfiles-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"
    }
}

ネストされたスキーマ : 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."
        }
    }
}

「トップに戻る」