Update a subscription account
patch
/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}
Request
Path Parameters
-
SubscrAccountNumber(required): string
The alternate unique identifier of the subscription account.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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). -
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. -
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. -
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. -
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. -
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. -
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. -
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. -
PartyId: integer
(int64)
Title:
Party ID
The uniquely generated id for HZ_PARTY. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
This is a unique user key for the table. -
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. -
SensitiveNubmerThreshold: number
Title:
Sensitive Number Threshold
Minimum Value:0
The sensitive number threshold for the subscription account. -
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. -
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. -
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. -
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.
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-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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. -
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.
Nested Schema : subscriptionAccounts-billingProfiles-item-patch-request
Type:
Show Source
object
-
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. -
BillingProfileName: string
Title:
Name
Maximum Length:30
The name of the billing profile. -
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. -
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. -
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. -
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. -
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.
Nested Schema : subscriptionAccounts-Note-item-patch-request
Type:
Show Source
object
-
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. -
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. -
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. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the parent source object associated to 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.
Nested Schema : subscriptionAccounts-subscriptionAccountAddress-item-patch-request
Type:
Show Source
object
-
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. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
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. -
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. -
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. -
State: string
Title:
State
Maximum Length:60
The state component of a postal address.
Nested Schema : subscriptionAccounts-subscriptionAccountAssetRelationships-item-patch-request
Type:
Show Source
object
-
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of asset. -
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. -
SubscriptionAccountId: integer
(int64)
Title:
Subscription Account ID
The unique identifier of the subscription account.
Nested Schema : subscriptionAccounts-subscriptionAccountRelationship-item-patch-request
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The comments for subscription account relationship. -
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. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The date when the record was created. -
PartyId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the party. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The alternate identifier of the record. -
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The type of the relationship.
Nested Schema : subscriptionAccounts-subscriptionAccountRoles-item-patch-request
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The application composer extensibility schema field. -
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. -
PartyId: integer
(int64)
Title:
Party ID
The party who got assigned with the role. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique identifier of the party. -
RoleName: string
Title:
Role
Maximum Length:30
The role of the consumer for the subscription account.
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-item-response
Type:
Show Source
object
-
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionAccounts-billingProfiles-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionAccounts-Note-item-response
Type:
Show Source
object
-
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
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
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)
Title:
Party ID
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. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountAddress-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountAssetRelationships-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountRelationship-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionAccounts-subscriptionAccountRoles-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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
- finder:
- 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
- finder:
- 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
- finder:
- Attachments
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/AttachmentsParameters:
- 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. - SubscrAccountNumber:
- 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
- finder:
- 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
- finder:
- 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. - SubscrAccountNumber:
- OrganizationVA
-
Operation: /crmRestApi/resources/11.13.18.05/accountsThe 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- billingProfiles
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfilesParameters:
- 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. - SubscrAccountNumber:
- 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. - SubscrAccountNumber:
- 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. - SubscrAccountNumber:
- subscriptionAccountRelationship
-
Parameters:
- SubscrAccountNumber:
$request.path.SubscrAccountNumber
The subscription account relationships resource is used to view, create, update, and delete an account relationship. - SubscrAccountNumber:
- 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. - SubscrAccountNumber: