Create an account
post
/crmRestApi/resources/11.13.18.05/accounts
Request
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AccountContact: array
Organization Contacts
Title:
Organization Contacts
The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account. -
AccountExtensionBase: array
Account Extension Bases
Title:
Account Extension Bases
The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type. -
AccountRollup: array
Account Rollups
Title:
Account Rollups
The account rollups resource is used to view, create, update, and delete an account rollup. -
AccountScore: integer
Title:
Account Score
Score assigned based on custom criteria by the user. -
AccountScoringTier: string
Title:
Account Scoring Tier
Maximum Length:30
Tier assigned based on custom criteria by the user. -
AdditionalIdentifier: array
Additional Identifier
Title:
Additional Identifier
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. -
AdditionalName: array
Additional Names
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name. -
Address: array
Addresses
Title:
Addresses
The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: 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 for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber(required): string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressType: string
Title:
Address Type
Additional information as type of address like BillTo, ShipTo. -
AnalysisFiscalYear: string
Title:
Analysis Year
Maximum Length:5
The fiscal year used as the source for financial information. -
Attachment: array
Account Attachments
Title:
Account Attachments
The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
BusinessReport: string
(byte)
Title:
D&B Business Report
The Dun & Bradstreet business information report. -
BusinessScope: string
Title:
Business Scope
Maximum Length:20
The class of business to which the account belongs, such as local, national, or international. -
CEOName: string
Title:
Chief Executive Name
Maximum Length:240
The name of the organization???s chief executive officer. -
CEOTitle: string
Title:
Chief Executive Title
Maximum Length:240
The formal title of the chief executive officer. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The code indicating the reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of the account. -
Comments: string
Title:
Comments
Maximum Length:2000
The corporate charter of the organization. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CongressionalDistrictCode: string
Title:
Congressional District
Maximum Length:2
The U.S. Congressional district code for the account. -
ContactPoint: array
Contact Points
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on. -
ControlYear: number
Title:
Organization Control Year
The year when current ownership gained control of the organization. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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:60
The taxation classification for corporation entities such as Chapter S in the US. -
Country(required): string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The application module that created the account record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrentFiscalYearPotentialRevenueAmount: number
Title:
Current Fiscal Year's Potential Revenue
The estimated revenues that can be earned by the organization during its current fiscal year. -
CustomerClassification: array
Aux Classifications
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private. -
DataCloudStatus: string
Title:
Enrichment Status
Maximum Length:30
The enrichment status of the contact record from Data-as-a-Service. A list of valid values are defined in the lookup DATA_CLOUD_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
DatafoxCompanyId: string
Title:
DataFox Company ID
Maximum Length:30
Datafox Company Identifier. -
Description: string
Title:
Description
Maximum Length:2000
Short description for the company. -
DisadvantageIndicator: string
Title:
Disadvantaged Indicator
Maximum Length:30
Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No. -
DomesticUltimateDatafoxId: string
Title:
Domestic Ultimate DataFox Id
Maximum Length:30
The DataFox Company identifier of the Domestic Ultimate for the account, which is the highest family member in the same country as this business entity. A subject may be its own Domestic Ultimate. -
DomesticUltimateDUNSNumber: string
Title:
Domestic Ultimate D-U-N-S Number
Maximum Length:30
The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate. -
DoNotConfuseWith: string
Title:
Don't Confuse With
Maximum Length:255
Indicates that there is an organization that is similarly named. -
DUNSCreditRating: string
Title:
D&B Credit Rating
Maximum Length:5
The Dun & Bradstreet credit rating. -
DUNSNumber: string
Title:
D-U-N-S Number
Maximum Length:30
The DUNS Number in freeform text format. The value not restricted to nine digit number. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the contact point for the organization. -
EmailFormat: string
Title:
Email Format
Maximum Length:30
The preferred format for e-mail addressed to this organization, such as HTML or ASCII. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
The date when email address of the account was last verified. -
EmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The status code of the verification of email address for the account. The values based on the lookup are valid, invalid, or partially invalid for email. -
EmployeesAtPrimaryAddress: string
Title:
Employees at Primary Address
Maximum Length:10
The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EmployeesAtPrimaryAddressEstimation: string
Title:
Number of Employees at Identifying Address Estimated Qualifier
Maximum Length:30
The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EmployeesAtPrimaryAddressMinimum: string
Title:
Number of Employees at Identifying Address Minimum Qualifier
Maximum Length:30
The qualifier to qualify calculation of employees at the primary address as minimum. -
EmployeesAtPrimaryAddressText: string
Title:
Employees at Identifying Address
Maximum Length:12
The number of employees at the referenced address in text format. -
EmployeesTotal: number
Title:
Number of Employees
The total number of employees in the organization. -
ExportIndicator: string
Title:
Exporter Indicator
Maximum Length:30
Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N. -
FavoriteAccountFlag: boolean
Title:
Favorite
Maximum Length:10
Default Value:false
Indicates if the account is a favorite. The default value is false. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:20
The area code for the fax number. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
The international country code for a fax number, such as 33 for France. -
FaxExtension: string
Title:
Fax Extension
Maximum Length:20
The extension to the fax number of the organization. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the organization in the local format. The number should not include area code, country code, or extension. -
FaxVerificationDate: string
(date)
Title:
Fax Verification Date
The date when fax number was last verified for the account. -
FaxVerificationStatus: string
Title:
Fax Verification Status
Maximum Length:30
The status code of the verification of fax number for the account. The values based on lookup are valid and invalid for fax. -
FiscalYearendMonth: string
Title:
Fiscal Year End Month
Maximum Length:30
The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
GeneralServicesAdministrationFlag: boolean
Title:
GSA Indicator
Maximum Length:1
Default Value:false
Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N. -
GlobalUltimateDatafoxId: string
Title:
Global Ultimate DataFox Id
Maximum Length:30
The DataFox Company identifier of the Global Ultimate for the account, which is the highest family member globally across countries as this business entity as you walk up this branch of the tree. A case may be its own Global Ultimate. -
GlobalUltimateDUNSNumber: string
Title:
Global Ultimate D-U-N-S Number
Maximum Length:30
The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate. -
GrowthStrategyDescription: string
Title:
Growth Strategy Description
Maximum Length:2000
The user-defined description of growth strategy. -
HomeCountry: string
Title:
Home Country
Maximum Length:2
The home country of the organization. -
HQBranchIndicator: string
Title:
HQ Branch Indicator
Maximum Length:30
The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND. -
ImportIndicator: string
Title:
Importer Indicator
Maximum Length:30
Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N. -
IndustryCode: string
Title:
Industry Code
The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task. -
Keywords: string
Title:
Keywords
Maximum Length:2000
List of the top keywords of the company. -
LaborSurplusIndicator: string
Title:
Labor Surplus Indicator
Maximum Length:30
Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N. -
LastEnrichmentDate: string
(date)
Title:
Last Enrichment Date
The date when the record was last enriched. -
LegalStatus: string
Title:
Legal Status
Maximum Length:30
The legal structure of the organization such as partnership, corporation, and so on. -
LineOfBusiness: string
Title:
Line of Business
Maximum Length:240
The type of business activities performed at this site. -
LocalActivityCode: string
Title:
Local Activity Code
Maximum Length:30
The local activity classification code. -
LocalActivityCodeType: string
Title:
Local Activity Code Type
Maximum Length:30
The type of the local activity classification code. -
LocalBusinessIdentifier: string
Title:
Common Business Identifier
Maximum Length:60
The unique identifier assigned to a businesses by a government agency such as Chamber of Commerce, or any other authority. It is often used by countries other than USA. -
LocalBusinessIdentifierType: string
Title:
Common Business Identifier Type
Maximum Length:30
The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values are defined in the lookup type LOCAL_BUS_IDEN_TYPE. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
MinorityOwnedIndicator: string
Title:
Minority-Owned Indicator
Maximum Length:30
Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. company is primarily owned by ethnic or racial minorities. The default value is N. -
MinorityOwnedType: string
Title:
Type of Minority-Owned Organization
Maximum Length:30
The type of minority-owned firm. -
MissionStatement: string
Title:
Mission Statement
Maximum Length:2000
The corporate charter of organization in user-defined text format. -
NamedFlag: boolean
Title:
Named Account
Maximum Length:1
Default Value:false
Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False. -
NextFiscalYearPotentialRevenueAmount: number
Title:
Next Fiscal Year's Potential Revenue
The estimated revenue of the organization to be earned during its next fiscal year. -
Note: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account. -
OrganizationName(required): string
Title:
Organization Name
Maximum Length:360
The name of the account. -
OrganizationSize: string
Title:
Organization Size
Maximum Length:30
The size of the organization based on its revenue, number of employees, and so on. -
OrganizationType: string
Title:
Organization Type
Maximum Length:30
The type of the organization. -
OrganizationTypeCode: string
Title:
Organization Type Code
The organization type code. -
OutOfBusinessIndicator: string
Title:
Out of Business Indicator
Maximum Length:30
Indicates whether the organization is out of business. If the value is Y, then the organization is out of business. The default value is N. -
OwnerPartyId: integer
(int64)
Title:
Owner ID
The unique identifier of a valid employee resource who owns and manages the sales account. -
ParentAccountPartyId: integer
Title:
Parent Account ID
The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference. -
ParentAccountPartyNumber: string
Title:
Parent Account Registry ID
The party number of the parent account within the hierarchy. -
ParentAccountSourceSystem: string
Title:
Parent Source System
The source system of the parent account within the hierarchy. -
ParentAccountSourceSystemReferenceValue: string
Title:
Parent Account Source System Reference
The source system reference of the parent account within the hierarchy. -
ParentDUNSNumber: string
Title:
Parent D-U-N-S Number
Maximum Length:30
The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company. A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent. -
ParentOrSubsidiaryIndicator: string
Title:
Subsidiary Indicator
Maximum Length:30
Indicates whether the organization is a parent or subsidiary. -
PartyNumber(required): string
Title:
Party Number
Maximum Length:30
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. -
PartyNumberKey(required): string
Title:
Registry ID
Maximum Length:30
The alternate identifier of the party. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:20
The area code for the telephone number. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
The extension to the phone number of the organization. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The phone number of the organization in the local format. The number should not include area code, country code, or extension. -
PhoneVerificationDate: string
(date)
Title:
Phone Verification Date
The date when phone number of account was last verified. -
PhoneVerificationStatus: string
Title:
Phone Verification Status
Maximum Length:30
The status code of the phone number verification for the account. The values based on lookup are valid and invalid for phone. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred contact method of the organization. The accepted values are defined in the lookup type HZ_PREFERRED_CONTACT_METHOD. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup. -
PrimaryAddress: array
Primary Addresses
Title:
Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
The unique identifier of the primary contact of the account. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
The party number of the primary contact of the account. -
PrimaryContactSourceSystem: string
Title:
Primary Contact Source System
The name of external source system where the primary contact of the account is imported from. -
PrimaryContactSourceSystemReferenceValue: string
Title:
Primary Contact Source System Reference
The unique identifier for the account's primary contact as specified in the external source system. -
PrincipalName: string
Title:
Principal Name
Maximum Length:240
The name of the highest ranking person in the organization. -
PrincipalTitle: string
Title:
Principal Title
Maximum Length:240
The title of the highest ranking person in the organization. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
PublicPrivateOwnershipFlag: boolean
Title:
Private Ownership
Maximum Length:1
Default Value:false
Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N. -
RawFaxNumber: string
Title:
Raw Fax Number
Maximum Length:60
The unformatted fax number of the organization. -
RawPhoneNumber: string
Title:
Raw Phone Number
Maximum Length:60
The unformatted phone number of the organization. -
RegistrationType: string
Title:
Registration Type
Maximum Length:30
Indicates the type of registration, such as nonprofit. The accepted values are defined in the lookup type REGISTRATION_TYPE. -
Relationship: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SalesProfileNumber: string
Title:
Sales Account Number
Maximum Length:30
The sales profile number. -
SalesProfileStatus: string
Title:
Status
Maximum Length:30
A valid user-defined status of the sales account. -
SalesTeamMember: array
Account Resources
Title:
Account Resources
Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account. -
SiebelLocation: string
Title:
Location
Maximum Length:50
Location of account - optional part of User Primary Key. -
SmallBusinessIndicator: string
Title:
Small Business Indicator
Maximum Length:30
Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceSystem: string
Title:
Party Source System
The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System. -
SourceSystemReference: array
Source System References
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data. -
SourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier for the account party from the external source system specified in the attribute SourceSystem. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
StockSymbol: string
Title:
Stock Symbol
Maximum Length:20
The corporate stock symbol of the organization as listed in stock exchanges. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification Number
Maximum Length:20
The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe. -
TotalEmployeesEstimatedIndicator: string
Title:
Number of Employees Estimated Qualifier
Maximum Length:30
Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND. -
TotalEmployeesIndicator: string
Title:
Number of Employees Includes Subsidiaries
Maximum Length:30
Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR. -
TotalEmployeesMinimumIndicator: string
Title:
Number of Employees Minimum Qualifier
Maximum Length:30
Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND. -
TotalEmployeesText: string
Title:
Total Number of Employees
Maximum Length:60
The total number of employees in text format. -
Type: string
Title:
Type
Maximum Length:30
The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. -
UniqueNameSuffix: string
Title:
Name Suffix
Maximum Length:540
The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. -
URL: string
Title:
URL
Maximum Length:2000
The uniform resource locator or a website containing information about the organization. -
WomanOwnedIndicator: string
Title:
Woman-Owned Indicator
Maximum Length:30
Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N. -
YearEstablished: integer
(int32)
Title:
Year Established
The year that the organization started it business operations. -
YearIncorporated: integer
(int32)
Title:
Year Incorporated
The year that the business was formally incorporated.
Nested Schema : Organization Contacts
Type:
array
Title:
Organization Contacts
The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.
Show Source
Nested Schema : Account Extension Bases
Type:
array
Title:
Account Extension Bases
The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.
Show Source
Nested Schema : Account Rollups
Type:
array
Title:
Account Rollups
The account rollups resource is used to view, create, update, and delete an account rollup.
Show Source
Nested Schema : Additional Identifier
Type:
array
Title:
Additional Identifier
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.
Show Source
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.
Show Source
Nested Schema : Account Attachments
Type:
array
Title:
Account Attachments
The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
Show Source
Nested Schema : Aux Classifications
Type:
array
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.
Show Source
Nested Schema : Primary Addresses
Type:
array
Title:
Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.
Show Source
Nested Schema : Account Resources
Type:
array
Title:
Account Resources
Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Show Source
Nested Schema : accounts-AccountContact-item-post-request
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account Party ID
The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
AccountPartyNumber: string
Title:
Account Party Number
Maximum Length:30
The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
AccountSourceSystem: string
Title:
Account Source System
The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
AccountSourceSystemReferenceValue: string
Title:
Account Source System Reference
The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
Comments: string
Title:
Comments
Maximum Length:2000
The comments of the user. -
ContactNumber: string
Title:
Contact Number
Maximum Length:30
The user-defined identification number for this contact. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
ContactPartyNumber: string
Title:
Contact Party Number
Maximum Length:30
The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
ContactSourceSystem: string
Title:
Contact Source System
The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
ContactSourceSystemReferenceValue: string
Title:
Contact Source System Reference
The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
DecisionMakerFlag: boolean
Title:
Decision Maker
Maximum Length:1
Default Value:false
Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker. -
Department: string
Title:
Department
Maximum Length:60
The free form text used to name the department for the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The value of the department code for the contact. -
InfluenceLevelCode: string
Title:
Influence Level
Maximum Length:30
The contact's level of influence in the buying process. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The free form text for job title for the contact associated to an account. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The value of the code for the job title of the contact person. -
PreferredContactFlag: boolean
Title:
Preferred Contact
Maximum Length:10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Title:
Primary Customer
Maximum Length:10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
ReferenceUseFlag: boolean
Title:
Reference
Maximum Length:1
Default Value:false
Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference. -
RelationshipRecId: integer
(int64)
Title:
Relationship Record ID
Finds an account contact with the relationship record identifier. -
RelationshipSourceSystem: string
Title:
Relationship Source System
The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
RelationshipSourceSystemReferenceValue: string
Title:
Relationship Source System Reference
The identifier for the relationship with the external source system. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The contact's affinity for the deploying organization. -
SalesAffinityComments: string
Title:
Affinity Comments
Maximum Length:2000
The comments describing the contact's affinity for the deploying organization. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The contact's role in the buying process. -
Status: string
Maximum Length:
1
Default Value:A
Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.
Nested Schema : schema
Type:
Show Source
object
-
CreatedBy: string
Maximum Length:
64
The user who created the object record. -
CreationDate: string
(date-time)
The date when the record was created.
-
Id: integer
(int64)
The unique identifier of the object record.
-
LastUpdateDate: string
(date-time)
The date when the record was last updated.
-
LastUpdatedBy: string
Maximum Length:
64
The user who last updated the record. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ParentId: integer
(int64)
The identifier for the foreign key to parent.
-
RecordName: string
Title:
Record Name
Maximum Length:80
The name of the object record. -
RecordNumber: string
Title:
Record Number
Maximum Length:64
The unique identifier of the object record. -
RowType: string
Maximum Length:
30
The identifier of the custom extension object row.
Nested Schema : schema
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. Review the list of country codes using the Manage Geographies task. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of party identifier. -
PartyIdentifierValue: string
Title:
Identifier Value
Maximum Length:60
The value of the party identifier. -
PartyNumber: string
The party number.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : accounts-AdditionalName-item-post-request
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
Description: string
Title:
Description
Maximum Length:240
The description of the Additional Name record -
FirstName: string
Title:
First Name
Maximum Length:150
The first name associated with the record. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name associated with the record. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name associated with the record. -
Name: string
Title:
Additional Name
Maximum Length:360
The name of the organization, person, or group party. For example, "Oracle" or "John Smith". -
NameType: string
Title:
Additional Name Type
Maximum Length:30
The type of the name. For example, ALIAS or LEGAL. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartySourceSystem: string
The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
-
PartySourceSystemReferenceValue: string
The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'. -
SourceSystem: string
The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
Indicates if the additional name is currently active. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
Nested Schema : accounts-Address-item-post-request
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLocale: array
Address Locales
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. -
AddressNumber(required): string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressPurpose: array
Address Purposes
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. -
AddressType: string
Title:
Type
The type of address. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the 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. -
Country(required): string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The user who created the module. -
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 currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The date when the address becomes active.
-
EndDateActive: string
(date)
Title:
End Date
The date after which the address becomes inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumber1: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId(required): integer
(int64)
Title:
Party ID
The unique identifier of the account associated with the address. -
PartyNumber: string
Title:
Party Number
The unique alternate identifier for the account associated with the address. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
User-defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
SourceSystem: string
The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
-
StartDateActive: string
(date)
Title:
Start Date
The date when the address becomes active. -
State: string
Title:
State
Maximum Length:60
The state of the address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type:
array
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : accounts-Address-AddressLocale-item-post-request
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : accounts-Address-AddressPurpose-item-post-request
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
-
EndDate: string
(date)
Title:
To Date
The date on which the address purpose is no longer valid. -
PrimaryPerType: string
Title:
Primary
Maximum Length:1
Default Value:N
Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites. -
Purpose: string
Title:
Purpose
Maximum Length:30
The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SiteSourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystem: string
The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
-
SourceSystemReferenceValue: string
The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDate: string
(date)
Title:
From Date
The date from which the address purpose is valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : accounts-Attachment-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
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 code indicating the type of error, 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 date when the contents in the attachment expire. -
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 attached file. -
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
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of contact point. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
The contact preference flag that indicates DNC option.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
Maximum Length:
255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code for the telephone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
-
PreferenceRequestedBy: string
Title:
Preference Requested By
Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Maximum Length:
255
The phone number in raw format. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier for the accounts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL associated with the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : schema
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
A valid classification code corresponding to the classification category. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application module that created the customer classification record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
EndDateActive: string
(date)
Title:
End Date
The date from which the classification code is no longer valid. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact or household to which the classification is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household to which the classification is associated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
Identifier from external source system for the account, contact or household with which the classification is associated. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the customer classification is the primary classification. The default value is false. -
SourceSystem: string
Title:
Source System
The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the customer classification in the external source. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the customer classification was created. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.
Nested Schema : accounts-Note-item-post-request
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
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
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
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
This is the column which will store the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The source_object_code of the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
This is the attribute to specify the visibility level of the note.
Nested Schema : accounts-PrimaryAddress-item-post-request
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line of the primary address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line of the primary address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line of the primary address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the primary address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the primary address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the primary address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the 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. -
Country: string
Title:
Country
Maximum Length:2
The country code of the primary address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CurcyConvRateType: string
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
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the primary address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the primary address. -
HouseType: string
Title:
House Type
Maximum Length:30
Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
The unique identifier for the location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
LocationSourceSystem: string
The name of source system for the location record.
-
LocationSourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
LocationStatusFlag: boolean
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumberPartySite: integer
(int32)
The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OverallPrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address. -
PartyId: integer
(int64)
The unique identifier of the account associated with the address.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of the party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state of the address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : schema
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
ObjectPartyId: integer
(int64)
The unique identifier of the object party in this relationship.
-
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The alternate key identifier for the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of the external source system for the object party in the relationship. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The identifier for the object party in the relationship from the external source system. -
ObjectTableName: string
Maximum Length:
30
The source table name of the object party in this relationship. -
ObjectType: string
Maximum Length:
30
The object type of the contact. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RelationshipRecId: integer
(int64)
The unique identifier of the relationship record.
-
RelationshipSourceSystem: string
The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RequestId: integer
(int64)
The unique identifier of the request.
-
Role: string
Title:
Role
The role between the subject and object party. -
StartDate: string
(date)
Title:
From Date
The date when the relationship was created. -
SubjectPartyId: integer
(int64)
The unique identifier of the subject party in this relationship.
-
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate key identifier for the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of the external source system for the subject party in the relationship. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The identifier for the subject party in the relationship from the external source system. -
SubjectTableName: string
Maximum Length:
30
The source table of the subject. -
SubjectType: string
Maximum Length:
30
The subject type of the contact. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the contact.
Nested Schema : accounts-SalesTeamMember-item-post-request
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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. -
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 currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
EndDateActive: string
(date)
Title:
Archived Date
The date when the resource is dissociated from the sales account. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the contact is the owner. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The resource identifier. -
ResourcePartyNumber: string
Title:
Resource Party Number
The unique public identifier of the resource record. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales account. -
StartDateActive: string
(date)
Title:
Start Date
The date when the resource is associated with the sales account. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the member of the sales account resource team. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date on which the record was last updated by a specific user.
Nested Schema : accounts-smartActions-item-post-request
Type:
Show Source
object
-
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:1024
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel(required): string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity(required): string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName(required): string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : accounts-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:250
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : accounts-smartActions-UserActionURLBinding-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
EndDate: string
(date)
The date after which the record is inactive.
-
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated account.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated account. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The name of the source system. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated account. -
StartDate: string
(date)
The date when the record was created.
-
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : accounts-item-response
Type:
Show Source
object
-
AccountContact: array
Organization Contacts
Title:
Organization Contacts
The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account. -
AccountExtensionBase: array
Account Extension Bases
Title:
Account Extension Bases
The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type. -
AccountRollup: array
Account Rollups
Title:
Account Rollups
The account rollups resource is used to view, create, update, and delete an account rollup. -
AccountScore: integer
Title:
Account Score
Score assigned based on custom criteria by the user. -
AccountScoringTier: string
Title:
Account Scoring Tier
Maximum Length:30
Tier assigned based on custom criteria by the user. -
AdditionalIdentifier: array
Additional Identifier
Title:
Additional Identifier
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. -
AdditionalName: array
Additional Names
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name. -
Address: array
Addresses
Title:
Addresses
The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: 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 for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for 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:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressType: string
Title:
Address Type
Additional information as type of address like BillTo, ShipTo. -
AnalysisFiscalYear: string
Title:
Analysis Year
Maximum Length:5
The fiscal year used as the source for financial information. -
AssignmentExceptionFlag: boolean
Title:
Assignment Exception Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the sales account had the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the dimensions. The default value is False. -
Attachment: array
Account Attachments
Title:
Account Attachments
The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
BusinessReport: string
(byte)
Title:
D&B Business Report
The Dun & Bradstreet business information report. -
BusinessScope: string
Title:
Business Scope
Maximum Length:20
The class of business to which the account belongs, such as local, national, or international. -
CEOName: string
Title:
Chief Executive Name
Maximum Length:240
The name of the organization???s chief executive officer. -
CEOTitle: string
Title:
Chief Executive Title
Maximum Length:240
The formal title of the chief executive officer. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The code indicating the reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of the account. -
Comments: string
Title:
Comments
Maximum Length:2000
The corporate charter of the organization. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CongressionalDistrictCode: string
Title:
Congressional District
Maximum Length:2
The U.S. Congressional district code for the account. -
ContactPoint: array
Contact Points
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on. -
ControlYear: number
Title:
Organization Control Year
The year when current ownership gained control of the organization. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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:60
The taxation classification for corporation entities such as Chapter S in the US. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the account record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The application module that created the account record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
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 currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrentFiscalYearPotentialRevenueAmount: number
Title:
Current Fiscal Year's Potential Revenue
The estimated revenues that can be earned by the organization during its current fiscal year. -
CustomerClassification: array
Aux Classifications
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private. -
DataCloudStatus: string
Title:
Enrichment Status
Maximum Length:30
The enrichment status of the contact record from Data-as-a-Service. A list of valid values are defined in the lookup DATA_CLOUD_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
DatafoxCompanyId: string
Title:
DataFox Company ID
Maximum Length:30
Datafox Company Identifier. -
DeleteFlag: boolean
Title:
Delete Account
Read Only:true
Indicates if the account can be deleted. The default value is false. -
Description: string
Title:
Description
Maximum Length:2000
Short description for the company. -
DisadvantageIndicator: string
Title:
Disadvantaged Indicator
Maximum Length:30
Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No. -
DomesticUltimateDatafoxId: string
Title:
Domestic Ultimate DataFox Id
Maximum Length:30
The DataFox Company identifier of the Domestic Ultimate for the account, which is the highest family member in the same country as this business entity. A subject may be its own Domestic Ultimate. -
DomesticUltimateDUNSNumber: string
Title:
Domestic Ultimate D-U-N-S Number
Maximum Length:30
The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate. -
DomesticUltimateFlag: boolean
Title:
Domestic Ultimate Indicator
Read Only:true
Default Value:false
Indicates whether an account is domestic ultimate parent in the hierarchy. Possible values are Yes and No. -
DoNotConfuseWith: string
Title:
Don't Confuse With
Maximum Length:255
Indicates that there is an organization that is similarly named. -
DUNSCreditRating: string
Title:
D&B Credit Rating
Maximum Length:5
The Dun & Bradstreet credit rating. -
DUNSNumber: string
Title:
D-U-N-S Number
Maximum Length:30
The DUNS Number in freeform text format. The value not restricted to nine digit number. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the contact point for the organization. -
EmailContactPointType: string
Title:
Email Type
Read Only:true
Maximum Length:30
Default Value:EMAIL
The type of the email contact. -
EmailFormat: string
Title:
Email Format
Maximum Length:30
The preferred format for e-mail addressed to this organization, such as HTML or ASCII. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
The date when email address of the account was last verified. -
EmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The status code of the verification of email address for the account. The values based on the lookup are valid, invalid, or partially invalid for email. -
EmployeesAtPrimaryAddress: string
Title:
Employees at Primary Address
Maximum Length:10
The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EmployeesAtPrimaryAddressEstimation: string
Title:
Number of Employees at Identifying Address Estimated Qualifier
Maximum Length:30
The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EmployeesAtPrimaryAddressMinimum: string
Title:
Number of Employees at Identifying Address Minimum Qualifier
Maximum Length:30
The qualifier to qualify calculation of employees at the primary address as minimum. -
EmployeesAtPrimaryAddressText: string
Title:
Employees at Identifying Address
Maximum Length:12
The number of employees at the referenced address in text format. -
EmployeesTotal: number
Title:
Number of Employees
The total number of employees in the organization. -
ExistingCustomerFlag: boolean
Title:
Existing Sales Account
Read Only:true
Maximum Length:1
Default Value:false
Indicates if there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False. -
ExistingCustomerFlagLastUpdateDate: string
(date)
Title:
Existing Indicator Last Update Date
Read Only:true
The date when the existing customer flag was last updated. -
ExportIndicator: string
Title:
Exporter Indicator
Maximum Length:30
Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N. -
FavoriteAccountFlag: boolean
Title:
Favorite
Maximum Length:10
Default Value:false
Indicates if the account is a favorite. The default value is false. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:20
The area code for the fax number. -
FaxContactPointType: string
Title:
Fax Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type of contact point for fax. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
The international country code for a fax number, such as 33 for France. -
FaxExtension: string
Title:
Fax Extension
Maximum Length:20
The extension to the fax number of the organization. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the organization in the local format. The number should not include area code, country code, or extension. -
FaxVerificationDate: string
(date)
Title:
Fax Verification Date
The date when fax number was last verified for the account. -
FaxVerificationStatus: string
Title:
Fax Verification Status
Maximum Length:30
The status code of the verification of fax number for the account. The values based on lookup are valid and invalid for fax. -
FiscalYearendMonth: string
Title:
Fiscal Year End Month
Maximum Length:30
The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the primary address. -
FormattedFaxNumber: string
Title:
Formatted Fax Number
Read Only:true
The formatted phone number of the organization. -
FormattedPhoneNumber: string
Title:
Phone Number
Read Only:true
The formatted phone number of the organization. -
GeneralServicesAdministrationFlag: boolean
Title:
GSA Indicator
Maximum Length:1
Default Value:false
Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N. -
GlobalUltimateDatafoxId: string
Title:
Global Ultimate DataFox Id
Maximum Length:30
The DataFox Company identifier of the Global Ultimate for the account, which is the highest family member globally across countries as this business entity as you walk up this branch of the tree. A case may be its own Global Ultimate. -
GlobalUltimateDUNSNumber: string
Title:
Global Ultimate D-U-N-S Number
Maximum Length:30
The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate. -
GlobalUltimateFlag: boolean
Title:
Global Ultimate Indicator
Read Only:true
Default Value:false
Indicates whether an account is global ultimate parent node in the hierarchy. Possible values are Yes and No. -
GrowthStrategyDescription: string
Title:
Growth Strategy Description
Maximum Length:2000
The user-defined description of growth strategy. -
HomeCountry: string
Title:
Home Country
Maximum Length:2
The home country of the organization. -
HQBranchIndicator: string
Title:
HQ Branch Indicator
Maximum Length:30
The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND. -
ImportIndicator: string
Title:
Importer Indicator
Maximum Length:30
Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N. -
IndustryCode: string
Title:
Industry Code
The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task. -
IndustryCodeType: string
Title:
Industry Category
Read Only:true
The industry classification category code type. It is defaulted to the value of profile option MOT_INDUSTRY_CLASS_CATEGORY. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task. -
Keywords: string
Title:
Keywords
Maximum Length:2000
List of the top keywords of the company. -
LaborSurplusIndicator: string
Title:
Labor Surplus Indicator
Maximum Length:30
Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N. -
LastAssignmentDateTime: string
(date-time)
Title:
Last Assignment Date Time
Read Only:true
The date when the sales account territory assignment was last run by assignment manager. -
LastEnrichmentDate: string
(date)
Title:
Last Enrichment Date
The date when the record was last enriched. -
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. -
LegalStatus: string
Title:
Legal Status
Maximum Length:30
The legal structure of the organization such as partnership, corporation, and so on. -
LineOfBusiness: string
Title:
Line of Business
Maximum Length:240
The type of business activities performed at this site. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocalActivityCode: string
Title:
Local Activity Code
Maximum Length:30
The local activity classification code. -
LocalActivityCodeType: string
Title:
Local Activity Code Type
Maximum Length:30
The type of the local activity classification code. -
LocalBusinessIdentifier: string
Title:
Common Business Identifier
Maximum Length:60
The unique identifier assigned to a businesses by a government agency such as Chamber of Commerce, or any other authority. It is often used by countries other than USA. -
LocalBusinessIdentifierType: string
Title:
Common Business Identifier Type
Maximum Length:30
The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values are defined in the lookup type LOCAL_BUS_IDEN_TYPE. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
MinorityOwnedIndicator: string
Title:
Minority-Owned Indicator
Maximum Length:30
Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. company is primarily owned by ethnic or racial minorities. The default value is N. -
MinorityOwnedType: string
Title:
Type of Minority-Owned Organization
Maximum Length:30
The type of minority-owned firm. -
MissionStatement: string
Title:
Mission Statement
Maximum Length:2000
The corporate charter of organization in user-defined text format. -
NamedFlag: boolean
Title:
Named Account
Maximum Length:1
Default Value:false
Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False. -
NextFiscalYearPotentialRevenueAmount: number
Title:
Next Fiscal Year's Potential Revenue
The estimated revenue of the organization to be earned during its next fiscal year. -
Note: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the account. -
OrganizationProfileId: integer
(int64)
Title:
Organization ID
Read Only:true
The unique identifier of the organization profile. -
OrganizationSize: string
Title:
Organization Size
Maximum Length:30
The size of the organization based on its revenue, number of employees, and so on. -
OrganizationType: string
Title:
Organization Type
Maximum Length:30
The type of the organization. -
OrganizationTypeCode: string
Title:
Organization Type Code
The organization type code. -
OutOfBusinessIndicator: string
Title:
Out of Business Indicator
Maximum Length:30
Indicates whether the organization is out of business. If the value is Y, then the organization is out of business. The default value is N. -
OwnerEmailAddress: string
Title:
Owner Email
Read Only:true
Maximum Length:320
The e-mail address of the employee resource that owns and manages the sales account. The owner is a valid employee resource defined within Engagement Cloud. -
OwnerName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the employee resource that owns and manages the sales account. -
OwnerPartyId: integer
(int64)
Title:
Owner ID
The unique identifier of a valid employee resource who owns and manages the sales account. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
The party number of a valid employee resource who owns and manages the sales account. -
ParentAccountList: string
Title:
Parent Account List
Read Only:true
Maximum Length:255
List of all the parent accounts till the top node in the account hierarchy. -
ParentAccountName: string
Title:
Parent Account
Read Only:true
The name of the parent account in the hierarchy. -
ParentAccountPartyId: integer
Title:
Parent Account ID
The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference. -
ParentAccountPartyNumber: string
Title:
Parent Account Registry ID
The party number of the parent account within the hierarchy. -
ParentAccountSourceSystem: string
Title:
Parent Source System
The source system of the parent account within the hierarchy. -
ParentAccountSourceSystemReferenceValue: string
Title:
Parent Account Source System Reference
The source system reference of the parent account within the hierarchy. -
ParentDUNSNumber: string
Title:
Parent D-U-N-S Number
Maximum Length:30
The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company. A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent. -
ParentOrSubsidiaryIndicator: string
Title:
Subsidiary Indicator
Maximum Length:30
Indicates whether the organization is a parent or subsidiary. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the account. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. -
PartyNumberKey: string
Title:
Registry ID
Maximum Length:30
The alternate identifier of the party. -
PartyStatus: string
Read Only:
true
Maximum Length:1
Default Value:A
Indicates the status of the account. This is an internally-used column and the values are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
Default Value:ORGANIZATION
The type of the party. -
PartyUniqueName: string
Title:
Unique Party Name
Read Only:true
Maximum Length:900
The unique account name displayed on account related screens. The default value is the concatenation of attributes AccountName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the AccountName is concatenated with a system generated number. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:20
The area code for the telephone number. -
PhoneContactPointType: string
Title:
Phone Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type of contact point. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
The extension to the phone number of the organization. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The phone number of the organization in the local format. The number should not include area code, country code, or extension. -
PhoneVerificationDate: string
(date)
Title:
Phone Verification Date
The date when phone number of account was last verified. -
PhoneVerificationStatus: string
Title:
Phone Verification Status
Maximum Length:30
The status code of the phone number verification for the account. The values based on lookup are valid and invalid for phone. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred contact method of the organization. The accepted values are defined in the lookup type HZ_PREFERRED_CONTACT_METHOD. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup. -
PrimaryAddress: array
Primary Addresses
Title:
Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account. -
PrimaryAddressId: integer
(int64)
Read Only:
true
The unique identifier of the primary address. -
PrimaryContactDoCallFlag: boolean
Title:
OK to Call Primary Contact
Read Only:true
Maximum Length:10
Default Value:false
Indicates whether the user can call the primary contact of an account. The accepted values are True and False or Y and N. Default is False or N. -
PrimaryContactDoEmailFlag: boolean
Title:
OK to Email Primary Contact
Read Only:true
Maximum Length:10
Default Value:false
Indicates whether the user can email the primary contact of an account. The accepted values are True and False or Y and N. Default is False or N. -
PrimaryContactEmail: string
Title:
Contact Email
Read Only:true
The e-mail address of the account's primary contact. -
PrimaryContactEmailDNC: boolean
Title:
Do Not Email Primary Contact
Read Only:true
Maximum Length:255
Default Value:false
Indicates whether the email can be used for the primary contact. The accepted values are True and False or Y and N. Default is False or N. -
PrimaryContactEmailVerificationDate: string
(date)
Title:
Primary Contact Email Verification Date
Read Only:true
The date of verification for the primary contact email. -
PrimaryContactEmailVerificationStatus: string
Title:
Primary Contact Email Verification Status
Read Only:true
Maximum Length:30
The status of the verification for primary contact email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified. -
PrimaryContactJobTitle: string
Title:
Job Title
Read Only:true
The free form text for the job title of the primary contact. -
PrimaryContactName: string
Title:
Primary Contact
Read Only:true
Maximum Length:255
The name of the account's primary contact. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
The unique identifier of the primary contact of the account. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
The party number of the primary contact of the account. -
PrimaryContactPhone: string
Title:
Contact Phone
Read Only:true
The phone number of the account's primary contact. -
PrimaryContactPhoneDNC: boolean
Title:
Do Not Call Primary Contact
Read Only:true
Maximum Length:255
Default Value:false
Indicates whether the user can call the primary contact phone. The accepted values are True and False or Y and N. Default is False or N. -
PrimaryContactPhoneVerificationDate: string
(date)
Title:
Primary Contact Phone Verification Date
Read Only:true
The date of verification of the primary contact phone. -
PrimaryContactPhoneVerificationStatus: string
Title:
Primary Contact Phone Verification Status
Read Only:true
Maximum Length:30
The status of the verification for primary contact phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified. -
PrimaryContactSourceSystem: string
Title:
Primary Contact Source System
The name of external source system where the primary contact of the account is imported from. -
PrimaryContactSourceSystemReferenceValue: string
Title:
Primary Contact Source System Reference
The unique identifier for the account's primary contact as specified in the external source system. -
PrincipalName: string
Title:
Principal Name
Maximum Length:240
The name of the highest ranking person in the organization. -
PrincipalTitle: string
Title:
Principal Title
Maximum Length:240
The title of the highest ranking person in the organization. -
ProfileQualityScore: number
Title:
Profile Quality Score
Read Only:true
The relative score which is used for promotion of a profile record associated to a sales account. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
PublicPrivateOwnershipFlag: boolean
Title:
Private Ownership
Maximum Length:1
Default Value:false
Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N. -
RawFaxNumber: string
Title:
Raw Fax Number
Maximum Length:60
The unformatted fax number of the organization. -
RawPhoneNumber: string
Title:
Raw Phone Number
Maximum Length:60
The unformatted phone number of the organization. -
RecordSet: string
Title:
Record Set
Read Only:true
Maximum Length:30
The record set to display search results. -
RegistrationType: string
Title:
Registration Type
Maximum Length:30
Indicates the type of registration, such as nonprofit. The accepted values are defined in the lookup type REGISTRATION_TYPE. -
Relationship: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SalesProfileNumber: string
Title:
Sales Account Number
Maximum Length:30
The sales profile number. -
SalesProfileStatus: string
Title:
Status
Maximum Length:30
A valid user-defined status of the sales account. -
SalesTeamMember: array
Account Resources
Title:
Account Resources
Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account. -
SiebelLocation: string
Title:
Location
Maximum Length:50
Location of account - optional part of User Primary Key. -
SmallBusinessIndicator: string
Title:
Small Business Indicator
Maximum Length:30
Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceObjectType: string
Read Only:
true
Maximum Length:255
Default Value:SALES_PARTY
The type for the source object. -
SourceSystem: string
Title:
Party Source System
The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System. -
SourceSystemReference: array
Source System References
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data. -
SourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier for the account party from the external source system specified in the attribute SourceSystem. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
StockSymbol: string
Title:
Stock Symbol
Maximum Length:20
The corporate stock symbol of the organization as listed in stock exchanges. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification Number
Maximum Length:20
The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe. -
TotalAccountsInHierarchy: integer
Title:
Total Accounts in Hierarchy
Read Only:true
The total number of accounts in the hierarchy. -
TotalChildAccounts: integer
Title:
Total Child Accounts
Read Only:true
The total number of direct and indirect child accounts in the hierarchy. -
TotalEmployeesEstimatedIndicator: string
Title:
Number of Employees Estimated Qualifier
Maximum Length:30
Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND. -
TotalEmployeesIndicator: string
Title:
Number of Employees Includes Subsidiaries
Maximum Length:30
Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR. -
TotalEmployeesMinimumIndicator: string
Title:
Number of Employees Minimum Qualifier
Maximum Length:30
Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND. -
TotalEmployeesText: string
Title:
Total Number of Employees
Maximum Length:60
The total number of employees in text format. -
TotalImmediateChildAccounts: integer
Title:
Total Immediate Child Accounts
Read Only:true
The number of immediate child nodes in hierarchy for the account. -
Type: string
Title:
Type
Maximum Length:30
The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. -
UltimateIdentifierSource: string
Title:
Ultimate Identifier Source
Read Only:true
Maximum Length:80
The name of the source used to enrich account data that identifies the ultimate identifiers. -
UltimateParentFlag: boolean
Title:
Ultimate Parent Indicator
Read Only:true
Default Value:false
Indicates whether an account is ultimate parent or root node in the hierarchy. Possible values are Yes and No. -
UltimateParentName: string
Title:
Ultimate Parent
Read Only:true
Maximum Length:255
The name of the ultimate parent of the account. -
UltimateParentPartyId: integer
Title:
Ultimate Parent ID
Read Only:true
The unique identifier of the ultimate parent party. -
UltimateParentPartyNumber: string
Title:
Ultimate Parent Registry ID
Read Only:true
Maximum Length:255
The alternate identifier of the ultimate parent. -
UniqueNameSuffix: string
Title:
Name Suffix
Maximum Length:540
The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. -
UpdateFlag: boolean
Title:
Update Account
Read Only:true
Indicates if the record can be updated. The default value is false. -
URL: string
Title:
URL
Maximum Length:2000
The uniform resource locator or a website containing information about the organization. -
WebContactPointType: string
Title:
Web Type
Read Only:true
Maximum Length:30
Default Value:WEB
The type of web contact point. -
WomanOwnedIndicator: string
Title:
Woman-Owned Indicator
Maximum Length:30
Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N. -
YearEstablished: integer
(int32)
Title:
Year Established
The year that the organization started it business operations. -
YearIncorporated: integer
(int32)
Title:
Year Incorporated
The year that the business was formally incorporated.
Nested Schema : Organization Contacts
Type:
array
Title:
Organization Contacts
The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.
Show Source
Nested Schema : Account Extension Bases
Type:
array
Title:
Account Extension Bases
The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.
Show Source
Nested Schema : Account Rollups
Type:
array
Title:
Account Rollups
The account rollups resource is used to view, create, update, and delete an account rollup.
Show Source
Nested Schema : Additional Identifier
Type:
array
Title:
Additional Identifier
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.
Show Source
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.
Show Source
Nested Schema : Account Attachments
Type:
array
Title:
Account Attachments
The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
Show Source
Nested Schema : Aux Classifications
Type:
array
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
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 an account. A note captures comments, information, or instructions related to an account.
Show Source
Nested Schema : Primary Addresses
Type:
array
Title:
Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.
Show Source
Nested Schema : Account Resources
Type:
array
Title:
Account Resources
Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Show Source
Nested Schema : accounts-AccountContact-item-response
Type:
Show Source
object
-
AccountContactId: integer
(int64)
Title:
Account Contact ID
Read Only:true
The unique identifier of the account contact. -
AccountPartyId: integer
(int64)
Title:
Account Party ID
The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
AccountPartyNumber: string
Title:
Account Party Number
Maximum Length:30
The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
AccountSourceSystem: string
Title:
Account Source System
The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
AccountSourceSystemReferenceValue: string
Title:
Account Source System Reference
The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
Comments: string
Title:
Comments
Maximum Length:2000
The comments of the user. -
ContactFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the contact record. -
ContactLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the contact record. -
ContactLastUpdateDate: string
(date-time)
Title:
Contact Last Update Date
Read Only:true
The date when the contact record was last updated. -
ContactName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the contact. -
ContactNumber: string
Title:
Contact Number
Maximum Length:30
The user-defined identification number for this contact. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
ContactPartyNumber: string
Title:
Contact Party Number
Maximum Length:30
The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
ContactSourceSystem: string
Title:
Contact Source System
The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
ContactSourceSystemReferenceValue: string
Title:
Contact Source System Reference
The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DecisionMakerFlag: boolean
Title:
Decision Maker
Maximum Length:1
Default Value:false
Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker. -
Department: string
Title:
Department
Maximum Length:60
The free form text used to name the department for the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The value of the department code for the contact. -
DoCallFlag: boolean
Title:
OK to Call
Read Only:true
Maximum Length:10
Default Value:false
Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N. -
DoEmailFlag: boolean
Title:
OK to Email
Read Only:true
Maximum Length:10
Default Value:false
Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallFlag: boolean
Title:
Do Not Call
Read Only:true
Maximum Length:255
Default Value:false
Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Read Only:true
Maximum Length:255
Default Value:false
Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address of the contact person for the account. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
Read Only:true
The date of the verification for the email. -
EmailVerificationStatus: string
Title:
Email Verification Status
Read Only:true
The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address of the contact. -
FormattedPhoneNumber: string
Title:
Phone Number
Read Only:true
The primary formatted phone number for the contact person. -
InfluenceLevelCode: string
Title:
Influence Level
Maximum Length:30
The contact's level of influence in the buying process. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The free form text for job title for the contact associated to an account. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The value of the code for the job title of the contact person. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time 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 row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonBuyingRole: string
Title:
Buying Role
Read Only:true
Maximum Length:30
Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker. -
PersonJobTitle: string
Title:
Contact Job Title
Read Only:true
Maximum Length:100
The title of the contact's job with deploying organization. -
PersonSalesAffinityCode: string
Title:
Affinity
Read Only:true
Maximum Length:30
The contact's affinity for the deploying organization. -
PhoneVerificationDate: string
(date)
Title:
Phone Verification Date
Read Only:true
The date of the verification for phone. -
PhoneVerificationStatus: string
Title:
Phone Verification Status
Read Only:true
The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified. -
PreferredContactFlag: boolean
Title:
Preferred Contact
Maximum Length:10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
The person's or organization's preferred contact method. -
PrimaryCustomerFlag: boolean
Title:
Primary Customer
Maximum Length:10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
ReferenceUseFlag: boolean
Title:
Reference
Maximum Length:1
Default Value:false
Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference. -
RelationshipId: integer
(int64)
Title:
Relationship Id
Read Only:true
The unique identifier of the relationship associated with account contact record. -
RelationshipRecId: integer
(int64)
Title:
Relationship Record ID
Finds an account contact with the relationship record identifier. -
RelationshipSourceSystem: string
Title:
Relationship Source System
The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
RelationshipSourceSystemReferenceValue: string
Title:
Relationship Source System Reference
The identifier for the relationship with the external source system. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The contact's affinity for the deploying organization. -
SalesAffinityComments: string
Title:
Affinity Comments
Maximum Length:2000
The comments describing the contact's affinity for the deploying organization. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The contact's role in the buying process. -
Status: string
Maximum Length:
1
Default Value:A
Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.
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 : accounts-AccountExtensionBase-item-response
Type:
Show Source
object
-
CreatedBy: string
Maximum Length:
64
The user who created the object record. -
CreationDate: string
(date-time)
The date when the record was created.
-
Id: integer
(int64)
The unique identifier of the object record.
-
LastUpdateDate: string
(date-time)
The date when the record was last updated.
-
LastUpdatedBy: string
Maximum Length:
64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ParentId: integer
(int64)
The identifier for the foreign key to parent.
-
RecordName: string
Title:
Record Name
Maximum Length:80
The name of the object record. -
RecordNumber: string
Title:
Record Number
Maximum Length:64
The unique identifier of the object record. -
RowType: string
Maximum Length:
30
The identifier of the custom extension object row. -
Subtype: string
Read Only:
true
Maximum Length:30
The extension choice list value mapped to the extension child object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-AccountRollup-item-response
Type:
Show Source
object
-
CallsMade: number
Title:
Number of Calls Made
Read Only:true
The total number of calls made to an account -
CorpCurrencyCode: string
Title:
Corporate Currency
Read Only:true
Maximum Length:15
The corporate currency code associated with the account rollup such as USD or INR. -
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. -
EmailsSent: number
Title:
Number of Emails Sent
Read Only:true
The total number of emails sent to an account. -
HierCallsMade: number
Title:
Hierarchy Number of Calls Made
Read Only:true
The total number of calls made to an account and the account's hierarchy. -
HierCurrentFiscalYearPotentialRevenueAmount: number
Title:
Hierarchy Current Fiscal Year's Potential Revenue
Read Only:true
The cumulative total of all of the current fiscal year's potential revenue within an account hierarchy. -
HierEmailsSent: number
Title:
Hierarchy Number of Emails Sent
Read Only:true
The total number of emails sent to an account and the account's hierarchy. -
HierEmployeesTotal: number
Title:
Hierarchy Total Number of Employees
Read Only:true
The count of employees, based on the account number of the employees for each account hierarchy. -
HierLastCallMadeDate: string
(date-time)
Title:
Hierarchy Last Call Made
Read Only:true
The date when last call was made to an account and the account's hierarchy. -
HierLastCompletedActivity: string
(date-time)
Title:
Hierarchy Last Completed Activity
Read Only:true
The date when the activity was last completed with an account and its hierarchy. Activity includes task, appointment, and call report. -
HierLastEmailSentDate: string
(date-time)
Title:
Hierarchy Last Email Sent
Read Only:true
The date when last email was sent to an account and the account's hierarchy. -
HierLastTouchDate: string
(date-time)
Title:
Hierarchy Last Touch
Read Only:true
The date when the last touch was made with an account and the account's hierarchy. -
HierNextTaskDue: string
(date)
Title:
Hierarchy Next Task Due
Read Only:true
The due date of the task with an account and its hierarchy. -
HierNumberOfOpenActivities: number
Title:
Hierarchy Number of Open Activities
Read Only:true
The count of activities that are open within an account hierarchy. -
HierNumberOfOpenCriticalServiceRequests: number
Title:
Hierarchy Number of Open Critical Service Requests
Read Only:true
The number of open service requests within an account hierarchy, where the severity is one. -
HierNumberOfOpenHotLeads: number
Title:
Hierarchy Number of Open Hot Leads
Read Only:true
The hierarchy count of leads that are open with Hot rank. -
HierNumberOfOpenLeads: number
Title:
Hierarchy Number of Open Leads
Read Only:true
The count of leads that are in Open status within an account hierarchy. -
HierNumberOfOpenOpportunities: number
Title:
Hierarchy Number of Open Opportunities
Read Only:true
The count of opportunities that are open within an account hierarchy. -
HierNumberOfOpenServiceRequests: number
Title:
Hierarchy Number of Open Service Requests
Read Only:true
The number of open Service Requests for the account hierarchy. -
HierNumberOfTouches: number
Title:
Hierarchy Number of Touches
Read Only:true
The total number of touches with an account and the account's hierarchy. A touch refers to an outbound communication such as email, phone and so on. -
HierSumOfActiveSubscriptionsMRR: number
Title:
Hierarchy Active Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from active subscription lines on an account and its hierarchy. -
HierSumOfActiveSubscriptionsTCV: number
Title:
Hierarchy Active Subscriptions TCV Amount
Read Only:true
The cumulative total contract value amounts from active subscription lines on an account and its hierarchy. -
HierSumOfClosedSubscriptionsMRR: number
Title:
Hierarchy Closed Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from subscription lines on an account and its hierarchy that were closed in a given period of time. -
HierSumOfLapsedRenewalsMRR: number
Title:
Hierarchy Lapsed Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expired subscription lines on an account and its hierarchy that don't have renewal lines. -
HierSumOfOpenLeadAmount: number
Title:
Hierarchy Total Potential Revenue from Open Leads
Read Only:true
The sum of the potential revenues from qualified and unqualified open leads of an account and the account's hierarchy. -
HierSumOfOpenOpportunitiesRevenue: number
Title:
Hierarchy Open Opportunity Revenue
Read Only:true
The cumulative total of open opportunity potential revenue amount within the account hierarchy. -
HierSumOfOpenOrderAmount: number
Title:
Hierarchy Open Order Amount
Read Only:true
The cumulative total of quote and order amount within the account hierarchy, where status is Open or Processing. -
HierSumOfUpcomingRenewalsMRR: number
Title:
Hierarchy Upcoming Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expiring subscription lines on an account and its hierarchy that haven't been amended, closed, suspended, or renewed. -
HierSumOfWonOpportunitiesRevenue: number
Title:
Hierarchy Won Opportunity Revenue
Read Only:true
The cumulative total of potential revenue amount from Won opportunities, within the account hierarchy. -
HierSumOfWonOrderAmount: number
Title:
Hierarchy Won Order Amount
Read Only:true
The total of orders within an Account Hierarchy, where the status is Closed. -
HierTotalCompletedActivities: number
Title:
Hierarchy Total Completed Activities
Read Only:true
The total number of completed activities with an account and its hierarchy. -
LastCallMadeDate: string
(date-time)
Title:
Last Call Made On
Read Only:true
The date when last call was made to an account. -
LastCompletedActivity: string
(date-time)
Title:
Last Completed Activity
Read Only:true
The date when the activity was last completed with an account. Activity includes task, appointment, and call report. -
LastEmailSentDate: string
(date-time)
Title:
Last Email Sent
Read Only:true
The date when last email was sent to an account. -
LastTouchDate: string
(date-time)
Title:
Last Touch
Read Only:true
The date when last email was sent to an account. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextTaskDue: string
(date)
Title:
Next Task Due
Read Only:true
The due date of the task with an account. -
NumberOfOpenActivities: number
Title:
Number of Open Activities
Read Only:true
The count of activities that are open within an account. -
NumberOfOpenCriticalServiceRequests: number
Title:
Number of Open Critical Service Requests
Read Only:true
The number of open Service Requests for the account that are Severity equal to one. -
NumberOfOpenHotLeads: number
Title:
Number of Open Hot Leads
Read Only:true
The count of leads that are open with Hot rank. -
NumberOfOpenLeads: number
Title:
Number of Open Leads
Read Only:true
The count of Leads that are Open on the Account. -
NumberOfOpenOpportunities: number
Title:
Number of Open Opportunities
Read Only:true
The count on open opportunities within an Account. -
NumberOfOpenServiceRequests: number
Title:
Number of Open Service Requests
Read Only:true
The number of open Service Requests for the account. -
NumberOfTouches: number
Title:
Number of Touches
Read Only:true
The total number of touches with an account. A touch refers to an outbound communication such as email, phone and so on. -
OrganizationProfileId: integer
(int64)
Title:
Organization Profile Identifier
Read Only:true
The unique identifier of the organization profile. -
SumOfActiveSubscriptionsMRR: number
Title:
Active Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from active subscription lines on an account. -
SumOfActiveSubscriptionsTCV: number
Title:
Active Subscriptions TCV Amount
Read Only:true
The cumulative total contract value amounts from active subscription lines on an account. -
SumOfClosedSubscriptionsMRR: number
Title:
Closed Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from subscription lines on an account that were closed in a given period of time. -
SumOfLapsedRenewalsMRR: number
Title:
Lapsed Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expired subscription lines on an account that don't have renewal lines. -
SumOfOpenLeadAmount: number
Title:
Total Potential Revenue from Open Leads
Read Only:true
The sum of the potential revenues from qualified and unqualified open leads of an account. -
SumOfOpenOpportunitiesRevenue: number
Title:
Open Opportunity Revenue
Read Only:true
The cumulative total of open opportunity potential revenue amount for the account. -
SumOfOpenOrderAmount: number
Title:
Open Order Amount
Read Only:true
The cumulative total of quote and order amount for the account where status is Open or Processing. -
SumOfUpcomingRenewalsMRR: number
Title:
Upcoming Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expiring subscription lines on an account that haven't been amended, closed, suspended, or renewed. -
SumOfWonOpportunitiesRevenue: number
Title:
Won Opportunity Revenue
Read Only:true
The cumulative total of won opportunity potential revenue amount for the account. -
SumOfWonOrderAmount: number
Title:
Won Order Amount
Read Only:true
The cumulative total of order amount for the orders where status is Closed. -
TotalCompletedActivities: number
Title:
Total Completed Activities
Read Only:true
The total number of completed activities with an account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-AdditionalIdentifier-item-response
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. Review the list of country codes using the Manage Geographies task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the additional identifier. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Read Only:
true
The date when the additional identifier was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the additional identifier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the additional identifier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the additional identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of party identifier. -
PartyIdentifierValue: string
Title:
Identifier Value
Maximum Length:60
The value of the party identifier. -
PartyNumber: string
The party number.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-AdditionalName-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the contact record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the contact record was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the Additional Name record -
FirstName: string
Title:
First Name
Maximum Length:150
The first name associated with the record. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name associated with the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the contact was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name associated with the record. -
Name: string
Title:
Additional Name
Maximum Length:360
The name of the organization, person, or group party. For example, "Oracle" or "John Smith". -
NameId: integer
(int64)
Read Only:
true
The unique identifier of the name. -
NameType: string
Title:
Additional Name Type
Maximum Length:30
The type of the name. For example, ALIAS or LEGAL. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate identifier of the party. -
PartySourceSystem: string
The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
-
PartySourceSystemReferenceValue: string
The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'. -
SourceSystem: string
The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
Indicates if the additional name is currently active. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Address-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLocale: array
Address Locales
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressPurpose: array
Address Purposes
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. -
AddressType: string
Title:
Type
The type of address. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the 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. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the account record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The user who created the module. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
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 currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The date when the address becomes active.
-
EndDateActive: string
(date)
Title:
End Date
The date after which the address becomes inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the address. -
FormattedAddress1: string
Title:
Formatted Address 1
Read Only:true
The formatted address of the contact address record. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiline version of the address. -
FormattedMultilineAddress1: string
Title:
Address
Read Only:true
The formatted address in multiline of the contact address record. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
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. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumber1: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the account associated with the address. -
PartyNumber: string
Title:
Party Number
The unique alternate identifier for the account associated with the address. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
User-defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
SourceSystem: string
The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
-
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
The name of the table that holds the record data and is referenced to manage source system reference. -
SSRPartyOwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the party record data and is referenced to manage source system reference. -
StartDateActive: string
(date)
Title:
Start Date
The date when the address becomes active. -
State: string
Title:
State
Maximum Length:60
The state of the address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N. -
ValidationStartDate: string
(date)
Read Only:
true
The date when the validation becomes active. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type:
array
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Address-AddressLocale-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The specific name of the country in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address locale record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address locale record was created. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
FormattedAddress: string
Read Only:
true
The formatted read only version of the locale address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address locale was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address locale record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address locale record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
LocationLocaleId: integer
(int64)
Read Only:
true
The unique identifier of the location locale record. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Address-AddressPurpose-item-response
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
-
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update. -
AddressPurposeId: integer
(int64)
Read Only:
true
The unique identifier of the address purpose. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address purpose record. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address purpose record was created. -
DeleteFlag: boolean
Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
-
EndDate: string
(date)
Title:
To Date
The date on which the address purpose is no longer valid. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address purpose was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address purpose record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address purpose record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryPerType: string
Title:
Primary
Maximum Length:1
Default Value:N
Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites. -
Purpose: string
Title:
Purpose
Maximum Length:30
The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SiteSourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystem: string
The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
-
SourceSystemReferenceValue: string
The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDate: string
(date)
Title:
From Date
The date from which the address purpose is valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of 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 name of the person who uploaded the attachment. -
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
The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
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 code indicating the type of error, 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 date when the contents in the attachment expire. -
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 attached file. -
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 name of the person who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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
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 : accounts-ContactPoint-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
ContactPointId: integer
(int64)
Read Only:
true
The unique identifier of the contact point. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of contact point. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
The contact preference flag that indicates DNC option.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
Maximum Length:
255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email. -
FormattedPhoneNumber: string
Read Only:
true
Maximum Length:255
The formatted phone number of the contact point. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the contact point was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact point. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code for the telephone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
-
PreferenceRequestedBy: string
Title:
Preference Requested By
Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Maximum Length:
255
The phone number in raw format. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier for the accounts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL associated with the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
A valid classification code corresponding to the classification category. -
CodeAssignmentId: integer
(int64)
Title:
Code Assignment ID
Read Only:true
The unique identifier for the customer classification assignment. -
ConflictId: integer
(int64)
Read Only:
true
Default Value:0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application module that created the customer classification record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDateActive: string
(date)
Title:
End Date
The date from which the classification code is no longer valid. -
IsAuxClassificationFlag: boolean
Title:
Auxiliary Classification Status
Read Only:true
Indicates whether the classification category is an user-defined group classification category. The default value is false. -
IsIndustryFlag: boolean
Title:
Industry Type Status
Read Only:true
Indicates whether the classification category is an industry group classification category. The default value is false. -
IsOrgTypeFlag: boolean
Title:
Organization Type Status
Read Only:true
Indicates whether the classification category is an organization type classification category. The default value is false. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact or household to which the classification is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household to which the classification is associated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
Identifier from external source system for the account, contact or household with which the classification is associated. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
The type of the party, such as account, contact, or household. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the customer classification is the primary classification. The default value is false. -
SourceSystem: string
Title:
Source System
The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the customer classification in the external source. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the customer classification was created. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
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
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N. -
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 and time when the note 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. -
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. -
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
This is the column which will store the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique Identifier of the account to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account record with which the address is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of a account party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The source_object_code of the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
This is the attribute to specify the visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-PrimaryAddress-item-response
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the primary address. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line of the primary address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line of the primary address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line of the primary address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the primary address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the primary address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the primary address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the 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. -
Country: string
Title:
Country
Maximum Length:2
The country code of the primary address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the primary address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
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
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the primary address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the primary address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the primary address. -
FormattedMultiLineAddress: string
Title:
Address
Read Only:true
The formatted multiline version of the primary address. -
HouseType: string
Title:
House Type
Maximum Length:30
Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
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. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
The unique identifier for the location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
LocationSourceSystem: string
The name of source system for the location record.
-
LocationSourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
LocationStatusFlag: boolean
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumberPartySite: integer
(int32)
The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OverallPrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address. -
PartyId: integer
(int64)
The unique identifier of the account associated with the address.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of the party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state of the address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Relationship-item-response
Type:
Show Source
object
-
BackwardRole: string
Title:
Backward Role
Read Only:true
The backward relationship code used to describe relationships. For example, SUPPLIER_OF. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
DirectionCode: string
Read Only:
true
Maximum Length:30
The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectPartyId: integer
(int64)
The unique identifier of the object party in this relationship.
-
ObjectPartyName: string
Title:
Object Party Name
Read Only:true
Maximum Length:360
The name of the object party of the relationship. -
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The alternate key identifier for the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of the external source system for the object party in the relationship. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The identifier for the object party in the relationship from the external source system. -
ObjectTableName: string
Maximum Length:
30
The source table name of the object party in this relationship. -
ObjectType: string
Maximum Length:
30
The object type of the contact. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The number to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyId1: integer
(int64)
Read Only:
true
The alternate unique identifier of the party. -
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RelationshipId: integer
(int64)
Read Only:
true
The unique identifier of the relationship. -
RelationshipRecId: integer
(int64)
The unique identifier of the relationship record.
-
RelationshipSourceSystem: string
The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RequestId: integer
(int64)
The unique identifier of the request.
-
Role: string
Title:
Role
The role between the subject and object party. -
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the record data and is referenced to manage source system reference. -
StartDate: string
(date)
Title:
From Date
The date when the relationship was created. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
Indicates if the relationship is active or inactive, such as A for active and I for inactive. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SubjectPartyId: integer
(int64)
The unique identifier of the subject party in this relationship.
-
SubjectPartyName: string
Title:
Subject Party Name
Read Only:true
Maximum Length:360
The name of the subject party. -
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate key identifier for the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of the external source system for the subject party in the relationship. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The identifier for the subject party in the relationship from the external source system. -
SubjectTableName: string
Maximum Length:
30
The source table of the subject. -
SubjectType: string
Maximum Length:
30
The subject type of the contact. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-SalesTeamMember-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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. -
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 and time the record was created. -
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 currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
EndDateActive: string
(date)
Title:
Archived Date
The date when the resource is dissociated from the sales account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which 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 details of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the contact is the owner. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The resource identifier. -
ResourceName: string
Title:
Resource Name
Read Only:true
The name of the sales team member. -
ResourceOrgName: string
Read Only:
true
The name of the organization that the sales team member belongs to. -
ResourcePartyNumber: string
Title:
Resource Party Number
The unique public identifier of the resource record. -
ResourcePhoneNumber: string
Title:
Phone
Read Only:true
The primary phone number of the sales team member. -
ResourceRoleName: string
Title:
Role
Read Only:true
The roles assigned to the sales team member. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales account. -
StartDateActive: string
(date)
Title:
Start Date
The date when the resource is associated with the sales account. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the member of the sales account resource team. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date on which the record was last updated by a specific user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-smartActions-item-response
Type:
Show Source
object
-
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:1024
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
array
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:250
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-SourceSystemReference-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDate: string
(date)
The date after which the record is inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
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. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated account.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated account. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The name of the source system. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The unique identifier of the source system reference. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated account. -
StartDate: string
(date)
The date when the record was created.
-
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AccountContact
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account. - PartyNumber:
- AccountExtensionBase
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type. - PartyNumber:
- AccountRollup
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The account rollups resource is used to view, create, update, and delete an account rollup. - PartyNumber:
- AdditionalIdentifier
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. - PartyNumber:
- AdditionalName
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name. - PartyNumber:
- Address
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account. - PartyNumber:
- Attachment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account. - PartyNumber:
- CertificationLevelLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_LEVEL
The list of values indicating the certification level of the account, such as Minimum or Highest.
The following properties are defined on the LOV link relation:- Source Attribute: CertificationLevel; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CertificationReasonCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_REASON
The list of values indicating the current certification level assignment of the account, such as Manual or Third-Party.
The following properties are defined on the LOV link relation:- Source Attribute: CertificationReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContactPoint
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on. - PartyNumber:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- CurrenciesLOV
-
Parameters:
- finder:
EnabledFlagFinder%3BBindEnabledFlag%3DY
The list of values indicating the default currency used by the organization, such as USD or GBP.
The following properties are defined on the LOV link relation:- Source Attribute: PreferredFunctionalCurrency; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode, Name
- finder:
- CustomerClassification
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private. - PartyNumber:
- DataCloudStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDATA_CLOUD_STATUS
The list of values indicating the enrichment status of the organization record, such as Enriched, Deleted, or Matched.
The following properties are defined on the LOV link relation:- Source Attribute: DataCloudStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EmailVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{EmailVerificationStatus}
The following properties are defined on the LOV link relation:- Source Attribute: EmailVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EmployeeAtPrimaryAdrEstIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEMP_AT_PRIMARY_ADR_EST_IND
The list of values indicating the number of employees in the organization at the primary location, such as minimum or maximum.
The following properties are defined on the LOV link relation:- Source Attribute: EmployeesAtPrimaryAddressEstimation; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EmployeeAtPrimaryAdrMinimumIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEMP_AT_PRIMARY_ADR_MIN_IND
The list of values indicating the minimum number of employees in the organization at the primary location.
The following properties are defined on the LOV link relation:- Source Attribute: EmployeesAtPrimaryAddressMinimum; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FavoriteAccountFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating the account is a favorite account.
The following properties are defined on the LOV link relation:- Source Attribute: FavoriteAccountFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FaxCountryCodeLOV
-
The list of values indicating the international country codes for the fax number.
The following properties are defined on the LOV link relation:- Source Attribute: FaxCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName
- FaxVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{FaxVerificationStatus}
The following properties are defined on the LOV link relation:- Source Attribute: FaxVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FiscalYearendMonthLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DMONTH
The list of values indicating the last fiscal month of the organization, such as March or December.
The following properties are defined on the LOV link relation:- Source Attribute: FiscalYearendMonth; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- HQBranchIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHQ_BRANCH_IND
The list of values indicating if the site is a headquarter or branch, such as Branch, Division, or Headquarters.
The following properties are defined on the LOV link relation:- Source Attribute: HQBranchIndicator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- IndustryCodeVA
-
Operation: /crmRestApi/resources/11.13.18.05/classCodesParameters:
- finder:
IndustryClassCategoryFinder
The list of values indicating the standard industry classification code.
The following properties are defined on the LOV link relation:- Source Attribute: IndustryCode; Target Attribute: ClassCode
- Display Attribute: ClassCodeMeaning
- finder:
- LegalStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DLEGAL_STATUS
The list of values indicating the legal status of the organization, such as Mutual Company, Cooperative, and General partnership.
The following properties are defined on the LOV link relation:- Source Attribute: LegalStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LocalBusIdenTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DLOCAL_BUS_IDEN_TYPE
The list of values indicating the most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan.
The following properties are defined on the LOV link relation:- Source Attribute: LocalBusinessIdentifierType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Note
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account. - PartyNumber:
- OrgSizeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_ORGANIZATION_SIZE
The list of values indicating the organization size based on the revenue, number of employees, and so on. The sample values are Small, Medium, and Large.
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationSize; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OrganizationTypeVA
-
Operation: /crmRestApi/resources/11.13.18.05/classCodesParameters:
- finder:
ClassCategoryFinder%3BBindClassCategory%3DORGANIZATION_TYPE
The list of values indicating the organization type classification for the account.
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationTypeCode; Target Attribute: ClassCode
- Display Attribute: ClassCodeMeaning
- finder:
- PhoneCountryCodeLOV
-
The list of values indicating the international country codes for the phone number.
The following properties are defined on the LOV link relation:- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName
- PhoneVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{PhoneVerificationStatus}
The following properties are defined on the LOV link relation:- Source Attribute: PhoneVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PreferredContactMethodLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PREFERRED_CONTACT_METHOD
The list of values indicating the preferred contact method of the account, such as mail and phone.
The following properties are defined on the LOV link relation:- Source Attribute: PreferredContactMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PrimaryAddress
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account. - PartyNumber:
- RatedCurrenciesLOV
-
The list of values indicating the currency code used by the organization, such as USD and GBP.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: Name
- RegistrationTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DREGISTRATION_TYPE
The list of values indicating the registration status of the organization, such as Profit and Nonprofit.
The following properties are defined on the LOV link relation:- Source Attribute: RegistrationType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Relationship
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person. - PartyNumber:
- RentOwnIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DOWN_RENT_IND
The list of values indicating if the organization owns or rents it current premises.
The following properties are defined on the LOV link relation:- Source Attribute: RentOrOwnIndicator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesProfileStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_SALES_ACCOUNT_STATUS
The list of values indicating the status of the account, such as active or inactive.
The following properties are defined on the LOV link relation:- Source Attribute: SalesProfileStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesProfileTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_ACCOUNT_TYPE
The list of values indicating if the type of the account, such as customer or prospect.
The following properties are defined on the LOV link relation:- Source Attribute: Type; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesTeamMember
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account. - PartyNumber:
- SearchFilters
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_ACCT_SRCH_RECORD_SET
The list of values indicating the record set to display search values, such as AllAccounts and MyAccounts.
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceSystemReference
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data. - PartyNumber:
- StatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_STATUS
The list of values indicating the status of the account, such as active or inactive.
The following properties are defined on the LOV link relation:- Source Attribute: PartyStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TerritoriesLOV
-
Parameters:
- finder:
ObsoleteFlagFinder%3BBindObsoleteFlag%3DN
The list of values indicating the home country of the organization, such as US or UK.
The following properties are defined on the LOV link relation:- Source Attribute: HomeCountry; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- TotalEmployeeEstIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DTOTAL_EMP_EST_IND
The list of values indicating the method used to calculate the total number of employees, such as actual or estimated.
The following properties are defined on the LOV link relation:- Source Attribute: TotalEmployeesEstimatedIndicator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TotalEmployeeMinimumIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DTOTAL_EMP_MIN_IND
The list of values indicating if the total number of employees is a minimum, average, or maximum.
The following properties are defined on the LOV link relation:- Source Attribute: TotalEmployeesMinimumIndicator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TotalEmployeesIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DTOTAL_EMPLOYEES_INDICATOR
The list of values indicating if the total number of employees includes employees from subsidiaries, such as Subsidiaries not included.
The following properties are defined on the LOV link relation:- Source Attribute: TotalEmployeesIndicator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- smartActions
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - PartyNumber: