Jump to

• Request
• Response
• Examples

Get an organization

get

/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}

Request

Path Parameters

• PartyNumber(required): string
  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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : hubOrganizations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Addresses",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-Address-item-response"
            }
        },
        "YearIncorporated":{
            "title":"Year Incorporated",
            "type":"integer",
            "description":"The year that the business was formally incorporated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "DisplayedDUNSPartyId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportIndicator":{
            "title":"Exporter Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "RecencyScore":{
            "title":"Recency",
            "type":"integer",
            "description":"The overall score for the contact or account record for category = Recency.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "YearEstablished":{
            "title":"Year Established",
            "type":"integer",
            "description":"The year that the organization started it business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "EmployeesAtPrimaryAddressEstimation":{
            "title":"Number of Employees at Identifying Address Estimated Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"A user-defined code to indicate a mail drop point within their organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentDUNSNumber":{
            "title":"Parent D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.\nA 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.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalPaymentAmount":{
            "title":"Total Payments",
            "type":"number",
            "description":"The total number of payment experiences.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the organization record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinorityOwnedType":{
            "title":"Type of Minority-Owned Organization",
            "maxLength":"30",
            "type":"string",
            "description":"The type of minority-owned firm.",
            "nullable":true,
            "x-queryable":true
        },
        "CEOName":{
            "title":"Chief Executive Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization's chief executive officer.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnalysisFiscalYear":{
            "title":"Analysis Year",
            "maxLength":"5",
            "type":"string",
            "description":"The fiscal year used as the source for financial information.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessScope":{
            "title":"Business Scope",
            "maxLength":"20",
            "type":"string",
            "description":"The class of business to which the organization belongs, such as local, national, or international.",
            "nullable":true,
            "x-queryable":true
        },
        "EnquiryDUNS":{
            "title":"Inquiry D-U-N-S",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MinorityOwnedIndicator":{
            "title":"Minority-Owned Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DomesticUltimateDUNSNumber":{
            "title":"Domestic Ultimate D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PrincipalName":{
            "title":"Principal Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the highest ranking person in the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationLevel":{
            "title":"Certification Level",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DataConfidenceScore":{
            "title":"Data Confidence",
            "type":"integer",
            "description":"The overall data confidence Score that indicates the level of data quality for a particular record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "type":"string",
            "description":"The e-mail address of the contact point for the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EmailStr"
                ]
            },
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the organization was validated.",
            "nullable":true,
            "x-queryable":true
        },
        "RentOrOwnIndicator":{
            "title":"Rent or Own Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DuplicateScore":{
            "title":"Duplication",
            "type":"integer",
            "description":"The overall score for the contact or account record for category = Duplicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "CustomerClassification":{
            "title":"Customer Classifications",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-CustomerClassification-item-response"
            }
        },
        "OrganizationSize":{
            "title":"Organization Size",
            "maxLength":"30",
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlYear":{
            "title":"Organization Control Year",
            "type":"number",
            "description":"The year when current ownership gained control of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateIndicator":{
            "title":"Duplicate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the duplicate status of the record in certain scenarios.",
            "nullable":true,
            "x-queryable":true
        },
        "LocalActivityCode":{
            "title":"Local Activity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The local activity classification code.",
            "nullable":true,
            "x-queryable":true
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-Note-item-response"
            }
        },
        "EmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The date when email address of the account was last verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EmailStr"
                ]
            }
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastEnrichmentDate":{
            "title":"Last Enrichment Date",
            "type":"string",
            "description":"The date when the record was last enriched.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BranchFlag":{
            "title":"Branch Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is a branch location. Y for branch locations, N for all other locations.",
            "nullable":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationReasonCode":{
            "title":"Certification Reason",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalName":{
            "title":"Additional Names",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-AdditionalName-item-response"
            }
        },
        "BusinessReport":{
            "title":"D&B Business Report",
            "type":"string",
            "description":"The Dun & Bradstreet business information report.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "URL":{
            "title":"URL",
            "type":"string",
            "description":"The uniform resource locator or a website containing information about the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "WomanOwnedIndicator":{
            "title":"Woman-Owned Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalIdentifier":{
            "title":"Additional Identifiers",
            "type":"array",
            "description":"The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-AdditionalIdentifier-item-response"
            }
        },
        "ContactPoint":{
            "title":"Contact Points",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-ContactPoint-item-response"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "OutOfBusinessIndicator":{
            "title":"Out of Business Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SmallBusinessIndicator":{
            "title":"Small Business Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalUltimateDUNSNumber":{
            "title":"Global Ultimate D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BankCode":{
            "title":"Bank Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code used to identify a bank in several countries, typically for regulatory purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployeesTotal":{
            "title":"Number of Employees",
            "type":"number",
            "description":"The total number of employees in the organization.",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GrowthStrategyDescription":{
            "title":"Growth Strategy Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-defined description of growth strategy.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Relationship":{
            "title":"Relationships",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-Relationship-item-response"
            }
        },
        "LineOfBusiness":{
            "title":"Line of Business",
            "maxLength":"240",
            "type":"string",
            "description":"The type of business activities performed at this site.",
            "nullable":true,
            "x-queryable":true
        },
        "MissionStatement":{
            "title":"Mission Statement",
            "maxLength":"2000",
            "type":"string",
            "description":"The corporate charter of organization in user-defined text format.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalEmployeesIndicator":{
            "title":"Number of Employees Includes Subsidiaries",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressType":{
            "type":"string",
            "description":"The additional information as type of address like BillTo, ShipTo.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"255",
            "type":"string",
            "description":"The name of external source system where the organization party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocalBusinessIdentifier":{
            "title":"Common Business Identifier",
            "maxLength":"60",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxpayerIdentificationNumber":{
            "title":"Taxpayer Identification Number",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Organization Attachments",
            "type":"array",
            "description":"The organization attachments resource is used to view, create, update, and delete attachments of an organization.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-Attachment-item-response"
            }
        },
        "CompletenessScore":{
            "title":"Completeness",
            "type":"integer",
            "description":"The overall score for the contact or account record for category = Completeness.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "LaborSurplusIndicator":{
            "title":"Labor Surplus Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-smartActions-item-response"
            }
        },
        "CorporationClass":{
            "title":"Corporation Class",
            "maxLength":"60",
            "type":"string",
            "description":"The taxation classification for corporation entities such as Chapter S in the US.",
            "nullable":true,
            "x-queryable":true
        },
        "DatafoxCompanyId":{
            "title":"DataFox Company ID",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the identifier of the matched record from DataFox.",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateParty":{
            "title":"Duplicate Parties",
            "type":"array",
            "description":"The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-DuplicateParty-item-response"
            }
        },
        "DisadvantageIndicator":{
            "title":"Disadvantaged Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NextFiscalYearPotentialRevenueAmount":{
            "title":"Next Fiscal Year's Potential Revenue",
            "type":"number",
            "description":"The estimated revenue of the organization to be earned during its next fiscal year.",
            "nullable":true,
            "x-queryable":true
        },
        "LocalActivityCodeType":{
            "title":"Local Activity Code Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the local activity classification code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalEmployeesEstimatedIndicator":{
            "title":"Number of Employees Estimated Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmailVerificationStatus":{
            "title":"Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmailStr"
                ]
            }
        },
        "TotalEmployeesText":{
            "title":"Total Number of Employees",
            "maxLength":"60",
            "type":"string",
            "description":"The total number of employees in text format.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_ZCH_WS",
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentOrSubsidiaryIndicator":{
            "title":"Subsidiary Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is a parent or subsidiary.",
            "nullable":true,
            "x-queryable":true
        },
        "CleanlinessScore":{
            "title":"Cleanliness",
            "type":"integer",
            "description":"The overall score for the contact or account record for category = Cleanliness.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "PreferredFunctionalCurrency":{
            "title":"Preferred Functional Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AccountScore":{
            "title":"Account Score",
            "type":"integer",
            "description":"The score assigned based on custom criteria by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployeesAtPrimaryAddressText":{
            "title":"Employees at Identifying Address",
            "maxLength":"12",
            "type":"string",
            "description":"The number of employees at the referenced address in text format.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "PhoneVerificationStatus":{
            "title":"Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the phone number verification for the account. The values based on lookup are valid and invalid for phone.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PhoneStr"
                ]
            }
        },
        "EmployeesAtPrimaryAddressMinimum":{
            "title":"Number of Employees at Identifying Address Minimum Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"The qualifier to qualify calculation of employees at the primary address as minimum.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ImportIndicator":{
            "title":"Importer Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "EmployeesAtPrimaryAddress":{
            "title":"Number of Employees at Identifying Address",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkedParty":{
            "title":"Linked Parties",
            "type":"array",
            "description":"The linked parties resource is used to view, create, and delete all the linked parties for the given organization.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-LinkedParty-item-response"
            }
        },
        "UniqueNameAlias":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name as captured by the users to internally identify the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "ThirdPartyFlag":{
            "title":"Third Party Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicate whether the organization was a third party.",
            "nullable":true,
            "x-queryable":true
        },
        "CEOTitle":{
            "title":"Chief Executive Title",
            "maxLength":"240",
            "type":"string",
            "description":"The formal title of the chief executive officer.",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueNameSuffix":{
            "title":"Name Suffix",
            "maxLength":"540",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "title":"Raw Phone Number",
            "type":"string",
            "description":"The unformatted phone number of the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PhoneStr"
                ]
            },
            "x-queryable":true
        },
        "BranchCode":{
            "title":"Branch Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code used to identify a bank branch in several countries, typically for regulatory purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentFiscalYearPotentialRevenueAmount":{
            "title":"Current Fiscal Year's Potential Revenue",
            "type":"number",
            "description":"The estimated revenues that can be earned by the organization during its current fiscal year.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "LocalBusinessIdentifierType":{
            "title":"Common Business Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HQBranchIndicator":{
            "title":"HQ Branch Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":"2000",
            "type":"string",
            "description":"The top keywords for an account.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotConfuseWith":{
            "title":"Don't Confuse With",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates that there is an organization that is similarly named.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "FiscalYearendMonth":{
            "title":"Fiscal Year End Month",
            "maxLength":"30",
            "type":"string",
            "description":"The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"The DUNS Number in freeform text format. The value not restricted to nine digit number.",
            "nullable":true,
            "x-queryable":true
        },
        "StockSymbol":{
            "title":"Stock Symbol",
            "maxLength":"20",
            "type":"string",
            "description":"The corporate stock symbol of the organization as listed in stock exchanges.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "CongressionalDistrictCode":{
            "title":"Congressional District",
            "maxLength":"2",
            "type":"string",
            "description":"The U.S. Congressional district code for the account.",
            "nullable":true,
            "x-queryable":true
        },
        "EnrichmentScore":{
            "title":"Enrichment",
            "type":"integer",
            "description":"The overall score for the contact or account record for category = Enrichment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "PublicPrivateOwnershipFlag":{
            "title":"Private Ownership",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastScoreUpdateDate":{
            "title":"Last Score Date",
            "type":"string",
            "description":"Indicates when the last data confidence score on this record was computed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "GeneralServicesAdministrationFlag":{
            "title":"GSA Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DataCloudStatus":{
            "title":"Enrichment Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceSystemReference":{
            "title":"Source System References",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-SourceSystemReference-item-response"
            }
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of registration, such as nonprofit. The accepted values are defined in the lookup type REGISTRATION_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountScoringTier":{
            "title":"Account Scoring Tier",
            "maxLength":"30",
            "type":"string",
            "description":"The tier assigned based on custom criteria by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerIdentifier":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute stores the FSIO related trading partner codes.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeCountry":{
            "title":"Home Country",
            "maxLength":"2",
            "type":"string",
            "description":"The home country of the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments for the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalStatus":{
            "title":"Legal Status",
            "maxLength":"30",
            "type":"string",
            "description":"The legal structure of the organization such as partnership, corporation, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "BankOrBranchNumber":{
            "title":"Bank or Branch Number",
            "maxLength":"30",
            "type":"string",
            "description":"The bank number for banks and branch number for bank branches, primarily the ABA number for US bank branches.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for the organization party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ValidityScore":{
            "title":"Validity",
            "type":"integer",
            "description":"The overall score for the contact or account record for category = Validity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "PrincipalTitle":{
            "title":"Principal Title",
            "maxLength":"240",
            "type":"string",
            "description":"The title of the highest ranking person in the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DUNSCreditRating":{
            "title":"D&B Credit Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The Dun & Bradstreet credit rating.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalEmployeesMinimumIndicator":{
            "title":"Number of Employees Minimum Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneVerificationDate":{
            "title":"Phone Verification Date",
            "type":"string",
            "description":"The date when phone number of account was last verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PhoneStr"
                ]
            }
        },
        "UsageAssignment":{
            "title":"Party Usage Assignments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-UsageAssignment-item-response"
            }
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "type":"string",
            "description":"The party usage code for this organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object hubOrganizations-AdditionalIdentifier-item-response

{
    "title":"Additional Identifiers",
    "type":"array",
    "description":"The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-AdditionalIdentifier-item-response"
    }
}

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

• Array of: object hubOrganizations-AdditionalName-item-response

{
    "title":"Additional Names",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-AdditionalName-item-response"
    }
}

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

• Array of: object hubOrganizations-Address-item-response

{
    "title":"Addresses",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-Address-item-response"
    }
}

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

• Array of: object hubOrganizations-Attachment-item-response

{
    "title":"Organization Attachments",
    "type":"array",
    "description":"The organization attachments resource is used to view, create, update, and delete attachments of an organization.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-Attachment-item-response"
    }
}

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

• Array of: object hubOrganizations-ContactPoint-item-response

{
    "title":"Contact Points",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-ContactPoint-item-response"
    }
}

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

• Array of: object hubOrganizations-CustomerClassification-item-response

{
    "title":"Customer Classifications",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-CustomerClassification-item-response"
    }
}

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

• Array of: object hubOrganizations-DuplicateParty-item-response

{
    "title":"Duplicate Parties",
    "type":"array",
    "description":"The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-DuplicateParty-item-response"
    }
}

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

• Array of: object hubOrganizations-LinkedParty-item-response

{
    "title":"Linked Parties",
    "type":"array",
    "description":"The linked parties resource is used to view, create, and delete all the linked parties for the given organization.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-LinkedParty-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Notes

Type: array

Title: Notes

The notes resource is used to view, create, update, and delete a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object.

Show Source

• Array of: object hubOrganizations-Note-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-Note-item-response"
    }
}

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

• Array of: object hubOrganizations-Relationship-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-Relationship-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object hubOrganizations-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-smartActions-item-response"
    }
}

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

• Array of: object hubOrganizations-SourceSystemReference-item-response

{
    "title":"Source System References",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-SourceSystemReference-item-response"
    }
}

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

• Array of: object hubOrganizations-UsageAssignment-item-response

{
    "title":"Party Usage Assignments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-UsageAssignment-item-response"
    }
}

