1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Accounts

Create a subscription account

post

/crmRestApi/resources/11.13.18.05/subscriptionAccounts

Request

Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • Title: Subscription Account Name
    Maximum Length: 240
    The description chosen by external party (but can be entered internally on behalf on the customer).
  • Title: Status
    Maximum Length: 30
    Default Value: A
    The status of the subscription account.
  • Title: Additional Address Element 1
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the account address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the account address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the account address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the account address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines (used in Japan).
  • Title: Address Number
    Maximum Length: 30
    The address number associated with the subscription account.
  • Title: Address Type
    Maximum Length: 100
    Address Type is the static choice list with values indicating the type of address.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.
  • 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.
  • Title: Building
    Maximum Length: 240
    The specific building name or number of a given address.
  • Title: City
    Maximum Length: 60
    The city of the identifying address.
  • 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.
  • 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.
  • Title: Corporation Class
    Maximum Length: 30
    The taxation classification for corporation entities such as Chapter S in the US.
  • Title: Country
    Maximum Length: 2
    The country of the identifying address.
  • Title: County
    Maximum Length: 60
    The county of the identifying address.
  • Title: Credit Agency
    Maximum Length: 30
    The credit agency for subscription account.
  • Title: Credit Score
    Minimum Value: 0
    The credit score issues by the credit agency for the subscription account.
  • Title: Credit Threshold
    Minimum Value: 0
    The credit threshold for subscription account issued by the credit agency.
  • Title: Credit Update Date
    The credit update date for subscription account.
  • Title: Credit Updated By
    Maximum Length: 30
    The use who updated the credit information for the subscription account.
  • 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.
  • Title: Currency Code
    Maximum Length: 15
    The rate of currency conversion for a subscription account.
  • Title: Customer Account ID
    The unique identifier of the customer account. The foreign key to the HZ_CUST_ACCOUNTS table.
  • Title: Daily Threshold
    Minimum Value: 0
    The daily threshold limit for subscription account.
  • Title: D&B Credit Rating
    Maximum Length: 30
    The Dun & Bradstreet credit rating.
  • Title: Directory Assistance Start Date
    The date when directory assistance starts for the subscription account.
  • Title: Directory Assistance Status
    Maximum Length: 30
    The status of directory assistance for the subscription account.
  • Title: Domestic Threshold
    Minimum Value: 0
    The domestic threshold for subscription accounts.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The column value not restricted to nine digit DUNS Number.
  • 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.
  • Title: Floor
    Maximum Length: 40
    The specific floor number at a given address or in a particular building when the building number is provided.
  • Title: International Threshold
    Minimum Value: 0
    The international threshold for the subscription account.
  • Title: Last Source Update Date
    The timestamp when this record was updated by the source system in the last update source system column.
  • Title: Last Update Source System
    Maximum Length: 30
    The source system that last updated this record.
  • Title: Legal Entity ID
    The legal entity associated with the subscription account.
  • Title: Maximum Call Duration
    Minimum Value: 0
    The maximum call duration for subscription account.
  • Title: Maximum Calls
    Minimum Value: 0
    The maximum number of calls for subscription account.
  • Title: Maximum Call Cost
    Minimum Value: 0
    The maximum cost that is set for the subscription account.
  • 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.
  • 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.
  • Title: Parent Subscription Account ID
    The unique identifier of the parent subscription account. It specifies the parent account of the subscription account.
  • Title: Subscription Account Number
    Maximum Length: 30
    The unique user key for the Parent Subscription Account Object.
  • Title: Party ID
    The uniquely generated id for HZ_PARTY.
  • Title: Registry ID
    Maximum Length: 30
    This is a unique user key for the table.
  • Title: Percentage Overflow
    Minimum Value: 0
    The percentage overflow for subscription account.
  • Title: Phone Assistance Exemption
    Maximum Length: 1
    Default Value: false
    The phone assistance exemption for subscription account.
  • Title: Phone Assistance Renewal Date
    The phone assistance renewal date for the subscription account.
  • Title: Phone Assistance Request Date
    The date when the phone assistance request for the subscription account was made.
  • Title: Phone Assistance Start Date
    The date when the phone assistance for the subscription account starts.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the subscription account primary address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code.
  • Title: Primary Language
    Maximum Length: 30
    The primary language for subscription account.
  • 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.
  • Title: Province
    Maximum Length: 60
    The province of the identifying address.
  • Title: Registration Type
    Maximum Length: 30
    The lookup for type of registration, such as nonprofit.
  • Title: Sensitive Number Threshold
    Minimum Value: 0
    The sensitive number threshold for the subscription account.
  • 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.
  • Title: Source System
    Maximum Length: 30
    The source system of the record.
  • Title: Source System Reference
    Maximum Length: 255
    The reference of the source system.
  • Title: State
    Maximum Length: 60
    The state of the identifying address.
  • Title: State Seller Tax Permit or License Number
    Maximum Length: 30
    The state sell tax permit LIC number for subscription account.
  • Title: Subscription Account Number
    Maximum Length: 30
    The alternate unique identifier of the subscription account.
  • 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.
  • 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.
  • Subscription Account Relationships
    Title: Subscription Account Relationships
    The subscription account relationships resource is used to view, create, update, and delete an account relationship.
  • 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.
  • 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.
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
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
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
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
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
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
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
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : subscriptionAccounts-Note-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines (used in Japan).
  • Title: Address Number
    Maximum Length: 30
    An alphanumeric number that uniquely identifies the address for a subscription account.
  • Title: Address Type
    Maximum Length: 100
    The address type is the static choice list with values indicating the type of address
  • Title: Building
    Maximum Length: 240
    The specific building name or number of a given address.
  • Title: City
    Maximum Length: 60
    The city component of a postal address.
  • Title: Country
    Maximum Length: 2
    The country component of a postal address.
  • Title: County
    Maximum Length: 60
    The country component of a postal address.
  • Title: Floor
    Maximum Length: 40
    The specific floor number at a given address or in a particular building when the building number is provided.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the subscription account address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code.
  • Title: Primary Address
    Maximum Length: 1
    Default Value: false
    Indicates the primary address of a subscription account.
  • Title: Province
    Maximum Length: 60
    The name of the province for address of resource.
  • Title: State
    Maximum Length: 60
    The state component of a postal address.
