REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get all subscription accounts

get

/crmRestApi/resources/11.13.18.05/subscriptionAccounts

Request

Query Parameters

expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey: Finds a subscription account with the specified primary key.
  Finder Variables:
  - LocationId; integer; The unique identifier in the subscription account.
  - SubscriptionAccountId; integer; The unique identifier of the subscription account.
- RowFinder: Finds a subscription account with the specified user key.
  Finder Variables:
  - SubscrAccountNumber; string; The alternate unique identifier of the subscription account.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AccountClass; string; Indicates the type of the subscription account. Possible values are OWNER_ACCOUNT, BILLING_ACCOUNT, CUST_ACCOUNT.
- AccountName; string; The description chosen by external party (but can be entered internally on behalf on the customer).
- AccountStatus; string; The status of the subscription account.
- AddrElementAttribute1; string; The additional address element to support flexible address format.
- AddrElementAttribute2; string; The additional address element to support flexible address format.
- AddrElementAttribute3; string; The additional address element to support flexible address format.
- AddrElementAttribute4; string; The additional address element to support flexible address format.
- AddrElementAttribute5; string; The additional address element to support flexible address format.
- Address1; string; The first line of the account address.
- Address2; string; The second line of the account address.
- Address3; string; The third line of the account address.
- Address4; string; The fourth line of the account address.
- AddressLinesPhonetic; string; The phonetic or Kana representation of the Kanji address lines (used in Japan).
- AddressNumber; string; The address number associated with the subscription account.
- AddressType; string; Address Type is the static choice list with values indicating the type of address.
- Building; string; The specific building name or number of a given address.
- City; string; The city of the identifying address.
- CommonBusinessIdentifier; string; The primary identifier assigned to businesses by government agency, Chamber of Commerce, or other authority, generally used outside US.
- CorpCurrencyCode; string; The corporate currency code associated with the subscription account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
- CorporationClass; string; The taxation classification for corporation entities such as Chapter S in the US.
- Country; string; The country of the identifying address.
- County; string; The county of the identifying address.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date when the record was created.
- CreditAgency; string; The credit agency for subscription account.
- CreditScore; integer; The credit score issues by the credit agency for the subscription account.
- CreditThreshold; number; The credit threshold for subscription account issued by the credit agency.
- CreditUpdateDate; string; The credit update date for subscription account.
- CreditUpdatedBy; string; The use who updated the credit information for the subscription account.
- CurcyConvRateType; string; The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
- CurrencyCode; string; The rate of currency conversion for a subscription account.
- CustomerAccountId; integer; The unique identifier of the customer account. The foreign key to the HZ_CUST_ACCOUNTS table.
- CustomerAccountSiteId; string; The unique identifier of the customer account side.
- DUNSNumber; string; The column value not restricted to nine digit DUNS Number.
- DailyThreshold; number; The daily threshold limit for subscription account.
- DbRating; string; The Dun & Bradstreet credit rating.
- DirectoryAssistStartDate; string; The date when directory assistance starts for the subscription account.
- DirectoryAssistStatus; string; The status of directory assistance for the subscription account.
- DomesticThreshold; number; The domestic threshold for subscription accounts.
- DuplicateType; string; The duplicate status of the record. A null value indicates that either the record is not a duplicate or it has not been evaluated. DUPE indicates the record is duplicate. LINK indicates that the record is linked to another record.
- FloorNumber; string; The specific floor number at a given address or in a particular building when the building number is provided.
- InternationalThreshold; number; The international threshold for the subscription account.
- LastSrcUpdateDate; string; The timestamp when this record was updated by the source system in the last update source system column.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdateSrcSystem; string; The source system that last updated this record.
- LastUpdatedBy; string; The user who last updated the record.
- LegalEntityId; integer; The legal entity associated with the subscription account.
- LocationId; integer; The unique identifier of the subscription account primary address.
- MaximumCallDuration; number; The maximum call duration for subscription account.
- MaximumCalls; number; The maximum number of calls for subscription account.
- MaximumCost; number; The maximum cost that is set for the subscription account.
- NonprofitOrganizationFlag; boolean; Indicates whether the organization is a non-profit organization. Y for non-profit organization and N for profit organization.
- ParentSubscrAccountId; integer; The unique identifier of the parent subscription account. It specifies the parent account of the subscription account.
- ParentSubscrAccountNumber; string; The unique user key for the Parent Subscription Account Object.
- ParentSubscriptionAccountName; string; The name of the Parent Subscription Account.
- PartyId; integer; The uniquely generated id for HZ_PARTY.
- PartyName; string; The name of the party.
- PartyNumber; string; This is a unique user key for the table.
- PartySiteId; string; The unique identifier of the party site of the identifying address.
- PartyType; string; The party type, like consumer or organization.
- PercentageOverflow; number; The percentage overflow for subscription account.
- PhAssistExemptionFlag; boolean; The phone assistance exemption for subscription account.
- PhAssistRenewalDate; string; The phone assistance renewal date for the subscription account.
- PhAssistRequestDate; string; The date when the phone assistance request for the subscription account was made.
- PhAssistStartDate; string; The date when the phone assistance for the subscription account starts.
- PostalCode; string; The postal code of the subscription account primary address.
- PostalPlus4Code; string; The four digit extension to the United States Postal ZIP code.
- PrimaryLanguage; string; The primary language for subscription account.
- PrivatelyOwnedFlag; boolean; Indicates whether the organization is privately owned. Y for a privately owned organization, N for a publicly owned organization.
- Province; string; The province of the identifying address.
- RegistrationType; string; The lookup for type of registration, such as nonprofit.
- SensitiveNubmerThreshold; number; The sensitive number threshold for the subscription account.
- SetCode; string; The reference set of the record.
- SetId; string; The account site set of the identifying address.
- SiteUseCode; string; The site use code of the identifying address.
- SmallBusinessFlag; boolean; Indicates the company is considered to be a small business. Y for small businesses, N for all other firms.
- SourceSystem; string; The source system of the record.
- SourceSystemReference; string; The reference of the source system.
- State; string; The state of the identifying address.
- StateSellTaxPermitLicenseNumber; string; The state sell tax permit LIC number for subscription account.
- SubscrAccountNumber; string; The alternate unique identifier of the subscription account.
- SubscriptionAccountId; integer; The unique identifier of the subscription account.
- TIN; string; The tax payer identification number, often unique identifier of person or organization, such as SSN , income taxpayer ID in US, or fiscal code or NIF in Europe.
- TaxCode; string; The tax code for the customer.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

Metadata-Context: string

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version: string

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : subscriptionAccounts

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

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.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object subscriptionAccounts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : subscriptionAccounts-item-response