Nested Schema : hubOrganizations-AdditionalIdentifier-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the additional identifier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the additional identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierValue":{
            "title":"Identifier Value",
            "maxLength":"60",
            "type":"string",
            "description":"The value of the party identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "IssuingAuthorityPartyId":{
            "type":"integer",
            "description":"The unique identifier of the issuing authority party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"1",
            "type":"string",
            "description":"The status code of the additional identifier.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the additional identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the additional identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvince":{
            "title":"Issuing State",
            "maxLength":"60",
            "type":"string",
            "description":"The attribute is used for certain types of identifiers such as Passports or Driving licenses based on geography setup.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingAuthorityName":{
            "title":"Issuing Authority Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the issuing authority of the additional identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the additional identifier was issued.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierType":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of party identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the additional identifier will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Issuing Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the additional identifier was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the additional identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

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

  The kind of the related resource.
• name: string
  Title: name

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

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

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Nested Schema : hubOrganizations-AdditionalName-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the Additional Name record.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "NameId":{
            "type":"integer",
            "description":"The unique identifier of the name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable.",
            "nullable":true,
            "x-queryable":true
        },
        "NameType":{
            "title":"Additional Name Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the name. For example, ALIAS or LEGAL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The status of the additional name, used for soft delete.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Additional Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the organization, person, or group party. For example, \"Oracle\" or \"John Smith\".",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":"30",
            "type":"string",
            "description":"The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-Address-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute2: string
  Title: Additional Address Element 2

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute3: string
  Title: Additional Address Element 3

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute4: string
  Title: Additional Address Element 4

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute5: string
  Title: Additional Address Element 5

  Maximum Length: 150

  The additional address element to support flexible address format.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress1":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The attribute used to store latitude information for the location for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":"60",
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code.",
            "nullable":true,
            "x-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"A user-defined code to indicate a mail drop point within their organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The user defined name for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "AddressId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates that this address should not be used for mailing.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"An internal application determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the address record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationStartDate":{
            "type":"string",
            "description":"The date on which the validation starts. Internally set by system during address cleansing.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":"30",
            "type":"string",
            "description":"The standardized status code that describes the results of the validation.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of Address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The attribute used to store longitude information for the location for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element of Address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date after which this address is rendered inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateFormattedAddress":{
            "type":"boolean",
            "description":"The formatted address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state element of Address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. Accepts values Y for primary contact, N for all others.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"An extensive description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which this address is active. Defaulted to the current system date if not provided during create.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "DunsNumberC":{
            "title":"D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"The D-U-N-S number of the business location.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule1":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date on which the address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location record for this address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The type of address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "SSRPartyOwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the party record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress1":{
            "title":"Formatted Address 1",
            "type":"string",
            "description":"The formatted address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveDate":{
            "type":"string",
            "description":"The effective date of the address.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-Attachment-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared.
• 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.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-ContactPoint-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of verification of the phone or email contact point.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VerificationStatus"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the phone number is preferred.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SocialNetworkId":{
            "title":"User ID",
            "type":"string",
            "description":"The unique identifier for the social network.",
            "nullable":true,
            "x-hints":{
                "Property":"Social Network Account"
            },
            "x-queryable":true
        },
        "URL":{
            "title":"URL",
            "type":"string",
            "description":"The URL associated with the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"255",
            "type":"string",
            "description":"The area code for the telephone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"255",
            "type":"string",
            "description":"The country code of the phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "maxLength":"255",
            "type":"string",
            "description":"The formatted phone number of the contact point.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The user who created the module.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact point.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the contact point.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "SocialNetworkPurpose":{
            "title":"Social Network Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "DoNotContactReason":{
            "title":"Do Not Contact Reason",
            "type":"string",
            "description":"The reason code for the contact preference.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhonePurpose":{
            "title":"Phone Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferenceRequestedBy":{
            "title":"Preference Requested By",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoContactPreferenceFlag":{
            "title":"OK to Contact",
            "type":"boolean",
            "description":"Indicates whether to use a particular contact method.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"255",
            "type":"string",
            "description":"The email address of the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"255",
            "type":"string",
            "description":"The extension number of the phone line number like office desk extension.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The type of the phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotContactPreferenceFlag":{
            "title":"Do Not Contact",
            "type":"boolean",
            "description":"The contact preference flag that indicates DNC option.",
            "nullable":true,
            "x-queryable":false
        },
        "WebPurpose":{
            "title":"Web Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailPurpose":{
            "title":"Email Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of the email.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The phone number of the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "SocialNetworkName":{
            "title":"Social Network",
            "type":"string",
            "description":"The social network type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Property":"Social Network"
            },
            "x-queryable":true
        },
        "ContactPointType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of contact point.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The phone number in raw format.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the contact point was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the contact point.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-CustomerClassification-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Indicates the date and time when the record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCodeMeaning":{
            "title":"Classification Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"A valid classification code meaning corresponding to the classification code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicator to show if the current code is the primary classification code.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IsAuxClassificationFlag":{
            "title":"Auxiliary Classification Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is a custom group classification category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCategory":{
            "title":"Classification Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the classification category.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier from external source system for the account, contact, or household with which the classification category and classification code is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the classification becomes valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":"30",
            "type":"string",
            "description":"The application or module that created the record. The default value is HZ_WS for all web service based creation.",
            "nullable":false,
            "x-queryable":true
        },
        "IsOrgTypeFlag":{
            "title":"Organization Type Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an organization type classification category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the party, such as account, contact, or household.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsIndustryFlag":{
            "title":"Industry Type Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an industry group classification category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the code assignment is active or inactive, such as A for active and I for inactive.",
            "nullable":true,
            "default":"A",
            "x-queryable":true
        },
        "CodeAssignmentId":{
            "title":"Code Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the customer classification assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of the external source system of the account, contact, or household with which the classification category and classification code is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the classification code is no longer valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassCode":{
            "title":"Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"A valid classification code corresponding to the classification category.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of account, contact, or household to which the classification category and classification code is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-DuplicateParty-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the duplicate party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the duplicate party was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the duplicate party.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the duplicate party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated to the duplicate party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PromotedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the party in the duplicate set is the promoted account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the duplicate party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the duplicate party was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the duplicate party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-LinkedParty-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the linked party was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MainLink":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the link direction. The valid values are Y and N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelatedPartyId":{
            "type":"integer",
            "description":"The unique identifier of the parent party associated to the linked party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the linked party.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated to the linked party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedPartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the parent party.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The link number of the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the link such as B2FLink, or DQ Link.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"The unique identifier for the linked party.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyType":{
            "maxLength":"30",
            "type":"string",
            "description":"The party type of the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the linked party was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the linked party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-Note-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"This is the attribute to specify the visibility level of the note.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The system generated or can come from external system (user key).",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"This is the source_object_code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the record.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"This is the column which will store the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The user provided title for the note.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The system attribute to capture the Id of the user who last updated the Note. This is defaulted by the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique note identifier. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The party id of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"This is the note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"This is the source_object_Uid for the source object (such as Activities, Opportunities etc.) as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The system attribute to capture the Id of the user who last updated the Note. This is defaulted by the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-Relationship-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the relationship was established. Defaulted to the system date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The subject type of the contact.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "BackwardRole":{
            "title":"Backward Role",
            "type":"string",
            "description":"The backward relationship code used to describe relationships. For example, SUPPLIER_OF.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubjectUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of subject party in the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipRecId":{
            "type":"integer",
            "description":"The unique identifier of the relationship record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectVersionNumber2":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Role",
            "type":"string",
            "description":"The role between the subject and object party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an admin as part of the system setup.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a person is the head of the household that he belongs to.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "ObjectUsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The usage code of object party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table of the subject.",
            "nullable":false,
            "x-queryable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is a dependent on another.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobDefinitionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table name of the object party in this relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "InfluenceLevel":{
            "title":"Influence Level",
            "type":"string",
            "description":"The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The object type of the contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobDefinitionPackage":{
            "maxLength":"900",
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyName":{
            "title":"Object Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the object party of the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyName":{
            "title":"Subject Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the subject party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments for this relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId1":{
            "type":"integer",
            "description":"The alternate unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-smartActions-item-response

Type: object

Show Source

• 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
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• 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.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object hubOrganizations-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-smartActions-UserActionNavigation-item-response"
    }
}

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

• Array of: object hubOrganizations-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-smartActions-UserActionRequestPayload-item-response"
    }
}

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

• Array of: object hubOrganizations-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : hubOrganizations-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• 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 value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-SourceSystemReference-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the reference. A for Active. Mapping is invalid. The for Inactive. Mapping is invalid. The default is A for Active.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemReferenceId":{
            "type":"integer",
            "description":"The sequentially generated identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The source system name for the account, contact, or household.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the reference ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The source system id for the source system logical entity.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The public unique identifier of the account, contact, or household. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique Identifier of the account, contact, or household.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"The source system name.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hubOrganizations-UsageAssignment-item-response

Type: object

Show Source

• 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'.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyUsageAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for a party usage assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"Indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"Indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of party that the party usage is assigned to.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"The user who created the module.",
            "nullable":false,
            "default":"ORA_ZCH_WS",
            "x-queryable":true
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of party usage assigned to the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AdditionalIdentifier

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier

Parameters:

• PartyNumber: $request.path.PartyNumber

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

AdditionalName

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

Address

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

Attachment

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment

Parameters:

• PartyNumber: $request.path.PartyNumber

The organization attachments resource is used to view, create, update, and delete attachments of an organization.

CertificationLevelLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

CertificationReasonCodeLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ContactPoint

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

CountriesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

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

CurrenciesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCurrencies

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

CustomerClassification

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification

Parameters:

• 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.

DataCloudStatusLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

DuplicateParty

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

EmailVerificationStatusLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

EmployeeAtPrimaryAdrEstIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

EmployeeAtPrimaryAdrMinimumIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

FiscalYearendMonthLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

HQBranchIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

HomeCountriesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

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

LegalStatusLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

LinkedParty

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

LocalActivityTypeLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

LocalBusIdenTypeLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Note

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

OrgSizeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

PartyUsageLOV

Operation: /crmRestApi/resources/11.13.18.05/partyUsages

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

PhoneVerificationStatusLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

PreferredContactMethodLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

RatedCurrenciesLOV

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Relationship

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

RentOwnIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

SourceSystemReference

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference

Parameters:

• 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.

StatusLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

TotalEmployeeEstIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

TotalEmployeeMinimumIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

TotalEmployeesIndLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

UsageAssignment

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/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.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions

Parameters:

• PartyNumber: $request.path.PartyNumber

This VO stores the endpoint and security details for every user action.

Back to Top

Examples

The following example shows how to get an organization by submitting a GET request on the REST resource.

cURL Command

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "PartyId": 300100019114221,
    "PartyNumber": "CDRM_53640",
    "SourceSystem": null,
    "SourceSystemReferenceValue": null,
    "OrganizationName": "AvinashTestOrgForRelationship2",
    "UniqueNameSuffix": null,
    "Status": "A",
    "CreatedByModule": "SALES",
    "CreatedBy": "DATA_STEWARD_MGR",
    "CreationDate": "2013-01-09T01:49:11.060+00:00",
    "LastUpdateDate": "2022-06-07T23:34:34.724+00:00",
    "LastUpdatedBy": "MHoope",
    "PartyUsageCode": "COMPETITOR",
    "RawPhoneNumber": null,
    "PhoneVerificationStatus": null,
    "PhoneVerificationDate": null,
    "EmailAddress": null,
    "EmailVerificationStatus": null,
    "EmailVerificationDate": null,
    "URL": null,
    "AddressNumber": "CDRM_19361",
    "AddressElementAttribute1": "TestAttr1",
    "AddressElementAttribute2": null,
    "AddressElementAttribute3": null,
    "AddressElementAttribute4": null,
    "AddressElementAttribute5": null,
    "Address1": "Test Address",
    "Address2": null,
    "Address3": null,
    "Address4": null,
    "AddressLinesPhonetic": null,
    "AddressType": null,
    "Building": null,
    "City": "Redwood City",
    "Country": "US",
    "County": null,
    "FloorNumber": null,
    "Mailstop": null,
    "PostalCode": "94063",
    "PostalPlus4Code": null,
    "Province": null,
    "State": "CA",
    "ThirdPartyFlag": null,
    "ValidatedFlag": null,
    "AccountScore": null,
    "AccountScoringTier": null,
    "AnalysisFiscalYear": null,
    "BankCode": null,
    "BankOrBranchNumber": null,
    "BranchCode": null,
    "BranchFlag": null,
    "BusinessScope": null,
    "CEOName": null,
    "CEOTitle": null,
    "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": null,
    "DoNotConfuseWith": null,
    "DUNSNumber": null,
    "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": null,
    "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": null,
    "PrincipalTitle": null,
    "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": "AvinashTestOrgForRelationship2",
    "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": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640",
            "name": "hubOrganizations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000004770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000017371007E00020000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640",
            "name": "hubOrganizations",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/AdditionalIdentifier",
            "name": "AdditionalIdentifier",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/AdditionalName",
            "name": "AdditionalName",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/Address",
            "name": "Address",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/Attachment",
            "name": "Attachment",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/ContactPoint",
            "name": "ContactPoint",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/CustomerClassification",
            "name": "CustomerClassification",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/Note",
            "name": "Note",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/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_53640/child/Relationship",
            "name": "Relationship",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/SourceSystemReference",
            "name": "SourceSystemReference",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/child/UsageAssignment",
            "name": "UsageAssignment",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/CDRM_53640/enclosure/BusinessReport",
            "name": "BusinessReport",
            "kind": "other"
        }
    ]
}

Back to Top