Create an organization
post
/crmRestApi/resources/11.13.18.05/hubOrganizations
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:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountScore: integer
Title:
Account Score
The score assigned based on custom criteria by the user. -
AccountScoringTier: string
Title:
Account Scoring Tier
Maximum Length:30
The tier assigned based on custom criteria by the user. -
AdditionalIdentifier: array
Additional Identifiers
Title:
Additional Identifiers
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 names 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 an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of address. -
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. -
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 unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressType: string
The 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
Organization Attachments
Title:
Organization Attachments
The organization attachments resource is used to view, create, update, and delete attachments of an organization. -
BankCode: string
Title:
Bank Code
Maximum Length:30
The code used to identify a bank in several countries, typically for regulatory purposes. -
BankOrBranchNumber: string
Title:
Bank or Branch Number
Maximum Length:30
The bank number for banks and branch number for bank branches, primarily the ABA number for US bank branches. -
BranchCode: string
Title:
Branch Code
Maximum Length:30
The code used to identify a bank branch in several countries, typically for regulatory purposes. -
BranchFlag: boolean
Title:
Branch Indicator
Maximum Length:1
Indicates whether this is a branch location. Y for branch locations, N for all other locations. -
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 organization 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 reason for the organization'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 address. -
CleanlinessScore: integer
(int64)
Title:
Cleanliness
The overall score for the contact or account record for category = Cleanliness. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the organization. -
CompletenessScore: integer
(int64)
Title:
Completeness
The overall score for the contact or account record for category = Completeness. -
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 points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc. -
ControlYear: number
Title:
Organization Control Year
The year when current ownership gained control of the organization. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code used by the CRM Extensibility framework. It is defaulted to the value set in the profile option ZCA_COMMON_CORPORATE_CURRENCY. -
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. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The application module that created the 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. -
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. -
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
Customer Classifications
Title:
Customer Classifications
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household. -
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. -
DataConfidenceScore: integer
(int64)
Title:
Data Confidence
The overall data confidence Score that indicates the level of data quality for a particular record. -
DatafoxCompanyId: string
Title:
DataFox Company ID
Maximum Length:30
Indicates the identifier of the matched record from DataFox. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
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. -
DisplayedDUNSPartyId: integer
(int64)
Indicates the unique identifier of an organization that is the Dun and Bradstreet headquarters location from which information should be displayed in the case that the branch location information is not available.
-
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. -
DuplicateIndicator: string
Title:
Duplicate Type
Maximum Length:30
Indicates the duplicate status of the record in certain scenarios. -
DuplicateParty: array
Duplicate Parties
Title:
Duplicate Parties
The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization. -
DuplicateScore: integer
(int64)
Title:
Duplication
The overall score for the contact or account record for category = Duplicate. -
EmailAddress: string
Title:
Email Address
The e-mail address of the contact point for the organization. -
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:
Number of Employees at Identifying 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. -
EnquiryDUNS: string
Title:
Inquiry D-U-N-S
Maximum Length:15
The identifier used to query the Dun and Bradstreet data. If a location is a branch, then in some countries the headquarters DUNS number is used to do the query. -
EnrichmentScore: integer
(int64)
Title:
Enrichment
The overall score for the contact or account record for category = Enrichment. -
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. -
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
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
GeneralServicesAdministrationFlag: boolean
Title:
GSA Indicator
Maximum Length:1
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. -
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. -
Keywords: string
Title:
Keywords
Maximum Length:2000
The top keywords for an account. -
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. -
LastScoreUpdateDate: string
(date-time)
Title:
Last Score Date
Indicates when the last data confidence score on this record was computed. -
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. -
LinkedParty: array
Linked Parties
Title:
Linked Parties
The linked parties resource is used to view, create, and delete all the linked parties for the given organization. -
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. -
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 a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object. -
OrganizationName(required): string
Title:
Organization Name
Maximum Length:360
The name of the organization. -
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. -
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. -
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 organization 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. Inactive records can't be updated. -
PartyUsageCode: string
Title:
Party Usage Code
The party usage code for this organization. -
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 as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
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. -
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 element of address. -
PublicPrivateOwnershipFlag: boolean
Title:
Private Ownership
Maximum Length:1
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. -
RawPhoneNumber: string
Title:
Raw Phone Number
The unformatted phone number of the organization. -
RecencyScore: integer
(int64)
Title:
Recency
The overall score for the contact or account record for category = Recency. -
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, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates whether 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. -
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
This VO stores the endpoint and security details for every user action. -
SourceSystem: string
Title:
Source System
Maximum Length:255
The name of external source system where the organization 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 references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry. -
SourceSystemReferenceValue: string
Title:
Source System Reference
Maximum Length:255
The unique identifier for the organization 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. -
ThirdPartyFlag: boolean
Title:
Third Party Indicator
Maximum Length:1
Indicate whether the organization was a third party. -
TotalEmployeesEstimatedIndicator: string
Title:
Number of Employees Estimated Qualifier
Maximum Length:30
Indicates whether 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 whether 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 whether 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. -
TotalPaymentAmount: number
Title:
Total Payments
The total number of payment experiences. -
TradingPartnerIdentifier: string
Maximum Length:
30
The attribute stores the FSIO related trading partner codes. -
UniqueNameAlias(required): string
Title:
Organization Name
Maximum Length:360
The name as captured by the users to internally identify the organization. -
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
The uniform resource locator or a website containing information about the organization. -
UsageAssignment: array
Party Usage Assignments
Title:
Party Usage Assignments
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Indicates whether the organization was validated. -
ValidityScore: integer
(int64)
Title:
Validity
The overall score for the contact or account record for category = Validity. -
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 : Additional Identifiers
Type:
array
Title:
Additional Identifiers
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 names 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 an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.
Show Source
Nested Schema : Organization Attachments
Type:
array
Title:
Organization Attachments
The organization attachments resource is used to view, create, update, and delete attachments of an organization.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc.
Show Source
Nested Schema : Customer Classifications
Type:
array
Title:
Customer Classifications
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household.
Show Source
Nested Schema : Duplicate Parties
Type:
array
Title:
Duplicate Parties
The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization.
Show Source
Nested Schema : Linked Parties
Type:
array
Title:
Linked Parties
The linked parties resource is used to view, create, and delete all the linked parties for the given organization.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry.
Show Source
Nested Schema : Party Usage Assignments
Type:
array
Title:
Party Usage Assignments
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.
Show Source
Nested Schema : hubOrganizations-AdditionalIdentifier-item-post-request
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. Inactive records can't be updated.
-
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
The attribute is 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 : hubOrganizations-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 in the additional name (Not Applicable). -
LastName: string
Title:
Last Name
Maximum Length:150
The last name in the additional name (Not Applicable). -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name in the additional name (Not Applicable). -
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 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.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Indicates the 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, 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.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
The status of the additional name, used for soft delete. -
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
The transliteration language attribute 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 : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line 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 (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressType: string
Title:
Type
The type of address. -
Building: string
Title:
Building
Maximum Length:240
Specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city element of Address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the addresses. A list of valid values is 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. This attribute is used by CRM Extensibility framework. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
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. 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 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. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of valid values is 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 related to the address. This attribute is used by CRM Extensibility framework. A list of valid values is 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 on which the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates that this 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 effective date of the address.
-
EndDateActive: string
(date)
Title:
End Date
The date after which this address is rendered inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
HouseType: string
Title:
House Type
Maximum Length:30
The building type. A list of valid values is 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 attribute used to store latitude information for the location for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location record for this address. -
Longitude: number
Title:
Longitude
The attribute used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
The attribute 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.
-
ObjectVersionNumber1: integer
(int32)
The attribute 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.
-
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact, or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact, or household record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the account, contact, or household to which the address is associated. 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 default value is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. The value is updateable depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of valid values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
The user defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
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
Title:
Party Source System Reference Value
Identifier from external source system for the account, contact or household with which the address is associated. Part of Alternate Key (along with PartySourceSystem) . 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. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. Accepts values Y for primary contact, N for all others. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
SourceSystem: 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.
-
SourceSystemReferenceValue: 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.
-
StartDateActive: string
(date)
Title:
Start Date
The date from which this address is active. Defaulted to the current system date if not provided during create. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
An internal application determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location was validated. Y for validated, N for invalidated. If the value is True, then the location is validated. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The standardized status code that describes the results of the validation.
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : hubOrganizations-ContactPoint-item-post-request
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The unique identifier of the conflict. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of contact point. -
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. -
DoNotContactPreferenceFlag: boolean
Title:
Do Not Contact
The contact preference flag that indicates DNC option. -
DoNotContactReason: string
Title:
Do Not Contact Reason
The reason code for the contact preference. -
EmailAddress: string
Title:
Email
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)
Title:
Object Version Number
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)
Title:
Party ID
The unique identifier of the party. -
PartyNumber: string
Title:
Registry ID
The party number. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
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
Title:
Party Source System Reference Value
The unique identifier of the relationship from external source system. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:255
The area code for the telephone number. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:255
The country code of the phone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Title:
Phone
Maximum Length:255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
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
Title:
Type
The type of the phone. -
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
Title:
Phone
Maximum Length:255
The phone number in raw format. -
SocialNetworkId: string
Title:
User ID
The unique identifier for the social network. -
SocialNetworkName: string
Title:
Social Network
The social network type. -
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
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
Title:
Source System
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
Title:
Source System Reference Value
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
Title:
Status
Maximum Length:30
Default Value:A
The status of the contact point. -
URL: string
Title:
URL
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 are not verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
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
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 or module that created the record. The default value is HZ_WS for all web service based creation. -
EndDateActive: string
(date)
Title:
End Date
The date on which the classification code is no longer valid. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of account, contact, or household to which the classification category and classification code is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household to which the classification category and classification code is associated. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification category and classification code is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier from external source system for the account, contact, or household with which the classification category and classification code is associated. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicator to show if the current code is the primary classification code. -
SourceSystem: string
Title:
Source System
The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the classification becomes valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the code assignment is active or inactive, such as A for active and I for inactive.
Nested Schema : schema
Type:
Show Source
object
-
PartyId: integer
(int64)
The unique identifier of the party associated to the duplicate party.
-
PartyNumber: string
Maximum Length:
30
The party number of the duplicate party.
Nested Schema : schema
Type:
Show Source
object
-
LinkType: string
Maximum Length:
30
The type of the link such as B2FLink, or DQ Link. -
MainLink: string
Maximum Length:
1
Indicates the link direction. The valid values are Y and N. -
PartyId: integer
(int64)
The unique identifier of the party associated to the linked party.
-
PartyNumber: string
Maximum Length:
30
The party number of the linked party. -
RelatedPartyId: integer
(int64)
The unique identifier of the parent party associated to the linked party.
-
RelatedPartyNumber: string
Maximum Length:
30
The party number of the parent party.
Nested Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The party id of 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 related to the note. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area. -
NoteNumber: string
Maximum Length:
30
The system generated or can come from external system (user key). -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
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
This is the source_object_code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
This is the source_object_Uid for the source object (such as Activities, Opportunities etc.) as defined in 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 : hubOrganizations-Relationship-item-post-request
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for this relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
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. -
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 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.
-
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The 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. -
ObjectSourceSystem: string
Title:
Object Source System
The name of external source system for the object party in the relationship, which are defined by an admin 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 in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. -
ObjectSourceSystemReferenceValue: string
Title:
Object 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. -
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
Indicates whether 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 for the relationship, which is defined by an admin as part of the system setup.
-
RelationshipSourceSystemReferenceValue: string
The identifier for the relationship with the external source system.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The relationship type name. For example, 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 established. Defaulted to the system date. -
SubjectPartyId: integer
(int64)
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.
-
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate 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. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of external source system for the subject party in the relationship, which are defined by an admin 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 in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. -
SubjectSourceSystemReferenceValue: string
Title:
Subject 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. -
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 : hubOrganizations-smartActions-item-post-request
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
DisplayLabel(required): string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
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 if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
Uniquely identifies the action. For internal use. -
UserActionName(required): string
Title:
Action Name
Maximum Length:256
Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
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 : hubOrganizations-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
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
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : hubOrganizations-smartActions-UserActionURLBinding-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : hubOrganizations-SourceSystemReference-item-post-request
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 when the reference ends.
-
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 account, contact, or household.
-
PartyNumber: string
Title:
Party Number
The public unique identifier of the account, contact, or household. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account, contact, or household. -
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 source system name. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system id for the source system logical entity. -
StartDate: string
(date)
The start date.
-
Status: string
Maximum Length:
1
Default Value:A
The status of the reference. A for Active. Mapping is invalid. The for Inactive. Mapping is invalid. The default is A for Active.
Nested Schema : schema
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The user who created the module. -
EndDate: string
(date)
Title:
To Date
Indicates the date at the end of the date range within which the row is effective. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The unique identifier of party usage assigned to the party. -
StartDate: string
(date)
Title:
From Date
Indicates the date at the beginning of the date range within which the row is effective.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hubOrganizations-item-response
Type:
Show Source
object
-
AccountScore: integer
Title:
Account Score
The score assigned based on custom criteria by the user. -
AccountScoringTier: string
Title:
Account Scoring Tier
Maximum Length:30
The tier assigned based on custom criteria by the user. -
AdditionalIdentifier: array
Additional Identifiers
Title:
Additional Identifiers
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 names 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 an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of address. -
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. -
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 unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressType: string
The 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
Organization Attachments
Title:
Organization Attachments
The organization attachments resource is used to view, create, update, and delete attachments of an organization. -
BankCode: string
Title:
Bank Code
Maximum Length:30
The code used to identify a bank in several countries, typically for regulatory purposes. -
BankOrBranchNumber: string
Title:
Bank or Branch Number
Maximum Length:30
The bank number for banks and branch number for bank branches, primarily the ABA number for US bank branches. -
BranchCode: string
Title:
Branch Code
Maximum Length:30
The code used to identify a bank branch in several countries, typically for regulatory purposes. -
BranchFlag: boolean
Title:
Branch Indicator
Maximum Length:1
Indicates whether this is a branch location. Y for branch locations, N for all other locations. -
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 organization 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 reason for the organization'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 address. -
CleanlinessScore: integer
(int64)
Title:
Cleanliness
The overall score for the contact or account record for category = Cleanliness. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the organization. -
CompletenessScore: integer
(int64)
Title:
Completeness
The overall score for the contact or account record for category = Completeness. -
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 points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc. -
ControlYear: number
Title:
Organization Control Year
The year when current ownership gained control of the organization. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code used by the CRM Extensibility framework. It is defaulted to the value set in the profile option ZCA_COMMON_CORPORATE_CURRENCY. -
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. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the organization record. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The application module that created the 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)
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. -
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
Customer Classifications
Title:
Customer Classifications
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household. -
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. -
DataConfidenceScore: integer
(int64)
Title:
Data Confidence
The overall data confidence Score that indicates the level of data quality for a particular record. -
DatafoxCompanyId: string
Title:
DataFox Company ID
Maximum Length:30
Indicates the identifier of the matched record from DataFox. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
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. -
DisplayedDUNSPartyId: integer
(int64)
Indicates the unique identifier of an organization that is the Dun and Bradstreet headquarters location from which information should be displayed in the case that the branch location information is not available.
-
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. -
DuplicateIndicator: string
Title:
Duplicate Type
Maximum Length:30
Indicates the duplicate status of the record in certain scenarios. -
DuplicateParty: array
Duplicate Parties
Title:
Duplicate Parties
The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization. -
DuplicateScore: integer
(int64)
Title:
Duplication
The overall score for the contact or account record for category = Duplicate. -
EmailAddress: string
Title:
Email Address
The e-mail address of the contact point for the organization. -
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:
Number of Employees at Identifying 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. -
EnquiryDUNS: string
Title:
Inquiry D-U-N-S
Maximum Length:15
The identifier used to query the Dun and Bradstreet data. If a location is a branch, then in some countries the headquarters DUNS number is used to do the query. -
EnrichmentScore: integer
(int64)
Title:
Enrichment
The overall score for the contact or account record for category = Enrichment. -
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. -
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
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the primary address. -
GeneralServicesAdministrationFlag: boolean
Title:
GSA Indicator
Maximum Length:1
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. -
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. -
Keywords: string
Title:
Keywords
Maximum Length:2000
The top keywords for an account. -
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
Read Only:true
The date when the record was last enriched. -
LastScoreUpdateDate: string
(date-time)
Title:
Last Score Date
Indicates when the last data confidence score on this record was computed. -
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. -
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. -
LinkedParty: array
Linked Parties
Title:
Linked Parties
The linked parties resource is used to view, create, and delete all the linked parties for the given organization. -
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. -
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 a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the organization. -
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. -
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. -
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 organization. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier for the organization 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. Inactive records can't be updated. -
PartyUsageCode: string
Title:
Party Usage Code
The party usage code for this organization. -
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 as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
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. -
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 element of address. -
PublicPrivateOwnershipFlag: boolean
Title:
Private Ownership
Maximum Length:1
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. -
RawPhoneNumber: string
Title:
Raw Phone Number
The unformatted phone number of the organization. -
RecencyScore: integer
(int64)
Title:
Recency
The overall score for the contact or account record for category = Recency. -
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, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates whether 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. -
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
This VO stores the endpoint and security details for every user action. -
SourceSystem: string
Title:
Source System
Maximum Length:255
The name of external source system where the organization 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 references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry. -
SourceSystemReferenceValue: string
Title:
Source System Reference
Maximum Length:255
The unique identifier for the organization party from the external source system specified in the attribute SourceSystem. -
State: string
Title:
State
Maximum Length:60
The state element of address. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
Indicates the status of the organization. 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. -
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. -
ThirdPartyFlag: boolean
Title:
Third Party Indicator
Maximum Length:1
Indicate whether the organization was a third party. -
TotalEmployeesEstimatedIndicator: string
Title:
Number of Employees Estimated Qualifier
Maximum Length:30
Indicates whether 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 whether 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 whether 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. -
TotalPaymentAmount: number
Title:
Total Payments
The total number of payment experiences. -
TradingPartnerIdentifier: string
Maximum Length:
30
The attribute stores the FSIO related trading partner codes. -
UniqueNameAlias: string
Title:
Organization Name
Maximum Length:360
The name as captured by the users to internally identify the organization. -
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
The uniform resource locator or a website containing information about the organization. -
UsageAssignment: array
Party Usage Assignments
Title:
Party Usage Assignments
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Indicates whether the organization was validated. -
ValidityScore: integer
(int64)
Title:
Validity
The overall score for the contact or account record for category = Validity. -
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 : Additional Identifiers
Type:
array
Title:
Additional Identifiers
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 names 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 an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.
Show Source
Nested Schema : Organization Attachments
Type:
array
Title:
Organization Attachments
The organization attachments resource is used to view, create, update, and delete attachments of an organization.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc.
Show Source
Nested Schema : Customer Classifications
Type:
array
Title:
Customer Classifications
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household.
Show Source
Nested Schema : Duplicate Parties
Type:
array
Title:
Duplicate Parties
The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization.
Show Source
Nested Schema : Linked Parties
Type:
array
Title:
Linked Parties
The linked parties resource is used to view, create, and delete all the linked parties for the given organization.
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 a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry.
Show Source
Nested Schema : Party Usage Assignments
Type:
array
Title:
Party Usage Assignments
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.
Show Source
Nested Schema : hubOrganizations-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. Inactive records can't be updated.
-
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
The attribute is 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 : 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 : hubOrganizations-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 in the additional name (Not Applicable). -
LastName: string
Title:
Last Name
Maximum Length:150
The last name in the additional name (Not Applicable). -
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 in the additional name (Not Applicable). -
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 party number. Inactive records can't be updated. -
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.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Indicates the 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, 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.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
The status of the additional name, used for soft delete. -
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
The transliteration language attribute 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 : hubOrganizations-Address-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line 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 address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
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 unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressType: string
Title:
Type
The type of address. -
Building: string
Title:
Building
Maximum Length:240
Specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city element of Address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the addresses. A list of valid values is 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. This attribute is used by CRM Extensibility framework. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
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. 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 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. 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 record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of valid values is 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 related to the address. This attribute is used by CRM Extensibility framework. A list of valid values is 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 on which the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates that this 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 effective date of the address.
-
EndDateActive: string
(date)
Title:
End Date
The date after which this address is rendered inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address information. -
FormattedAddress1: string
Title:
Formatted Address 1
Read Only:true
The formatted address information. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
FormattedMultilineAddress1: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
HouseType: string
Title:
House Type
Maximum Length:30
The building type. A list of valid values is 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 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 session login associated to the user who last updated the contact record. -
Latitude: number
Title:
Latitude
The attribute used to store latitude information for the location 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 location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location record for this address. -
Longitude: number
Title:
Longitude
The attribute used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
The attribute 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.
-
ObjectVersionNumber1: integer
(int32)
The attribute 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.
-
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact, or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact, or household record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the account, contact, or household to which the address is associated. 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 default value is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. The value is updateable depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of valid values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
The user defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
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
Title:
Party Source System Reference Value
Identifier from external source system for the account, contact or household with which the address is associated. Part of Alternate Key (along with PartySourceSystem) . 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. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. Accepts values Y for primary contact, N for all others. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
SourceSystem: 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.
-
SourceSystemReferenceValue: 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.
-
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 from which this address is active. Defaulted to the current system date if not provided during create. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
An internal application determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location was validated. Y for validated, N for invalidated. If the value is True, then the location is validated. The value is internally set by system during address cleansing. -
ValidationStartDate: string
(date)
Read Only:
true
The date on which the validation starts. Internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The standardized status code that describes the results of the validation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the 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 who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-ContactPoint-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The unique identifier of the conflict. -
ContactPointId: integer
(int64)
Title:
Contact Point ID
Read Only:true
The unique identifier of the contact point. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of contact point. -
CreatedBy: string
Title:
Created By
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)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. -
DoNotContactPreferenceFlag: boolean
Title:
Do Not Contact
The contact preference flag that indicates DNC option. -
DoNotContactReason: string
Title:
Do Not Contact Reason
The reason code for the contact preference. -
EmailAddress: string
Title:
Email
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
Title:
Phone Number
Read Only:true
Maximum Length:255
The formatted phone number of the contact point. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the contact point was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the contact point. -
LastUpdateLogin: string
Title:
Last Update Login
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)
Title:
Object Version Number
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)
Title:
Party ID
The unique identifier of the party. -
PartyNumber: string
Title:
Registry ID
The party number. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
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
Title:
Party Source System Reference Value
The unique identifier of the relationship from external source system. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:255
The area code for the telephone number. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:255
The country code of the phone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Title:
Phone
Maximum Length:255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
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
Title:
Type
The type of the phone. -
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
Title:
Phone
Maximum Length:255
The phone number in raw format. -
SocialNetworkId: string
Title:
User ID
The unique identifier for the social network. -
SocialNetworkName: string
Title:
Social Network
The social network type. -
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
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
Title:
Source System
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
Title:
Source System Reference Value
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
Title:
Status
Maximum Length:30
Default Value:A
The status of the contact point. -
URL: string
Title:
URL
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 are not verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
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 : hubOrganizations-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
Name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
A valid classification code corresponding to the classification category. -
ClassCodeMeaning: string
Title:
Classification Code Meaning
Read Only:true
Maximum Length:80
A valid classification code meaning corresponding to the classification code. -
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the record. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application or module that created the record. The default value is HZ_WS for all web service based creation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Indicates the date and time when the record is created. -
EndDateActive: string
(date)
Title:
End Date
The date on which the classification code is no longer valid. -
IsAuxClassificationFlag: boolean
Title:
Auxiliary Classification Status
Read Only:true
Indicates whether the classification category is a custom group classification category. -
IsIndustryFlag: boolean
Title:
Industry Type Status
Read Only:true
Indicates whether the classification category is an industry group classification category. -
IsOrgTypeFlag: boolean
Title:
Organization Type Status
Read Only:true
Indicates whether the classification category is an organization type classification category. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates 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
Indicates the session login associated to 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 account, contact, or household to which the classification category and classification code is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household to which the classification category and classification code is associated. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification category and classification code is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier from external source system for the account, contact, or household with which the classification category and classification code is associated. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
Indicates the type of the party, such as account, contact, or household. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicator to show if the current code is the primary classification code. -
SourceSystem: string
Title:
Source System
The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the classification becomes valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the code assignment is active or inactive, such as A for active and I for inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-DuplicateParty-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the duplicate party. -
CreationDate: string
(date-time)
Read Only:
true
The date when the duplicate party was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the duplicate party was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the duplicate party. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the duplicate party. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The unique identifier of the party associated to the duplicate party.
-
PartyName: string
Read Only:
true
Maximum Length:360
The party name of the duplicate party. -
PartyNumber: string
Maximum Length:
30
The party number of the duplicate party. -
PromotedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the party in the duplicate set is the promoted account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-LinkedParty-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the linked party. -
CreationDate: string
(date-time)
Read Only:
true
The date when the linked party was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the linked party was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the linked party. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the linked party. -
LinkId: integer
(int64)
Read Only:
true
The unique identifier for the linked party. -
LinkNumber: string
Read Only:
true
Maximum Length:64
The link number of the linked party. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkType: string
Maximum Length:
30
The type of the link such as B2FLink, or DQ Link. -
MainLink: string
Maximum Length:
1
Indicates the link direction. The valid values are Y and N. -
PartyId: integer
(int64)
The unique identifier of the party associated to the linked party.
-
PartyName: string
Read Only:
true
Maximum Length:360
The party name of the linked party. -
PartyNumber: string
Maximum Length:
30
The party number of the linked party. -
PartyType: string
Read Only:
true
Maximum Length:30
The party type of the linked party. -
RelatedPartyId: integer
(int64)
The unique identifier of the parent party associated to the linked party.
-
RelatedPartyNumber: string
Maximum Length:
30
The party number of the parent party.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
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 when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The party id of 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 related to the note. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the record. -
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 record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The system attribute to capture the Id of the user who last updated the Note. This is defaulted by the system. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The system attribute to capture the Id of the user who last updated the Note. This is defaulted by the system. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique note identifier. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
The system generated or can come from external system (user key). -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
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 party. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of the party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
This is the source_object_code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
This is the source_object_Uid for the source object (such as Activities, Opportunities etc.) as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user has access to update the record. -
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 : hubOrganizations-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 comments for this relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
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 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 and time 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 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 session login of the user who last updated the contact record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectPartyId: integer
(int64)
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.
-
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 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. -
ObjectSourceSystem: string
Title:
Object Source System
The name of external source system for the object party in the relationship, which are defined by an admin 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 in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. -
ObjectSourceSystemReferenceValue: string
Title:
Object 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. -
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 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. -
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
Indicates whether 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 for the relationship, which is defined by an admin as part of the system setup.
-
RelationshipSourceSystemReferenceValue: string
The identifier for the relationship with the external source system.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The relationship type name. For example, 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 established. Defaulted to the system date. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
Indicates whether this is an active or inactive relationship. A for active, I for inactive. This is an internal column and you are not expected to pass in a value. 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 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.
-
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. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of external source system for the subject party in the relationship, which are defined by an admin 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 in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. -
SubjectSourceSystemReferenceValue: string
Title:
Subject 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. -
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 : hubOrganizations-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
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 if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
Uniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action Name
Maximum Length:256
Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
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 : 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
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 : hubOrganizations-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
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
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-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 when the reference ends.
-
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 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 account, contact, or household.
-
PartyNumber: string
Title:
Party Number
The public unique identifier of the account, contact, or household. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account, contact, or household. -
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 source system name. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The sequentially generated identifier. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system id for the source system logical entity. -
StartDate: string
(date)
The start date.
-
Status: string
Maximum Length:
1
Default Value:A
The status of the reference. A for Active. Mapping is invalid. The for Inactive. Mapping is invalid. The default is A for Active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubOrganizations-UsageAssignment-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The user who created the module. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
EndDate: string
(date)
Title:
To Date
Indicates the date at the end of the date range within which the row is effective. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of party that the party usage is assigned to. -
PartyUsageAssignmentId: integer
(int64)
Read Only:
true
The unique identifier for a party usage assignment. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The unique identifier of party usage assigned to the party. -
StartDate: string
(date)
Title:
From Date
Indicates the date at the beginning of the date range within which the row is effective. -
StatusFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:true
The internal use to soft delete 'from' assignment in transition rule. Assignment API won't expose this column. However, any query on assignment table should have status_flag = 'A'.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AdditionalIdentifier
-
Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifierParameters:
- 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 names 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 an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household. - PartyNumber:
- Attachment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The organization attachments resource is used to view, create, update, and delete attachments of an organization. - PartyNumber:
- CertificationLevelLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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 points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc. - PartyNumber:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The list of values indicating the country of the address, such as US and UK.
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
-
Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassificationParameters:
- PartyNumber:
$request.path.PartyNumber
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household. - PartyNumber:
- DataCloudStatusLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- DuplicateParty
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization. - PartyNumber:
- 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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- FiscalYearendMonthLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- HomeCountriesLOV
-
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:
- LegalStatusLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- LinkedParty
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The linked parties resource is used to view, create, and delete all the linked parties for the given organization. - PartyNumber:
- LocalActivityTypeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DLOCAL_ACTIVITY_CODE_TYPE
The list of values indicating the local activity code.
The following properties are defined on the LOV link relation:- Source Attribute: LocalActivityCodeType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LocalBusIdenTypeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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 a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object. - PartyNumber:
- OrgSizeLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_ORGANIZATION_SIZE
The list of values indicating the organization size.
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationSize; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PartyUsageLOV
-
Parameters:
- finder:
OrganizationPartyUsageRowFinder
The list of values indicating the party usage codes that can be assigned to the organization.
The following properties are defined on the LOV link relation:- Source Attribute: PartyUsageCode; Target Attribute: PartyUsageCode
- Display Attribute: PartyUsageCode
- finder:
- 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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- 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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household. - PartyNumber:
- RentOwnIndLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- SourceSystemReference
-
Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReferenceParameters:
- PartyNumber:
$request.path.PartyNumber
The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry. - PartyNumber:
- StatusLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_STATUS
The list of values indicating the status.
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TotalEmployeeEstIndLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%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:
- UsageAssignment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member. - PartyNumber:
- smartActions
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
This VO stores the endpoint and security details for every user action. - PartyNumber:
Examples
The following example shows how to create a hub organization by submitting a POST request on the REST resource.
cURL Command
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "SourceSystem": "DNB", "SourceSystemReferenceValue": "DNB-ckh0001-A1", "OrganizationName": "Ckh A1dnb", "PartyUsageCode": "PARTY_OF_INTEREST", "CEOName" : "Lego", "CEOTitle" : "Mr", "PrincipalName" : "Lego", "PrincipalTitle" : "Mr", "DomesticUltimateDUNSNumber": "222222201", "GlobalUltimateDUNSNumber": "2111111101", "DUNSNumber": "233333301", "RawPhoneNumber": "+14085550001", "EmailAddress": "ckha1dnb@oracle.com", "URL": "http://www.oracle.com/ckha1dnb", "AddressType": "BILL_TO,SHIP_TO", "Address1": "100 main st.", "City": "San Francisco", "Country": "US" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PartyId": 300100561331772, "PartyNumber": "CDRM_954852", "SourceSystem": "DNB", "SourceSystemReferenceValue": "DNB-ckh0001-A1", "OrganizationName": "Ckh A1dnb", "UniqueNameSuffix": "(San Francisco, US)", "Status": "A", "CreatedByModule": "ORA_ZCH_WS", "CreatedBy": "SALES_ADMIN", "CreationDate": "2022-09-20T10:15:42.003+00:00", "LastUpdateDate": "2022-09-20T10:16:01.703+00:00", "LastUpdatedBy": "SALES_ADMIN", "PartyUsageCode": "PARTY_OF_INTEREST", "RawPhoneNumber": "+14085550001", "PhoneVerificationStatus": null, "PhoneVerificationDate": null, "EmailAddress": "ckha1dnb@oracle.com", "EmailVerificationStatus": null, "EmailVerificationDate": null, "URL": "http://www.oracle.com/ckha1dnb", "AddressNumber": "CDRM_866696", "AddressElementAttribute1": null, "AddressElementAttribute2": null, "AddressElementAttribute3": null, "AddressElementAttribute4": null, "AddressElementAttribute5": null, "Address1": "100 main st.", "Address2": null, "Address3": null, "Address4": null, "AddressLinesPhonetic": null, "AddressType": "BILL_TO,SHIP_TO", "Building": null, "City": "San Francisco", "Country": "US", "County": null, "FloorNumber": null, "Mailstop": null, "PostalCode": null, "PostalPlus4Code": null, "Province": null, "State": null, "ThirdPartyFlag": null, "ValidatedFlag": null, "AccountScore": null, "AccountScoringTier": null, "AnalysisFiscalYear": null, "BankCode": null, "BankOrBranchNumber": null, "BranchCode": null, "BranchFlag": null, "BusinessScope": null, "CEOName": "Lego", "CEOTitle": "Mr", "CertificationLevel": null, "CertificationReasonCode": null, "CleanlinessScore": null, "Comments": null, "CompletenessScore": null, "CongressionalDistrictCode": null, "ControlYear": null, "CorpCurrencyCode": "USD", "CorporationClass": null, "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "CurrentFiscalYearPotentialRevenueAmount": null, "DataCloudStatus": null, "DataConfidenceScore": null, "DatafoxCompanyId": null, "Description": null, "DisadvantageIndicator": null, "DisplayedDUNSPartyId": null, "DomesticUltimateDUNSNumber": "222222201", "DoNotConfuseWith": null, "DUNSNumber": "233333301", "DUNSCreditRating": null, "DuplicateIndicator": null, "DuplicateScore": null, "EmployeesAtPrimaryAddress": null, "EmployeesAtPrimaryAddressEstimation": null, "EmployeesAtPrimaryAddressMinimum": null, "EmployeesAtPrimaryAddressText": null, "EmployeesTotal": null, "EnquiryDUNS": null, "EnrichmentScore": null, "ExportIndicator": null, "FiscalYearendMonth": null, "GlobalUltimateDUNSNumber": "2111111101", "GrowthStrategyDescription": null, "GeneralServicesAdministrationFlag": null, "HomeCountry": null, "HQBranchIndicator": null, "ImportIndicator": null, "Keywords": null, "LaborSurplusIndicator": null, "LastEnrichmentDate": null, "LastScoreUpdateDate": null, "LegalStatus": null, "LineOfBusiness": null, "LocalActivityCode": null, "LocalActivityCodeType": null, "LocalBusinessIdentifier": null, "LocalBusinessIdentifierType": null, "MinorityOwnedIndicator": null, "MinorityOwnedType": null, "MissionStatement": null, "NextFiscalYearPotentialRevenueAmount": null, "OutOfBusinessIndicator": null, "OrganizationSize": null, "OrganizationType": null, "ParentDUNSNumber": null, "ParentOrSubsidiaryIndicator": null, "PreferredFunctionalCurrency": null, "PreferredContactMethod": null, "PrincipalName": "Lego", "PrincipalTitle": "Mr", "PublicPrivateOwnershipFlag": null, "RecencyScore": null, "RegistrationType": null, "RentOrOwnIndicator": null, "SmallBusinessIndicator": null, "StockSymbol": null, "TaxpayerIdentificationNumber": null, "TotalEmployeesEstimatedIndicator": null, "TotalEmployeesIndicator": null, "TotalEmployeesMinimumIndicator": null, "TotalEmployeesText": null, "TotalPaymentAmount": null, "TradingPartnerIdentifier": null, "UniqueNameAlias": "Ckh A1dnb", "ValidityScore": null, "WomanOwnedIndicator": null, "YearEstablished": null, "YearIncorporated": null, "OrganizationDEO_CustomText_c": null, "OrganizationDEO_CustomNumber_c": null, "OrganizationDEO_CustomDate_c": null, "OrganizationDEO_CustomDatetime_c": null, "OrganizationDEO_CustomFlag_c": false, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852", "name": "hubOrganizations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000004770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000017371007E00020000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852", "name": "hubOrganizations", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/AdditionalIdentifier", "name": "AdditionalIdentifier", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/AdditionalName", "name": "AdditionalName", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/Address", "name": "Address", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/Attachment", "name": "Attachment", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/ContactPoint", "name": "ContactPoint", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/CustomerClassification", "name": "CustomerClassification", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/Note", "name": "Note", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/OrganizationDEO_OPACustomTestChild1_OPAAcctChildCO_Tgt", "name": "OrganizationDEO_OPACustomTestChild1_OPAAcctChildCO_Tgt", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/Relationship", "name": "Relationship", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/SourceSystemReference", "name": "SourceSystemReference", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/child/UsageAssignment", "name": "UsageAssignment", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_954852/enclosure/BusinessReport", "name": "BusinessReport", "kind": "other" } ] }
Note:
When creating a new hub organization, you must assign only party usage codes that support unconditional assignment. You can get the list of party usages that support unconditional assignment from the Setup and Maintenance work area, Manage Party Usages task.