Type: object

Show Source

AccountClass: string

Title: Account Class

Maximum Length: 30

Default Value: ORA_ATC_ACCOUNT_OWNER

Indicates the type of the subscription account. Possible values are OWNER_ACCOUNT, BILLING_ACCOUNT, CUST_ACCOUNT.
AccountName: string

Title: Subscription Account Name

Maximum Length: 240

The description chosen by external party (but can be entered internally on behalf on the customer).
AccountStatus: string

Title: Status

Maximum Length: 30

Default Value: A

The status of the subscription account.
AddrElementAttribute1: string

Title: Additional Address Element 1

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute2: string

Title: Additional Address Element 2

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute3: string

Title: Additional Address Element 3

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute4: string

Title: Additional Address Element 4

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute5: string

Title: Additional Address Element 5

Maximum Length: 150

The additional address element to support flexible address format.
Address1: string

Title: Address Line 1

Maximum Length: 240

The first line of the account address.
Address2: string

Title: Address Line 2

Maximum Length: 240

The second line of the account address.
Address3: string

Title: Address Line 3

Maximum Length: 240

The third line of the account address.
Address4: string

Title: Address Line 4

Maximum Length: 240

The fourth line of the account address.
AddressLinesPhonetic: string

Title: Address Lines Phonetic

Maximum Length: 560

The phonetic or Kana representation of the Kanji address lines (used in Japan).
AddressNumber: string

Title: Address Number

Maximum Length: 30

The address number associated with the subscription account.
AddressType: string

Title: Address Type

Maximum Length: 100

Address Type is the static choice list with values indicating the type of address.
Attachments: array Attachments

Title: Attachments

The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.
billingProfiles: array Billing Profiles

Title: Billing Profiles

The billing profiles resource is used view, create, update, and delete a billing profile. It lists all the billing profiles for the given subscription account.
Building: string

Title: Building

Maximum Length: 240

The specific building name or number of a given address.
City: string

Title: City

Maximum Length: 60

The city of the identifying address.
CommonBusinessIdentifier: string

Title: Common Business Identifier

Maximum Length: 265

The primary identifier assigned to businesses by government agency, Chamber of Commerce, or other authority, generally used outside US.
CorpCurrencyCode: string

Title: Corporate Currency Code

Maximum Length: 15

The corporate currency code associated with the subscription account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CorporationClass: string

Title: Corporation Class

Maximum Length: 30

The taxation classification for corporation entities such as Chapter S in the US.
Country: string

Title: Country

Maximum Length: 2

The country of the identifying address.
County: string

Title: County

Maximum Length: 60

The county of the identifying address.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the row.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the record was created.
CreditAgency: string

Title: Credit Agency

Maximum Length: 30

The credit agency for subscription account.
CreditScore: integer (int64)

Title: Credit Score

Minimum Value: 0

The credit score issues by the credit agency for the subscription account.
CreditThreshold: number

Title: Credit Threshold

Minimum Value: 0

The credit threshold for subscription account issued by the credit agency.
CreditUpdateDate: string (date-time)

Title: Credit Update Date

The credit update date for subscription account.
CreditUpdatedBy: string

Title: Credit Updated By

Maximum Length: 30

The use who updated the credit information for the subscription account.
CurcyConvRateType: string

Title: Currency Conversion Rate Type

Maximum Length: 30

The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
CurrencyCode: string

Title: Currency Code

Maximum Length: 15

The rate of currency conversion for a subscription account.
CustomerAccountId: integer (int64)

Title: Customer Account ID

The unique identifier of the customer account. The foreign key to the HZ_CUST_ACCOUNTS table.
CustomerAccountSiteId: string

Read Only: true

The unique identifier of the customer account side.
DailyThreshold: number

Title: Daily Threshold

Minimum Value: 0

The daily threshold limit for subscription account.
DbRating: string

Title: D&B Credit Rating

Maximum Length: 30

The Dun & Bradstreet credit rating.
DeleteFlag: boolean

Read Only: true

Indicates whether the subscription account has been deleted.
DirectoryAssistStartDate: string (date-time)

Title: Directory Assistance Start Date

The date when directory assistance starts for the subscription account.
DirectoryAssistStatus: string

Title: Directory Assistance Status

Maximum Length: 30

The status of directory assistance for the subscription account.
DomesticThreshold: number

Title: Domestic Threshold

Minimum Value: 0

The domestic threshold for subscription accounts.
DUNSNumber: string

Title: D-U-N-S Number

Maximum Length: 30

The column value not restricted to nine digit DUNS Number.
DuplicateType: string

Title: Duplicate Type

Maximum Length: 30

The duplicate status of the record. A null value indicates that either the record is not a duplicate or it has not been evaluated. DUPE indicates the record is duplicate. LINK indicates that the record is linked to another record.
FloorNumber: string

Title: Floor

Maximum Length: 40

The specific floor number at a given address or in a particular building when the building number is provided.
FormattedAddress: string

Title: Address

Read Only: true

Maximum Length: 255

The formatted address of the identifying address.
FormattedMultilineAddress: string

Title: Address

Read Only: true

The formatted multiline address of the identifying address.
InternationalThreshold: number

Title: International Threshold

Minimum Value: 0

The international threshold for the subscription account.
LastSrcUpdateDate: string (date-time)

Title: Last Source Update Date

The timestamp when this record was updated by the source system in the last update source system column.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the record.
LastUpdateSrcSystem: string

Title: Last Update Source System

Maximum Length: 30

The source system that last updated this record.
LegalEntityId: integer (int64)

Title: Legal Entity ID

The legal entity associated with the subscription account.
links: array Links

Title: Links

The link relations associated with the resource instance.
LocationId: integer (int64)

Title: Location ID

Read Only: true

The unique identifier of the subscription account primary address.
MaximumCallDuration: number

Title: Maximum Call Duration

Minimum Value: 0

The maximum call duration for subscription account.
MaximumCalls: number

Title: Maximum Calls

Minimum Value: 0

The maximum number of calls for subscription account.
MaximumCost: number

Title: Maximum Call Cost

Minimum Value: 0

The maximum cost that is set for the subscription account.
NonprofitOrganizationFlag: boolean

Title: Nonprofit Organization

Maximum Length: 1

Indicates whether the organization is a non-profit organization. Y for non-profit organization and N for profit organization.
Note: array Notes

Title: Notes

The notes resource is used to view, create, update, and delete notes associated with the subscription account. A note captures comments, information, or instructions related to an account.
ParentSubscrAccountId: integer (int64)

Title: Parent Subscription Account ID

The unique identifier of the parent subscription account. It specifies the parent account of the subscription account.
ParentSubscrAccountNumber: string

Title: Subscription Account Number

Maximum Length: 30

The unique user key for the Parent Subscription Account Object.
ParentSubscriptionAccountName: string

Title: Parent Subscription Account Name

Read Only: true

Maximum Length: 240

The name of the Parent Subscription Account.
PartyId: integer (int64)

Title: Party ID

The uniquely generated id for HZ_PARTY.
PartyName: string

Title: Name

Read Only: true

Maximum Length: 360

The name of the party.
PartyNumber: string

Title: Registry ID

Maximum Length: 30

This is a unique user key for the table.
PartySiteId: string

Read Only: true

The unique identifier of the party site of the identifying address.
PartyType: string

Title: Party Type

Read Only: true

Maximum Length: 30

The party type, like consumer or organization.
PercentageOverflow: number

Title: Percentage Overflow

Minimum Value: 0

The percentage overflow for subscription account.
PhAssistExemptionFlag: boolean

Title: Phone Assistance Exemption

Maximum Length: 1

Default Value: false

The phone assistance exemption for subscription account.
PhAssistRenewalDate: string (date-time)

Title: Phone Assistance Renewal Date

The phone assistance renewal date for the subscription account.
PhAssistRequestDate: string (date-time)

Title: Phone Assistance Request Date

The date when the phone assistance request for the subscription account was made.
PhAssistStartDate: string (date-time)

Title: Phone Assistance Start Date

The date when the phone assistance for the subscription account starts.
PostalCode: string

Title: Postal Code

Maximum Length: 60

The postal code of the subscription account primary address.
PostalPlus4Code: string

Title: Postal Code Extension

Maximum Length: 20

The four digit extension to the United States Postal ZIP code.
PrimaryLanguage: string

Title: Primary Language

Maximum Length: 30

The primary language for subscription account.
PrivatelyOwnedFlag: boolean

Title: Privately Owned

Maximum Length: 1

Indicates whether the organization is privately owned. Y for a privately owned organization, N for a publicly owned organization.
Province: string

Title: Province

Maximum Length: 60

The province of the identifying address.
RegistrationType: string

Title: Registration Type

Maximum Length: 30

The lookup for type of registration, such as nonprofit.
SalesAccountId: integer

Title: Sales Account ID

Read Only: true

The party identifier for Organization.
SensitiveNubmerThreshold: number

Title: Sensitive Number Threshold

Minimum Value: 0

The sensitive number threshold for the subscription account.
SetCode: string

Read Only: true

The reference set of the record.
SetId: string

Read Only: true

The account site set of the identifying address.
SiteUseCode: string

Read Only: true

The site use code of the identifying address.
SmallBusinessFlag: boolean

Title: Small Business

Maximum Length: 1

Indicates the company is considered to be a small business. Y for small businesses, N for all other firms.
SourceSystem: string

Title: Source System

Maximum Length: 30

The source system of the record.
SourceSystemReference: string

Title: Source System Reference

Maximum Length: 255

The reference of the source system.
State: string

Title: State

Maximum Length: 60

The state of the identifying address.
StateSellTaxPermitLicenseNumber: string

Title: State Seller Tax Permit or License Number

Maximum Length: 30

The state sell tax permit LIC number for subscription account.
SubscrAccountNumber: string

Title: Subscription Account Number

Maximum Length: 30

The alternate unique identifier of the subscription account.
subscriptionAccountAddress: array Subscription Account Addresses

Title: Subscription Account Addresses

The subscription account addresses resource is used to view, create, update, and delete an account resource. It lists all the subscription account addresses with details.
subscriptionAccountAssetRelationships: array Subscription Account Asset Relationships

Title: Subscription Account Asset Relationships

The subscription account asset relationships resource is used to view, create, update, and delete a subscription account asset relationship. It lists all the subscription account asset relationships with details.
SubscriptionAccountId: integer (int64)

Title: Subscription Account ID

Read Only: true

The unique identifier of the subscription account.
subscriptionAccountRelationship: array Subscription Account Relationships

Title: Subscription Account Relationships

The subscription account relationships resource is used to view, create, update, and delete an account relationship.
subscriptionAccountRoles: array Subscription Account Roles

Title: Subscription Account Roles

The subscription account roles resource is used to view, create, update, and delete an account role. It lists all the subscription account roles with details.
TaxCode: string

Title: Tax Code

Read Only: true

Maximum Length: 50

The tax code for the customer.
TIN: string

Title: Tax Identification Number

Maximum Length: 30

The tax payer identification number, often unique identifier of person or organization, such as SSN , income taxpayer ID in US, or fiscal code or NIF in Europe.
UpdateFlag: boolean

Read Only: true

Indicates whether the subscription account has been updated.