Nested Schema : subscriptionAccounts-subscriptionAccountAssetRelationships-item-post-request
Type: object
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountRelationship-item-post-request
Type: object
Show Source
  • Title: Comments
    Maximum Length: 2000
    The comments for subscription account relationship.
  • 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.
  • Title: Currency Code
    Maximum Length: 15
    The date when the record was created.
  • Title: Sales Account ID
    The unique identifier of the party.
  • Title: Registry ID
    Maximum Length: 30
    The alternate identifier of the record.
  • Title: Relationship Type
    Maximum Length: 30
    The type of the relationship.
  • Title: Subscription Account ID
    The unique identifier of the subscription account.
  • Title: Subscription Account Relationship Number
    Maximum Length: 30
    The alternate identifier of the subscription account relationship.
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : subscriptionAccounts-item-response
Type: object
Show Source
  • 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.
  • Title: Subscription Account Name
    Maximum Length: 240
    The description chosen by external party (but can be entered internally on behalf on the customer).
  • Title: Status
    Maximum Length: 30
    Default Value: A
    The status of the subscription account.
  • Title: Additional Address Element 1
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the account address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the account address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the account address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the account address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines (used in Japan).
  • Title: Address Number
    Maximum Length: 30
    The address number associated with the subscription account.
  • Title: Address Type
    Maximum Length: 100
    Address Type is the static choice list with values indicating the type of address.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.
  • 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.
  • Title: Building
    Maximum Length: 240
    The specific building name or number of a given address.
  • Title: City
    Maximum Length: 60
    The city of the identifying address.
  • 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.
  • 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.
  • Title: Corporation Class
    Maximum Length: 30
    The taxation classification for corporation entities such as Chapter S in the US.
  • Title: Country
    Maximum Length: 2
    The country of the identifying address.
  • Title: County
    Maximum Length: 60
    The county of the identifying address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the row.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Credit Agency
    Maximum Length: 30
    The credit agency for subscription account.
  • Title: Credit Score
    Minimum Value: 0
    The credit score issues by the credit agency for the subscription account.
  • Title: Credit Threshold
    Minimum Value: 0
    The credit threshold for subscription account issued by the credit agency.
  • Title: Credit Update Date
    The credit update date for subscription account.
  • Title: Credit Updated By
    Maximum Length: 30
    The use who updated the credit information for the subscription account.
  • 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.
  • Title: Currency Code
    Maximum Length: 15
    The rate of currency conversion for a subscription account.
  • Title: Customer Account ID
    The unique identifier of the customer account. The foreign key to the HZ_CUST_ACCOUNTS table.
  • Read Only: true
    The unique identifier of the customer account side.
  • Title: Daily Threshold
    Minimum Value: 0
    The daily threshold limit for subscription account.
  • Title: D&B Credit Rating
    Maximum Length: 30
    The Dun & Bradstreet credit rating.
  • Read Only: true
    Indicates whether the subscription account has been deleted.
  • Title: Directory Assistance Start Date
    The date when directory assistance starts for the subscription account.
  • Title: Directory Assistance Status
    Maximum Length: 30
    The status of directory assistance for the subscription account.
  • Title: Domestic Threshold
    Minimum Value: 0
    The domestic threshold for subscription accounts.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The column value not restricted to nine digit DUNS Number.
  • 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.
  • Title: Floor
    Maximum Length: 40
    The specific floor number at a given address or in a particular building when the building number is provided.
  • Title: Address
    Read Only: true
    Maximum Length: 255
    The formatted address of the identifying address.
  • Title: Address
    Read Only: true
    The formatted multiline address of the identifying address.
  • Title: International Threshold
    Minimum Value: 0
    The international threshold for the subscription account.
  • Title: Last Source Update Date
    The timestamp when this record was updated by the source system in the last update source system column.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Title: Last Update Source System
    Maximum Length: 30
    The source system that last updated this record.
  • Title: Legal Entity ID
    The legal entity associated with the subscription account.
  • Links
  • Title: Location ID
    Read Only: true
    The unique identifier of the subscription account primary address.
  • Title: Maximum Call Duration
    Minimum Value: 0
    The maximum call duration for subscription account.
  • Title: Maximum Calls
    Minimum Value: 0
    The maximum number of calls for subscription account.
  • Title: Maximum Call Cost
    Minimum Value: 0
    The maximum cost that is set for the subscription account.
  • 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.
  • 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.
  • Title: Parent Subscription Account ID
    The unique identifier of the parent subscription account. It specifies the parent account of the subscription account.
  • Title: Subscription Account Number
    Maximum Length: 30
    The unique user key for the Parent Subscription Account Object.
  • Title: Parent Subscription Account Name
    Read Only: true
    Maximum Length: 240
    The name of the Parent Subscription Account.
  • Title: Party ID
    The uniquely generated id for HZ_PARTY.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the party.
  • Title: Registry ID
    Maximum Length: 30
    This is a unique user key for the table.
  • Read Only: true
    The unique identifier of the party site of the identifying address.
  • Title: Party Type
    Read Only: true
    Maximum Length: 30
    The party type, like consumer or organization.
  • Title: Percentage Overflow
    Minimum Value: 0
    The percentage overflow for subscription account.
  • Title: Phone Assistance Exemption
    Maximum Length: 1
    Default Value: false
    The phone assistance exemption for subscription account.
  • Title: Phone Assistance Renewal Date
    The phone assistance renewal date for the subscription account.
  • Title: Phone Assistance Request Date
    The date when the phone assistance request for the subscription account was made.
  • Title: Phone Assistance Start Date
    The date when the phone assistance for the subscription account starts.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the subscription account primary address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code.
  • Title: Primary Language
    Maximum Length: 30
    The primary language for subscription account.
  • 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.
  • Title: Province
    Maximum Length: 60
    The province of the identifying address.
  • Title: Registration Type
    Maximum Length: 30
    The lookup for type of registration, such as nonprofit.
  • Title: Sales Account ID
    Read Only: true
    The party identifier for Organization.
  • Title: Sensitive Number Threshold
    Minimum Value: 0
    The sensitive number threshold for the subscription account.
  • Read Only: true
    The reference set of the record.
  • Read Only: true
    The account site set of the identifying address.
  • Read Only: true
    The site use code of the identifying address.
  • 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.
  • Title: Source System
    Maximum Length: 30
    The source system of the record.
  • Title: Source System Reference
    Maximum Length: 255
    The reference of the source system.
  • Title: State
    Maximum Length: 60
    The state of the identifying address.
  • Title: State Seller Tax Permit or License Number
    Maximum Length: 30
    The state sell tax permit LIC number for subscription account.
  • Title: Subscription Account Number
    Maximum Length: 30
    The alternate unique identifier of the subscription account.
  • 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.
  • 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.
  • Title: Subscription Account ID
    Read Only: true
    The unique identifier of the subscription account.
  • Subscription Account Relationships
    Title: Subscription Account Relationships
    The subscription account relationships resource is used to view, create, update, and delete an account relationship.
  • 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.
  • Title: Tax Code
    Read Only: true
    Maximum Length: 50
    The tax code for the customer.
  • 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.
  • Read Only: true
    Indicates whether the subscription account has been updated.
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
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
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
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
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
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
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
Nested Schema : subscriptionAccounts-Attachments-item-response
Type: object
Show Source
Nested Schema : subscriptionAccounts-billingProfiles-item-response
Type: object
Show Source
Nested Schema : subscriptionAccounts-Note-item-response
Type: object
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountAddress-item-response
Type: object
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountAssetRelationships-item-response
Type: object
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountRelationship-item-response
Type: object
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountRoles-item-response
Type: object
Show Source
Links
AccountClassListVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_ACCOUNT_CLASS
The list of values indicating the class of a subscription account

The following properties are defined on the LOV link relation:
  • Source Attribute: AccountClass; Target Attribute: LookupCode
  • Display Attribute: Meaning
AccountStatusListVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_STATUS
The list of values indicating the status of subscription account.

The following properties are defined on the LOV link relation:
  • Source Attribute: AccountStatus; Target Attribute: LookupCode
  • Display Attribute: Meaning
AddressTypeListVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_SUBSC_ACC_ADDRESS_TYPE
The following properties are defined on the LOV link relation:
  • Source Attribute: AddressType; Target Attribute: LookupCode
  • Display Attribute: Meaning
Attachments
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.
CountryVA
Parameters:
  • finder: ObsoleteEnabledFlagFinder%3BBindObsoleteFlag%3DN%2CBindEnabledFlag%3DY
The following properties are defined on the LOV link relation:
  • Source Attribute: Country; Target Attribute: TerritoryCode
  • Display Attribute: TerritoryShortName
DirectoryAssistStatusListVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_ACC_DIRECT_ASSIST_STAT
The following properties are defined on the LOV link relation:
  • Source Attribute: DirectoryAssistStatus; Target Attribute: LookupCode
  • Display Attribute: Meaning
Note
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
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.
OrganizationVA
The following properties are defined on the LOV link relation:
  • Source Attribute: SalesAccountId; Target Attribute: PartyId
  • Display Attribute: PartyUniqueName
PartyTypeListVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DPARTY_TYPE
The list of values indicating the party type as account or contact.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartyType; Target Attribute: LookupCode
  • Display Attribute: Meaning
RatedCurrenciesVA


The following properties are defined on the LOV link relation:
  • Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
  • Display Attribute: Name
RegistrationTypeListVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DREGISTRATION_TYPE
The list of values indicating the subscription account registration type.

The following properties are defined on the LOV link relation:
  • Source Attribute: RegistrationType; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoNonprofitOrganizationFlagVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:
  • Source Attribute: NonprofitOrganizationFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoPhAssistExemptionVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating yes or no.

The following properties are defined on the LOV link relation:
  • Source Attribute: PhAssistExemptionFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoPrivatelyOwnedFlagVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:
  • Source Attribute: PrivatelyOwnedFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoSmallBusinessFlagVA
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:
  • Source Attribute: SmallBusinessFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
billingProfiles
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
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.
subscriptionAccountAddress
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
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
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
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.
subscriptionAccountRelationship
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
The subscription account relationships resource is used to view, create, update, and delete an account relationship.
subscriptionAccountRoles
Parameters:
  • SubscrAccountNumber: $request.path.SubscrAccountNumber
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.
Back to Top