{
    "type":"object",
    "properties":{
        "AccountClass":{
            "title":"Account Class",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of the subscription account. Possible values are OWNER_ACCOUNT, BILLING_ACCOUNT, CUST_ACCOUNT.",
            "nullable":true,
            "default":"ORA_ATC_ACCOUNT_OWNER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Subscription Account Name",
            "maxLength":240,
            "type":"string",
            "description":"The description chosen by external party (but can be entered internally on behalf on the customer).",
            "nullable":true,
            "x-queryable":true
        },
        "AccountStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription account.",
            "nullable":true,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the account address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the account address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the account address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the account address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "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
        },
        "AddressNumber":{
            "title":"Address Number",
            "maxLength":30,
            "type":"string",
            "description":"The address number associated with the subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":100,
            "type":"string",
            "description":"Address Type is the static choice list with values indicating the type of address.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-Attachments-item-response"
            }
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The specific building name or number of a given address.",
            "nullable":true,
            "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
        },
        "CommonBusinessIdentifier":{
            "title":"Common Business Identifier",
            "maxLength":265,
            "type":"string",
            "description":"The primary identifier assigned to businesses by government agency, Chamber of Commerce, or other authority, generally used outside US.",
            "nullable":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the subscription account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "CorporationClass":{
            "title":"Corporation Class",
            "maxLength":30,
            "type":"string",
            "description":"The taxation classification for corporation entities such as Chapter S in the US.",
            "nullable":true,
            "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAgency":{
            "title":"Credit Agency",
            "maxLength":30,
            "type":"string",
            "description":"The credit agency for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditScore":{
            "title":"Credit Score",
            "minimum":0,
            "type":"integer",
            "description":"The credit score issues by the credit agency for the subscription account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "CreditThreshold":{
            "title":"Credit Threshold",
            "minimum":0,
            "type":"number",
            "description":"The credit threshold for subscription account issued by the credit agency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditUpdateDate":{
            "title":"Credit Update Date",
            "type":"string",
            "description":"The credit update date for subscription account.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreditUpdatedBy":{
            "title":"Credit Updated By",
            "maxLength":30,
            "type":"string",
            "description":"The use who updated the credit information for the subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The rate of currency conversion for a subscription account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account. The foreign key to the HZ_CUST_ACCOUNTS table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountSiteId":{
            "type":"string",
            "description":"The unique identifier of the customer account side.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "description":"The column value not restricted to nine digit DUNS Number.",
            "nullable":true,
            "x-queryable":true
        },
        "DailyThreshold":{
            "title":"Daily Threshold",
            "minimum":0,
            "type":"number",
            "description":"The daily threshold limit for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "DbRating":{
            "title":"D&B Credit Rating",
            "maxLength":30,
            "type":"string",
            "description":"The Dun & Bradstreet credit rating.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DirectoryAssistStartDate":{
            "title":"Directory Assistance Start Date",
            "type":"string",
            "description":"The date when directory assistance starts for the subscription account.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DirectoryAssistStatus":{
            "title":"Directory Assistance Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of directory assistance for the subscription account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DomesticThreshold":{
            "title":"Domestic Threshold",
            "minimum":0,
            "type":"number",
            "description":"The domestic threshold for subscription accounts.",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateType":{
            "title":"Duplicate Type",
            "maxLength":30,
            "type":"string",
            "description":"The duplicate status of the record. A null value indicates that either the record is not a duplicate  or it has not been evaluated. DUPE indicates the record is duplicate. LINK indicates that the record is linked to another record.",
            "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
        },
        "FormattedAddress":{
            "title":"Address",
            "maxLength":255,
            "type":"string",
            "description":"The formatted address of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline address of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InternationalThreshold":{
            "title":"International Threshold",
            "minimum":0,
            "type":"number",
            "description":"The international threshold for the subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "LastSrcUpdateDate":{
            "title":"Last Source Update Date",
            "type":"string",
            "description":"The timestamp when this record was updated by the source system in the last update source system column.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateSrcSystem":{
            "title":"Last Update Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system that last updated this record.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"The legal entity associated with the subscription account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account primary address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumCallDuration":{
            "title":"Maximum Call Duration",
            "minimum":0,
            "type":"number",
            "description":"The maximum call duration for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumCalls":{
            "title":"Maximum Calls",
            "minimum":0,
            "type":"number",
            "description":"The maximum number of calls for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumCost":{
            "title":"Maximum Call Cost",
            "minimum":0,
            "type":"number",
            "description":"The maximum cost that is set for the subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "NonprofitOrganizationFlag":{
            "title":"Nonprofit Organization",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the organization is a non-profit organization. Y for non-profit organization and N for profit organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is used to view, create, update, and delete notes associated with the subscription account. A note captures comments, information, or instructions related to an account.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-Note-item-response"
            }
        },
        "ParentSubscrAccountId":{
            "title":"Parent Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the parent subscription account. It specifies the parent account of the subscription account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentSubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique user key for the Parent Subscription Account Object.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentSubscriptionAccountName":{
            "title":"Parent Subscription Account Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the Parent Subscription Account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The uniquely generated id for HZ_PARTY.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"This is a unique user key for the table.",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"string",
            "description":"The unique identifier of the party site of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The party type, like consumer or organization.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PercentageOverflow":{
            "title":"Percentage Overflow",
            "minimum":0,
            "type":"number",
            "description":"The percentage overflow for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "PhAssistExemptionFlag":{
            "title":"Phone Assistance Exemption",
            "maxLength":1,
            "type":"boolean",
            "description":"The phone assistance exemption  for subscription account.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "PhAssistRenewalDate":{
            "title":"Phone Assistance Renewal Date",
            "type":"string",
            "description":"The phone assistance renewal date for the subscription account.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PhAssistRequestDate":{
            "title":"Phone Assistance Request Date",
            "type":"string",
            "description":"The date when the phone assistance request for the subscription account was made.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PhAssistStartDate":{
            "title":"Phone Assistance Start Date",
            "type":"string",
            "description":"The date when the phone assistance for the subscription account starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the subscription account primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "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
        },
        "PrimaryLanguage":{
            "title":"Primary Language",
            "maxLength":30,
            "type":"string",
            "description":"The primary language for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivatelyOwnedFlag":{
            "title":"Privately Owned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the organization is privately owned. Y for a privately owned organization, N for a publicly owned organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":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"
            },
            "x-queryable":true
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup for type of registration, such as nonprofit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesAccountId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The party identifier for Organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SensitiveNubmerThreshold":{
            "title":"Sensitive Number Threshold",
            "minimum":0,
            "type":"number",
            "description":"The sensitive number threshold for the subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "SetCode":{
            "type":"string",
            "description":"The reference set of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"string",
            "description":"The account site set of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteUseCode":{
            "type":"string",
            "description":"The site use code of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SmallBusinessFlag":{
            "title":"Small Business",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the company is considered to be a small business. Y for small businesses, N for all other firms.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the record.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReference":{
            "title":"Source System Reference",
            "maxLength":255,
            "type":"string",
            "description":"The reference of the source system.",
            "nullable":true,
            "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
        },
        "StateSellTaxPermitLicenseNumber":{
            "title":"State Seller Tax Permit or License Number",
            "maxLength":30,
            "type":"string",
            "description":"The state sell tax permit LIC number for subscription account.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TIN":{
            "title":"Tax Identification Number",
            "maxLength":30,
            "type":"string",
            "description":"The tax payer identification number, often unique identifier of person  or organization, such as SSN , income taxpayer ID in US, or fiscal code or NIF in Europe.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxCode":{
            "title":"Tax Code",
            "maxLength":50,
            "type":"string",
            "description":"The tax code for the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "billingProfiles":{
            "title":"Billing Profiles",
            "type":"array",
            "description":"The billing profiles resource is used view, create, update, and delete a billing profile. It lists all the billing profiles for the given subscription account.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-billingProfiles-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "subscriptionAccountAddress":{
            "title":"Subscription Account Addresses",
            "type":"array",
            "description":"The subscription account addresses resource is used to view, create, update, and delete an account resource. It lists all the subscription account addresses with details.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountAddress-item-response"
            }
        },
        "subscriptionAccountAssetRelationships":{
            "title":"Subscription Account Asset Relationships",
            "type":"array",
            "description":"The subscription account asset relationships resource is used to view, create, update, and delete a subscription account asset relationship. It lists all the subscription account asset relationships with details.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountAssetRelationships-item-response"
            }
        },
        "subscriptionAccountRelationship":{
            "title":"Subscription Account Relationships",
            "type":"array",
            "description":"The subscription account relationships resource is used to view, create, update, and delete an account relationship.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountRelationship-item-response"
            }
        },
        "subscriptionAccountRoles":{
            "title":"Subscription Account Roles",
            "type":"array",
            "description":"The subscription account roles resource is used to view, create, update, and delete an account role. It lists all the subscription account roles with details.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountRoles-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.

Show Source

Array of: object subscriptionAccounts-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-Attachments-item-response"
    }
}

Nested Schema : Billing Profiles

Type: array

Title: Billing Profiles

The billing profiles resource is used view, create, update, and delete a billing profile. It lists all the billing profiles for the given subscription account.

Show Source

Array of: object subscriptionAccounts-billingProfiles-item-response

{
    "title":"Billing Profiles",
    "type":"array",
    "description":"The billing profiles resource is used view, create, update, and delete a billing profile. It lists all the billing profiles for the given subscription account.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-billingProfiles-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : Notes

Type: array

Title: Notes

The notes resource is used to view, create, update, and delete notes associated with the subscription account. A note captures comments, information, or instructions related to an account.

Show Source

Array of: object subscriptionAccounts-Note-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is used to view, create, update, and delete notes associated with the subscription account. A note captures comments, information, or instructions related to an account.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-Note-item-response"
    }
}

Nested Schema : Subscription Account Addresses

Type: array

Title: Subscription Account Addresses

The subscription account addresses resource is used to view, create, update, and delete an account resource. It lists all the subscription account addresses with details.

Show Source

Array of: object subscriptionAccounts-subscriptionAccountAddress-item-response

{
    "title":"Subscription Account Addresses",
    "type":"array",
    "description":"The subscription account addresses resource is used to view, create, update, and delete an account resource. It lists all the subscription account addresses with details.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountAddress-item-response"
    }
}

Nested Schema : Subscription Account Asset Relationships

Type: array

Title: Subscription Account Asset Relationships

The subscription account asset relationships resource is used to view, create, update, and delete a subscription account asset relationship. It lists all the subscription account asset relationships with details.

Show Source

Array of: object subscriptionAccounts-subscriptionAccountAssetRelationships-item-response

{
    "title":"Subscription Account Asset Relationships",
    "type":"array",
    "description":"The subscription account asset relationships resource is used to view, create, update, and delete a subscription account asset relationship. It lists all the subscription account asset relationships with details.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountAssetRelationships-item-response"
    }
}

Nested Schema : Subscription Account Relationships

Type: array

Title: Subscription Account Relationships

The subscription account relationships resource is used to view, create, update, and delete an account relationship.

Show Source

Array of: object subscriptionAccounts-subscriptionAccountRelationship-item-response

{
    "title":"Subscription Account Relationships",
    "type":"array",
    "description":"The subscription account relationships resource is used to view, create, update, and delete an account relationship.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountRelationship-item-response"
    }
}

Nested Schema : Subscription Account Roles

Type: array

Title: Subscription Account Roles

The subscription account roles resource is used to view, create, update, and delete an account role. It lists all the subscription account roles with details.

Show Source

Array of: object subscriptionAccounts-subscriptionAccountRoles-item-response

{
    "title":"Subscription Account Roles",
    "type":"array",
    "description":"The subscription account roles resource is used to view, create, update, and delete an account role. It lists all the subscription account roles with details.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAccounts-subscriptionAccountRoles-item-response"
    }
}

Nested Schema : subscriptionAccounts-Attachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
AttachedDocumentId: integer (int64)

Title: Attached Document Id

The unique identifier of the attached document.
CategoryName: string

Title: Category

Maximum Length: 30

The category of the attachment.
ContentRepositoryFileShared: boolean

Title: Shared

Indicates whether the attachment is shared.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

The user who created the attachment.
CreatedByUserName: string

Title: Created By User Name

Read Only: true

The user who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the attachment record was created.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

A value that indicates the data type.
Description: string

Title: Description

Maximum Length: 255

The description of the attachment.
DmDocumentId: string

Maximum Length: 255

The document ID from which the attachment is created.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

The folder path of the attachment.
DmVersionNumber: string

Maximum Length: 255

The document version number from which the attachment is created.
DownloadInfo: string

Title: DownloadInfo

JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

The error code, if any, for the attachment.
ErrorStatusMessage: string

Title: Error Status Message

The error message, if any, for the attachment.
ExpirationDate: string (date-time)

Title: Expiration Date

The expiration date of the contents in the attachment.
FileContents: string (byte)

Title: File Contents

The contents of the attachment.
FileName: string

Title: File Name

Maximum Length: 2048

The file name of the attachment.
FileUrl: string

Title: File Url

The URL of the attachment.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

The user who last updated the record.
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true

The user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction

The name of the action that can be performed after an attachment is uploaded.
Title: string

Title: Title

The title of the attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

The content type of the attachment.
UploadedFileLength: integer

Title: File Size

The length of the attachment file.
UploadedFileName: string

Title: Uploaded File Name

The name of the attachment file.
UploadedText: string

Title: Uploaded Text

The text of the attachment.
Uri: string

Title: Uri

Maximum Length: 4000

The URI of the attachment.
Url: string

Title: Url

Maximum Length: 4000

The URL of the attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

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

Nested Schema : subscriptionAccounts-billingProfiles-item-response

Type: object

Show Source

AddrElementAttribute1: string

Title: Additional Address Element 1

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute2: string

Title: Additional Address Element 2

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute3: string

Title: Additional Address Element 3

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute4: string

Title: Additional Address Element 4

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute5: string

Title: Additional Address Element 5

Maximum Length: 150

The additional address element to support flexible address format.
AddressLine1: string

Title: Address Line 1

Maximum Length: 240

The first line of the identifying address.
AddressLine2: string

Title: Address Line 2

Maximum Length: 240

The second line of the identifying address.
AddressLine3: string

Title: Address Line 3

Maximum Length: 240

The third line of the identifying address.
AddressLine4: string

Title: Address Line 4

Maximum Length: 240

The fourth line of the identifying address.
AddressLinesPhonetic: string

Title: Address Lines Phonetic

Maximum Length: 560

The phonetic or Kana representation of the Kanji address lines (used in Japan).
BillCycle: integer (int64)

Title: Bill Cycle

Minimum Value: 0

Indicates when the bill cycle occurs.
BillCycleDay: integer (int32)

Title: Bill Cycle Day

Minimum Value: 1

Maximum Value: 31

The day on which the bill cycle occurs.
BillingAccountNumber: string

Title: Billing Account Number

Maximum Length: 30

The billing account number of the profile.
BillingEmailAddress: string

Title: Email Address

Maximum Length: 100

The email address of the billing profile.
BillingFrequency: string

Title: Billing Frequency

Maximum Length: 100

The interval in which customer is billed for a service.
BillingProfileId: integer (int64)

Title: Billing Profile ID

Read Only: true

The unique identifier of the billing profile.
BillingProfileName: string

Title: Name

Maximum Length: 30

The name of the billing profile.
BillingProfileNumber: string

Title: Billing Profile Number

Maximum Length: 30

The unique user key for the table.
BillingType: string

Title: Billing Type

Maximum Length: 100

The billing type for a billing profile.
BillLanguage: string

Title: Language

Maximum Length: 30

The language that is used in an invoice.
BillMedia: string

Title: Bill Media

Maximum Length: 100

The media used to generate a bill for a billing profile.
Building: string

Title: Building

Maximum Length: 240

The specific building name or number of a given address.
City: string

Title: City

Maximum Length: 60

The city of the identifying address.
CollectionsFlag: boolean

Title: Collections

Maximum Length: 1

Default Value: false

The amount collected when users have not paid their bills for some time, and a collection process has been initiated.
Comments: string

Title: Comments

Maximum Length: 255

The additional comments for billing profile.
CorpCurrencyCode: string

Title: Corporate Currency Code

Maximum Length: 15

The application composer extensibility schema field.
Country: string

Title: Country

Maximum Length: 2

The country of the identifying address.
County: string

Title: County

Maximum Length: 60

The county of the identifying address.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the row.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the row was created.
CurcyConvRateType: string

Title: Currency Conversion Rate Type

Maximum Length: 30

The application composer extensibility schema field.
CurrencyCode: string

Title: Currency Code

Maximum Length: 15

The application composer extensibility schema field.
DeleteFlag: boolean

Read Only: true

Indicates whether the billing profile can be deleted.
ExternalBillingAccount: string

Title: External Billing Account Number

Maximum Length: 30

The external billing account number.
FloorNumber: string

Title: Floor

Maximum Length: 40

The specific floor number at a given address or in a particular building when the building number is provided.
FormattedAddress: string

Title: Address

Read Only: true

The formatted address of the identifying address.
FormattedMultilineAddress: string

Title: Address

Read Only: true

The multiline formatted address of the identifying address.
IdenAddrLocationId: integer (int64)

Title: Location ID

The unique identifier of the location of the identifying address.
InvoiceByEmailFlag: boolean

Title: Email Invoice

Maximum Length: 1

Default Value: false

Indicates whether an electronic copy of the invoice is preferred.
InvoiceByMailFlag: boolean

Title: Mail Invoice

Maximum Length: 1

Default Value: false

Indicates whether a paper copy of the invoice is preferred.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the row was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the row.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the row.
links: array Links

Title: Links

The link relations associated with the resource instance.
PaymentMethod: string

Title: Payment Method

Maximum Length: 100

The method of payment used for a billing profile.
PostalCode: string

Title: Postal Code

Maximum Length: 60

The postal code of the identifying address.
PostalPlus4Code: string

Title: Postal Code Extension

Maximum Length: 20

The four digit extension to the United States Postal ZIP code.
PrepaidAutomaticTopupFlag: boolean

Title: Prepaid Automatic Top Up

Maximum Length: 1

Default Value: false

Indicates whether the customer requires a prepaid automatic top up for a billing profile.
PrepaidSMSNotificationFlag: boolean

Title: Prepaid SMS Notification

Maximum Length: 1

Default Value: false

Indicates whether the customer requires a short message service notification for a prepaid billing profile.
PrimaryFlag: boolean

Title: Primary

Maximum Length: 1

Default Value: false

Indicate whether the billing profile is the primary billing profile for the subscription account.
Province: string

Title: Province

Maximum Length: 60

The province of the identifying address.
State: string

Title: State

Maximum Length: 60

The state of the identifying address.
StatementFlag: boolean

Title: Statement

Maximum Length: 1

Default Value: false

Indicates whether the customer requires a statement for the billing profile.
Status: string

Title: Status

Maximum Length: 30

The status of a billing profile.
SubscrAccountNumber: string

Title: Subscription Account Number

Read Only: true

Maximum Length: 30

The unique user key of the subscription account.
SubscriptionAccountId: integer (int64)

Title: Subscription Account ID

The unique identifier of the subscription account.
UpdateFlag: boolean

Read Only: true

Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "BillLanguage":{
            "title":"Language",
            "maxLength":30,
            "type":"string",
            "description":"The language that is used in an invoice.",
            "nullable":true,
            "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
        },
        "BillingAccountNumber":{
            "title":"Billing Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The billing account number of the profile.",
            "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
        },
        "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
        },
        "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
        },
        "BillingProfileName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the billing profile.",
            "nullable":false,
            "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
        },
        "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
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The specific building name or number of a given address.",
            "nullable":true,
            "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
        },
        "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
        },
        "Comments":{
            "title":"Comments",
            "maxLength":255,
            "type":"string",
            "description":"The additional comments for billing profile.",
            "nullable":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
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the identifying address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing profile can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalBillingAccount":{
            "title":"External Billing Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The external billing account number.",
            "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
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline formatted address of the identifying address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of a billing profile.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : subscriptionAccounts-Note-item-response

Type: object

Show Source

ContactRelationshipId: integer (int64)

Title: Contact Relationship ID

The relationship ID populated when the note is associated with a contact.
CorpCurrencyCode: string

Title: Corporate Currency Code

Maximum Length: 15

The corporate currency code for extensibility.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the record was created.
CreatorPartyId: integer (int64)

Title: Creator Party ID

The unique identifier of the party.
CurcyConvRateType: string

Title: Currency Conversion Rate Type

Maximum Length: 30

The currency conversion rate type for extensibility.
CurrencyCode: string

Title: Currency

Maximum Length: 15

The currency code for extensibility.
DeleteFlag: boolean

Title: Delete Indicator

Read Only: true

Indicates whether the user has access to delete the note.
EmailAddress: string

Read Only: true

Maximum Length: 320

The email address of the user who created the note.
FormattedAddress: string

Read Only: true

The address of the user who created the note.
FormattedPhoneNumber: string

Read Only: true

The phone number of the user who created the note.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The unique identifier of the note. This is the primary key of the notes table.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
NoteId: integer (int64)

Title: Note ID

Read Only: true

The unique identifier of the note. This is the primary key of the notes table.
NoteNumber: string

Maximum Length: 30

The alternate unique identifier of the note. A user key that's system generated or from an external system.
NoteTitle: string

Title: Title

Maximum Length: 500

The title of the note entered by the user.
NoteTxt: string (byte)

Title: Note

The column which stores the actual note text.
NoteTypeCode: string

Title: Type

Maximum Length: 30

The note type code for categorization of note.
ParentNoteId: integer (int64)

Title: Parent Note ID

The identifier for the Parent Note.
PartyId: integer (int64)

Read Only: true

The unique identifier of the party.
PartyName: string

Title: Author

Read Only: true

Maximum Length: 360

The name of the party.
SourceObjectCode: string

Title: Related Object Type

Maximum Length: 30

This is the source object code for the source object as defined in OBJECTS Metadata.
SourceObjectId: string

Title: Related Object

Maximum Length: 64

The unique identifier of the parent source object associated to the note.
SourceSystem: string

Title: Source System

Maximum Length: 30

This is the source object code for the source object as defined in OBJECTS Metadata.
UpdateFlag: boolean

Title: Update Indicator

Read Only: true

Indicates whether the user can update the note.
VisibilityCode: string

Title: Private

Maximum Length: 30

Default Value: INTERNAL

The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "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 for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Country",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The identifier for the Parent Note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : subscriptionAccounts-subscriptionAccountAddress-item-response

Type: object

Show Source

AddrElementAttribute1: string

Title: Additional Address Element 1

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute2: string

Title: Additional Address Element 2

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute3: string

Title: Additional Address Element 3

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute4: string

Title: Additional Address Element 4

Maximum Length: 150

The additional address element to support flexible address format.
AddrElementAttribute5: string

Title: Additional Address Element 5

Maximum Length: 150

The additional address element to support flexible address format.
Address1: string

Title: Address Line 1

Maximum Length: 240

The first line of the address.
Address2: string

Title: Address Line 2

Maximum Length: 240

The second line of the address.
Address3: string

Title: Address Line 3

Maximum Length: 240

The third line of the address.
Address4: string

Title: Address Line 4

Maximum Length: 240

The fourth line of the address.
AddressId: integer (int64)

Title: Address Identifier

Read Only: true

The unique identifier of the subscription account address record.
AddressLinesPhonetic: string

Title: Address Lines Phonetic

Maximum Length: 560

The phonetic or Kana representation of the Kanji address lines (used in Japan).
AddressNumber: string

Title: Address Number

Maximum Length: 30

An alphanumeric number that uniquely identifies the address for a subscription account.
AddressType: string

Title: Address Type

Maximum Length: 100

The address type is the static choice list with values indicating the type of address
Building: string

Title: Building

Maximum Length: 240

The specific building name or number of a given address.
City: string

Title: City

Maximum Length: 60

The city component of a postal address.
Country: string

Title: Country

Maximum Length: 2

The country component of a postal address.
County: string

Title: County

Maximum Length: 60

The country component of a postal address.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the subscription account address.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the subscription account address was created.
CustomerAccountId: string

Read Only: true

The unique identifier of the customer account.
CustomerAccountSiteId: string

Read Only: true

The unique identifier of the customer account side.
DeleteFlag: boolean

Read Only: true

Indicates whether the subscription account address can be deleted.
FloorNumber: string

Title: Floor

Maximum Length: 40

The specific floor number at a given address or in a particular building when the building number is provided.
FormattedAddress: string

Title: Address

Read Only: true

The complete street address of a location.
FormattedMultilineAddress: string

Title: Address

Read Only: true

The complete street address of a location.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time the subscription account address was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the subscription account address.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the subscription account address.
links: array Links

Title: Links

The link relations associated with the resource instance.
Location: string

Read Only: true

The location of the subscription account address.
PartySiteId: string

Read Only: true

The unique identifier of the party address.
PostalCode: string

Title: Postal Code

Maximum Length: 60

The postal code of the subscription account address.
PostalPlus4Code: string

Title: Postal Code Extension

Maximum Length: 20

The four digit extension to the United States Postal ZIP code.
PrimaryFlag: boolean

Title: Primary Address

Maximum Length: 1

Default Value: false

Indicates the primary address of a subscription account.
Province: string

Title: Province

Maximum Length: 60

The name of the province for address of resource.
SetCode: string

Read Only: true

The reference set of the record.
SetId: string

Read Only: true

The unique identifier of the set.
SiteUseId: string

Read Only: true

The unique identifier of the party site usage.
State: string

Title: State

Maximum Length: 60

The state component of a postal address.
SubscrAccountNumber: string

Title: Subscription Account Number

Read Only: true

Maximum Length: 30

The alternate unique identifier of the subscription account.
UpdateFlag: boolean

Read Only: true

Indicates whether the subscription account address can be updated.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address Identifier",
            "type":"integer",
            "description":"The unique identifier of the subscription account address record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "AddressNumber":{
            "title":"Address Number",
            "maxLength":30,
            "type":"string",
            "description":"An alphanumeric number that uniquely identifies the address for a subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":100,
            "type":"string",
            "description":"The address type is the static choice list with values indicating the type of address",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city component of a postal address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country component of a postal address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The country component of a postal address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription account address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the subscription account address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"string",
            "description":"The unique identifier of the customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountSiteId":{
            "type":"string",
            "description":"The unique identifier of the customer account side.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account address can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The complete street address of a location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The complete street address of a location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the subscription account address was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription account address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription account address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "type":"string",
            "description":"The location of the subscription account address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"string",
            "description":"The unique identifier of the party address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the subscription account address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "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
        },
        "PrimaryFlag":{
            "title":"Primary Address",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the primary address of a subscription account.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The name of the province for address of resource.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "SetCode":{
            "type":"string",
            "description":"The reference set of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"string",
            "description":"The unique identifier of the set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteUseId":{
            "type":"string",
            "description":"The unique identifier of the party site usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state component of a postal address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account address can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : subscriptionAccounts-subscriptionAccountAssetRelationships-item-response

Type: object

Show Source

AssetId: integer (int64)

Title: Asset ID

The unique identifier of asset.
AssetNumber: string

Read Only: true

Maximum Length: 80

The alternate unique identifier of the asset.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the subscription account asset relationship.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the subscription account asset relationship was created.
DeleteFlag: boolean

Read Only: true

Indicates whether the user can delete the subscription account asset relationship.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date when the subscription account asset relationship was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the subscription account asset relationship.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the subscription account asset relationship.
links: array Links

Title: Links

The link relations associated with the resource instance.
RelationshipType: string

Title: Relationship Type

Maximum Length: 30

Indicates the relationship between the subscription account and the asset.
SubscrAccountNumber: string

Title: Subscription Account Number

Maximum Length: 30

The alternate unique identifier of the subscription account.
SubscriptionAccountAssetRelationshipId: integer (int64)

Title: Subscription Account Asset Relationship ID

The alternate unique identifier of subscription account asset relationship.
SubscriptionAccountAssetRelationshipNumber: string

Title: Subscription Account Asset Relationship Number

Maximum Length: 30

The unique identifier of the subscription account asset relationship.
SubscriptionAccountId: integer (int64)

Title: Subscription Account ID

The unique identifier of the subscription account.
UpdateFlag: boolean

Read Only: true

Indicates whether the user can update the subscription account asset relationship.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The alternate unique identifier of the asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription account asset relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the subscription account asset relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user can delete the subscription account asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription account asset relationship was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription account asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription account asset relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the relationship between the subscription account and the asset.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionAccountAssetRelationshipId":{
            "title":"Subscription Account Asset Relationship ID",
            "type":"integer",
            "description":"The alternate unique identifier of subscription account asset relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionAccountAssetRelationshipNumber":{
            "title":"Subscription Account Asset Relationship Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the subscription account asset relationship.",
            "nullable":false,
            "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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the user can update the subscription account asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : subscriptionAccounts-subscriptionAccountRelationship-item-response

Type: object

Show Source

Comments: string

Title: Comments

Maximum Length: 2000

The comments for subscription account relationship.
ContactId: integer

Title: Contact ID

Read Only: true

The unique identifier of the contact.
CorpCurrencyCode: string

Title: Corporate Currency Code

Maximum Length: 15

The corporate currency code associated with the subscription account relationship. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the record was created.
CurrencyCode: string

Title: Currency Code

Maximum Length: 15

The date when the record was created.
DeleteFlag: boolean

Read Only: true

The rate of currency conversion for a subscription account.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

Indicates whether the account relationship can be deleted.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The login of the user who last updated the record.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The date when the record was last updated.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyId: integer (int64)

Title: Sales Account ID

The unique identifier of the party.
PartyName: string

Title: Name

Read Only: true

Maximum Length: 360

The name of the party.
PartyNumber: string

Title: Registry ID

Maximum Length: 30

The alternate identifier of the record.
PartyType: string

Title: Party Type

Read Only: true

Maximum Length: 30

The type of the party.
RelationshipType: string

Title: Relationship Type

Maximum Length: 30

The type of the relationship.
RelationshipTypeLookup: string

Title: Relationship Type Lookup Code

Read Only: true

The relationship type lookup associated with the subscription account relationship. It's used to expose the Lookup code of RelationshipType field based on Party Type.
SalesAccountId: integer

Title: Sales Account ID

Read Only: true

The unique identifier of the sales account.
SubscrAccountNumber: string

Title: Subscription Account Number

Read Only: true

Maximum Length: 30

The alternate identifier of the subscription account.
SubscriptionAccountId: integer (int64)

Title: Subscription Account ID

The unique identifier of the subscription account.
SubscriptionAccountRelationshipId: integer (int64)

Title: Subscription Account Relationship ID

Read Only: true

The unique identifier of the subscription account relationship.
SubscriptionAccountRelationshipNumber: string

Title: Subscription Account Relationship Number

Maximum Length: 30

The alternate identifier of the subscription account relationship.
UpdateFlag: boolean

Read Only: true

Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The comments for subscription account relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the subscription account relationship. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"The rate of currency conversion for a subscription account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates whether the account relationship can be deleted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyId",
                    "PartyNumber",
                    "PartyType"
                ]
            },
            "x-queryable":true
        },
        "RelationshipTypeLookup":{
            "title":"Relationship Type Lookup Code",
            "type":"string",
            "description":"The relationship type lookup associated with the subscription account relationship. It's used to expose the Lookup code of RelationshipType field based on Party Type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyType"
                ]
            }
        },
        "SalesAccountId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the subscription account.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "SubscriptionAccountRelationshipId":{
            "title":"Subscription Account Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionAccountRelationshipNumber":{
            "title":"Subscription Account Relationship Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the subscription account relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : subscriptionAccounts-subscriptionAccountRoles-item-response

Type: object

Show Source

CorpCurrencyCode: string

Title: Corporate Currency Code

Maximum Length: 15

The application composer extensibility schema field.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the row.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the row was created.
CurcyConvRateType: string

Title: Currency Conversion Rate Type

Maximum Length: 30

The application composer extensibility schema field.
CurrencyCode: string

Title: Currency Code

Maximum Length: 15

The application composer extensibility schema field.
DeleteFlag: boolean

Read Only: true

Indicates whether the subscription account role has been deleted.
EmailAddress: string

Title: Primary Email

Read Only: true

Maximum Length: 320

The primary email address of the party.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the row was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the row.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The login of the user who last updated the row.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyId: integer (int64)

Title: Party ID

The party who got assigned with the role.
PartyName: string

Title: Name

Read Only: true

Maximum Length: 360

The name of the party associated with the subscription account.
PartyNumber: string

Title: Registry ID

Maximum Length: 30

The unique identifier of the party.
PartyType: string

Title: Party Type

Read Only: true

Maximum Length: 30

The type of the party associated with the subscription account.
PersonFirstName: string

Title: First Name

Read Only: true

Maximum Length: 150

The first name of the party.
PersonLastName: string

Title: Last Name

Read Only: true

Maximum Length: 150

The last name of the party.
RoleName: string

Title: Role

Maximum Length: 30

The role of the consumer for the subscription account.
SubscrAccMgmtRoleId: integer (int64)

Title: Subscription Account Roles ID

Read Only: true

The unique identifier for storing subscription account role record.
SubscrAccountNumber: string

Title: Subscription Account Number

Maximum Length: 30

The alternate unique identifier of the subscription account.
SubscrAccRoleNumber: string

Title: Subscription Account Role Number

Maximum Length: 30

The alternate unique identifier of the subscription account.
SubscriptionAccountId: integer (int64)

Title: Subscription Account ID

The subscription account associated to the subscription account role record.
UpdateFlag: boolean

Read Only: true

Indicates whether the subscription account role has been updated.

{
    "type":"object",
    "properties":{
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "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
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The application composer extensibility schema field.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account role has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The primary email address of the party.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The party who got assigned with the role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the party.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the party associated with the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the party.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the party.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The role of the consumer for the subscription account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscrAccMgmtRoleId":{
            "title":"Subscription Account Roles ID",
            "type":"integer",
            "description":"The unique identifier for storing subscription account role record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscrAccRoleNumber":{
            "title":"Subscription Account Role Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The subscription account associated to the subscription account role record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account role has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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