Jump to

• Request
• Response
• Examples

Update an account

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}

Request

Path Parameters

• PartyNumber(required): string
  The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountContact: array Organization Contacts
  Title: Organization Contacts

  The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.
• AccountExtensionBase: array Account Extension Bases
  Title: Account Extension Bases

  The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.
• AccountHierarchySummary: array Account Hierarchy
  Title: Account Hierarchy

  The account hierarchy summaries resource is used to view the account hierarchy information.
• AccountRollup: array Account Rollups
  Title: Account Rollups

  The account rollups resource is used to view, create, update, and delete an account rollup.
• AccountScore: integer
  Title: Account Score

  Score assigned based on custom criteria by the user.
• AccountScoringTier: string
  Title: Account Scoring Tier

  Maximum Length: 30

  Tier assigned based on custom criteria by the user.
• AccountTeam: array Account Team
  Title: Account Team

  The account team resource is used to view the team members and territory team members associated with an account.
• AdditionalIdentifier: array Additional Identifier
  Title: Additional Identifier

  The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
• AdditionalName: array Additional Names
  Title: Additional Names

  The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.
• Address: array Addresses
  Title: Addresses

  The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 240

  The first line for address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or kana representation of the Kanji address lines (used in Japan).
• AddressType: string
  Title: Address Type

  Additional information as type of address like BillTo, ShipTo.
• AddressTypeList: string
  Title: Address Type

  The address type as a list.
• AnalysisFiscalYear: string
  Title: Analysis Year

  Maximum Length: 5

  The fiscal year used as the source for financial information.
• Attachment: array Account Attachments
  Title: Account Attachments

  The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address.
• BusinessReport: string (byte)
  Title: D&B Business Report

  The Dun & Bradstreet business information report.
• BusinessScope: string
  Title: Business Scope

  Maximum Length: 20

  The class of business to which the account belongs, such as local, national, or international.
• CEOName: string
  Title: Chief Executive Name

  Maximum Length: 240

  The name of the organization???s chief executive officer.
• CEOTitle: string
  Title: Chief Executive Title

  Maximum Length: 240

  The formal title of the chief executive officer.
• CertificationLevel: string
  Title: Certification Level

  Maximum Length: 30

  The certification level of the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CertificationReasonCode: string
  Title: Certification Reason

  Maximum Length: 30

  The code indicating the reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the account.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The corporate charter of the organization.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• CongressionalDistrictCode: string
  Title: Congressional District

  Maximum Length: 2

  The U.S. Congressional district code for the account.
• ContactPoint: array Contact Points
  Title: Contact Points

  The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
• ControlYear: number
  Title: Organization Control Year

  The year when current ownership gained control of the organization.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CorporationClass: string
  Title: Corporation Class

  Maximum Length: 60

  The taxation classification for corporation entities such as Chapter S in the US.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Title: County

  Maximum Length: 60

  The county of the primary address.
• CreatedByModule: string
  Title: Created by Application

  Default Value: HZ_WS

  The application module that created the account record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrentFiscalYearPotentialRevenueAmount: number
  Title: Current Fiscal Year's Potential Revenue

  The estimated revenues that can be earned by the organization during its current fiscal year.
• CustomerClassification: array Aux Classifications
  Title: Aux Classifications

  The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
• DataCloudStatus: string
  Title: Enrichment Status

  Maximum Length: 30

  The enrichment status of the contact record from Data-as-a-Service. A list of valid values are defined in the lookup DATA_CLOUD_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DatafoxCompanyId: string
  Title: DataFox Company ID

  Maximum Length: 30

  Datafox Company Identifier.
• Description: string
  Title: Description

  Maximum Length: 2000

  Short description for the company.
• DisadvantageIndicator: string
  Title: Disadvantaged Indicator

  Maximum Length: 30

  Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No.
• DomesticUltimateDatafoxId: string
  Title: Domestic Ultimate DataFox Id

  Maximum Length: 30

  The DataFox Company identifier of the Domestic Ultimate for the account, which is the highest family member in the same country as this business entity. A subject may be its own Domestic Ultimate.
• DomesticUltimateDUNSNumber: string
  Title: Domestic Ultimate D-U-N-S Number

  Maximum Length: 30

  The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate.
• DoNotConfuseWith: string
  Title: Don't Confuse With

  Maximum Length: 255

  Indicates that there is an organization that is similarly named.
• DUNSCreditRating: string
  Title: D&B Credit Rating

  Maximum Length: 5

  The Dun & Bradstreet credit rating.
• DUNSNumber: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The DUNS Number in freeform text format. The value not restricted to nine digit number.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The e-mail address of the contact point for the organization.
• EmailFormat: string
  Title: Email Format

  Maximum Length: 30

  The preferred format for e-mail addressed to this organization, such as HTML or ASCII.
• EmailVerificationDate: string (date)
  Title: Email Verification Date

  The date when email address of the account was last verified.
• EmailVerificationStatus: string
  Title: Email Verification Status

  Maximum Length: 30

  The status code of the verification of email address for the account. The values based on the lookup are valid, invalid, or partially invalid for email.
• EmployeesAtPrimaryAddress: string
  Title: Employees at Primary Address

  Maximum Length: 10

  The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• EmployeesAtPrimaryAddressEstimation: string
  Title: Number of Employees at Identifying Address Estimated Qualifier

  Maximum Length: 30

  The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• EmployeesAtPrimaryAddressMinimum: string
  Title: Number of Employees at Identifying Address Minimum Qualifier

  Maximum Length: 30

  The qualifier to qualify calculation of employees at the primary address as minimum.
• EmployeesAtPrimaryAddressText: string
  Title: Employees at Identifying Address

  Maximum Length: 12

  The number of employees at the referenced address in text format.
• EmployeesTotal: number
  Title: Number of Employees

  The total number of employees in the organization.
• ExportIndicator: string
  Title: Exporter Indicator

  Maximum Length: 30

  Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N.
• FavoriteAccountFlag: boolean
  Title: Favorite

  Maximum Length: 10

  Default Value: false

  Indicates if the account is a favorite. The default value is false.
• FaxAreaCode: string
  Title: Fax Area Code

  Maximum Length: 20

  The area code for the fax number.
• FaxCountryCode: string
  Title: Fax Country Code

  Maximum Length: 10

  The international country code for a fax number, such as 33 for France.
• FaxExtension: string
  Title: Fax Extension

  Maximum Length: 20

  The extension to the fax number of the organization.
• FaxNumber: string
  Title: Fax

  Maximum Length: 40

  The fax number of the organization in the local format. The number should not include area code, country code, or extension.
• FaxVerificationDate: string (date)
  Title: Fax Verification Date

  The date when fax number was last verified for the account.
• FaxVerificationStatus: string
  Title: Fax Verification Status

  Maximum Length: 30

  The status code of the verification of fax number for the account. The values based on lookup are valid and invalid for fax.
• FiscalYearendMonth: string
  Title: Fiscal Year End Month

  Maximum Length: 30

  The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  The specific floor number at a given address or in a particular building when building number is provided.
• GeneralServicesAdministrationFlag: boolean
  Title: GSA Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N.
• GlobalUltimateDatafoxId: string
  Title: Global Ultimate DataFox Id

  Maximum Length: 30

  The DataFox Company identifier of the Global Ultimate for the account, which is the highest family member globally across countries as this business entity as you walk up this branch of the tree. A case may be its own Global Ultimate.
• GlobalUltimateDUNSNumber: string
  Title: Global Ultimate D-U-N-S Number

  Maximum Length: 30

  The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate.
• GrowthStrategyDescription: string
  Title: Growth Strategy Description

  Maximum Length: 2000

  The user-defined description of growth strategy.
• HomeCountry: string
  Title: Home Country

  Maximum Length: 2

  The home country of the organization.
• HQBranchIndicator: string
  Title: HQ Branch Indicator

  Maximum Length: 30

  The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND.
• ImportIndicator: string
  Title: Importer Indicator

  Maximum Length: 30

  Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N.
• IndustryCode: string
  Title: Primary Industry

  The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
• Keywords: string
  Title: Keywords

  Maximum Length: 2000

  List of the top keywords of the company.
• LaborSurplusIndicator: string
  Title: Labor Surplus Indicator

  Maximum Length: 30

  Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N.
• LastEnrichmentDate: string (date)
  Title: Last Enrichment Date

  The date when the record was last enriched.
• LegalStatus: string
  Title: Legal Status

  Maximum Length: 30

  The legal structure of the organization such as partnership, corporation, and so on.
• LineOfBusiness: string
  Title: Line of Business

  Maximum Length: 240

  The type of business activities performed at this site.
• LocalActivityCode: string
  Title: Local Activity Code

  Maximum Length: 30

  The local activity classification code.
• LocalActivityCodeType: string
  Title: Local Activity Code Type

  Maximum Length: 30

  The type of the local activity classification code.
• LocalBusinessIdentifier: string
  Title: Common Business Identifier

  Maximum Length: 60

  The unique identifier assigned to a businesses by a government agency such as Chamber of Commerce, or any other authority. It is often used by countries other than USA.
• LocalBusinessIdentifierType: string
  Title: Common Business Identifier Type

  Maximum Length: 30

  The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values are defined in the lookup type LOCAL_BUS_IDEN_TYPE.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization.
• MinorityOwnedIndicator: string
  Title: Minority-Owned Indicator

  Maximum Length: 30

  Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. company is primarily owned by ethnic or racial minorities. The default value is N.
• MinorityOwnedType: string
  Title: Type of Minority-Owned Organization

  Maximum Length: 30

  The type of minority-owned firm.
• MissionStatement: string
  Title: Mission Statement

  Maximum Length: 2000

  The corporate charter of organization in user-defined text format.
• NamedFlag: boolean
  Title: Named Account

  Maximum Length: 1

  Default Value: false

  Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False.
• NextFiscalYearPotentialRevenueAmount: number
  Title: Next Fiscal Year's Potential Revenue

  The estimated revenue of the organization to be earned during its next fiscal year.
• Note: array Notes
  Title: Notes

  The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  The name of the account.
• OrganizationSize: string
  Title: Organization Size

  Maximum Length: 30

  The size of the organization based on its revenue, number of employees, and so on.
• OrganizationType: string
  Title: Organization Type

  Maximum Length: 30

  The type of the organization.
• OrganizationTypeCode: string
  Title: Organization Type Code

  The organization type code.
• OutOfBusinessIndicator: string
  Title: Out of Business Indicator

  Maximum Length: 30

  Indicates whether the organization is out of business. If the value is Y, then the organization is out of business. The default value is N.
• OwnerPartyId: integer (int64)
  Title: Owner ID

  The unique identifier of a valid employee resource who owns and manages the sales account.
• ParentAccountPartyId: integer
  Title: Parent Account ID

  The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference.
• ParentAccountPartyNumber: string
  Title: Parent Account Registry ID

  The party number of the parent account within the hierarchy.
• ParentAccountSourceSystem: string
  Title: Parent Source System

  The source system of the parent account within the hierarchy.
• ParentAccountSourceSystemReferenceValue: string
  Title: Parent Account Source System Reference

  The source system reference of the parent account within the hierarchy.
• ParentDUNSNumber: string
  Title: Parent D-U-N-S Number

  Maximum Length: 30

  The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company. A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent.
• ParentOrSubsidiaryIndicator: string
  Title: Subsidiary Indicator

  Maximum Length: 30

  Indicates whether the organization is a parent or subsidiary.
• PartyNumberKey: string
  Title: Registry ID

  Maximum Length: 30

  The alternate identifier of the party.
• PhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 20

  The area code for the telephone number.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The international country code for a telephone number, such as 33 for France.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20

  The extension to the phone number of the organization.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The phone number of the organization in the local format. The number should not include area code, country code, or extension.
• PhoneVerificationDate: string (date)
  Title: Phone Verification Date

  The date when phone number of account was last verified.
• PhoneVerificationStatus: string
  Title: Phone Verification Status

  Maximum Length: 30

  The status code of the phone number verification for the account. The values based on lookup are valid and invalid for phone.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Maximum Length: 30

  The preferred contact method of the organization. The accepted values are defined in the lookup type HZ_PREFERRED_CONTACT_METHOD. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• PreferredFunctionalCurrency: string
  Title: Preferred Functional Currency

  Maximum Length: 15

  The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup.
• PrimaryAddress: array Primary Addresses
  Title: Primary Addresses

  The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact Party ID

  The unique identifier of the primary contact of the account.
• PrimaryContactPartyNumber: string
  Title: Primary Contact Party Number

  The party number of the primary contact of the account.
• PrimaryContactSourceSystem: string
  Title: Primary Contact Source System

  The name of external source system where the primary contact of the account is imported from.
• PrimaryContactSourceSystemReferenceValue: string
  Title: Primary Contact Source System Reference

  The unique identifier for the account's primary contact as specified in the external source system.
• PrincipalName: string
  Title: Principal Name

  Maximum Length: 240

  The name of the highest ranking person in the organization.
• PrincipalTitle: string
  Title: Principal Title

  Maximum Length: 240

  The title of the highest ranking person in the organization.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• PublicPrivateOwnershipFlag: boolean
  Title: Private Ownership

  Maximum Length: 1

  Default Value: false

  Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.
• RawFaxNumber: string
  Title: Raw Fax Number

  Maximum Length: 60

  The unformatted fax number of the organization.
• RawPhoneNumber: string
  Title: Raw Phone Number

  Maximum Length: 60

  The unformatted phone number of the organization.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 30

  Indicates the type of registration, such as nonprofit. The accepted values are defined in the lookup type REGISTRATION_TYPE.
• Relationship: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.
• RentOrOwnIndicator: string
  Title: Rent or Own Indicator

  Maximum Length: 30

  Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SalesProfileNumber: string
  Title: Sales Account Number

  Maximum Length: 30

  The sales profile number.
• SalesProfileStatus: string
  Title: Status

  Maximum Length: 30

  A valid user-defined status of the sales account.
• SalesTeamMember: array Account Resources
  Title: Account Resources

  Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.
• SiebelLocation: string
  Title: Location

  Maximum Length: 50

  Location of account - optional part of User Primary Key.
• SmallBusinessIndicator: string
  Title: Small Business Indicator

  Maximum Length: 30

  Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• SourceSystem: string
  Title: Party Source System

  The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReference: array Source System References
  Title: Source System References

  The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
• SourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
• State: string
  Title: State

  Maximum Length: 60

  The state element of Address.
• StockSymbol: string
  Title: Stock Symbol

  Maximum Length: 20

  The corporate stock symbol of the organization as listed in stock exchanges.
• TaxpayerIdentificationNumber: string
  Title: Taxpayer Identification Number

  Maximum Length: 20

  The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe.
• TotalEmployeesEstimatedIndicator: string
  Title: Number of Employees Estimated Qualifier

  Maximum Length: 30

  Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.
• TotalEmployeesIndicator: string
  Title: Number of Employees Includes Subsidiaries

  Maximum Length: 30

  Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR.
• TotalEmployeesMinimumIndicator: string
  Title: Number of Employees Minimum Qualifier

  Maximum Length: 30

  Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND.
• TotalEmployeesText: string
  Title: Total Number of Employees

  Maximum Length: 60

  The total number of employees in text format.
• Type: string
  Title: Type

  Maximum Length: 30

  The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided.
• UniqueNameSuffix: string
  Title: Name Suffix

  Maximum Length: 540

  The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
• URL: string
  Title: URL

  Maximum Length: 2000

  The uniform resource locator or a website containing information about the organization.
• WomanOwnedIndicator: string
  Title: Woman-Owned Indicator

  Maximum Length: 30

  Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N.
• YearEstablished: integer (int32)
  Title: Year Established

  The year that the organization started it business operations.
• YearIncorporated: integer (int32)
  Title: Year Incorporated

  The year that the business was formally incorporated.

{
    "type":"object",
    "properties":{
        "AccountTeam":{
            "title":"Account Team",
            "type":"array",
            "description":"The account team resource is used to view the team members and territory team members associated with an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountTeam-item-patch-request"
            }
        },
        "PartyNumberKey":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":false
        },
        "SiebelLocation":{
            "title":"Location",
            "maxLength":"50",
            "type":"string",
            "description":"Location of account - optional part of User Primary Key.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SeblUserKeyLoc"
            }
        },
        "Address":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-Address-item-patch-request"
            }
        },
        "YearIncorporated":{
            "title":"Year Incorporated",
            "type":"integer",
            "description":"The year that the business was formally incorporated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"IncorpYear",
                "precision":"4"
            }
        },
        "NamedFlag":{
            "title":"Named Account",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"NamedFlag",
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "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"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"ExportInd"
            }
        },
        "FaxVerificationDate":{
            "title":"Fax Verification Date",
            "type":"string",
            "description":"The date when fax number was last verified for the account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FaxStr"
                ]
            }
        },
        "YearEstablished":{
            "title":"Year Established",
            "type":"integer",
            "description":"The year that the organization started it business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"YearEstablished",
                "precision":"4"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "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-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"CurrencyCode",
                "controlType":"choice"
            }
        },
        "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":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddressEstimation",
                "controlType":"choice"
            }
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"A user-defined code to indicate a mail drop point within their organization.",
            "nullable":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-hints":{
                "PrimaryAttributeName":"ParentDUNSNumberC"
            }
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the organization in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "ParentAccountPartyId":{
            "title":"Parent Account ID",
            "type":"integer",
            "description":"The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference.",
            "nullable":true,
            "x-hints":{
                "AltLabel":"Parent Company"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact of the account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "AltLabel":"Primary Contact"
            }
        },
        "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":{
                "PrimaryAttributeName":"PreferredContactMethod",
                "controlType":"choice"
            }
        },
        "DomesticUltimateDatafoxId":{
            "title":"Domestic Ultimate DataFox Id",
            "maxLength":"30",
            "type":"string",
            "description":"The DataFox Company identifier of the Domestic Ultimate for the account, which is the highest family member in the same country as this business entity. A subject may be its own Domestic Ultimate.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DomesticUltimateDatafoxId"
            }
        },
        "MinorityOwnedType":{
            "title":"Type of Minority-Owned Organization",
            "maxLength":"30",
            "type":"string",
            "description":"The type of minority-owned firm.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"MinorityOwnedType"
            }
        },
        "CEOName":{
            "title":"Chief Executive Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization???s chief executive officer.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CeoName"
            }
        },
        "AnalysisFiscalYear":{
            "title":"Analysis Year",
            "maxLength":"5",
            "type":"string",
            "description":"The fiscal year used as the source for financial information.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AnalysisFy"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"MinorityOwnedInd"
            }
        },
        "BusinessScope":{
            "title":"Business Scope",
            "maxLength":"20",
            "type":"string",
            "description":"The class of business to which the account belongs, such as local, national, or international.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"BusinessScope"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"DomesticUltimateDUNSNumberC"
            }
        },
        "PrincipalName":{
            "title":"Principal Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the highest ranking person in the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PrincipalName"
            }
        },
        "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":{
                "PrimaryAttributeName":"CertificationLevel",
                "controlType":"choice"
            }
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact point for the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension to the phone number of the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            }
        },
        "AddressLine3":{
            "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"
            }
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "type":"string",
            "description":"The party number of the primary contact of the account.",
            "nullable":true
        },
        "RentOrOwnIndicator":{
            "title":"Rent or Own Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"RentOwnInd",
                "controlType":"choice"
            }
        },
        "AddressLine2":{
            "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"
            }
        },
        "AddressLine1":{
            "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"
            }
        },
        "CustomerClassification":{
            "title":"Aux Classifications",
            "type":"array",
            "description":"The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
            "items":{
                "$ref":"#/components/schemas/accounts-CustomerClassification-item-patch-request"
            }
        },
        "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":{
                "PrimaryAttributeName":"OrganizationSize",
                "controlType":"choice"
            }
        },
        "ControlYear":{
            "title":"Organization Control Year",
            "type":"number",
            "description":"The year when current ownership gained control of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"ControlYr"
            }
        },
        "LocalActivityCode":{
            "title":"Local Activity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The local activity classification code.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"LocalActivityCode"
            }
        },
        "AddressLine4":{
            "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"
            }
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-Note-item-patch-request"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
                ]
            }
        },
        "LastEnrichmentDate":{
            "title":"Last Enrichment Date",
            "type":"string",
            "description":"The date when the record was last enriched.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"LastEnrichmentDate"
            }
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Short description for the company.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Description"
            }
        },
        "CertificationReasonCode":{
            "title":"Certification Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CertReasonCode",
                "controlType":"choice"
            }
        },
        "AdditionalName":{
            "title":"Additional Names",
            "type":"array",
            "description":"The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.",
            "items":{
                "$ref":"#/components/schemas/accounts-AdditionalName-item-patch-request"
            }
        },
        "SalesProfileNumber":{
            "title":"Sales Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The sales profile number.",
            "nullable":false
        },
        "FaxVerificationStatus":{
            "title":"Fax Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the verification of fax number for the account. The values based on lookup are valid and invalid for fax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FaxStr"
                ]
            }
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "type":"string",
            "description":"The organization type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessReport":{
            "title":"D&B Business Report",
            "type":"string",
            "description":"The Dun & Bradstreet business information report.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"BusinessReport"
            }
        },
        "URL":{
            "title":"URL",
            "maxLength":"2000",
            "type":"string",
            "description":"The uniform resource locator or a website containing information about the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"WebEO.Url",
                "AltLabel":"Website",
                "protectionObjectTitle":"URL",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"URL"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"WomanOwnedInd"
            }
        },
        "AdditionalIdentifier":{
            "title":"Additional Identifier",
            "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/accounts-AdditionalIdentifier-item-patch-request"
            }
        },
        "ContactPoint":{
            "title":"Contact Points",
            "type":"array",
            "description":"The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.",
            "items":{
                "$ref":"#/components/schemas/accounts-ContactPoint-item-patch-request"
            }
        },
        "FavoriteAccountFlag":{
            "title":"Favorite",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates if the account is a favorite.  The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FaxExtension":{
            "title":"Fax Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension to the fax number of the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"OobInd"
            }
        },
        "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
        },
        "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-hints":{
                "PrimaryAttributeName":"SmallBusInd"
            }
        },
        "ParentAccountSourceSystemReferenceValue":{
            "title":"Parent Account Source System Reference",
            "type":"string",
            "description":"The source system reference of the parent account within the hierarchy.",
            "nullable":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-hints":{
                "PrimaryAttributeName":"GlobalUltimateDUNSNumberC"
            }
        },
        "OwnerPartyId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the sales account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"OwnerPartyId",
                "precision":"18",
                "AltLabel":"Owner"
            }
        },
        "EmployeesTotal":{
            "title":"Number of Employees",
            "type":"number",
            "description":"The total number of employees in the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"EmployeesTotal",
                "precision":"18"
            }
        },
        "GrowthStrategyDescription":{
            "title":"Growth Strategy Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-defined description of growth strategy.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"GrowthStrategyDescription"
            }
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SalesProfileType",
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "ParentAccountPartyNumber":{
            "title":"Parent Account Registry ID",
            "type":"string",
            "description":"The party number of the parent account within the hierarchy.",
            "nullable":true
        },
        "PrimaryContactSourceSystemReferenceValue":{
            "title":"Primary Contact Source System Reference",
            "type":"string",
            "description":"The unique identifier for the account's primary contact as specified in the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "Relationship":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.",
            "items":{
                "$ref":"#/components/schemas/accounts-Relationship-item-patch-request"
            }
        },
        "MissionStatement":{
            "title":"Mission Statement",
            "maxLength":"2000",
            "type":"string",
            "description":"The corporate charter of organization in user-defined text format.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"MissionStatement"
            }
        },
        "LineOfBusiness":{
            "title":"Line of Business",
            "maxLength":"240",
            "type":"string",
            "description":"The type of business activities performed at this site.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"LineOfBusiness"
            }
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the organization in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "TotalEmployeesIndicator":{
            "title":"Number of Employees Includes Subsidiaries",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if 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":{
                "PrimaryAttributeName":"TotalEmployeesInd",
                "controlType":"choice"
            }
        },
        "AddressType":{
            "title":"Address Type",
            "type":"string",
            "description":"Additional information as type of address like BillTo, ShipTo.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":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-hints":{
                "PrimaryAttributeName":"LocalBusIdentifier"
            }
        },
        "FaxCountryCode":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a fax number, such as 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"JgzzFiscalCode"
            }
        },
        "Attachment":{
            "title":"Account Attachments",
            "type":"array",
            "description":"The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-Attachment-item-patch-request"
            }
        },
        "EmailFormat":{
            "title":"Email Format",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred format for e-mail addressed to this organization, such as HTML or ASCII.",
            "nullable":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-hints":{
                "PrimaryAttributeName":"LaborSurplusInd"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-smartActions-item-patch-request"
            }
        },
        "AccountHierarchySummary":{
            "title":"Account Hierarchy",
            "type":"array",
            "description":"The account hierarchy summaries resource is used to view the account hierarchy information.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountHierarchySummary-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "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-hints":{
                "PrimaryAttributeName":"CorporationClass"
            }
        },
        "DatafoxCompanyId":{
            "title":"DataFox Company ID",
            "maxLength":"30",
            "type":"string",
            "description":"Datafox Company Identifier.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DatafoxCompanyId"
            }
        },
        "AccountRollup":{
            "title":"Account Rollups",
            "type":"array",
            "description":"The account rollups resource is used to view, create, update, and delete an account rollup.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountRollup-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "ParentAccountSourceSystem":{
            "title":"Parent Source System",
            "type":"string",
            "description":"The source system of the parent account within the hierarchy.",
            "nullable":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-hints":{
                "PrimaryAttributeName":"NextFyPotentialRevenueAmount"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"Disadv8aInd"
            }
        },
        "LocalActivityCodeType":{
            "title":"Local Activity Code Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the local activity classification code.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"LocalActivityCodeType"
            }
        },
        "SalesProfileStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"A valid user-defined status of the sales account.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SalesProfileStatus",
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "TotalEmployeesEstimatedIndicator":{
            "title":"Number of Employees Estimated Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"TotalEmployeesEstimatedIndicator",
                "controlType":"choice"
            }
        },
        "TotalEmployeesText":{
            "title":"Total Number of Employees",
            "maxLength":"60",
            "type":"string",
            "description":"The total number of employees in text format.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"TotalEmployeesText"
            }
        },
        "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"
                ]
            }
        },
        "AccountContact":{
            "title":"Organization Contacts",
            "type":"array",
            "description":"The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-item-patch-request"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The application module that created the account record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "IndustryCode":{
            "title":"Primary Industry",
            "type":"string",
            "description":"The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AltLabel":"Industry"
            }
        },
        "ParentOrSubsidiaryIndicator":{
            "title":"Subsidiary Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is a parent or subsidiary.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"ParentSubInd"
            }
        },
        "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":{
                "PrimaryAttributeName":"PreferredFunctionalCurrency",
                "controlType":"combo_lov"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the account.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddressText"
            }
        },
        "AccountScore":{
            "title":"Account Score",
            "type":"integer",
            "description":"Score assigned based on custom criteria by the user.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AccountScore"
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "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":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddressMinimum",
                "controlType":"choice"
            }
        },
        "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"
                ]
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"ImportInd"
            }
        },
        "EmployeesAtPrimaryAddress":{
            "title":"Employees at Primary 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-hints":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddress"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "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"
            }
        },
        "GlobalUltimateDatafoxId":{
            "title":"Global Ultimate DataFox Id",
            "maxLength":"30",
            "type":"string",
            "description":"The DataFox Company identifier of the Global Ultimate for the account, which is the highest family member globally across countries as this business entity as you walk up this branch of the tree. A case may be its own Global Ultimate.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"GlobalUltimateDatafoxId"
            }
        },
        "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"
            }
        },
        "CEOTitle":{
            "title":"Chief Executive Title",
            "maxLength":"240",
            "type":"string",
            "description":"The formal title of the chief executive officer.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CeoTitle"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"UniqueNameSuffix"
            }
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "SalesTeamMember":{
            "title":"Account Resources",
            "type":"array",
            "description":"Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
            "items":{
                "$ref":"#/components/schemas/accounts-SalesTeamMember-item-patch-request"
            }
        },
        "RawPhoneNumber":{
            "title":"Raw Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The unformatted phone number of the organization.",
            "nullable":true,
            "x-hints":{
                "AltLabel":"Phone"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"CurrentFiscalYearPotentialRevenueAmount"
            }
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the account.",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"OrganizationName"
            }
        },
        "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":{
                "PrimaryAttributeName":"LocalBusIdenType",
                "controlType":"choice"
            }
        },
        "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":{
                "PrimaryAttributeName":"HQBranchIndicator",
                "controlType":"choice"
            }
        },
        "PrimaryAddress":{
            "title":"Primary Addresses",
            "type":"array",
            "description":"The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-PrimaryAddress-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "FaxAreaCode":{
            "title":"Fax Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code for the fax number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":"2000",
            "type":"string",
            "description":"List of the top keywords of the company.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Keywords"
            }
        },
        "DoNotConfuseWith":{
            "title":"Don't Confuse With",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates that there is an organization that is similarly named.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DoNotConfuseWith"
            }
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":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":{
                "PrimaryAttributeName":"FiscalYearendMonth",
                "controlType":"choice"
            }
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":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-hints":{
                "PrimaryAttributeName":"DUNSNumberC"
            }
        },
        "StockSymbol":{
            "title":"Stock Symbol",
            "maxLength":"20",
            "type":"string",
            "description":"The corporate stock symbol of the organization as listed in stock exchanges.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"StockSymbol"
            }
        },
        "CongressionalDistrictCode":{
            "title":"Congressional District",
            "maxLength":"2",
            "type":"string",
            "description":"The U.S. Congressional district code for the account.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CongDistCode"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "PrimaryContactSourceSystem":{
            "title":"Primary Contact Source System",
            "type":"string",
            "description":"The name of external source system where the primary contact of the account is imported from.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "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,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"PublicPrivateOwnershipFlag"
            }
        },
        "AddressTypeList":{
            "title":"Address Type",
            "type":"string",
            "description":"The address type as a list.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "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,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"GSAIndicatorFlag"
            }
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a telephone number, such as 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code for the telephone number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "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":{
                "PrimaryAttributeName":"DataCloudStatus",
                "controlType":"choice"
            }
        },
        "SourceSystemReference":{
            "title":"Source System References",
            "type":"array",
            "description":"The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.",
            "items":{
                "$ref":"#/components/schemas/accounts-SourceSystemReference-item-patch-request"
            }
        },
        "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":{
                "PrimaryAttributeName":"RegistrationType",
                "controlType":"choice"
            }
        },
        "AccountExtensionBase":{
            "title":"Account Extension Bases",
            "type":"array",
            "description":"The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountExtensionBase-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "AccountScoringTier":{
            "title":"Account Scoring Tier",
            "maxLength":"30",
            "type":"string",
            "description":"Tier assigned based on custom criteria by the user.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AccountScoringTier"
            }
        },
        "HomeCountry":{
            "title":"Home Country",
            "maxLength":"2",
            "type":"string",
            "description":"The home country of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"HomeCountry",
                "controlType":"choice"
            }
        },
        "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":{
                "PrimaryAttributeName":"LegalStatus",
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The corporate charter of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Comments"
            }
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"OrganizationType"
            }
        },
        "SourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true
        },
        "PrincipalTitle":{
            "title":"Principal Title",
            "maxLength":"240",
            "type":"string",
            "description":"The title of the highest ranking person in the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PrincipalTitle"
            }
        },
        "DUNSCreditRating":{
            "title":"D&B Credit Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The Dun & Bradstreet credit rating.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DbRating"
            }
        },
        "TotalEmployeesMinimumIndicator":{
            "title":"Number of Employees Minimum Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"TotalEmployeesMinimumIndicator",
                "controlType":"choice"
            }
        },
        "RawFaxNumber":{
            "title":"Raw Fax Number",
            "maxLength":"60",
            "type":"string",
            "description":"The unformatted fax number of the organization.",
            "nullable":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"
                ]
            }
        }
    }
}

Nested Schema : Organization Contacts

Type: array

Title: Organization Contacts

The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.

Show Source

• Array of: object schema

{
    "title":"Organization Contacts",
    "type":"array",
    "description":"The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-item-patch-request"
    }
}

Nested Schema : Account Extension Bases

Type: array

Title: Account Extension Bases

The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.

Show Source

• Array of: object schema

{
    "title":"Account Extension Bases",
    "type":"array",
    "description":"The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountExtensionBase-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Account Hierarchy

Type: array

Title: Account Hierarchy

The account hierarchy summaries resource is used to view the account hierarchy information.

Show Source

• Array of: object accounts-AccountHierarchySummary-item-patch-request

{
    "title":"Account Hierarchy",
    "type":"array",
    "description":"The account hierarchy summaries resource is used to view the account hierarchy information.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountHierarchySummary-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Account Rollups

Type: array

Title: Account Rollups

The account rollups resource is used to view, create, update, and delete an account rollup.

Show Source

• Array of: object accounts-AccountRollup-item-patch-request

{
    "title":"Account Rollups",
    "type":"array",
    "description":"The account rollups resource is used to view, create, update, and delete an account rollup.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountRollup-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Account Team

Type: array

Title: Account Team

The account team resource is used to view the team members and territory team members associated with an account.

Show Source

• Array of: object accounts-AccountTeam-item-patch-request

{
    "title":"Account Team",
    "type":"array",
    "description":"The account team resource is used to view the team members and territory team members associated with an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountTeam-item-patch-request"
    }
}

Nested Schema : Additional Identifier

Type: array

Title: Additional Identifier

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

Show Source

• Array of: object accounts-AdditionalIdentifier-item-patch-request

{
    "title":"Additional Identifier",
    "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/accounts-AdditionalIdentifier-item-patch-request"
    }
}

Nested Schema : Additional Names

Type: array

Title: Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Show Source

• Array of: object schema

{
    "title":"Additional Names",
    "type":"array",
    "description":"The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.",
    "items":{
        "$ref":"#/components/schemas/accounts-AdditionalName-item-patch-request"
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.

Show Source

• Array of: object schema

{
    "title":"Addresses",
    "type":"array",
    "description":"The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-Address-item-patch-request"
    }
}

Nested Schema : Account Attachments

Type: array

Title: Account Attachments

The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.

Show Source

• Array of: object schema

{
    "title":"Account Attachments",
    "type":"array",
    "description":"The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-Attachment-item-patch-request"
    }
}

Nested Schema : Contact Points

Type: array

Title: Contact Points

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

Show Source

• Array of: object accounts-ContactPoint-item-patch-request

{
    "title":"Contact Points",
    "type":"array",
    "description":"The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.",
    "items":{
        "$ref":"#/components/schemas/accounts-ContactPoint-item-patch-request"
    }
}

Nested Schema : Aux Classifications

Type: array

Title: Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Show Source

• Array of: object schema

{
    "title":"Aux Classifications",
    "type":"array",
    "description":"The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
    "items":{
        "$ref":"#/components/schemas/accounts-CustomerClassification-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.

Show Source

• Array of: object schema

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-Note-item-patch-request"
    }
}

Nested Schema : Primary Addresses

Type: array

Title: Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.

Show Source

• Array of: object accounts-PrimaryAddress-item-patch-request

{
    "title":"Primary Addresses",
    "type":"array",
    "description":"The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-PrimaryAddress-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.

Show Source

• Array of: object schema

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.",
    "items":{
        "$ref":"#/components/schemas/accounts-Relationship-item-patch-request"
    }
}

Nested Schema : Account Resources

Type: array

Title: Account Resources

Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Show Source

• Array of: object schema

{
    "title":"Account Resources",
    "type":"array",
    "description":"Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
    "items":{
        "$ref":"#/components/schemas/accounts-SalesTeamMember-item-patch-request"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object accounts-smartActions-item-patch-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-smartActions-item-patch-request"
    }
}

Nested Schema : Source System References

Type: array

Title: Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Show Source

• Array of: object schema

{
    "title":"Source System References",
    "type":"array",
    "description":"The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.",
    "items":{
        "$ref":"#/components/schemas/accounts-SourceSystemReference-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account Party ID

  The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
• AccountPartyNumber: string
  Title: Account Party Number

  Maximum Length: 30

  The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
• AccountSourceSystem: string
  Title: Account Source System

  The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
• AccountSourceSystemReferenceValue: string
  Title: Account Source System Reference

  The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The comments of the user.
• ContactNumber: string
  Title: Contact Number

  Maximum Length: 30

  The user-defined identification number for this contact.
• ContactPartyNumber: string
  Title: Contact Party Number

  Maximum Length: 30

  The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
• ContactSourceSystem: string
  Title: Contact Source System

  The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
• ContactSourceSystemReferenceValue: string
  Title: Contact Source System Reference

  The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
• DecisionMakerFlag: boolean
  Title: Decision Maker

  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
• Department: string
  Title: Department

  Maximum Length: 60

  The free form text used to name the department for the contact.
• DepartmentCode: string
  Title: Department Code

  Maximum Length: 30

  The value of the department code for the contact.
• InfluenceLevelCode: string
  Title: Influence Level

  Maximum Length: 30

  The contact's level of influence in the buying process.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The free form text for job title for the contact associated to an account.
• JobTitleCode: string
  Title: Job Title Code

  Maximum Length: 30

  The value of the code for the job title of the contact person.
• PreferredContactFlag: boolean
  Title: Preferred Contact

  Maximum Length: 10

  Default Value: false

  Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
• PrimaryCustomerFlag: boolean
  Title: Primary Customer

  Maximum Length: 10

  Default Value: false

  Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
• ReferenceUseFlag: boolean
  Title: Reference

  Maximum Length: 1

  Default Value: false

  Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
• RelationshipSourceSystem: string
  Title: Relationship Source System

  The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
• RelationshipSourceSystemReferenceValue: string
  Title: Relationship Source System Reference

  The identifier for the relationship with the external source system.
• SalesAffinityCode: string
  Title: Affinity

  Maximum Length: 30

  The contact's affinity for the deploying organization.
• SalesAffinityComments: string
  Title: Affinity Comments

  Maximum Length: 2000

  The comments describing the contact's affinity for the deploying organization.
• SalesBuyingRoleCode: string
  Title: Buying Role

  Maximum Length: 30

  The contact's role in the buying process.
• Status: string
  Maximum Length: 1

  Default Value: A

  Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.

{
    "type":"object",
    "properties":{
        "ReferenceUseFlag":{
            "title":"Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.",
            "nullable":true,
            "default":false
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title for the contact associated to an account.",
            "nullable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false
        },
        "AccountSourceSystem":{
            "title":"Account Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            }
        },
        "Department":{
            "title":"Department",
            "maxLength":"60",
            "type":"string",
            "description":"The free form text used to name the department for the contact.",
            "nullable":true
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "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"
                ]
            }
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-defined identification number for this contact.",
            "nullable":true
        },
        "AccountPartyId":{
            "title":"Account Party ID",
            "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"
            }
        },
        "DepartmentCode":{
            "title":"Department Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the department code for the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.",
            "nullable":false,
            "default":"A"
        },
        "DecisionMakerFlag":{
            "title":"Decision Maker",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.",
            "nullable":true,
            "default":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments of the user.",
            "nullable":true
        },
        "SalesAffinityComments":{
            "title":"Affinity Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments describing the contact's affinity for the deploying organization.",
            "nullable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            }
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            }
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact 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-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            }
        },
        "PrimaryCustomerFlag":{
            "title":"Primary Customer",
            "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
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's role in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            }
        },
        "JobTitleCode":{
            "title":"Job Title Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the code for the job title of the contact person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's level of influence in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountSourceSystemReferenceValue":{
            "title":"Account 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-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  The user who created the object record.
• CreationDate: string (date-time)
  The date when the record was created.
• LastUpdateDate: string (date-time)
  The date when the record was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  The user who last updated the record.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ParentId: integer (int64)
  The identifier for the foreign key to parent.
• RecordName: string
  Title: Record Name

  Maximum Length: 80

  The name of the object record.
• RowType: string
  Maximum Length: 30

  The identifier of the custom extension object row.

{
    "type":"object",
    "properties":{
        "RecordName":{
            "title":"Record Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the object record.",
            "nullable":true
        },
        "ParentId":{
            "type":"integer",
            "description":"The identifier for the foreign key to parent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the object record.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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"
            }
        },
        "RowType":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the custom extension object row.",
            "nullable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false
        }
    }
}

Nested Schema : accounts-AccountHierarchySummary-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : accounts-AccountRollup-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : accounts-AccountTeam-item-patch-request

Type: object

Show Source

• AccountTeamId: integer (int64)
  The unique key to identify the account team member.
• AddedOnDateTime: string (date-time)
  Title: Joining Date

  The date when the account team member was created based on either the date the resource was added to the account resource or the date the territory was added to account territory.
• PartyId: integer (int64)
  The unique identifier of the account.
• ResourceId: integer (int64)
  The unique identifier of the resource party associated with the account team.
• SalesProfileId: integer (int64)
  The unique identifier of the sales account.
• TerritoryVersionId: integer
  The unique identifier of the territory version for the resource that got assigned to the account through territory-based assignment.

{
    "type":"object",
    "properties":{
        "AddedOnDateTime":{
            "title":"Joining Date",
            "type":"string",
            "description":"The date when the account team member was created based on either the date the resource was added to the account resource or the date the territory was added to account territory.",
            "format":"date-time",
            "nullable":true
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version for the resource that got assigned to the account through territory-based assignment.",
            "nullable":true
        },
        "SalesProfileId":{
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource party associated with the account team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccountTeamId":{
            "type":"integer",
            "description":"The unique key to identify the account team member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : accounts-AdditionalIdentifier-item-patch-request

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.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the additional identifier.
• ExpirationDate: string (date)
  Title: Expiration Date

  The date when the additional identifier will expire.
• IssueDate: string (date)
  Title: Issue Date

  The date when the additional identifier was issued.
• IssuingAuthorityName: string
  Title: Issuing Authority Name

  Maximum Length: 500

  The name of the issuing authority of the additional identifier.
• IssuingAuthorityPartyId: integer (int64)
  The unique identifier of the issuing authority party.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyIdentifierType: string
  Title: Identifier Type

  Maximum Length: 30

  The type of party identifier.
• PartyIdentifierValue: string
  Title: Identifier Value

  Maximum Length: 60

  The value of the party identifier.
• PartyNumber: string
  The party number. Inactive records can't be updated.
• PartySourceSystem: string
  The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
• PartySourceSystemReferenceValue: string
  The identifier for the record from an external source system.
• SourceSystem: string
  The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
• SourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• StateProvince: string
  Title: Issuing State

  Maximum Length: 60

  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":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the additional identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "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":"Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.",
            "nullable":true
        },
        "PartyIdentifierValue":{
            "title":"Identifier Value",
            "maxLength":"60",
            "type":"string",
            "description":"The value of the party identifier.",
            "nullable":false
        },
        "IssuingAuthorityName":{
            "title":"Issuing Authority Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the issuing authority of the additional identifier.",
            "nullable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the additional identifier was issued.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "IssuingAuthorityPartyId":{
            "type":"integer",
            "description":"The unique identifier of the issuing authority party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCode":{
            "maxLength":"1",
            "type":"string",
            "description":"The status code of the additional identifier.",
            "nullable":false,
            "default":"A"
        },
        "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"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
        },
        "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
        }
    }
}

Nested Schema : schema

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.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the Additional Name record
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name associated with the record.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name associated with the record.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name associated with the record.
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
• PartySourceSystem: string
  The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
• PartySourceSystemReferenceValue: string
  The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
• PreferredFlag: boolean
  Title: Preferred Indicator

  Maximum Length: 1

  Default Value: false

  Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.
• SourceSystem: string
  The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if the additional name is currently active.
• Title: string
  Title: Title

  Maximum Length: 60

  A professional or family title, such as Don or The Right Honorable
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the Additional Name record",
            "nullable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable",
            "nullable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the additional name is currently active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"TransliterationLanguage 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"
            }
        },
        "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
        },
        "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
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 240

  The first line for address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
• AddressLocale: array Address Locales
  Title: Address Locales

  The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
• AddressPurpose: array Address Purposes
  Title: Address Purposes

  The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
• AddressType: string
  Title: Type

  The type of address.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the address.
• CalculateFormattedAddress: boolean
  The formatted address.
• City: string
  Title: City

  Maximum Length: 60

  The city in the address.
• ClliCode: string
  Title: CLLI Code

  Maximum Length: 60

  The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the address.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• CorpCurrencyCode: string
  Title: Corporate Currency

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

  The county of the address.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreatedByModule1: string
  Title: Created by Application

  Maximum Length: 30

  The user who created the module.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DateValidated: string (date)
  Title: Validated Date

  The date when the address was last validated.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the location.
• DoNotMailFlag: boolean
  Title: Contact Preferences

  Default Value: false

  Indicates whether the address should not be used for mailing.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
• DunsNumberC: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The D-U-N-S number of the business location.
• EffectiveDate: string (date)
  The date when the address becomes active.
• EndDateActive: string (date)
  Title: End Date

  The date after which the address becomes inactive.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the address.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• Latitude: number
  Title: Latitude

  The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the address location.
• LocationId: integer (int64)
  Title: Location ID

  The unique identifier for the location.
• Longitude: number
  Title: Longitude

  The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumber1: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the account associated with the address.
• PartyNumber: string
  Title: Party Number

  The unique alternate identifier for the account associated with the address. Inactive records can't be updated.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  User-defined name for the address.
• PartySourceSystem: string
  Title: Party Source System

  The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code for the address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• SourceSystem: string
  The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
• State: string
  Title: State

  Maximum Length: 60

  The state of the address.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
• ValidationStatusCode: string
  Title: Validation Status

  Maximum Length: 30

  The code indicating the status of the validation. Internally set by system during address cleansing.

{
    "type":"object",
    "properties":{
        "AddressPurpose":{
            "title":"Address Purposes",
            "type":"array",
            "description":"The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.",
            "items":{
                "$ref":"#/components/schemas/accounts-Address-AddressPurpose-item-patch-request"
            }
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":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
        },
        "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"
            }
        },
        "AddressLocale":{
            "title":"Address Locales",
            "type":"array",
            "description":"The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.",
            "items":{
                "$ref":"#/components/schemas/accounts-Address-AddressLocale-item-patch-request"
            }
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "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
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":"60",
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.",
            "nullable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":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
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"User-defined name for the address.",
            "nullable":true
        },
        "CreatedByModule":{
            "type":"string",
            "description":"The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates whether the address should not be used for mailing.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A"
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date after which the address becomes inactive.",
            "format":"date",
            "nullable":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 for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the address.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.",
            "nullable":false,
            "default":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "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"
            }
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":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
        },
        "CreatedByModule1":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"The user who created the module.",
            "nullable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the address was last validated.",
            "format":"date",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the address.",
            "nullable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The unique alternate identifier for the account associated with the address. Inactive records can't be updated.",
            "nullable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The type of address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"The date when the address  becomes active.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : Address Locales

Type: array

Title: Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Show Source

• Array of: object schema

{
    "title":"Address Locales",
    "type":"array",
    "description":"The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.",
    "items":{
        "$ref":"#/components/schemas/accounts-Address-AddressLocale-item-patch-request"
    }
}

Nested Schema : Address Purposes

Type: array

Title: Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Show Source

• Array of: object accounts-Address-AddressPurpose-item-patch-request

{
    "title":"Address Purposes",
    "type":"array",
    "description":"The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.",
    "items":{
        "$ref":"#/components/schemas/accounts-Address-AddressPurpose-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Address Element Attribute 1

  Maximum Length: 150

  The additional address element 1 to support flexible address format in local language.
• AddrElementAttribute2: string
  Title: Address Element Attribute 2

  Maximum Length: 150

  The additional address element 2 to support flexible address format in local language.
• AddrElementAttribute3: string
  Title: Address Element Attribute 3

  Maximum Length: 150

  The additional address element 3 to support flexible address format in local language.
• AddrElementAttribute4: string
  Title: Address Element Attribute 4

  Maximum Length: 150

  The additional address element 4 to support flexible address format in local language.
• AddrElementAttribute5: string
  Title: Address Element Attribute 5

  Maximum Length: 150

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

  Maximum Length: 240

  The first line of the address in the local language.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address in the local language.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the address in the local language.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address in the local language.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address in local language.
• City: string
  Title: City

  Maximum Length: 60

  The specific name of the city in local language.
• County: string
  Title: County

  Maximum Length: 60

  The specific name of the county in local language.
• FloorNumber: string
  Title: Floor

  Maximum Length: 240

  The specific floor number at a given address or a particular building when building number is provided in local language.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
• PostalPlus4code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code in local language.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province in local language.
• SiteSourceSystem: string
  The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the State in the local language.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address in local language.",
            "nullable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "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 in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"240",
            "type":"string",
            "description":"The specific floor number at a given address or a particular building when building number is provided in local language.",
            "nullable":true
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddrElementAttribute5":{
            "title":"Address Element Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 5 to support flexible address format in local language.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the city in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AddrElementAttribute1":{
            "title":"Address Element Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 1 to support flexible address format in local language.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Address Element Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 2 to support flexible address format in local language.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the county in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddrElementAttribute3":{
            "title":"Address Element Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 3 to support flexible address format in local language.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "AddrElementAttribute4":{
            "title":"Address Element Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 4 to support flexible address format in local language.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the State in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        }
    }
}

Nested Schema : accounts-Address-AddressPurpose-item-patch-request

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user comments for the address purpose.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: HZ_WS

  The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
• DeleteFlag: boolean
  Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
• EndDate: string (date)
  Title: To Date

  The date on which the address purpose is no longer valid.
• PrimaryPerType: string
  Title: Primary

  Maximum Length: 1

  Default Value: N

  Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
• SiteSourceSystem: string
  The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SourceSystem: string
  The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
• SourceSystemReferenceValue: string
  The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.",
            "nullable":false,
            "default":"A"
        },
        "SiteSourceSystem":{
            "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":false
        },
        "SiteSourceSystemReferenceValue":{
            "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":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments for the address purpose.",
            "nullable":true
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "default":"HZ_WS"
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date on which the address purpose is no longer valid.",
            "format":"date",
            "nullable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the address purpose is to be deleted. If the value  is Y, then the address purpose has to be deleted. The default value is N.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryPerType":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.",
            "nullable":false,
            "default":"N"
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attached file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attached 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. The default value is false.",
            "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"
            }
        },
        "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"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, if any, for 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"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length 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 current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : accounts-ContactPoint-item-patch-request

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The unique identifier of the conflict.
• CreatedByModule: string
  Title: Created by Application

  Default Value: HZ_WS

  The user who created the module.
• DoContactPreferenceFlag: boolean
  Title: OK to Contact

  Indicates whether to use a particular contact method. Defaulted to false.
• DoNotContactPreferenceFlag: boolean
  Title: Do Not Contact

  The contact preference flag that indicates DNC option.
• DoNotContactReason: string
  Title: Do Not Contact Reason

  The reason code for the contact preference.
• EmailAddress: string
  Title: Email

  Maximum Length: 255

  The email address of the contact point.
• EmailPurpose: string
  Title: Email Purpose

  Maximum Length: 30

  The purpose of the email.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party.
• PartyNumber: string
  Title: Registry ID

  The party number. Inactive records can't be updated.
• PartySourceSystem: string
  Title: Party Source System

  The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The unique identifier of the relationship from external source system.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 255

  The area code for the telephone number.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 255

  The country code of the phone number.
• PhoneExtension: string
  Title: Extension

  Maximum Length: 255

  The extension number of the phone line number like office desk extension.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The phone number of the contact point.
• PhonePurpose: string
  Title: Phone Purpose

  Maximum Length: 30

  Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
• PhoneType: string
  Title: Type

  The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
• PreferenceRequestedBy: string
  Title: Preference Requested By

  Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the phone number is preferred.
• RawPhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The phone number in raw format.
• SocialNetworkId: string
  Title: User ID

  The unique identifier of the social network.
• SocialNetworkName: string
  Title: Social Network

  The name of the social network.
• SocialNetworkPurpose: string
  Title: Social Network Purpose

  Maximum Length: 30

  Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
• SourceSystem: string
  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 aren't verified.
• WebPurpose: string
  Title: Web Purpose

  Maximum Length: 30

  Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.

{
    "type":"object",
    "properties":{
        "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 aren't verified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
                ]
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the phone number is preferred.",
            "nullable":true,
            "default":false
        },
        "SocialNetworkId":{
            "title":"User ID",
            "type":"string",
            "description":"The unique identifier of the social network.",
            "nullable":true,
            "x-hints":{
                "Property":"Social Network Account"
            }
        },
        "URL":{
            "title":"URL",
            "type":"string",
            "description":"The URL associated with the contact point.",
            "nullable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"255",
            "type":"string",
            "description":"The country code of the phone number.",
            "nullable":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"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The user who created the module.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the contact point.",
            "nullable":false,
            "default":"A"
        },
        "SocialNetworkPurpose":{
            "title":"Social Network Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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":"Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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. Defaulted to false.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"255",
            "type":"string",
            "description":"The email address of the contact point.",
            "nullable":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
        },
        "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"
            }
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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":"Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmailPurpose":{
            "title":"Email Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of the email.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The phone number of the contact point.",
            "nullable":true
        },
        "SocialNetworkName":{
            "title":"Social Network",
            "type":"string",
            "description":"The name of the social network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Property":"Social Network"
            }
        },
        "RawPhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The phone number in raw format.",
            "nullable":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
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDateActive: string (date)
  Title: End Date

  The date from which the classification code is no longer valid.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates if the customer classification is the primary classification. The default value is false.
• SourceSystem: string
  Title: Source System

  The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.
• SourceSystemReferenceValue: string
  Title: Source System Reference Value

  The unique identifier for the customer classification in the external source.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.",
            "nullable":true,
            "default":"A"
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date from which the classification code is no longer valid.",
            "format":"date",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the customer classification is the primary classification. The default value is false.",
            "nullable":false,
            "default":false
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the customer classification in the external source.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

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

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique party identifier for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  This is the column which will store the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  This is the note type code for categorization of note.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  This is the attribute to specify the visibility level of the note.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata.",
            "nullable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique party identifier for the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
                ]
            }
        },
        "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
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship that is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true
        }
    }
}

Nested Schema : accounts-PrimaryAddress-item-patch-request

Type: object

Show Source

• Addressee: string
  Title: Addressee

  Maximum Length: 360

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the primary address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the primary address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the primary address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the primary address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

  The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the primary address.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the primary address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the primary address.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the primary address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

  The county of the primary address.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DateValidated: string (date)
  Title: Validated Date

  The date when the primary address was last validated.
• DeleteFlag: boolean
  Title: Delete Primary Address

  Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the location.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates the contact preference to indicate DNC option.
• EndDateActive: string (date)
  Title: To Date

  The last date for a record in active status.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the primary address.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• Latitude: number
  Title: Latitude

  The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
• LocationComments: string
  Title: Comments

  Maximum Length: 2000

  The additional information for the record in free text format.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the address location.
• LocationId: integer (int64)
  The unique identifier for the location.
• LocationIntegrationKey: string
  The integration key for the location record.
• LocationLocationId: integer (int64)
  Title: Location ID

  The system identifier for the location record.
• LocationSourceSystem: string
  The name of source system for the location record.
• LocationSourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• LocationStatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The status flag for location record.
• Longitude: number
  Title: Longitude

  The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ObjectVersionNumberLocation: integer (int32)
  The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumberPartySite: integer (int32)
  The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OverallPrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  The name of the party site.
• PartySiteType: string
  Title: One-Time Address

  Maximum Length: 30

  The type information of the party site.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code for the address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 240

  The brief free text that describes the site record.
• SourceSystem: string
  The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
• State: string
  Title: State

  Maximum Length: 60

  The state of the address.
• Status: string
  Maximum Length: 1

  Default Value: A

  The status of the record.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 64

  The time zone for the location.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
• ValidationStatusCode: string
  Title: Validation Status

  Maximum Length: 30

  The code indicating the status of the validation. Internally set by system during address cleansing.

{
    "type":"object",
    "properties":{
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":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
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"The brief free text that describes the site record.",
            "nullable":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
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the contact preference to indicate DNC option.",
            "nullable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "default":"A"
        },
        "OverallPrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.",
            "nullable":false,
            "default":false
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true
        },
        "LocationLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The system identifier for the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "LocationStatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The status flag for location record.",
            "nullable":false,
            "default":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "DeleteFlag":{
            "title":"Delete Primary Address",
            "type":"boolean",
            "description":"Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.",
            "nullable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "LocationComments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The additional information for the record in free text format.",
            "nullable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a record in active status.",
            "format":"date",
            "nullable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the primary address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the primary address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the primary address.",
            "nullable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The time zone for the location.",
            "nullable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":"30",
            "type":"string",
            "description":"The type information of the party site.",
            "nullable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the primary address was last validated.",
            "format":"date",
            "nullable":true
        },
        "LocationSourceSystem":{
            "type":"string",
            "description":"The name of source system for the location record.",
            "nullable":true
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":"360",
            "type":"string",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the primary address.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocationSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true
        },
        "ObjectVersionNumberPartySite":{
            "type":"integer",
            "description":"The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the relationship.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• DependentFlag: string
  Title: Dependent Indicator

  Maximum Length: 1

  Default Value: N

  Indicates whether one party is a dependent on another.
• EndDate: string (date)
  Title: To Date

  The date when the relationship ends.
• HeadOfHouseholdFlag: string
  Title: Head of Household Indicator

  Maximum Length: 1

  Default Value: N

  Indicates whether a person is the head of the household that he belongs to.
• InfluenceLevel: string
  Title: Influence Level

  The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
• JobDefinitionName: string
  Maximum Length: 100

  The definition of the job name.
• JobDefinitionPackage: string
  Maximum Length: 900

  The definition of the job package.
• ObjectPartyId: integer (int64)
  The unique identifier of the object party in this relationship.
• ObjectPartyNumber: string
  Title: Object Registry ID

  Maximum Length: 30

  The alternate key identifier for the object party of the relationship.
• ObjectSourceSystem: string
  Title: Object Source System

  The name of the external source system for the object party in the relationship.
• ObjectSourceSystemReferenceValue: string
  Title: Object Source System Reference

  The identifier for the object party in the relationship from the external source system.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• PercentageOwnership: number
  Title: Ownership Percentage

  The percentage of the child entity owned by the parent entity.
• PreferredContactFlag: boolean
  Maximum Length: 10

  Default Value: false

  Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
• PrimaryCustomerFlag: boolean
  Maximum Length: 10

  Default Value: false

  Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
• RelationshipSourceSystem: string
  The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
• RelationshipSourceSystemReferenceValue: string
  The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
• RequestId: integer (int64)
  The unique identifier of the request.
• SubjectPartyId: integer (int64)
  The unique identifier of the subject party in this relationship.
• SubjectPartyNumber: string
  Title: Subject Registry ID

  Maximum Length: 30

  The alternate key identifier for the subject party of the relationship.
• SubjectSourceSystem: string
  Title: Subject Source System

  The name of the external source system for the subject party in the relationship.
• SubjectSourceSystemReferenceValue: string
  Title: Subject Source System Reference

  The identifier for the subject party in the relationship from the external source system.

{
    "type":"object",
    "properties":{
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the subject party of the relationship.",
            "nullable":false
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the relationship.",
            "nullable":true
        },
        "JobDefinitionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from the external source system.",
            "nullable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "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"
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the object party in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "JobDefinitionPackage":{
            "maxLength":"900",
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of the external source system for the object party in the relationship.",
            "nullable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the object party of the relationship.",
            "nullable":false
        },
        "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"
            }
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of the external source system for the subject party in the relationship.",
            "nullable":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"
                ]
            }
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subject party in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from the external source system.",
            "nullable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is a dependent on another.",
            "nullable":true,
            "default":"N"
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.
• AssignmentTypeCode: string
  Title: Assignment Type

  Maximum Length: 30

  Default Value: MANUAL

  The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• EndDateActive: string (date)
  Title: Archived Date

  The date when the resource is dissociated from the sales account.
• LockAssignmentFlag: boolean
  Title: Locked

  Maximum Length: 1

  Default Value: false

  Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OwnerFlag: boolean
  Title: Owner

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  The party number. 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 unique identifier of the relationship from external source system.
• ResourceEmailAddress: string
  Title: Resource Email

  The e-mail address of the resource.
• ResourcePartyNumber: string
  Title: Resource Party Number

  The unique public identifier of the resource record.
• StartDateActive: string (date)
  Title: Start Date

  The date when the resource is associated with the sales account.
• TeamMemberId: integer (int64)
  Title: Sales Account Resource ID

  The unique identifier of the member of the sales account resource team.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date on which the record was last updated by a specific user.

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date on which the record was last updated by a specific user.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.",
            "nullable":true,
            "default":"MANUAL",
            "x-queryable":false
        },
        "ResourceEmailAddress":{
            "title":"Resource Email",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "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-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the resource is associated with the sales account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TeamMemberId":{
            "title":"Sales Account Resource ID",
            "type":"integer",
            "description":"The unique identifier of the member of the sales account resource team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDateActive":{
            "title":"Archived Date",
            "type":"string",
            "description":"The date when the resource is dissociated from the sales account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "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-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "type":"string",
            "description":"The unique public identifier of the resource record.",
            "nullable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LockAssignmentFlag":{
            "title":"Locked",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : accounts-smartActions-item-patch-request

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

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• 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

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Indicates whether the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• 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

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/accounts-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/accounts-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":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/accounts-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":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
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

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 accounts-smartActions-UserActionNavigation-item-patch-request

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

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 accounts-smartActions-UserActionRequestPayload-item-patch-request

{
    "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/accounts-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

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 accounts-smartActions-UserActionURLBinding-item-patch-request

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

Nested Schema : accounts-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false
        }
    }
}

Nested Schema : accounts-smartActions-UserActionRequestPayload-item-patch-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true
        }
    }
}

Nested Schema : accounts-smartActions-UserActionURLBinding-item-patch-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        }
    }
}

Nested Schema : schema

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.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• EndDate: string (date)
  The date after which the record is inactive.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
• PartyId: integer (int64)
  The unique identifier of the associated account.
• PartyNumber: string
  Title: Party Number

  The alternate unique identifier of the associated account. Inactive records can't be updated.
• PartySourceSystem: string
  Title: Party Source System

  The source system name for the account.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The identifier for the record from an external source system.
• SourceSystemReferenceValue: string
  Maximum Length: 255

  The source system reference value required to identify the associated account.
• Status: string
  Maximum Length: 1

  Default Value: A

  Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.

{
    "type":"object",
    "properties":{
        "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
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.",
            "nullable":false,
            "default":"A"
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate unique identifier of the associated account. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The source system name for the account.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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
        },
        "EndDate":{
            "type":"string",
            "description":"The date after which the record is inactive.",
            "format":"date",
            "nullable":false
        },
        "SourceSystemReferenceValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The source system reference value required to identify the associated account.",
            "nullable":false
        },
        "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"
            }
        }
    }
}

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 : accounts-item-response

Type: object

Show Source

• AccountContact: array Organization Contacts
  Title: Organization Contacts

  The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.
• AccountExtensionBase: array Account Extension Bases
  Title: Account Extension Bases

  The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.
• AccountHierarchySummary: array Account Hierarchy
  Title: Account Hierarchy

  The account hierarchy summaries resource is used to view the account hierarchy information.
• AccountRollup: array Account Rollups
  Title: Account Rollups

  The account rollups resource is used to view, create, update, and delete an account rollup.
• AccountScore: integer
  Title: Account Score

  Score assigned based on custom criteria by the user.
• AccountScoringTier: string
  Title: Account Scoring Tier

  Maximum Length: 30

  Tier assigned based on custom criteria by the user.
• AccountTeam: array Account Team
  Title: Account Team

  The account team resource is used to view the team members and territory team members associated with an account.
• AdditionalIdentifier: array Additional Identifier
  Title: Additional Identifier

  The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
• AdditionalName: array Additional Names
  Title: Additional Names

  The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.
• Address: array Addresses
  Title: Addresses

  The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 240

  The first line for address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or kana representation of the Kanji address lines (used in Japan).
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

  The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• AddressType: string
  Title: Address Type

  Additional information as type of address like BillTo, ShipTo.
• AddressTypeList: string
  Title: Address Type

  The address type as a list.
• AnalysisFiscalYear: string
  Title: Analysis Year

  Maximum Length: 5

  The fiscal year used as the source for financial information.
• AssignmentExceptionFlag: boolean
  Title: Assignment Exception Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the sales account had the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the dimensions. The default value is False.
• Attachment: array Account Attachments
  Title: Account Attachments

  The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address.
• BusinessReport: string (byte)
  Title: D&B Business Report

  The Dun & Bradstreet business information report.
• BusinessScope: string
  Title: Business Scope

  Maximum Length: 20

  The class of business to which the account belongs, such as local, national, or international.
• CEOName: string
  Title: Chief Executive Name

  Maximum Length: 240

  The name of the organization???s chief executive officer.
• CEOTitle: string
  Title: Chief Executive Title

  Maximum Length: 240

  The formal title of the chief executive officer.
• CertificationLevel: string
  Title: Certification Level

  Maximum Length: 30

  The certification level of the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CertificationReasonCode: string
  Title: Certification Reason

  Maximum Length: 30

  The code indicating the reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the account.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The corporate charter of the organization.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• CongressionalDistrictCode: string
  Title: Congressional District

  Maximum Length: 2

  The U.S. Congressional district code for the account.
• ContactPoint: array Contact Points
  Title: Contact Points

  The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
• ControlYear: number
  Title: Organization Control Year

  The year when current ownership gained control of the organization.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CorporationClass: string
  Title: Corporation Class

  Maximum Length: 60

  The taxation classification for corporation entities such as Chapter S in the US.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Title: County

  Maximum Length: 60

  The county of the primary address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the account record.
• CreatedByModule: string
  Title: Created by Application

  Default Value: HZ_WS

  The application module that created the account record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrentFiscalYearPotentialRevenueAmount: number
  Title: Current Fiscal Year's Potential Revenue

  The estimated revenues that can be earned by the organization during its current fiscal year.
• CustomerClassification: array Aux Classifications
  Title: Aux Classifications

  The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
• DataCloudStatus: string
  Title: Enrichment Status

  Maximum Length: 30

  The enrichment status of the contact record from Data-as-a-Service. A list of valid values are defined in the lookup DATA_CLOUD_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DatafoxCompanyId: string
  Title: DataFox Company ID

  Maximum Length: 30

  Datafox Company Identifier.
• DeleteFlag: boolean
  Title: Delete Account

  Read Only: true

  Indicates if the account can be deleted. If current user has permission to delete the record, delete flag will be true, otherwise the flag will be false.
• Description: string
  Title: Description

  Maximum Length: 2000

  Short description for the company.
• DisadvantageIndicator: string
  Title: Disadvantaged Indicator

  Maximum Length: 30

  Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No.
• DomesticUltimateDatafoxId: string
  Title: Domestic Ultimate DataFox Id

  Maximum Length: 30

  The DataFox Company identifier of the Domestic Ultimate for the account, which is the highest family member in the same country as this business entity. A subject may be its own Domestic Ultimate.
• DomesticUltimateDUNSNumber: string
  Title: Domestic Ultimate D-U-N-S Number

  Maximum Length: 30

  The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate.
• DomesticUltimateFlag: boolean
  Title: Domestic Ultimate Indicator

  Read Only: true

  Default Value: false

  Indicates whether an account is domestic ultimate parent in the hierarchy. Possible values are Yes and No.
• DoNotConfuseWith: string
  Title: Don't Confuse With

  Maximum Length: 255

  Indicates that there is an organization that is similarly named.
• DUNSCreditRating: string
  Title: D&B Credit Rating

  Maximum Length: 5

  The Dun & Bradstreet credit rating.
• DUNSNumber: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The DUNS Number in freeform text format. The value not restricted to nine digit number.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The e-mail address of the contact point for the organization.
• EmailContactPointType: string
  Title: Email Type

  Read Only: true

  Maximum Length: 30

  Default Value: EMAIL

  The type of the email contact.
• EmailFormat: string
  Title: Email Format

  Maximum Length: 30

  The preferred format for e-mail addressed to this organization, such as HTML or ASCII.
• EmailVerificationDate: string (date)
  Title: Email Verification Date

  The date when email address of the account was last verified.
• EmailVerificationStatus: string
  Title: Email Verification Status

  Maximum Length: 30

  The status code of the verification of email address for the account. The values based on the lookup are valid, invalid, or partially invalid for email.
• EmployeesAtPrimaryAddress: string
  Title: Employees at Primary Address

  Maximum Length: 10

  The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• EmployeesAtPrimaryAddressEstimation: string
  Title: Number of Employees at Identifying Address Estimated Qualifier

  Maximum Length: 30

  The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• EmployeesAtPrimaryAddressMinimum: string
  Title: Number of Employees at Identifying Address Minimum Qualifier

  Maximum Length: 30

  The qualifier to qualify calculation of employees at the primary address as minimum.
• EmployeesAtPrimaryAddressText: string
  Title: Employees at Identifying Address

  Maximum Length: 12

  The number of employees at the referenced address in text format.
• EmployeesTotal: number
  Title: Number of Employees

  The total number of employees in the organization.
• EngagementLevel: string
  Title: Engagement Level

  Read Only: true

  An insight from Sales Insights feature set for Accounts that explains the level of interactions with each account.
• ExistingCustomerFlag: boolean
  Title: Existing Sales Account

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates if there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False.
• ExistingCustomerFlagLastUpdateDate: string (date)
  Title: Existing Indicator Last Update Date

  Read Only: true

  The date when the existing customer flag was last updated.
• ExportIndicator: string
  Title: Exporter Indicator

  Maximum Length: 30

  Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N.
• FavoriteAccountFlag: boolean
  Title: Favorite

  Maximum Length: 10

  Default Value: false

  Indicates if the account is a favorite. The default value is false.
• FaxAreaCode: string
  Title: Fax Area Code

  Maximum Length: 20

  The area code for the fax number.
• FaxContactPointType: string
  Title: Fax Type

  Read Only: true

  Maximum Length: 30

  Default Value: PHONE

  The type of contact point for fax.
• FaxCountryCode: string
  Title: Fax Country Code

  Maximum Length: 10

  The international country code for a fax number, such as 33 for France.
• FaxExtension: string
  Title: Fax Extension

  Maximum Length: 20

  The extension to the fax number of the organization.
• FaxNumber: string
  Title: Fax

  Maximum Length: 40

  The fax number of the organization in the local format. The number should not include area code, country code, or extension.
• FaxVerificationDate: string (date)
  Title: Fax Verification Date

  The date when fax number was last verified for the account.
• FaxVerificationStatus: string
  Title: Fax Verification Status

  Maximum Length: 30

  The status code of the verification of fax number for the account. The values based on lookup are valid and invalid for fax.
• FiscalYearendMonth: string
  Title: Fiscal Year End Month

  Maximum Length: 30

  The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  The specific floor number at a given address or in a particular building when building number is provided.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted version of the primary address.
• FormattedFaxNumber: string
  Title: Formatted Fax Number

  Read Only: true

  The formatted phone number of the organization.
• FormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The formatted phone number of the organization.
• GeneralServicesAdministrationFlag: boolean
  Title: GSA Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N.
• GlobalUltimateDatafoxId: string
  Title: Global Ultimate DataFox Id

  Maximum Length: 30

  The DataFox Company identifier of the Global Ultimate for the account, which is the highest family member globally across countries as this business entity as you walk up this branch of the tree. A case may be its own Global Ultimate.
• GlobalUltimateDUNSNumber: string
  Title: Global Ultimate D-U-N-S Number

  Maximum Length: 30

  The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate.
• GlobalUltimateFlag: boolean
  Title: Global Ultimate Indicator

  Read Only: true

  Default Value: false

  Indicates whether an account is global ultimate parent node in the hierarchy. Possible values are Yes and No.
• GrowthStrategyDescription: string
  Title: Growth Strategy Description

  Maximum Length: 2000

  The user-defined description of growth strategy.
• HomeCountry: string
  Title: Home Country

  Maximum Length: 2

  The home country of the organization.
• HQBranchIndicator: string
  Title: HQ Branch Indicator

  Maximum Length: 30

  The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND.
• ImportIndicator: string
  Title: Importer Indicator

  Maximum Length: 30

  Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N.
• Industries: string
  Title: Industries

  Read Only: true

  Indicates the multiple class code meaning values of the industry classification for the account
• IndustryCode: string
  Title: Primary Industry

  The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
• IndustryCodeType: string
  Title: Industry Category

  Read Only: true

  The industry classification category code type. It is defaulted to the value of profile option MOT_INDUSTRY_CLASS_CATEGORY. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
• Keywords: string
  Title: Keywords

  Maximum Length: 2000

  List of the top keywords of the company.
• LaborSurplusIndicator: string
  Title: Labor Surplus Indicator

  Maximum Length: 30

  Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N.
• LastAssignmentDateTime: string (date-time)
  Title: Last Assignment Date Time

  Read Only: true

  The date when the sales account territory assignment was last run by assignment manager.
• LastEnrichmentDate: string (date)
  Title: Last Enrichment Date

  The date when the record was last enriched.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LegalStatus: string
  Title: Legal Status

  Maximum Length: 30

  The legal structure of the organization such as partnership, corporation, and so on.
• LineOfBusiness: string
  Title: Line of Business

  Maximum Length: 240

  The type of business activities performed at this site.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocalActivityCode: string
  Title: Local Activity Code

  Maximum Length: 30

  The local activity classification code.
• LocalActivityCodeType: string
  Title: Local Activity Code Type

  Maximum Length: 30

  The type of the local activity classification code.
• LocalBusinessIdentifier: string
  Title: Common Business Identifier

  Maximum Length: 60

  The unique identifier assigned to a businesses by a government agency such as Chamber of Commerce, or any other authority. It is often used by countries other than USA.
• LocalBusinessIdentifierType: string
  Title: Common Business Identifier Type

  Maximum Length: 30

  The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values are defined in the lookup type LOCAL_BUS_IDEN_TYPE.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization.
• MinorityOwnedIndicator: string
  Title: Minority-Owned Indicator

  Maximum Length: 30

  Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. company is primarily owned by ethnic or racial minorities. The default value is N.
• MinorityOwnedType: string
  Title: Type of Minority-Owned Organization

  Maximum Length: 30

  The type of minority-owned firm.
• MissionStatement: string
  Title: Mission Statement

  Maximum Length: 2000

  The corporate charter of organization in user-defined text format.
• NamedFlag: boolean
  Title: Named Account

  Maximum Length: 1

  Default Value: false

  Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False.
• NextFiscalYearPotentialRevenueAmount: number
  Title: Next Fiscal Year's Potential Revenue

  The estimated revenue of the organization to be earned during its next fiscal year.
• Note: array Notes
  Title: Notes

  The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  The name of the account.
• OrganizationProfileId: integer (int64)
  Title: Organization ID

  Read Only: true

  The unique identifier of the organization profile.
• OrganizationSize: string
  Title: Organization Size

  Maximum Length: 30

  The size of the organization based on its revenue, number of employees, and so on.
• OrganizationType: string
  Title: Organization Type

  Maximum Length: 30

  The type of the organization.
• OrganizationTypeCode: string
  Title: Organization Type Code

  The organization type code.
• OutOfBusinessIndicator: string
  Title: Out of Business Indicator

  Maximum Length: 30

  Indicates whether the organization is out of business. If the value is Y, then the organization is out of business. The default value is N.
• OwnerEmailAddress: string
  Title: Owner Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the employee resource that owns and manages the sales account. The owner is a valid employee resource defined within Engagement Cloud.
• OwnerName: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The name of the employee resource that owns and manages the sales account.
• OwnerPartyId: integer (int64)
  Title: Owner ID

  The unique identifier of a valid employee resource who owns and manages the sales account.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  The party number of a valid employee resource who owns and manages the sales account.
• ParentAccountList: string
  Title: Parent Account List

  Read Only: true

  Maximum Length: 255

  List of all the parent accounts till the top node in the account hierarchy.
• ParentAccountName: string
  Title: Parent Account

  Read Only: true

  The name of the parent account in the hierarchy.
• ParentAccountPartyId: integer
  Title: Parent Account ID

  The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference.
• ParentAccountPartyNumber: string
  Title: Parent Account Registry ID

  The party number of the parent account within the hierarchy.
• ParentAccountSourceSystem: string
  Title: Parent Source System

  The source system of the parent account within the hierarchy.
• ParentAccountSourceSystemReferenceValue: string
  Title: Parent Account Source System Reference

  The source system reference of the parent account within the hierarchy.
• ParentDUNSNumber: string
  Title: Parent D-U-N-S Number

  Maximum Length: 30

  The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company. A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent.
• ParentOrSubsidiaryIndicator: string
  Title: Subsidiary Indicator

  Maximum Length: 30

  Indicates whether the organization is a parent or subsidiary.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the account.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 30

  The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
• PartyNumberKey: string
  Title: Registry ID

  Maximum Length: 30

  The alternate identifier of the party.
• PartyStatus: string
  Read Only: true

  Maximum Length: 1

  Default Value: A

  Indicates the status of the account. This is an internally-used column and the values are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• PartyType: string
  Title: Party Type

  Read Only: true

  Maximum Length: 30

  Default Value: ORGANIZATION

  The type of the party.
• PartyUniqueName: string
  Title: Unique Party Name

  Read Only: true

  Maximum Length: 900

  The unique account name displayed on account related screens. The default value is the concatenation of attributes AccountName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the AccountName is concatenated with a system generated number.
• PhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 20

  The area code for the telephone number.
• PhoneContactPointType: string
  Title: Phone Type

  Read Only: true

  Maximum Length: 30

  Default Value: PHONE

  The type of contact point.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The international country code for a telephone number, such as 33 for France.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20

  The extension to the phone number of the organization.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The phone number of the organization in the local format. The number should not include area code, country code, or extension.
• PhoneVerificationDate: string (date)
  Title: Phone Verification Date

  The date when phone number of account was last verified.
• PhoneVerificationStatus: string
  Title: Phone Verification Status

  Maximum Length: 30

  The status code of the phone number verification for the account. The values based on lookup are valid and invalid for phone.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Maximum Length: 30

  The preferred contact method of the organization. The accepted values are defined in the lookup type HZ_PREFERRED_CONTACT_METHOD. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• PreferredFunctionalCurrency: string
  Title: Preferred Functional Currency

  Maximum Length: 15

  The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup.
• PrimaryAddress: array Primary Addresses
  Title: Primary Addresses

  The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.
• PrimaryAddressId: integer (int64)
  Read Only: true

  The unique identifier of the primary address.
• PrimaryContactDoCallFlag: boolean
  Title: OK to Call Primary Contact

  Read Only: true

  Maximum Length: 10

  Default Value: false

  Indicates whether the user can call the primary contact of an account. The accepted values are True and False or Y and N. Default is False or N.
• PrimaryContactDoEmailFlag: boolean
  Title: OK to Email Primary Contact

  Read Only: true

  Maximum Length: 10

  Default Value: false

  Indicates whether the user can email the primary contact of an account. The accepted values are True and False or Y and N. Default is False or N.
• PrimaryContactEmail: string
  Title: Contact Email

  Read Only: true

  The e-mail address of the account's primary contact.
• PrimaryContactEmailDNC: boolean
  Title: Do Not Email Primary Contact

  Read Only: true

  Maximum Length: 255

  Default Value: false

  Indicates whether the email can be used for the primary contact. The accepted values are True and False or Y and N. Default is False or N.
• PrimaryContactEmailVerificationDate: string (date)
  Title: Primary Contact Email Verification Date

  Read Only: true

  The date of verification for the primary contact email.
• PrimaryContactEmailVerificationStatus: string
  Title: Primary Contact Email Verification Status

  Read Only: true

  Maximum Length: 30

  The status of the verification for primary contact email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.
• PrimaryContactJobTitle: string
  Title: Job Title

  Read Only: true

  The free form text for the job title of the primary contact.
• PrimaryContactName: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 255

  The name of the account's primary contact.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact Party ID

  The unique identifier of the primary contact of the account.
• PrimaryContactPartyNumber: string
  Title: Primary Contact Party Number

  The party number of the primary contact of the account.
• PrimaryContactPhone: string
  Title: Contact Phone

  Read Only: true

  The phone number of the account's primary contact.
• PrimaryContactPhoneDNC: boolean
  Title: Do Not Call Primary Contact

  Read Only: true

  Maximum Length: 255

  Default Value: false

  Indicates whether the user can call the primary contact phone. The accepted values are True and False or Y and N. Default is False or N.
• PrimaryContactPhoneVerificationDate: string (date)
  Title: Primary Contact Phone Verification Date

  Read Only: true

  The date of verification of the primary contact phone.
• PrimaryContactPhoneVerificationStatus: string
  Title: Primary Contact Phone Verification Status

  Read Only: true

  Maximum Length: 30

  The status of the verification for primary contact phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.
• PrimaryContactSourceSystem: string
  Title: Primary Contact Source System

  The name of external source system where the primary contact of the account is imported from.
• PrimaryContactSourceSystemReferenceValue: string
  Title: Primary Contact Source System Reference

  The unique identifier for the account's primary contact as specified in the external source system.
• PrincipalName: string
  Title: Principal Name

  Maximum Length: 240

  The name of the highest ranking person in the organization.
• PrincipalTitle: string
  Title: Principal Title

  Maximum Length: 240

  The title of the highest ranking person in the organization.
• ProfileQualityScore: number
  Title: Profile Quality Score

  Read Only: true

  The relative score which is used for promotion of a profile record associated to a sales account.
• PromotedAccountId: integer (int64)
  Title: Main Account ID

  Read Only: true

  The unique identifier of the promoted party. The identifier of the master link record.
• PromotedFlag: boolean
  Title: Main Flag

  Read Only: true

  Indicates whether the record is promoted.
• PromotedPartyName: string
  Title: Main Account Name

  Read Only: true

  Maximum Length: 900

  The party name of the master link record.
• PromotedPartyNumber: string
  Title: Main Account Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the master link record.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• PublicPrivateOwnershipFlag: boolean
  Title: Private Ownership

  Maximum Length: 1

  Default Value: false

  Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.
• RawFaxNumber: string
  Title: Raw Fax Number

  Maximum Length: 60

  The unformatted fax number of the organization.
• RawPhoneNumber: string
  Title: Raw Phone Number

  Maximum Length: 60

  The unformatted phone number of the organization.
• RecordSet: string
  Title: Record Set

  Read Only: true

  Maximum Length: 30

  The record set to display search results.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 30

  Indicates the type of registration, such as nonprofit. The accepted values are defined in the lookup type REGISTRATION_TYPE.
• Relationship: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.
• RentOrOwnIndicator: string
  Title: Rent or Own Indicator

  Maximum Length: 30

  Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SalesProfileNumber: string
  Title: Sales Account Number

  Maximum Length: 30

  The sales profile number.
• SalesProfileStatus: string
  Title: Status

  Maximum Length: 30

  A valid user-defined status of the sales account.
• SalesTeamMember: array Account Resources
  Title: Account Resources

  Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.
• SiebelLocation: string
  Title: Location

  Maximum Length: 50

  Location of account - optional part of User Primary Key.
• SmallBusinessIndicator: string
  Title: Small Business Indicator

  Maximum Length: 30

  Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• SourceObjectType: string
  Read Only: true

  Maximum Length: 255

  Default Value: SALES_PARTY

  The type for the source object.
• SourceSystem: string
  Title: Party Source System

  The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReference: array Source System References
  Title: Source System References

  The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
• SourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
• State: string
  Title: State

  Maximum Length: 60

  The state element of Address.
• StockSymbol: string
  Title: Stock Symbol

  Maximum Length: 20

  The corporate stock symbol of the organization as listed in stock exchanges.
• TaxpayerIdentificationNumber: string
  Title: Taxpayer Identification Number

  Maximum Length: 20

  The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe.
• TotalAccountsInHierarchy: integer
  Title: Total Accounts in Hierarchy

  Read Only: true

  The total number of accounts in the hierarchy.
• TotalChildAccounts: integer
  Title: Total Child Accounts

  Read Only: true

  The total number of direct and indirect child accounts in the hierarchy.
• TotalEmployeesEstimatedIndicator: string
  Title: Number of Employees Estimated Qualifier

  Maximum Length: 30

  Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.
• TotalEmployeesIndicator: string
  Title: Number of Employees Includes Subsidiaries

  Maximum Length: 30

  Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR.
• TotalEmployeesMinimumIndicator: string
  Title: Number of Employees Minimum Qualifier

  Maximum Length: 30

  Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND.
• TotalEmployeesText: string
  Title: Total Number of Employees

  Maximum Length: 60

  The total number of employees in text format.
• TotalImmediateChildAccounts: integer
  Title: Total Immediate Child Accounts

  Read Only: true

  The number of immediate child nodes in hierarchy for the account.
• Type: string
  Title: Type

  Maximum Length: 30

  The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided.
• UltimateIdentifierSource: string
  Title: Ultimate Identifier Source

  Read Only: true

  Maximum Length: 80

  The name of the source used to enrich account data that identifies the ultimate identifiers.
• UltimateParentFlag: boolean
  Title: Ultimate Parent Indicator

  Read Only: true

  Default Value: false

  Indicates whether an account is ultimate parent or root node in the hierarchy. Possible values are Yes and No.
• UltimateParentName: string
  Title: Ultimate Parent

  Read Only: true

  Maximum Length: 255

  The name of the ultimate parent of the account.
• UltimateParentPartyId: integer
  Title: Ultimate Parent ID

  Read Only: true

  The unique identifier of the ultimate parent party.
• UltimateParentPartyNumber: string
  Title: Ultimate Parent Registry ID

  Read Only: true

  Maximum Length: 255

  The alternate identifier of the ultimate parent.
• UniqueNameSuffix: string
  Title: Name Suffix

  Maximum Length: 540

  The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
• UpdateFlag: boolean
  Title: Update Account

  Read Only: true

  Indicates if the record can be updated. The default value is false.
• URL: string
  Title: URL

  Maximum Length: 2000

  The uniform resource locator or a website containing information about the organization.
• WebContactPointType: string
  Title: Web Type

  Read Only: true

  Maximum Length: 30

  Default Value: WEB

  The type of web contact point.
• WomanOwnedIndicator: string
  Title: Woman-Owned Indicator

  Maximum Length: 30

  Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N.
• YearEstablished: integer (int32)
  Title: Year Established

  The year that the organization started it business operations.
• YearIncorporated: integer (int32)
  Title: Year Incorporated

  The year that the business was formally incorporated.

{
    "type":"object",
    "properties":{
        "PartyNumberKey":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryContactEmail":{
            "title":"Contact Email",
            "type":"string",
            "description":"The e-mail address of the account's primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FaxVerificationDate":{
            "title":"Fax Verification Date",
            "type":"string",
            "description":"The date when fax number was last verified for the account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FaxStr"
                ]
            }
        },
        "YearEstablished":{
            "title":"Year Established",
            "type":"integer",
            "description":"The year that the organization started it business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"YearEstablished",
                "precision":"4"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "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-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"CurrencyCode",
                "controlType":"choice"
            }
        },
        "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-hints":{
                "PrimaryAttributeName":"ParentDUNSNumberC"
            },
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the organization in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "IndustryCodeType":{
            "title":"Industry Category",
            "type":"string",
            "description":"The industry classification category code type. It is defaulted to the value of profile option MOT_INDUSTRY_CLASS_CATEGORY. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The formatted phone number of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact of the account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "AltLabel":"Primary Contact"
            },
            "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":{
                "PrimaryAttributeName":"PreferredContactMethod",
                "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-hints":{
                "PrimaryAttributeName":"LastUpdatedBy"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the account record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"CreatedBy"
            },
            "x-queryable":true
        },
        "ParentAccountList":{
            "title":"Parent Account List",
            "maxLength":"255",
            "type":"string",
            "description":"List of all the parent accounts till the top node in the account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CEOName":{
            "title":"Chief Executive Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization???s chief executive officer.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CeoName"
            },
            "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-hints":{
                "PrimaryAttributeName":"AnalysisFy"
            },
            "x-queryable":true
        },
        "BusinessScope":{
            "title":"Business Scope",
            "maxLength":"20",
            "type":"string",
            "description":"The class of business to which the account belongs, such as local, national, or international.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"BusinessScope"
            },
            "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-hints":{
                "PrimaryAttributeName":"PrincipalName"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Account",
            "type":"boolean",
            "description":"Indicates if the account can be deleted. If current user has permission to delete the record, delete flag will be true, otherwise the flag will be false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension to the phone number of the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "type":"string",
            "description":"The party number of the primary contact of the account.",
            "nullable":true,
            "x-queryable":true
        },
        "RentOrOwnIndicator":{
            "title":"Rent or Own Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"RentOwnInd",
                "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-hints":{
                "PrimaryAttributeName":"ControlYr"
            },
            "x-queryable":true
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-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"
                ]
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"LastUpdateLogin"
            },
            "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 Number",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of a valid employee resource who owns and manages the sales account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FaxVerificationStatus":{
            "title":"Fax Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the verification of fax number for the account. The values based on lookup are valid and invalid for fax.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FaxStr"
                ]
            }
        },
        "BusinessReport":{
            "title":"D&B Business Report",
            "type":"string",
            "description":"The Dun & Bradstreet business information report.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"BusinessReport"
            }
        },
        "ParentAccountName":{
            "title":"Parent Account",
            "type":"string",
            "description":"The name of the parent account in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPoint":{
            "title":"Contact Points",
            "type":"array",
            "description":"The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.",
            "items":{
                "$ref":"#/components/schemas/accounts-ContactPoint-item-response"
            }
        },
        "FavoriteAccountFlag":{
            "title":"Favorite",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates if the account is a favorite.  The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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-hints":{
                "PrimaryAttributeName":"OobInd"
            },
            "x-queryable":true
        },
        "OwnerPartyId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the sales account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"OwnerPartyId",
                "precision":"18",
                "AltLabel":"Owner"
            },
            "x-queryable":true
        },
        "OrganizationProfileId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"OrganizationProfileId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmployeesTotal":{
            "title":"Number of Employees",
            "type":"number",
            "description":"The total number of employees in the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"EmployeesTotal",
                "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-hints":{
                "PrimaryAttributeName":"GrowthStrategyDescription"
            },
            "x-queryable":true
        },
        "ParentAccountPartyNumber":{
            "title":"Parent Account Registry ID",
            "type":"string",
            "description":"The party number of the parent account within the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "Relationship":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.",
            "items":{
                "$ref":"#/components/schemas/accounts-Relationship-item-response"
            }
        },
        "MissionStatement":{
            "title":"Mission Statement",
            "maxLength":"2000",
            "type":"string",
            "description":"The corporate charter of organization in user-defined text format.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"MissionStatement"
            },
            "x-queryable":true
        },
        "LineOfBusiness":{
            "title":"Line of Business",
            "maxLength":"240",
            "type":"string",
            "description":"The type of business activities performed at this site.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"LineOfBusiness"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the organization in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "TotalEmployeesIndicator":{
            "title":"Number of Employees Includes Subsidiaries",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if 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":{
                "PrimaryAttributeName":"TotalEmployeesInd",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "type":"string",
            "description":"Additional information as type of address like BillTo, ShipTo.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"LastUpdateDate"
            },
            "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-hints":{
                "PrimaryAttributeName":"LocalBusIdentifier"
            },
            "x-queryable":true
        },
        "PrimaryContactEmailDNC":{
            "title":"Do Not Email Primary Contact",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the email can be used for the primary contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PartyStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the status of the account. This is an internally-used column and the values are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "readOnly":true,
            "default":"A",
            "x-hints":{
                "PrimaryAttributeName":"Status",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachment":{
            "title":"Account Attachments",
            "type":"array",
            "description":"The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-Attachment-item-response"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-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-hints":{
                "PrimaryAttributeName":"CorporationClass"
            },
            "x-queryable":true
        },
        "ParentAccountSourceSystem":{
            "title":"Parent Source System",
            "type":"string",
            "description":"The source system of the parent account within the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "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-hints":{
                "PrimaryAttributeName":"Disadv8aInd"
            },
            "x-queryable":true
        },
        "SalesProfileStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"A valid user-defined status of the sales account.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SalesProfileStatus",
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactEmailVerificationDate":{
            "title":"Primary Contact Email Verification Date",
            "type":"string",
            "description":"The date of verification for the primary contact email.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RecordSet":{
            "title":"Record Set",
            "maxLength":"30",
            "type":"string",
            "description":"The record set to display search results.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"SearchFilter",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalEmployeesText":{
            "title":"Total Number of Employees",
            "maxLength":"60",
            "type":"string",
            "description":"The total number of employees in text format.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"TotalEmployeesText"
            },
            "x-queryable":true
        },
        "AccountContact":{
            "title":"Organization Contacts",
            "type":"array",
            "description":"The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountContact-item-response"
            }
        },
        "ExistingCustomerFlag":{
            "title":"Existing Sales Account",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "UltimateParentName":{
            "title":"Ultimate Parent",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the ultimate parent of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UltimateParentStr"
                ]
            }
        },
        "DomesticUltimateFlag":{
            "title":"Domestic Ultimate Indicator",
            "type":"boolean",
            "description":"Indicates whether an account is domestic ultimate parent in the hierarchy. Possible values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"DomesticUltimateFlag",
                "dependencies":[
                    "DomesticUltimateDatafoxId",
                    "DatafoxCompanyId",
                    "DomesticUltimateDUNSNumber",
                    "DUNSNumber"
                ]
            }
        },
        "EmailContactPointType":{
            "title":"Email Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the email contact.",
            "nullable":false,
            "readOnly":true,
            "default":"EMAIL",
            "x-queryable":true
        },
        "IndustryCode":{
            "title":"Primary Industry",
            "type":"string",
            "description":"The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AltLabel":"Industry"
            },
            "x-queryable":true
        },
        "UltimateParentPartyNumber":{
            "title":"Ultimate Parent Registry ID",
            "maxLength":"255",
            "type":"string",
            "description":"The alternate identifier of the ultimate parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UltimateParentStr"
                ]
            }
        },
        "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":{
                "PrimaryAttributeName":"PreferredFunctionalCurrency",
                "controlType":"combo_lov"
            },
            "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-hints":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddressText"
            },
            "x-queryable":true
        },
        "AccountScore":{
            "title":"Account Score",
            "type":"integer",
            "description":"Score assigned based on custom criteria by the user.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AccountScore"
            },
            "x-queryable":true
        },
        "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":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddressMinimum",
                "controlType":"choice"
            },
            "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"
                ]
            }
        },
        "EmployeesAtPrimaryAddress":{
            "title":"Employees at Primary 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-hints":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddress"
            },
            "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
        },
        "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-hints":{
                "PrimaryAttributeName":"UniqueNameSuffix"
            },
            "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
        },
        "OwnerEmailAddress":{
            "title":"Owner Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the employee resource that owns and manages the sales account. The owner is a valid employee resource defined within Engagement Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "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
        },
        "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-hints":{
                "PrimaryAttributeName":"CurrentFiscalYearPotentialRevenueAmount"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the account.",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"OrganizationName"
            },
            "x-queryable":true
        },
        "PrimaryAddress":{
            "title":"Primary Addresses",
            "type":"array",
            "description":"The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-PrimaryAddress-item-response"
            },
            "x-cardinality":"1"
        },
        "FaxAreaCode":{
            "title":"Fax Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code for the fax number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":"2000",
            "type":"string",
            "description":"List of the top keywords of the company.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Keywords"
            },
            "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
        },
        "LastAssignmentDateTime":{
            "title":"Last Assignment Date Time",
            "type":"string",
            "description":"The date when the sales account territory assignment was last run by assignment manager.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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
        },
        "AssignmentExceptionFlag":{
            "title":"Assignment Exception Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales account had the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the dimensions. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "CongressionalDistrictCode":{
            "title":"Congressional District",
            "maxLength":"2",
            "type":"string",
            "description":"The U.S. Congressional district code for the account.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CongDistCode"
            },
            "x-queryable":true
        },
        "PhoneContactPointType":{
            "title":"Phone Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of contact point.",
            "nullable":false,
            "readOnly":true,
            "default":"PHONE",
            "x-queryable":true
        },
        "SourceObjectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type for the source object.",
            "nullable":true,
            "readOnly":true,
            "default":"SALES_PARTY",
            "x-queryable":false
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a telephone number, such as 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code for the telephone number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Account",
            "type":"boolean",
            "description":"Indicates if the record can be updated.  The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPhoneVerificationDate":{
            "title":"Primary Contact Phone Verification Date",
            "type":"string",
            "description":"The date of verification of the primary contact phone.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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":{
                "PrimaryAttributeName":"RegistrationType",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalImmediateChildAccounts":{
            "title":"Total Immediate Child Accounts",
            "type":"integer",
            "description":"The number of immediate child nodes in hierarchy for the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UltimateIdentifierSource":{
            "title":"Ultimate Identifier Source",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the source used to enrich account data that identifies the ultimate identifiers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"UltimateIdentifierSource",
                "dependencies":[
                    "ParentDUNSNumber",
                    "GlobalUltimateDUNSNumber",
                    "DomesticUltimateDUNSNumber",
                    "GlobalUltimateDatafoxId",
                    "DomesticUltimateDatafoxId"
                ]
            }
        },
        "PrimaryContactPhone":{
            "title":"Contact Phone",
            "type":"string",
            "description":"The phone number of the account's primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountExtensionBase":{
            "title":"Account Extension Bases",
            "type":"array",
            "description":"The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountExtensionBase-item-response"
            },
            "x-cardinality":"1"
        },
        "AccountScoringTier":{
            "title":"Account Scoring Tier",
            "maxLength":"30",
            "type":"string",
            "description":"Tier assigned based on custom criteria by the user.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AccountScoringTier"
            },
            "x-queryable":true
        },
        "HomeCountry":{
            "title":"Home Country",
            "maxLength":"2",
            "type":"string",
            "description":"The home country of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"HomeCountry",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TotalEmployeesMinimumIndicator":{
            "title":"Number of Employees Minimum Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"TotalEmployeesMinimumIndicator",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FormattedFaxNumber":{
            "title":"Formatted Fax Number",
            "type":"string",
            "description":"The formatted phone number of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GlobalUltimateFlag":{
            "title":"Global Ultimate Indicator",
            "type":"boolean",
            "description":"Indicates whether an account is global ultimate parent node in the hierarchy. Possible values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"GlobalUltimateFlag",
                "dependencies":[
                    "GlobalUltimateDatafoxId",
                    "DatafoxCompanyId",
                    "GlobalUltimateDUNSNumber",
                    "DUNSNumber"
                ]
            }
        },
        "PromotedPartyName":{
            "title":"Main Account Name",
            "maxLength":"900",
            "type":"string",
            "description":"The party name of the master link record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountTeam":{
            "title":"Account Team",
            "type":"array",
            "description":"The account team resource is used to view the team members and territory team members associated with an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountTeam-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"CreationDate"
            },
            "x-queryable":true
        },
        "SiebelLocation":{
            "title":"Location",
            "maxLength":"50",
            "type":"string",
            "description":"Location of account - optional part of User Primary Key.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SeblUserKeyLoc"
            },
            "x-queryable":true
        },
        "Address":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.",
            "items":{
                "$ref":"#/components/schemas/accounts-Address-item-response"
            }
        },
        "YearIncorporated":{
            "title":"Year Incorporated",
            "type":"integer",
            "description":"The year that the business was formally incorporated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"IncorpYear",
                "precision":"4"
            },
            "x-queryable":true
        },
        "NamedFlag":{
            "title":"Named Account",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"NamedFlag",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "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
        },
        "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-hints":{
                "PrimaryAttributeName":"ExportInd"
            },
            "x-queryable":true
        },
        "PrimaryAddressId":{
            "type":"integer",
            "description":"The unique identifier of the primary address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"IdenAddrPartySiteId",
                "precision":"18"
            },
            "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":{
                "PrimaryAttributeName":"EmployeesAtPrimaryAddressEstimation",
                "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
        },
        "PromotedFlag":{
            "title":"Main Flag",
            "type":"boolean",
            "description":"Indicates whether the record is promoted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PromotedAccountId"
                ]
            }
        },
        "ParentAccountPartyId":{
            "title":"Parent Account ID",
            "type":"integer",
            "description":"The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference.",
            "nullable":true,
            "x-hints":{
                "AltLabel":"Parent Company"
            },
            "x-queryable":true
        },
        "DomesticUltimateDatafoxId":{
            "title":"Domestic Ultimate DataFox Id",
            "maxLength":"30",
            "type":"string",
            "description":"The DataFox Company identifier of the Domestic Ultimate for the account, which is the highest family member in the same country as this business entity. A subject may be its own Domestic Ultimate.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DomesticUltimateDatafoxId"
            },
            "x-queryable":true
        },
        "PrimaryContactName":{
            "title":"Primary Contact",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the account's primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "MinorityOwnedType":{
            "title":"Type of Minority-Owned Organization",
            "maxLength":"30",
            "type":"string",
            "description":"The type of minority-owned firm.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"MinorityOwnedType"
            },
            "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-hints":{
                "PrimaryAttributeName":"MinorityOwnedInd"
            },
            "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-hints":{
                "PrimaryAttributeName":"DomesticUltimateDUNSNumberC"
            },
            "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":{
                "PrimaryAttributeName":"CertificationLevel",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact point for the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AddressLine3":{
            "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
        },
        "AddressLine2":{
            "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
        },
        "AddressLine1":{
            "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
        },
        "CustomerClassification":{
            "title":"Aux Classifications",
            "type":"array",
            "description":"The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
            "items":{
                "$ref":"#/components/schemas/accounts-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":{
                "PrimaryAttributeName":"OrganizationSize",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryContactDoEmailFlag":{
            "title":"OK to Email Primary Contact",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can email the primary contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "LocalActivityCode":{
            "title":"Local Activity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The local activity classification code.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"LocalActivityCode"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "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
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.",
            "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,
            "x-hints":{
                "PrimaryAttributeName":"LastEnrichmentDate"
            },
            "x-queryable":true
        },
        "Industries":{
            "title":"Industries",
            "type":"string",
            "description":"Indicates the multiple class code meaning values of the industry classification for the account",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Short description for the company.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Description"
            },
            "x-queryable":true
        },
        "CertificationReasonCode":{
            "title":"Certification Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CertReasonCode",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalName":{
            "title":"Additional Names",
            "type":"array",
            "description":"The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.",
            "items":{
                "$ref":"#/components/schemas/accounts-AdditionalName-item-response"
            }
        },
        "SalesProfileNumber":{
            "title":"Sales Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The sales profile number.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "type":"string",
            "description":"The organization type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "URL":{
            "title":"URL",
            "maxLength":"2000",
            "type":"string",
            "description":"The uniform resource locator or a website containing information about the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"WebEO.Url",
                "AltLabel":"Website",
                "protectionObjectTitle":"URL",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"URL"
            },
            "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-hints":{
                "PrimaryAttributeName":"WomanOwnedInd"
            },
            "x-queryable":true
        },
        "AdditionalIdentifier":{
            "title":"Additional Identifier",
            "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/accounts-AdditionalIdentifier-item-response"
            }
        },
        "FaxExtension":{
            "title":"Fax Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension to the fax number of the organization.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "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
        },
        "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-hints":{
                "PrimaryAttributeName":"SmallBusInd"
            },
            "x-queryable":true
        },
        "ParentAccountSourceSystemReferenceValue":{
            "title":"Parent Account Source System Reference",
            "type":"string",
            "description":"The source system reference of the parent account within the hierarchy.",
            "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-hints":{
                "PrimaryAttributeName":"GlobalUltimateDUNSNumberC"
            },
            "x-queryable":true
        },
        "PromotedPartyNumber":{
            "title":"Main Account Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the master link record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProfileQualityScore":{
            "title":"Profile Quality Score",
            "type":"number",
            "description":"The relative score which is used for promotion of a profile record associated to a sales account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"ProfileQualityScore"
            },
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SalesProfileType",
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"PartyId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactSourceSystemReferenceValue":{
            "title":"Primary Contact Source System Reference",
            "type":"string",
            "description":"The unique identifier for the account's primary contact as specified in the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPhoneDNC":{
            "title":"Do Not Call Primary Contact",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the user can call the primary contact phone. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "SourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactJobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The free form text for the job title of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalAccountsInHierarchy":{
            "title":"Total Accounts in Hierarchy",
            "type":"integer",
            "description":"The total number of accounts in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FaxCountryCode":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a fax number, such as 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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-hints":{
                "PrimaryAttributeName":"JgzzFiscalCode"
            },
            "x-queryable":true
        },
        "EmailFormat":{
            "title":"Email Format",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred format for e-mail addressed to this organization, such as HTML or ASCII.",
            "nullable":true,
            "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-hints":{
                "PrimaryAttributeName":"LaborSurplusInd"
            },
            "x-queryable":true
        },
        "AccountHierarchySummary":{
            "title":"Account Hierarchy",
            "type":"array",
            "description":"The account hierarchy summaries resource is used to view the account hierarchy information.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountHierarchySummary-item-response"
            },
            "x-cardinality":"1"
        },
        "DatafoxCompanyId":{
            "title":"DataFox Company ID",
            "maxLength":"30",
            "type":"string",
            "description":"Datafox Company Identifier.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DatafoxCompanyId"
            },
            "x-queryable":true
        },
        "AccountRollup":{
            "title":"Account Rollups",
            "type":"array",
            "description":"The account rollups resource is used to view, create, update, and delete an account rollup.",
            "items":{
                "$ref":"#/components/schemas/accounts-AccountRollup-item-response"
            },
            "x-cardinality":"1"
        },
        "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-hints":{
                "PrimaryAttributeName":"NextFyPotentialRevenueAmount"
            },
            "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":{
                "PrimaryAttributeName":"LocalActivityCodeType"
            },
            "x-queryable":true
        },
        "TotalEmployeesEstimatedIndicator":{
            "title":"Number of Employees Estimated Qualifier",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"TotalEmployeesEstimatedIndicator",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalChildAccounts":{
            "title":"Total Child Accounts",
            "type":"integer",
            "description":"The total number of direct and indirect child accounts in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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"
                ]
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The application module that created the account record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "PrimaryContactEmailVerificationStatus":{
            "title":"Primary Contact Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the verification for primary contact email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentOrSubsidiaryIndicator":{
            "title":"Subsidiary Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is a parent or subsidiary.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"ParentSubInd"
            },
            "x-queryable":true
        },
        "PromotedAccountId":{
            "title":"Main Account ID",
            "type":"integer",
            "description":"The unique identifier of the promoted party. The identifier of the master link record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"MasterPartyId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the account.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "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-hints":{
                "PrimaryAttributeName":"ImportInd"
            },
            "x-queryable":true
        },
        "UltimateParentPartyId":{
            "title":"Ultimate Parent ID",
            "type":"integer",
            "description":"The unique identifier of the ultimate parent party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UltimateParentStr"
                ]
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "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
        },
        "UltimateParentFlag":{
            "title":"Ultimate Parent Indicator",
            "type":"boolean",
            "description":"Indicates whether an account is ultimate parent or root node in the hierarchy. Possible values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UltimateParentStr"
                ]
            }
        },
        "GlobalUltimateDatafoxId":{
            "title":"Global Ultimate DataFox Id",
            "maxLength":"30",
            "type":"string",
            "description":"The DataFox Company identifier of the Global Ultimate for the account, which is the highest family member globally across countries as this business entity as you walk up this branch of the tree. A case may be its own Global Ultimate.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"GlobalUltimateDatafoxId"
            },
            "x-queryable":true
        },
        "CEOTitle":{
            "title":"Chief Executive Title",
            "maxLength":"240",
            "type":"string",
            "description":"The formal title of the chief executive officer.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CeoTitle"
            },
            "x-queryable":true
        },
        "SalesTeamMember":{
            "title":"Account Resources",
            "type":"array",
            "description":"Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
            "items":{
                "$ref":"#/components/schemas/accounts-SalesTeamMember-item-response"
            }
        },
        "RawPhoneNumber":{
            "title":"Raw Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The unformatted phone number of the organization.",
            "nullable":true,
            "x-hints":{
                "AltLabel":"Phone"
            },
            "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":{
                "PrimaryAttributeName":"LocalBusIdenType",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the employee resource that owns and manages the sales account.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"OwnerPartyName"
            },
            "x-queryable":true
        },
        "ExistingCustomerFlagLastUpdateDate":{
            "title":"Existing Indicator Last Update Date",
            "type":"string",
            "description":"The date when the existing customer flag was last updated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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":{
                "PrimaryAttributeName":"HQBranchIndicator",
                "controlType":"choice"
            },
            "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-hints":{
                "PrimaryAttributeName":"DoNotConfuseWith"
            },
            "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":{
                "PrimaryAttributeName":"FiscalYearendMonth",
                "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-hints":{
                "PrimaryAttributeName":"DUNSNumberC"
            },
            "x-queryable":true
        },
        "EngagementLevel":{
            "title":"Engagement Level",
            "type":"string",
            "description":"An insight from Sales Insights feature set for Accounts that explains the level of interactions with each account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StockSymbol":{
            "title":"Stock Symbol",
            "maxLength":"20",
            "type":"string",
            "description":"The corporate stock symbol of the organization as listed in stock exchanges.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"StockSymbol"
            },
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Unique Party Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique account name displayed on account related screens. The default value is the concatenation of attributes AccountName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the AccountName is concatenated with a system generated number.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"PartyUniqueName"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PrimaryContactSourceSystem":{
            "title":"Primary Contact Source System",
            "type":"string",
            "description":"The name of external source system where the primary contact of the account is imported from.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            },
            "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,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"PublicPrivateOwnershipFlag"
            },
            "x-queryable":true
        },
        "PrimaryContactDoCallFlag":{
            "title":"OK to Call Primary Contact",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can call the primary contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "AddressTypeList":{
            "title":"Address Type",
            "type":"string",
            "description":"The address type as a list.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "WebContactPointType":{
            "title":"Web Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of web contact point.",
            "nullable":false,
            "readOnly":true,
            "default":"WEB",
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the primary 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,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"GSAIndicatorFlag"
            },
            "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":{
                "PrimaryAttributeName":"DataCloudStatus",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceSystemReference":{
            "title":"Source System References",
            "type":"array",
            "description":"The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.",
            "items":{
                "$ref":"#/components/schemas/accounts-SourceSystemReference-item-response"
            }
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party.",
            "nullable":false,
            "readOnly":true,
            "default":"ORGANIZATION",
            "x-hints":{
                "PrimaryAttributeName":"PartyType"
            },
            "x-queryable":true
        },
        "PrimaryContactPhoneVerificationStatus":{
            "title":"Primary Contact Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the verification for primary contact phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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":{
                "PrimaryAttributeName":"LegalStatus",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The corporate charter of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Comments"
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the organization.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"OrganizationType"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the account 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 account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"PartyNumber"
            },
            "x-queryable":true
        },
        "FaxContactPointType":{
            "title":"Fax Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of contact point for fax.",
            "nullable":false,
            "readOnly":true,
            "default":"PHONE",
            "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-hints":{
                "PrimaryAttributeName":"PrincipalTitle"
            },
            "x-queryable":true
        },
        "DUNSCreditRating":{
            "title":"D&B Credit Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The Dun & Bradstreet credit rating.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DbRating"
            },
            "x-queryable":true
        },
        "RawFaxNumber":{
            "title":"Raw Fax Number",
            "maxLength":"60",
            "type":"string",
            "description":"The unformatted fax number of the organization.",
            "nullable":true,
            "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"
                ]
            }
        }
    }
}

Nested Schema : Organization Contacts

Type: array

Title: Organization Contacts

The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.

Show Source

• Array of: object accounts-AccountContact-item-response

{
    "title":"Organization Contacts",
    "type":"array",
    "description":"The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountContact-item-response"
    }
}

Nested Schema : Account Extension Bases

Type: array

Title: Account Extension Bases

The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.

Show Source

• Array of: object accounts-AccountExtensionBase-item-response

{
    "title":"Account Extension Bases",
    "type":"array",
    "description":"The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountExtensionBase-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Account Hierarchy

Type: array

Title: Account Hierarchy

The account hierarchy summaries resource is used to view the account hierarchy information.

Show Source

• Array of: object accounts-AccountHierarchySummary-item-response

{
    "title":"Account Hierarchy",
    "type":"array",
    "description":"The account hierarchy summaries resource is used to view the account hierarchy information.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountHierarchySummary-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Account Rollups

Type: array

Title: Account Rollups

The account rollups resource is used to view, create, update, and delete an account rollup.

Show Source

• Array of: object accounts-AccountRollup-item-response

{
    "title":"Account Rollups",
    "type":"array",
    "description":"The account rollups resource is used to view, create, update, and delete an account rollup.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountRollup-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Account Team

Type: array

Title: Account Team

The account team resource is used to view the team members and territory team members associated with an account.

Show Source

• Array of: object accounts-AccountTeam-item-response

{
    "title":"Account Team",
    "type":"array",
    "description":"The account team resource is used to view the team members and territory team members associated with an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-AccountTeam-item-response"
    }
}

Nested Schema : Additional Identifier

Type: array

Title: Additional Identifier

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

Show Source

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

{
    "title":"Additional Identifier",
    "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/accounts-AdditionalIdentifier-item-response"
    }
}

Nested Schema : Additional Names

Type: array

Title: Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Show Source

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

{
    "title":"Additional Names",
    "type":"array",
    "description":"The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.",
    "items":{
        "$ref":"#/components/schemas/accounts-AdditionalName-item-response"
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.

Show Source

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

{
    "title":"Addresses",
    "type":"array",
    "description":"The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-Address-item-response"
    }
}

Nested Schema : Account Attachments

Type: array

Title: Account Attachments

The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.

Show Source

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

{
    "title":"Account Attachments",
    "type":"array",
    "description":"The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-Attachment-item-response"
    }
}

Nested Schema : Contact Points

Type: array

Title: Contact Points

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

Show Source

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

{
    "title":"Contact Points",
    "type":"array",
    "description":"The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.",
    "items":{
        "$ref":"#/components/schemas/accounts-ContactPoint-item-response"
    }
}

Nested Schema : Aux Classifications

Type: array

Title: Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Show Source

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

{
    "title":"Aux Classifications",
    "type":"array",
    "description":"The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
    "items":{
        "$ref":"#/components/schemas/accounts-CustomerClassification-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 notes associated with an account. A note captures comments, information, or instructions related to an account.

Show Source

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

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-Note-item-response"
    }
}

Nested Schema : Primary Addresses

Type: array

Title: Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.

Show Source

• Array of: object accounts-PrimaryAddress-item-response

{
    "title":"Primary Addresses",
    "type":"array",
    "description":"The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.",
    "items":{
        "$ref":"#/components/schemas/accounts-PrimaryAddress-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.

Show Source

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

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.",
    "items":{
        "$ref":"#/components/schemas/accounts-Relationship-item-response"
    }
}

Nested Schema : Account Resources

Type: array

Title: Account Resources

Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Show Source

• Array of: object accounts-SalesTeamMember-item-response

{
    "title":"Account Resources",
    "type":"array",
    "description":"Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
    "items":{
        "$ref":"#/components/schemas/accounts-SalesTeamMember-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-smartActions-item-response"
    }
}

Nested Schema : Source System References

Type: array

Title: Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Show Source

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

{
    "title":"Source System References",
    "type":"array",
    "description":"The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.",
    "items":{
        "$ref":"#/components/schemas/accounts-SourceSystemReference-item-response"
    }
}

Nested Schema : accounts-AccountContact-item-response

Type: object

Show Source

• AccountContactId: integer (int64)
  Title: Account Contact ID

  Read Only: true

  The unique identifier of the account contact.
• AccountPartyId: integer (int64)
  Title: Account Party ID

  The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
• AccountPartyNumber: string
  Title: Account Party Number

  Maximum Length: 30

  The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
• AccountSourceSystem: string
  Title: Account Source System

  The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
• AccountSourceSystemReferenceValue: string
  Title: Account Source System Reference

  The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The comments of the user.
• ContactFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the contact record.
• ContactLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the contact record.
• ContactLastUpdateDate: string (date-time)
  Title: Contact Last Update Date

  Read Only: true

  The date when the contact record was last updated.
• ContactName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the contact.
• ContactNumber: string
  Title: Contact Number

  Maximum Length: 30

  The user-defined identification number for this contact.
• ContactPartyId: integer (int64)
  Title: Contact Party ID

  The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
• ContactPartyNumber: string
  Title: Contact Party Number

  Maximum Length: 30

  The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
• ContactSourceSystem: string
  Title: Contact Source System

  The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
• ContactSourceSystemReferenceValue: string
  Title: Contact Source System Reference

  The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreatedByModule: string
  Title: Created by Application

  Maximum Length: 30

  Default Value: HZ_WS

  The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• DecisionMakerFlag: boolean
  Title: Decision Maker

  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.
• Department: string
  Title: Department

  Maximum Length: 60

  The free form text used to name the department for the contact.
• DepartmentCode: string
  Title: Department Code

  Maximum Length: 30

  The value of the department code for the contact.
• DoCallFlag: boolean
  Title: OK to Call

  Read Only: true

  Maximum Length: 10

  Default Value: false

  Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
• DoEmailFlag: boolean
  Title: OK to Email

  Read Only: true

  Maximum Length: 10

  Default Value: false

  Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.
• DoNotCallFlag: boolean
  Title: Do Not Call

  Read Only: true

  Maximum Length: 255

  Default Value: false

  Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.
• DoNotEmailFlag: boolean
  Title: Do Not Email

  Read Only: true

  Maximum Length: 255

  Default Value: false

  Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the contact person for the account.
• EmailVerificationDate: string (date)
  Title: Email Verification Date

  Read Only: true

  The date of the verification for the email.
• EmailVerificationStatus: string
  Title: Email Verification Status

  Read Only: true

  The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted address of the contact.
• FormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The primary formatted phone number for the contact person.
• InfluenceLevelCode: string
  Title: Influence Level

  Maximum Length: 30

  The contact's level of influence in the buying process.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The free form text for job title for the contact associated to an account.
• JobTitleCode: string
  Title: Job Title Code

  Maximum Length: 30

  The value of the code for the job title of the contact person.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonBuyingRole: string
  Title: Buying Role

  Read Only: true

  Maximum Length: 30

  Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.
• PersonJobTitle: string
  Title: Contact Job Title

  Read Only: true

  Maximum Length: 100

  The title of the contact's job with deploying organization.
• PersonSalesAffinityCode: string
  Title: Affinity

  Read Only: true

  Maximum Length: 30

  The contact's affinity for the deploying organization.
• PhoneVerificationDate: string (date)
  Title: Phone Verification Date

  Read Only: true

  The date of the verification for phone.
• PhoneVerificationStatus: string
  Title: Phone Verification Status

  Read Only: true

  The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.
• PreferredContactFlag: boolean
  Title: Preferred Contact

  Maximum Length: 10

  Default Value: false

  Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  The person's or organization's preferred contact method.
• PrimaryCustomerFlag: boolean
  Title: Primary Customer

  Maximum Length: 10

  Default Value: false

  Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
• ReferenceUseFlag: boolean
  Title: Reference

  Maximum Length: 1

  Default Value: false

  Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.
• RelationshipId: integer (int64)
  Title: Relationship Id

  Read Only: true

  The unique identifier of the relationship associated with account contact record.
• RelationshipRecId: integer (int64)
  Title: Relationship Record ID

  Finds an account contact with the relationship record identifier.
• RelationshipSourceSystem: string
  Title: Relationship Source System

  The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
• RelationshipSourceSystemReferenceValue: string
  Title: Relationship Source System Reference

  The identifier for the relationship with the external source system.
• SalesAffinityCode: string
  Title: Affinity

  Maximum Length: 30

  The contact's affinity for the deploying organization.
• SalesAffinityComments: string
  Title: Affinity Comments

  Maximum Length: 2000

  The comments describing the contact's affinity for the deploying organization.
• SalesBuyingRoleCode: string
  Title: Buying Role

  Maximum Length: 30

  The contact's role in the buying process.
• Status: string
  Maximum Length: 1

  Default Value: A

  Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceUseFlag":{
            "title":"Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DoCallFlag":{
            "title":"OK to Call",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PersonSalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountSourceSystem":{
            "title":"Account Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"60",
            "type":"string",
            "description":"The free form text used to name the department for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "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"
                ]
            }
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-defined identification number for this contact.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account Party ID",
            "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
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The primary formatted phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailVerificationStatus":{
            "title":"Email Verification Status",
            "type":"string",
            "description":"The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "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
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "type":"string",
            "description":"The person's or organization's preferred contact method.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactLastUpdateDate":{
            "title":"Contact Last Update Date",
            "type":"string",
            "description":"The date when the contact record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAffinityComments":{
            "title":"Affinity Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments describing the contact's affinity for the deploying organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipRecId":{
            "title":"Relationship Record ID",
            "type":"integer",
            "description":"Finds an account contact with the relationship record identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonBuyingRole":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "title":"Primary Customer",
            "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
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact person for the account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PhoneVerificationStatus":{
            "title":"Phone Verification Status",
            "type":"string",
            "description":"The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "EmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The date of the verification for the email.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonJobTitle":{
            "title":"Contact Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of the contact's job with deploying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountSourceSystemReferenceValue":{
            "title":"Account 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-hints":{
                "dependencies":[
                    "AccountSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title for the contact associated to an account.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ContactFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "DoEmailFlag":{
            "title":"OK to Email",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "DepartmentCode":{
            "title":"Department Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the department code for the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DecisionMakerFlag":{
            "title":"Decision Maker",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountContactId":{
            "title":"Account Contact ID",
            "type":"integer",
            "description":"The unique identifier of the account contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact 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-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's role in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship Id",
            "type":"integer",
            "description":"The unique identifier of the relationship associated with account contact record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobTitleCode":{
            "title":"Job Title Code",
            "maxLength":"30",
            "type":"string",
            "description":"The value of the code for the job title of the contact person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotEmailFlag":{
            "title":"Do Not Email",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "InfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's level of influence in the buying process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneVerificationDate":{
            "title":"Phone Verification Date",
            "type":"string",
            "description":"The date of the verification for phone.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The contact's affinity for the deploying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : 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 : accounts-AccountExtensionBase-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  The user who created the object record.
• CreationDate: string (date-time)
  The date when the record was created.
• Id: integer (int64)
  The unique identifier of the object record.
• LastUpdateDate: string (date-time)
  The date when the record was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ParentId: integer (int64)
  The identifier for the foreign key to parent.
• RecordName: string
  Title: Record Name

  Maximum Length: 80

  The name of the object record.
• RecordNumber: string
  Title: Record Number

  Maximum Length: 64

  The unique identifier of the object record.
• RowType: string
  Maximum Length: 30

  The identifier of the custom extension object row.
• Subtype: string
  Read Only: true

  Maximum Length: 30

  The extension choice list value mapped to the extension child object.

{
    "type":"object",
    "properties":{
        "RecordName":{
            "title":"Record Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the object record.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentId":{
            "type":"integer",
            "description":"The identifier for the foreign key to parent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the object record.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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
        },
        "RowType":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the custom extension object row.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the object record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Subtype":{
            "maxLength":"30",
            "type":"string",
            "description":"The extension choice list value mapped  to the extension child object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "title":"Record Number",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the object record.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "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 : accounts-AccountHierarchySummary-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the account hierarchy summary.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the account hierarchy summary was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the account hierarchy summary was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the account hierarchy summary.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentAccountList: string
  Title: Parent Account List

  Read Only: true

  Maximum Length: 4000

  List of all the parent accounts till the top node in the account hierarchy.
• ParentAccountName: string
  Title: Parent Account Name

  Read Only: true

  Maximum Length: 360

  The parent account name of the given account.
• ParentAccountPartyId: integer (int64)
  Title: Parent Account ID

  Read Only: true

  The parent account identifier of the given account.
• ParentAccountPartyNumber: string
  Title: Parent Account Registry ID

  Read Only: true

  Maximum Length: 30

  The parent account registry identifier of given account.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the party associated to the given account.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the party record.
• PartyUniqueName: string
  Title: Unique Party Name

  Read Only: true

  Maximum Length: 900

  The unique party name of the party record.
• TotalChildAccounts: integer (int32)
  Title: Descendant Count

  Read Only: true

  The total number of child accounts.
• TotalImmediateChildAccounts: integer (int32)
  Title: Immediate Child Count

  Read Only: true

  Total number of immediate child of given account.
• UltimateParentName: string
  Title: Ultimate Parent Name

  Read Only: true

  Maximum Length: 360

  The ultimate parent account name of given account.
• UltimateParentPartyId: integer (int64)
  Title: Ultimate Parent ID

  Read Only: true

  The ultimate parent account identifier of given account.
• UltimateParentPartyNumber: string
  Title: Ultimate Parent Registry ID

  Read Only: true

  Maximum Length: 30

  The ultimate parent account registry identifier of given account.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the account hierarchy summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the account hierarchy summary was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the account hierarchy summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentAccountList":{
            "title":"Parent Account List",
            "maxLength":"4000",
            "type":"string",
            "description":"List of all the parent accounts till the top node in the account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UltimateParentPartyNumber":{
            "title":"Ultimate Parent Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The ultimate parent account registry identifier of given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Unique Party Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique party name of the party record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAccountName":{
            "title":"Parent Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The parent account name of the given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UltimateParentPartyId":{
            "title":"Ultimate Parent ID",
            "type":"integer",
            "description":"The ultimate parent account identifier of given account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the party record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated to the given account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentAccountPartyNumber":{
            "title":"Parent Account Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The parent account registry identifier of given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalChildAccounts":{
            "title":"Descendant Count",
            "type":"integer",
            "description":"The total number of child accounts.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "ParentAccountPartyId":{
            "title":"Parent Account ID",
            "type":"integer",
            "description":"The parent account identifier of the given account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UltimateParentName":{
            "title":"Ultimate Parent Name",
            "maxLength":"360",
            "type":"string",
            "description":"The ultimate parent account name of given account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalImmediateChildAccounts":{
            "title":"Immediate Child Count",
            "type":"integer",
            "description":"Total number of immediate child of given account.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the account hierarchy summary was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : accounts-AccountRollup-item-response

Type: object

Show Source

• CallsMade: number
  Title: Number of Calls Made

  Read Only: true

  The total number of calls made to an account
• CorpCurrencyCode: string
  Title: Corporate Currency

  Read Only: true

  Maximum Length: 15

  The corporate currency code associated with the account rollup such as USD or INR.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DateLastLeadCreated: string (date-time)
  Title: Last Creation Date of Qualified Lead

  Read Only: true

  Last Creation Date of Qualified Lead
• DateNextOptyClosed: string (date)
  Title: Next Opportunity Closing Date

  Read Only: true

  Next Opportunity Closing Date
• EmailsSent: number
  Title: Number of Emails Sent

  Read Only: true

  The total number of emails sent to an account.
• HierCallsMade: number
  Title: Hierarchy Number of Calls Made

  Read Only: true

  The total number of calls made to an account and the account's hierarchy.
• HierCurrentFiscalYearPotentialRevenueAmount: number
  Title: Hierarchy Current Fiscal Year's Potential Revenue

  Read Only: true

  The cumulative total of all of the current fiscal year's potential revenue within an account hierarchy.
• HierDateLastLeadCreated: string (date-time)
  Title: Hierarchy Last Lead Creation Date

  Read Only: true

  The date when the last lead was created in account hierarchy.
• HierDateNextOptyClosed: string (date)
  Title: Hierarchy Next Opportunity Closing Date

  Read Only: true

  The date when the next opportunity is expected to close in account hierarchy.
• HierEmailsSent: number
  Title: Hierarchy Number of Emails Sent

  Read Only: true

  The total number of emails sent to an account and the account's hierarchy.
• HierEmployeesTotal: number
  Title: Hierarchy Total Number of Employees

  Read Only: true

  The count of employees, based on the account number of the employees for each account hierarchy.
• HierLastCallMadeDate: string (date-time)
  Title: Hierarchy Last Call Made

  Read Only: true

  The date when last call was made to an account and the account's hierarchy.
• HierLastCompletedActivity: string (date-time)
  Title: Hierarchy Last Completed Activity

  Read Only: true

  The date when the activity was last completed with an account and its hierarchy. Activity includes task, appointment, and call report.
• HierLastEmailSentDate: string (date-time)
  Title: Hierarchy Last Email Sent

  Read Only: true

  The date when last email was sent to an account and the account's hierarchy.
• HierLastTouchDate: string (date-time)
  Title: Hierarchy Last Touch

  Read Only: true

  The date when the last touch was made with an account and the account's hierarchy.
• HierNextTaskDue: string (date)
  Title: Hierarchy Next Task Due

  Read Only: true

  The due date of the task with an account and its hierarchy.
• HierNumberOfDecMakerContacts: number
  Title: Hierarchy Decision Maker Contacts

  Read Only: true

  The number of contacts, and its hierarchy, with buying role of either decision maker or secondary decision maker.
• HierNumberOfOpenActivities: number
  Title: Hierarchy Number of Open Activities

  Read Only: true

  The count of activities that are open within an account hierarchy.
• HierNumberOfOpenCriticalServiceRequests: number
  Title: Hierarchy Number of Open Critical Service Requests

  Read Only: true

  The number of open service requests within an account hierarchy, where the severity is one.
• HierNumberOfOpenHotLeads: number
  Title: Hierarchy Number of Open Hot Leads

  Read Only: true

  The hierarchy count of leads that are open with Hot rank.
• HierNumberOfOpenLeads: number
  Title: Hierarchy Number of Open Leads

  Read Only: true

  The count of leads that are in Open status within an account hierarchy.
• HierNumberOfOpenOpportunities: number
  Title: Hierarchy Number of Open Opportunities

  Read Only: true

  The count of opportunities that are open within an account hierarchy.
• HierNumberOfOpenServiceRequests: number
  Title: Hierarchy Number of Open Service Requests

  Read Only: true

  The number of open Service Requests for the account hierarchy.
• HierNumberOfQualHotLeads: number
  Title: Hierarchy Qualified Hot Leads

  Read Only: true

  The number of leads, and its hierarchy, that are qualified and hot.
• HierNumberOfQualifiedLeads: number
  Title: Hierarchy Qualified Leads

  Read Only: true

  The number of leads, and its hierarchy, that are qualified.
• HierNumberOfSrClosePastWeek: number
  Title: Hierarchy Service Requests Closed Previous Week

  Read Only: true

  The number of service requests with close date falling in the past seven days and its hierarchy.
• HierNumberOfSubsExpNxtQtr: number
  Title: Hierarchy Total Subscription Products Expiring Next Quarter

  Read Only: true

  The count of subscription products, and it hierarchy, that are expiring in the next quarter.
• HierNumberOfSubsExpQtr: number
  Title: Hierarchy Total Subscription Products Expiring Current Quarter

  Read Only: true

  The count of subscription products, and its hierarchy, that are expiring in the current quarter.
• HierNumberOfTouches: number
  Title: Hierarchy Number of Touches

  Read Only: true

  The total number of touches with an account and the account's hierarchy. A touch refers to an outbound communication such as email, phone and so on.
• HierPotentialRevenueOpenLeads: number
  Title: Hierarchy Potential Revenue from Open Leads

  Read Only: true

  Total Potential Revenue from Qualified Open Leads of an account and its hierarchy
• HierSumOfActiveSubscriptionsMRR: number
  Title: Hierarchy Active Subscriptions MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from active subscription lines on an account and its hierarchy.
• HierSumOfActiveSubscriptionsTCV: number
  Title: Hierarchy Active Subscriptions TCV Amount

  Read Only: true

  The cumulative total contract value amounts from active subscription lines on an account and its hierarchy.
• HierSumOfClosedSubscriptionsMRR: number
  Title: Hierarchy Closed Subscriptions MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from subscription lines on an account and its hierarchy that were closed in a given period of time.
• HierSumOfLapsedRenewalsMRR: number
  Title: Hierarchy Lapsed Renewals MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from expired subscription lines on an account and its hierarchy that don't have renewal lines.
• HierSumOfOpenLeadAmount: number
  Title: Hierarchy Total Potential Revenue from Open Leads

  Read Only: true

  The sum of the potential revenues from qualified and unqualified open leads of an account and the account's hierarchy.
• HierSumOfOpenOpportunitiesRevenue: number
  Title: Hierarchy Open Opportunity Revenue

  Read Only: true

  The cumulative total of open opportunity potential revenue amount within the account hierarchy.
• HierSumOfOpenOrderAmount: number
  Title: Hierarchy Open Order Amount

  Read Only: true

  The cumulative total of quote and order amount within the account hierarchy, where status is Open or Processing.
• HierSumOfUpcomingRenewalsMRR: number
  Title: Hierarchy Upcoming Renewals MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from expiring subscription lines on an account and its hierarchy that haven't been amended, closed, suspended, or renewed.
• HierSumOfWonOpportunitiesRevenue: number
  Title: Hierarchy Won Opportunity Revenue

  Read Only: true

  The cumulative total of potential revenue amount from Won opportunities, within the account hierarchy.
• HierSumOfWonOrderAmount: number
  Title: Hierarchy Won Order Amount

  Read Only: true

  The total of orders within an Account Hierarchy, where the status is Closed.
• HierTotalCompletedActivities: number
  Title: Hierarchy Total Completed Activities

  Read Only: true

  The total number of completed activities with an account and its hierarchy.
• HierTotalNotes: number
  Title: Hierarchy Total Notes

  Read Only: true

  The total number of notes for an account in hierarchy.
• LastCallMadeDate: string (date-time)
  Title: Last Call Made On

  Read Only: true

  The date when last call was made to an account.
• LastCompletedActivity: string (date-time)
  Title: Last Completed Activity

  Read Only: true

  The date when the activity was last completed with an account. Activity includes task, appointment, and call report.
• LastEmailSentDate: string (date-time)
  Title: Last Email Sent

  Read Only: true

  The date when last email was sent to an account.
• LastTouchDate: string (date-time)
  Title: Last Touch

  Read Only: true

  The date when last email was sent to an account.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextTaskDue: string (date)
  Title: Next Task Due

  Read Only: true

  The due date of the task with an account.
• NumberOfDecisionMakerContacts: number
  Title: Decision Maker Contacts

  Read Only: true

  Decision Maker Contacts
• NumberOfOpenActivities: number
  Title: Number of Open Activities

  Read Only: true

  The count of activities that are open within an account.
• NumberOfOpenCriticalServiceRequests: number
  Title: Number of Open Critical Service Requests

  Read Only: true

  The number of open Service Requests for the account that are Severity equal to one.
• NumberOfOpenHotLeads: number
  Title: Number of Open Hot Leads

  Read Only: true

  The count of leads that are open with Hot rank.
• NumberOfOpenLeads: number
  Title: Number of Open Leads

  Read Only: true

  The count of Leads that are Open on the Account.
• NumberOfOpenOpportunities: number
  Title: Number of Open Opportunities

  Read Only: true

  The count on open opportunities within an Account.
• NumberOfOpenServiceRequests: number
  Title: Number of Open Service Requests

  Read Only: true

  The number of open Service Requests for the account.
• NumberOfQualifiedHotLeads: number
  Title: Qualified Hot Leads

  Read Only: true

  Qualified Hot Leads
• NumberOfQualifiedLeads: number
  Title: Qualified Leads

  Read Only: true

  Qualified Leads
• NumberOfSrClosedPastWeek: number
  Title: Service Requests Closed in past Week

  Read Only: true

  Service Requests Closed in past Week
• NumberOfSubsExpNxtQtr: number
  Title: Total Subscription Products Expiring in Next Quarter

  Read Only: true

  Total Subscription Products Expiring in Next Quarter
• NumberOfSubsExpQtr: number
  Title: Total Subscription Products Expiring in Current Quarter

  Read Only: true

  Total Subscription Products Expiring in Current Quarter
• NumberOfTouches: number
  Title: Number of Touches

  Read Only: true

  The total number of touches with an account. A touch refers to an outbound communication such as email, phone and so on.
• OrganizationProfileId: integer (int64)
  Title: Organization Profile Identifier

  Read Only: true

  The unique identifier of the organization profile.
• PotentialRevenueOpenLeads: number
  Title: Total Potential Revenue from Qualified Leads

  Read Only: true

  Total Potential Revenue from Qualified Leads
• SumOfActiveSubscriptionsMRR: number
  Title: Active Subscriptions MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from active subscription lines on an account.
• SumOfActiveSubscriptionsTCV: number
  Title: Active Subscriptions TCV Amount

  Read Only: true

  The cumulative total contract value amounts from active subscription lines on an account.
• SumOfClosedSubscriptionsMRR: number
  Title: Closed Subscriptions MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from subscription lines on an account that were closed in a given period of time.
• SumOfLapsedRenewalsMRR: number
  Title: Lapsed Renewals MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from expired subscription lines on an account that don't have renewal lines.
• SumOfOpenLeadAmount: number
  Title: Total Potential Revenue from Open Leads

  Read Only: true

  The sum of the potential revenues from qualified and unqualified open leads of an account.
• SumOfOpenOpportunitiesRevenue: number
  Title: Open Opportunity Revenue

  Read Only: true

  The cumulative total of open opportunity potential revenue amount for the account.
• SumOfOpenOrderAmount: number
  Title: Open Order Amount

  Read Only: true

  The cumulative total of quote and order amount for the account where status is Open or Processing.
• SumOfUpcomingRenewalsMRR: number
  Title: Upcoming Renewals MRR Amount

  Read Only: true

  The cumulative monthly recurring revenue from expiring subscription lines on an account that haven't been amended, closed, suspended, or renewed.
• SumOfWonOpportunitiesRevenue: number
  Title: Won Opportunity Revenue

  Read Only: true

  The cumulative total of won opportunity potential revenue amount for the account.
• SumOfWonOrderAmount: number
  Title: Won Order Amount

  Read Only: true

  The cumulative total of order amount for the orders where status is Closed.
• TotalCompletedActivities: number
  Title: Total Completed Activities

  Read Only: true

  The total number of completed activities with an account.
• TotalNotes: number
  Title: Total Notes

  Read Only: true

  The total number of notes for an account.

{
    "type":"object",
    "properties":{
        "NumberOfOpenHotLeads":{
            "title":"Number of Open Hot Leads",
            "type":"number",
            "description":"The count of leads that are open with Hot rank.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of leads that are open with Hot rank."
            },
            "x-queryable":true
        },
        "SumOfClosedSubscriptionsMRR":{
            "title":"Closed Subscriptions MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from subscription lines on an account that were closed in a given period of time.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from subscription lines on an account that were closed in a given period of time.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "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-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the creation of the row."
            },
            "x-queryable":true
        },
        "HierSumOfOpenOrderAmount":{
            "title":"Hierarchy Open Order Amount",
            "type":"number",
            "description":"The cumulative total of quote and order amount within the account hierarchy, where status is Open or Processing.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of quote and order amount within the account hierarchy, where status is Open or Processing.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "SumOfUpcomingRenewalsMRR":{
            "title":"Upcoming Renewals MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from expiring subscription lines on an account that haven't been amended, closed, suspended, or renewed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from expiring subscription lines on an account that haven't been amended, closed, suspended, or renewed.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "LastCompletedActivity":{
            "title":"Last Completed Activity",
            "type":"string",
            "description":"The date when the activity was last completed with an account. Activity includes task, appointment, and call report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date of last completed activity with an account. Activity includes task, appointment, and call report."
            },
            "x-queryable":true
        },
        "NumberOfDecisionMakerContacts":{
            "title":"Decision Maker Contacts",
            "type":"number",
            "description":"Decision Maker Contacts",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total Number of Decision Maker Contacts"
            },
            "x-queryable":true
        },
        "HierSumOfActiveSubscriptionsMRR":{
            "title":"Hierarchy Active Subscriptions MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from active subscription lines on an account and its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from active subscription lines on an account and its hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfTouches":{
            "title":"Hierarchy Number of Touches",
            "type":"number",
            "description":"The total number of touches with an account and the account's hierarchy. A touch refers to an outbound communication such as email, phone and so on.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total number of touches with an account and its hierarchy. Touches refer to communications such as email, phone, email, phone and so on."
            },
            "x-queryable":true
        },
        "LastCallMadeDate":{
            "title":"Last Call Made On",
            "type":"string",
            "description":"The date when last call was made to an account.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last call was made to an account."
            },
            "x-queryable":true
        },
        "HierTotalCompletedActivities":{
            "title":"Hierarchy Total Completed Activities",
            "type":"number",
            "description":"The total number of completed activities with an account and its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of completed activities with an account and its hierarchy."
            },
            "x-queryable":true
        },
        "NumberOfSrClosedPastWeek":{
            "title":"Service Requests Closed in past Week",
            "type":"number",
            "description":"Service Requests Closed in past Week",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total Number of Service Requests closed in the past week"
            },
            "x-queryable":true
        },
        "HierSumOfWonOpportunitiesRevenue":{
            "title":"Hierarchy Won Opportunity Revenue",
            "type":"number",
            "description":"The cumulative total of potential revenue amount from Won opportunities, within the account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of potential revenue amount from Won opportunities, within the account hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfOpenOpportunities":{
            "title":"Hierarchy Number of Open Opportunities",
            "type":"number",
            "description":"The count of opportunities that are open within an account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"the count of opportunities that are open within an account hierarchy."
            },
            "x-queryable":true
        },
        "HierSumOfActiveSubscriptionsTCV":{
            "title":"Hierarchy Active Subscriptions TCV Amount",
            "type":"number",
            "description":"The cumulative total contract value amounts from active subscription lines on an account and its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total contract value amounts from active subscription lines on an account and its hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "DateNextOptyClosed":{
            "title":"Next Opportunity Closing Date",
            "type":"string",
            "description":"Next Opportunity Closing Date",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Date when the next opportunity is expected to close."
            },
            "x-queryable":true
        },
        "HierLastCallMadeDate":{
            "title":"Hierarchy Last Call Made",
            "type":"string",
            "description":"The date when last call was made to an account and the account's hierarchy.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last call was made to an account and its hierarchy."
            },
            "x-queryable":true
        },
        "DateLastLeadCreated":{
            "title":"Last Creation Date of Qualified Lead",
            "type":"string",
            "description":"Last Creation Date of Qualified Lead",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Last Creation Date of a Qualified Lead"
            },
            "x-queryable":true
        },
        "SumOfOpenOrderAmount":{
            "title":"Open Order Amount",
            "type":"number",
            "description":"The cumulative total of quote and order amount for the account where status is Open or Processing.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of quote and order amount for the account where status is Open or Processing.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfSubsExpQtr":{
            "title":"Total Subscription Products Expiring in Current Quarter",
            "type":"number",
            "description":"Total Subscription Products Expiring in Current Quarter",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of subscription products where the associated subscription is expiring in the current quarter."
            },
            "x-queryable":true
        },
        "HierNumberOfOpenServiceRequests":{
            "title":"Hierarchy Number of Open Service Requests",
            "type":"number",
            "description":"The number of open Service Requests for the account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open Service Requests for the account hierarchy."
            },
            "x-queryable":true
        },
        "HierNextTaskDue":{
            "title":"Hierarchy Next Task Due",
            "type":"string",
            "description":"The due date of the task with an account and its hierarchy.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when a task is due with an account and its hierarchy."
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HierCurrentFiscalYearPotentialRevenueAmount":{
            "title":"Hierarchy Current Fiscal Year's Potential Revenue",
            "type":"number",
            "description":"The cumulative total of all of the current fiscal year's potential revenue within an account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of all of the current fiscal year's potential revenue within an account hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfDecMakerContacts":{
            "title":"Hierarchy Decision Maker Contacts",
            "type":"number",
            "description":"The number of contacts, and its hierarchy, with buying role of either decision maker or secondary decision maker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of contacts with buying role of either decision maker or secondary decision maker and its hierarchy."
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account rollup such as USD or INR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "description":"The corporate currency code associated with the account rollup such as USD or INR."
            }
        },
        "HierNumberOfOpenHotLeads":{
            "title":"Hierarchy Number of Open Hot Leads",
            "type":"number",
            "description":"The hierarchy count of leads that are open with Hot rank.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The hierarchy count of leads that are open with Hot rank."
            },
            "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-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"User",
                "description":"Who column: indicates the user who last updated the row."
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"User",
                "description":"Who column: indicates the user who created the row."
            },
            "x-queryable":true
        },
        "LastTouchDate":{
            "title":"Last Touch",
            "type":"string",
            "description":"The date when last email was sent to an account.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when the last touch was made with an account."
            },
            "x-queryable":true
        },
        "TotalNotes":{
            "title":"Total Notes",
            "type":"number",
            "description":"The total number of notes for an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of public notes associated with an account."
            },
            "x-queryable":true
        },
        "SumOfActiveSubscriptionsMRR":{
            "title":"Active Subscriptions MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from active subscription lines on an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from active subscription lines on an account.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "SumOfLapsedRenewalsMRR":{
            "title":"Lapsed Renewals MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from expired subscription lines on an account that don't have renewal lines.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from expired subscription lines on an account that don't have renewal lines.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "SumOfActiveSubscriptionsTCV":{
            "title":"Active Subscriptions TCV Amount",
            "type":"number",
            "description":"The cumulative total contract value amounts from active subscription lines on an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total contract value amounts from active subscription lines on an account.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierLastCompletedActivity":{
            "title":"Hierarchy Last Completed Activity",
            "type":"string",
            "description":"The date when the activity was last completed with an account and its hierarchy. Activity includes task, appointment, and call report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date of last completed activity with an account and its hierarchy. Activity includes task, appointment, and call report."
            },
            "x-queryable":true
        },
        "NumberOfTouches":{
            "title":"Number of Touches",
            "type":"number",
            "description":"The total number of touches with an account. A touch refers to an outbound communication such as email, phone and so on.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total number of touches with an account. Touches refer to outbound communications such as email, phone and so on."
            },
            "x-queryable":true
        },
        "NumberOfOpenOpportunities":{
            "title":"Number of Open Opportunities",
            "type":"number",
            "description":"The count on open opportunities within an Account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count on open opportunities within an Account."
            },
            "x-queryable":true
        },
        "PotentialRevenueOpenLeads":{
            "title":"Total Potential Revenue from Qualified Leads",
            "type":"number",
            "description":"Total Potential Revenue from Qualified Leads",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total potential revenue from qualified leads.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfOpenCriticalServiceRequests":{
            "title":"Number of Open Critical Service Requests",
            "type":"number",
            "description":"The number of open Service Requests for the account that are Severity equal to one.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open Service Requests for the account that are Severity equal to one."
            },
            "x-queryable":true
        },
        "SumOfOpenLeadAmount":{
            "title":"Total Potential Revenue from Open Leads",
            "type":"number",
            "description":"The sum of the potential revenues from qualified and unqualified open leads of an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The sum of the potential revenues from qualified and unqualified open leads of an account.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfOpenServiceRequests":{
            "title":"Number of Open Service Requests",
            "type":"number",
            "description":"The number of open Service Requests for the account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open Service Requests for the account."
            },
            "x-queryable":true
        },
        "NumberOfQualifiedHotLeads":{
            "title":"Qualified Hot Leads",
            "type":"number",
            "description":"Qualified Hot Leads",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of leads that are qualified and hot."
            },
            "x-queryable":true
        },
        "HierNumberOfOpenActivities":{
            "title":"Hierarchy Number of Open Activities",
            "type":"number",
            "description":"The count of activities that are open within an account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of activities that are open within an account hierarchy."
            },
            "x-queryable":true
        },
        "HierEmailsSent":{
            "title":"Hierarchy Number of Emails Sent",
            "type":"number",
            "description":"The total number of emails sent to an account and the account's hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total number of emails sent to an account and its hierarchy."
            },
            "x-queryable":true
        },
        "HierLastEmailSentDate":{
            "title":"Hierarchy Last Email Sent",
            "type":"string",
            "description":"The date when last email was sent to an account and the account's hierarchy.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last email was sent to an account and its hierarchy."
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the session login associated to the user who last updated the row."
            },
            "x-queryable":true
        },
        "NumberOfOpenLeads":{
            "title":"Number of Open Leads",
            "type":"number",
            "description":"The count of Leads that are Open on the Account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of Leads that are Open on the Account."
            },
            "x-queryable":true
        },
        "HierSumOfUpcomingRenewalsMRR":{
            "title":"Hierarchy Upcoming Renewals MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from expiring subscription lines on an account and its hierarchy that haven't been amended, closed, suspended, or renewed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from expiring subscription lines on an account and its hierarchy that haven't been amended, closed, suspended, or renewed.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NextTaskDue":{
            "title":"Next Task Due",
            "type":"string",
            "description":"The due date of the task with an account.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when a task is due with an account."
            },
            "x-queryable":true
        },
        "HierSumOfOpenLeadAmount":{
            "title":"Hierarchy Total Potential Revenue from Open Leads",
            "type":"number",
            "description":"The sum of the potential revenues from qualified and unqualified open leads of an account and the account's hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The sum of the potential revenues from qualified and unqualified open leads of an account and its hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierEmployeesTotal":{
            "title":"Hierarchy Total Number of Employees",
            "type":"number",
            "description":"The count of employees, based on the account number of the employees for each account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of employees, based on the account number of the employees for each account hierarchy."
            },
            "x-queryable":true
        },
        "NumberOfQualifiedLeads":{
            "title":"Qualified Leads",
            "type":"number",
            "description":"Qualified Leads",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of leads that are qualified."
            },
            "x-queryable":true
        },
        "CallsMade":{
            "title":"Number of Calls Made",
            "type":"number",
            "description":"The total number of calls made to an account",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Number of calls made to an account."
            },
            "x-queryable":true
        },
        "TotalCompletedActivities":{
            "title":"Total Completed Activities",
            "type":"number",
            "description":"The total number of completed activities with an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of completed activities with an account."
            },
            "x-queryable":true
        },
        "HierNumberOfQualHotLeads":{
            "title":"Hierarchy Qualified Hot Leads",
            "type":"number",
            "description":"The number of leads, and its hierarchy, that are qualified and hot.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of leads that are qualified and hot and its hierarchy."
            },
            "x-queryable":true
        },
        "HierNumberOfSubsExpNxtQtr":{
            "title":"Hierarchy Total Subscription Products Expiring Next Quarter",
            "type":"number",
            "description":"The count of subscription products, and it hierarchy, that are expiring in the next quarter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of subscription products where the associated subscription is expiring in the next quarter and its hierarchy."
            },
            "x-queryable":true
        },
        "HierNumberOfQualifiedLeads":{
            "title":"Hierarchy Qualified Leads",
            "type":"number",
            "description":"The number of leads, and its hierarchy, that are qualified.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of leads that are qualified and its hierarchy."
            },
            "x-queryable":true
        },
        "EmailsSent":{
            "title":"Number of Emails Sent",
            "type":"number",
            "description":"The total number of emails sent to an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total number of emails sent to an account."
            },
            "x-queryable":true
        },
        "HierCallsMade":{
            "title":"Hierarchy Number of Calls Made",
            "type":"number",
            "description":"The total number of calls made to an account and the account's hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Number of calls made to an account and its hierarchy."
            },
            "x-queryable":true
        },
        "HierNumberOfOpenLeads":{
            "title":"Hierarchy Number of Open Leads",
            "type":"number",
            "description":"The count of leads that are in Open status within an account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of leads that are in Open status within an account hierarchy."
            },
            "x-queryable":true
        },
        "HierSumOfClosedSubscriptionsMRR":{
            "title":"Hierarchy Closed Subscriptions MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from subscription lines on an account and its hierarchy that were closed in a given period of time.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from subscription lines on an account and its hierarchy that were closed in a given period of time.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfOpenActivities":{
            "title":"Number of Open Activities",
            "type":"number",
            "description":"The count of activities that are open within an account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of activities that are open within an account."
            },
            "x-queryable":true
        },
        "LastEmailSentDate":{
            "title":"Last Email Sent",
            "type":"string",
            "description":"The date when last email was sent to an account.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last email was sent to an account."
            },
            "x-queryable":true
        },
        "HierSumOfOpenOpportunitiesRevenue":{
            "title":"Hierarchy Open Opportunity Revenue",
            "type":"number",
            "description":"The cumulative total of open opportunity potential revenue amount within the account hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of open opportunity potential revenue amount within the account hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "SumOfWonOpportunitiesRevenue":{
            "title":"Won Opportunity Revenue",
            "type":"number",
            "description":"The cumulative total of won opportunity potential revenue amount for the account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of won opportunity potential revenue amount for the account.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "SumOfWonOrderAmount":{
            "title":"Won Order Amount",
            "type":"number",
            "description":"The cumulative total of order amount for the orders where status is Closed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of order amount for the orders where status is Closed.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierSumOfWonOrderAmount":{
            "title":"Hierarchy Won Order Amount",
            "type":"number",
            "description":"The total of orders within an Account Hierarchy, where the status is Closed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total of orders within an Account Hierarchy, where the status is Closed.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfSubsExpQtr":{
            "title":"Hierarchy Total Subscription Products Expiring Current Quarter",
            "type":"number",
            "description":"The count of subscription products, and its hierarchy, that are expiring in the current quarter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of subscription products where the associated subscription is expiring in the current quarter and its hierarchy."
            },
            "x-queryable":true
        },
        "HierLastTouchDate":{
            "title":"Hierarchy Last Touch",
            "type":"string",
            "description":"The date when the last touch was made with an account and the account's hierarchy.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when the last touch was made with an account and its hierarchy."
            },
            "x-queryable":true
        },
        "HierTotalNotes":{
            "title":"Hierarchy Total Notes",
            "type":"number",
            "description":"The total number of notes for an account in hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of public notes associated with an account and its hierarchy."
            },
            "x-queryable":true
        },
        "OrganizationProfileId":{
            "title":"Organization Profile Identifier",
            "type":"integer",
            "description":"The unique identifier of the organization profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "description":"The unique identifier of the organization profile."
            },
            "x-queryable":true
        },
        "SumOfOpenOpportunitiesRevenue":{
            "title":"Open Opportunity Revenue",
            "type":"number",
            "description":"The cumulative total of open opportunity potential revenue amount for the account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of open opportunity potential revenue amount for the account.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierDateLastLeadCreated":{
            "title":"Hierarchy Last Lead Creation Date",
            "type":"string",
            "description":"The date when the last lead was created in account hierarchy.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Date last lead was created in account hierarchy."
            },
            "x-queryable":true
        },
        "HierPotentialRevenueOpenLeads":{
            "title":"Hierarchy Potential Revenue from Open Leads",
            "type":"number",
            "description":"Total Potential Revenue from Qualified Open Leads of an account and its hierarchy",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Total Potential Revenue from qualified open leads of an account and its hierarchy.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfOpenCriticalServiceRequests":{
            "title":"Hierarchy Number of Open Critical Service Requests",
            "type":"number",
            "description":"The number of open service requests within an account hierarchy, where the severity is one.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open service requests within an account hierarchy, where the severity is one."
            },
            "x-queryable":true
        },
        "NumberOfSubsExpNxtQtr":{
            "title":"Total Subscription Products Expiring in Next Quarter",
            "type":"number",
            "description":"Total Subscription Products Expiring in Next Quarter",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of subscription products where the associated subscription is expiring in the next quarter."
            },
            "x-queryable":true
        },
        "HierDateNextOptyClosed":{
            "title":"Hierarchy Next Opportunity Closing Date",
            "type":"string",
            "description":"The date when the next opportunity is expected to close in account hierarchy.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Date when the next opportunity is expected to close in account hierarchy."
            },
            "x-queryable":true
        },
        "HierNumberOfSrClosePastWeek":{
            "title":"Hierarchy Service Requests Closed Previous Week",
            "type":"number",
            "description":"The number of service requests with close date falling in the past seven days and its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of Service Requests with close date falling in the past 7 days and its hierarchy."
            },
            "x-queryable":true
        },
        "HierSumOfLapsedRenewalsMRR":{
            "title":"Hierarchy Lapsed Renewals MRR Amount",
            "type":"number",
            "description":"The cumulative monthly recurring revenue from expired subscription lines on an account and its hierarchy that don't have renewal lines.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative monthly recurring revenue from expired subscription lines on an account and its hierarchy that don't have renewal lines.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "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-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the last update of the row."
            },
            "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 : accounts-AccountTeam-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Read Only: true

  Maximum Length: 30

  The access level granted to the account team member, manager, and administrator of the organizations in the resource hierarchy.
• AccountTeamId: integer (int64)
  The unique key to identify the account team member.
• AddedOnDateTime: string (date-time)
  Title: Joining Date

  The date when the account team member was created based on either the date the resource was added to the account resource or the date the territory was added to account territory.
• AssignmentTypeCode: string
  Read Only: true

  Maximum Length: 30

  Indicates how the resource is added to the account team. For example, Ad-Hoc indicates that the resource is added manually or through rule-based assignment and Territory indicates that the resource is added through territory-based assignment.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the resource.
• CorpCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The country code of the resource.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the account team member.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CurcyConvRateType: string
  Read Only: true

  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
  Read Only: true

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• EndDateActive: string (date)
  Read Only: true

  The end date the account team member is active.
• ForecastParticipationCode: string
  Title: Enable Forecasting

  Read Only: true

  Maximum Length: 30

  Default Value: REVENUE

  The forecast participation type of the territory.
• FunctionCode: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The code of the function or role of the territory team member.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the account team was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the account team 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.
• LockAssignmentFlag: boolean
  Title: Locked

  Read Only: true

  Maximum Length: 1

  Indicates that the account team member cannot be removed from the team by automatic assignment.
• MemberFunctionCode: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The code of the account team member function.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number.
• OwnerFlag: boolean
  Read Only: true

  Indicates if the account team member is the owner of the account.
• PartyId: integer (int64)
  The unique identifier of the account.
• PrimaryPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The primary formatted phone number for the resource.
• ResourceEmailAddress: string
  Read Only: true

  Maximum Length: 320

  The e-mail address of the resource.
• ResourceId: integer (int64)
  The unique identifier of the resource party associated with the account team.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The full name of the account team member.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The party number of the resource.
• ResourceRoleName: string
  Read Only: true

  Maximum Length: 255

  The role of the resource associated with the account team..
• SalesProfileId: integer (int64)
  The unique identifier of the sales account.
• StartDateActive: string (date)
  Read Only: true

  The start date the account team member is active.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the resource.
• TeamMemberId: integer (int64)
  Read Only: true

  The unique identifier of the account resource.
• TerritoryFunctionCode: string
  Title: Territory Function

  Read Only: true

  Maximum Length: 30

  The code of the business function of the territory.
• TerritoryName: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 60

  The name of the territory associated with the account team..
• TerritoryNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 30

  The number of the territory.
• TerritoryOwnerFlag: boolean
  Read Only: true

  Indicates if the account team member is the territory owner.
• TerritoryVersionId: integer
  The unique identifier of the territory version for the resource that got assigned to the account through territory-based assignment.
• TypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: PRIME

  The code of the type of the territory associated with the account team.
• UserLastUpdateDate: string (date-time)
  Read Only: true

  The date and time the account team member was last updated.

{
    "type":"object",
    "properties":{
        "TerritoryName":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory associated with the account team..",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The access level granted to the account team member, manager, and administrator of the organizations in the resource hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The full name of the account team member.",
            "nullable":false,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time the account team member was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates how the resource is added to the account team. For example, Ad-Hoc indicates that the resource is added manually or through rule-based assignment and Territory indicates that the resource is added through territory-based assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceEmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The start date the account team member is active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"The unique identifier of the account resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryOwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the account team member is the territory owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TerritoryOwnerResourceId"
                ]
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the business function of the territory.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the account team record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddedOnDateTime":{
            "title":"Joining Date",
            "type":"string",
            "description":"The date when the account team member was created based on either the date the resource was added to the account resource or the date the territory was added to account territory.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the account team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesProfileId":{
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the type of the territory associated with the account team.",
            "nullable":false,
            "readOnly":true,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the account team member is the owner of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AccountDirectorId"
                ]
            }
        },
        "FunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the function or role of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryNumber":{
            "title":"Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountTeamId":{
            "type":"integer",
            "description":"The unique key to identify the account team member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":"30",
            "type":"string",
            "description":"The forecast participation type of the territory.",
            "nullable":true,
            "readOnly":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceRoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The role of the resource associated with the account team..",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateActive":{
            "type":"string",
            "description":"The end date the account team member is active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version for the resource that got assigned to the account through territory-based assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource party associated with the account team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The primary formatted phone number for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the account team member function.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Locked",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the account team member cannot be removed from the team by automatic assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the account team 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 : accounts-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

  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":"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 : accounts-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 associated with the record.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name associated with the record.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the contact was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the contact record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name associated with the record.
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
• NameId: integer (int64)
  Read Only: true

  The unique identifier of the name.
• NameType: string
  Title: Additional Name Type

  Maximum Length: 30

  The type of the name. For example, ALIAS or LEGAL.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate identifier of the party. Inactive records can't be updated.
• PartySourceSystem: string
  The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
• PartySourceSystemReferenceValue: string
  The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
• PreferredFlag: boolean
  Title: Preferred Indicator

  Maximum Length: 1

  Default Value: false

  Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.
• SourceSystem: string
  The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if the additional name is currently active.
• Title: string
  Title: Title

  Maximum Length: 60

  A professional or family title, such as Don or The Right Honorable
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.

{
    "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 where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "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 associated with the record.",
            "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 associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the additional name is currently active.",
            "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 for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"TransliterationLanguage 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 unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the party. 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 associated with the record.",
            "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 where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identify the name as 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 : accounts-Address-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 240

  The first line for address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressId: integer (int64)
  Read Only: true

  The unique identifier of the address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
• AddressLocale: array Address Locales
  Title: Address Locales

  The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

  The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• AddressPurpose: array Address Purposes
  Title: Address Purposes

  The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
• AddressType: string
  Title: Type

  The type of address.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the address.
• CalculateFormattedAddress: boolean
  The formatted address.
• City: string
  Title: City

  Maximum Length: 60

  The city in the address.
• ClliCode: string
  Title: CLLI Code

  Maximum Length: 60

  The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the address.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• CorpCurrencyCode: string
  Title: Corporate Currency

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

  The county of the address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the account record.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreatedByModule1: string
  Title: Created by Application

  Maximum Length: 30

  The user who created the module.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DateValidated: string (date)
  Title: Validated Date

  The date when the address was last validated.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the location.
• DoNotMailFlag: boolean
  Title: Contact Preferences

  Default Value: false

  Indicates whether the address should not be used for mailing.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
• DunsNumberC: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The D-U-N-S number of the business location.
• EffectiveDate: string (date)
  The date when the address becomes active.
• EndDateActive: string (date)
  Title: End Date

  The date after which the address becomes inactive.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the address.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted version of the address.
• FormattedAddress1: string
  Title: Formatted Address 1

  Read Only: true

  The formatted address of the contact address record.
• FormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The formatted multiline version of the address.
• FormattedMultilineAddress1: string
  Title: Address

  Read Only: true

  The formatted address in multiline of the contact address record.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• Latitude: number
  Title: Latitude

  The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the address location.
• LocationId: integer (int64)
  Title: Location ID

  The unique identifier for the location.
• Longitude: number
  Title: Longitude

  The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumber1: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the account associated with the address.
• PartyNumber: string
  Title: Party Number

  The unique alternate identifier for the account associated with the address. Inactive records can't be updated.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  User-defined name for the address.
• PartySourceSystem: string
  Title: Party Source System

  The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code for the address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• SourceSystem: string
  The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
• SSROwnerTableName: string
  Read Only: true

  Maximum Length: 255

  The name of the table that holds the record data and is referenced to manage source system reference.
• SSRPartyOwnerTableName: string
  Read Only: true

  Maximum Length: 255

  Default Value: HZ_PARTIES

  The name of the table that holds the party record data and is referenced to manage source system reference.
• StartDateActive: string (date)
  Title: Start Date

  The date when the address becomes active.
• State: string
  Title: State

  Maximum Length: 60

  The state of the address.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
• ValidationStartDate: string (date)
  Read Only: true

  The date when the validation becomes active. The value is internally set by system during address cleansing.
• ValidationStatusCode: string
  Title: Validation Status

  Maximum Length: 30

  The code indicating the status of the validation. Internally set by system during address cleansing.

{
    "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
        },
        "AddressPurpose":{
            "title":"Address Purposes",
            "type":"array",
            "description":"The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.",
            "items":{
                "$ref":"#/components/schemas/accounts-Address-AddressPurpose-item-response"
            }
        },
        "FormattedMultilineAddress1":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address in multiline of the contact address record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used 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. 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
        },
        "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
        },
        "AddressLocale":{
            "title":"Address Locales",
            "type":"array",
            "description":"The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.",
            "items":{
                "$ref":"#/components/schemas/accounts-Address-AddressLocale-item-response"
            }
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "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-queryable":true
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":"60",
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the 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":"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 the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the address.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates whether the 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":"The internal flag indicating status of the address. The 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 account record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationStartDate":{
            "type":"string",
            "description":"The date when the validation becomes active. The value is 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 where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the 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":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the 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":"An 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 is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date after which the address becomes 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 for the address.",
            "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 address location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the 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 key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "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 of the 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 when the address becomes active.",
            "format":"date",
            "nullable":false,
            "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
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "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. This is used for addresses 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 user who created the module.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location.",
            "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 system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The unique alternate identifier for the account associated with the address. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the address.",
            "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 where the address 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
        },
        "FormattedAddress1":{
            "title":"Formatted Address 1",
            "type":"string",
            "description":"The formatted address of the contact address record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveDate":{
            "type":"string",
            "description":"The date when the address  becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Address Locales

Type: array

Title: Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Show Source

• Array of: object accounts-Address-AddressLocale-item-response

{
    "title":"Address Locales",
    "type":"array",
    "description":"The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.",
    "items":{
        "$ref":"#/components/schemas/accounts-Address-AddressLocale-item-response"
    }
}

Nested Schema : Address Purposes

Type: array

Title: Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Show Source

• Array of: object accounts-Address-AddressPurpose-item-response

{
    "title":"Address Purposes",
    "type":"array",
    "description":"The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.",
    "items":{
        "$ref":"#/components/schemas/accounts-Address-AddressPurpose-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 : accounts-Address-AddressLocale-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Address Element Attribute 1

  Maximum Length: 150

  The additional address element 1 to support flexible address format in local language.
• AddrElementAttribute2: string
  Title: Address Element Attribute 2

  Maximum Length: 150

  The additional address element 2 to support flexible address format in local language.
• AddrElementAttribute3: string
  Title: Address Element Attribute 3

  Maximum Length: 150

  The additional address element 3 to support flexible address format in local language.
• AddrElementAttribute4: string
  Title: Address Element Attribute 4

  Maximum Length: 150

  The additional address element 4 to support flexible address format in local language.
• AddrElementAttribute5: string
  Title: Address Element Attribute 5

  Maximum Length: 150

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

  Maximum Length: 240

  The first line of the address in the local language.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address in the local language.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the address in the local language.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address in the local language.
• AddressNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address in local language.
• City: string
  Title: City

  Maximum Length: 60

  The specific name of the city in local language.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The specific name of the country in local language.
• County: string
  Title: County

  Maximum Length: 60

  The specific name of the county in local language.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the address locale record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the address locale record was created.
• FloorNumber: string
  Title: Floor

  Maximum Length: 240

  The specific floor number at a given address or a particular building when building number is provided in local language.
• FormattedAddress: string
  Read Only: true

  The formatted read only version of the locale address.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the address locale was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the address locale record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the address locale record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  The unique identifier of the location record.
• LocationLocaleId: integer (int64)
  Read Only: true

  The unique identifier of the location locale record.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
• PostalPlus4code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code in local language.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province in local language.
• SiteSourceSystem: string
  The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the State in the local language.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the address locale record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"240",
            "type":"string",
            "description":"The specific floor number at a given address or a particular building when building number is provided in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationLocaleId":{
            "type":"integer",
            "description":"The unique identifier of the location locale record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.",
            "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 specific name of the county in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the address locale record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the address locale record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The formatted read only version of the locale address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier of the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Address Element Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 5 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address in the local language.",
            "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 of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The specific name of the city in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Address Element Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 1 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Address Element Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 2 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Address Element Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 3 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Address Element Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element 4 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the State in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The specific name of the country in local language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the address locale record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the address locale 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 : accounts-Address-AddressPurpose-item-response

Type: object

Show Source

• AddressId: integer (int64)
  The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
• AddressNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
• AddressPurposeId: integer (int64)
  Read Only: true

  The unique identifier of the address purpose.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user comments for the address purpose.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the address purpose record.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: HZ_WS

  The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the address purpose record was created.
• DeleteFlag: boolean
  Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
• EndDate: string (date)
  Title: To Date

  The date on which the address purpose is no longer valid.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the address purpose was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the address purpose record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the address purpose record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryPerType: string
  Title: Primary

  Maximum Length: 1

  Default Value: N

  Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
• Purpose: string
  Title: Purpose

  Maximum Length: 30

  The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SiteSourceSystem: string
  The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SourceSystem: string
  The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
• SourceSystemReferenceValue: string
  The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• StartDate: string (date)
  Title: From Date

  The date from which the address purpose is valid.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the address purpose record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "SiteSourceSystem":{
            "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":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the address purpose record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the address purpose record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteSourceSystemReferenceValue":{
            "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":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user comments for the address purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "Purpose":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressPurposeId":{
            "type":"integer",
            "description":"The unique identifier of the address purpose.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date on which the address purpose is no longer valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the address purpose is to be deleted. If the value  is Y, then the address purpose has to be deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryPerType":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which the address purpose is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "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 purpose record during update.",
            "nullable":false,
            "readOnly":true,
            "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 application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "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 purpose record during update.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the address purpose record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the address purpose 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 : accounts-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name of the person who uploaded the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name of the person who last updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment 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 the 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 the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "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 of the person who uploaded the attachment.",
            "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 length 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 current version number of the attachment.",
            "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 associated with 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 attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE.",
            "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 of the person who last updated the attachment.",
            "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 of the 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 URL of the attached 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. The default value is false.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of 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 unique identifier used for tracking the uploaded 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 : accounts-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. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups.
• CreatedBy: string
  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. Defaulted to false.
• 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

  Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
• PhoneType: string
  Title: Type

  The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
• PreferenceRequestedBy: string
  Title: Preference Requested By

  Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the phone number is preferred.
• RawPhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The phone number in raw format.
• SocialNetworkId: string
  Title: User ID

  The unique identifier of the social network.
• SocialNetworkName: string
  Title: Social Network

  The name of the social network.
• SocialNetworkPurpose: string
  Title: Social Network Purpose

  Maximum Length: 30

  Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
• SourceSystem: string
  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 aren't verified.
• WebPurpose: string
  Title: Web Purpose

  Maximum Length: 30

  Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.

{
    "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 aren't 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 of 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":"Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "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":"Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "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. Defaulted to false.",
            "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. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.",
            "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":"Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.",
            "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 name of the social network.",
            "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. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups.",
            "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 : accounts-CustomerClassification-item-response

Type: object

Show Source

• ClassCategory: string
  Title: Classification Category

  Maximum Length: 30

  The name of the classification category.
• ClassCode: string
  Title: Classification Code

  Maximum Length: 30

  A valid classification code corresponding to the classification category.
• 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. This number is used by mobile or portable applications that consume the web service.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedByModule: string
  Title: Created by Module

  Maximum Length: 30

  The application module that created the customer classification record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• EndDateActive: string (date)
  Title: End Date

  The date from which the classification code is no longer valid.
• IsAuxClassificationFlag: boolean
  Title: Auxiliary Classification Status

  Read Only: true

  Indicates whether the classification category is an user-defined group classification category. The default value is false.
• IsIndustryFlag: boolean
  Title: Industry Type Status

  Read Only: true

  Indicates whether the classification category is an industry group classification category. The default value is false.
• IsOrgTypeFlag: boolean
  Title: Organization Type Status

  Read Only: true

  Indicates whether the classification category is an organization type classification category. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The unique Identifier of the account, contact or household to which the classification is associated.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 30

  The unique alternate identifier of the account, contact, or household to which the classification is associated. 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 is associated.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  Identifier from external source system for the account, contact or household with which the classification is associated.
• PartyType: string
  Title: Party Type

  Read Only: true

  Maximum Length: 30

  The type of the party, such as account, contact, or household.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates if the customer classification is the primary classification. The default value is false.
• SourceSystem: string
  Title: Source System

  The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.
• SourceSystemReferenceValue: string
  Title: Source System Reference Value

  The unique identifier for the customer classification in the external source.
• StartDateActive: string (date)
  Title: Start Date

  The date on which the customer classification was created.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.

{
    "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
        },
        "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":"Indicates if the customer classification is the primary classification. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IsAuxClassificationFlag":{
            "title":"Auxiliary Classification Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an user-defined group classification category.  The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCategory":{
            "title":"Classification Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the classification category.",
            "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,
            "readOnly":true,
            "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 classification is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the customer classification was created.",
            "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 module that created the customer classification record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":false,
            "x-queryable":true
        },
        "IsOrgTypeFlag":{
            "title":"Organization Type Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an organization type classification category.  The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.  The default value is false.",
            "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 if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.",
            "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 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 is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the customer classification in the external source.",
            "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 is associated. Inactive records can't be updated.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date from 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 the account, contact or household to which the classification 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 where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.",
            "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
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "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 : accounts-Note-item-response

Type: object

Show Source

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

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

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the note.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the note was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique party identifier for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the note was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  This is the column which will store the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  This is the note type code for categorization of note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the parent note.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique Identifier of the account to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account record with which the address is associated. Inactive records can't be updated.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of a account party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The source_object_code of the source object as defined in OBJECTS Metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  This is the attribute to specify the visibility level of the note.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the note was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of a account 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 unique identifier of the relationship that is 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 associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The source_object_code of 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 associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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 title of the note entered by the user.",
            "nullable":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
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note.",
            "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 note.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique party identifier for 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 note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique Identifier of the account to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account record with which the address is associated. Inactive records can't be updated.",
            "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 note 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 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 : accounts-PrimaryAddress-item-response

Type: object

Show Source

• Addressee: string
  Title: Addressee

  Maximum Length: 360

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddressId: integer (int64)
  Read Only: true

  The unique identifier of the primary address.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the primary address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the primary address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the primary address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the primary address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

  The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the primary address.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the primary address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the primary address.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the primary address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

  The county of the primary address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the primary address record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DateValidated: string (date)
  Title: Validated Date

  The date when the primary address was last validated.
• DeleteFlag: boolean
  Title: Delete Primary Address

  Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the location.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates the contact preference to indicate DNC option.
• EndDateActive: string (date)
  Title: To Date

  The last date for a record in active status.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the primary address.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted version of the primary address.
• FormattedMultiLineAddress: string
  Title: Address

  Read Only: true

  The formatted multiline version of the primary address.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• Latitude: number
  Title: Latitude

  The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationComments: string
  Title: Comments

  Maximum Length: 2000

  The additional information for the record in free text format.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the address location.
• LocationId: integer (int64)
  The unique identifier for the location.
• LocationIntegrationKey: string
  The integration key for the location record.
• LocationLocationId: integer (int64)
  Title: Location ID

  The system identifier for the location record.
• LocationSourceSystem: string
  The name of source system for the location record.
• LocationSourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• LocationStatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The status flag for location record.
• Longitude: number
  Title: Longitude

  The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ObjectVersionNumberLocation: integer (int32)
  The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumberPartySite: integer (int32)
  The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OverallPrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.
• PartyId: integer (int64)
  The unique identifier of the account associated with the address.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  The name of the party site.
• PartySiteType: string
  Title: One-Time Address

  Maximum Length: 30

  The type information of the party site.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code for the address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 240

  The brief free text that describes the site record.
• SourceSystem: string
  The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
• StartDateActive: string (date)
  Title: From Date

  The date on which the record becomes active.
• State: string
  Title: State

  Maximum Length: 60

  The state of the address.
• Status: string
  Maximum Length: 1

  Default Value: A

  The status of the record.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 64

  The time zone for the location.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
• ValidationStatusCode: string
  Title: Validation Status

  Maximum Length: 30

  The code indicating the status of the validation. Internally set by system during address cleansing.

{
    "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
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "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
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"The brief free text that describes the site record.",
            "nullable":true,
            "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-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the contact preference to indicate DNC option.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the primary address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":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":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the primary address record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverallPrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The system identifier for the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationStatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The status flag for location record.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Primary Address",
            "type":"boolean",
            "description":"Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "LocationComments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The additional information for the record in free text format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a record in active status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the primary address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The time zone for the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "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 of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date on which the record becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":"30",
            "type":"string",
            "description":"The type information of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the primary address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationSourceSystem":{
            "type":"string",
            "description":"The name of source system for the location record.",
            "nullable":true,
            "x-queryable":true
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":"360",
            "type":"string",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberPartySite":{
            "type":"integer",
            "description":"The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultiLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address 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
        }
    }
}

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 : accounts-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-provided comments for the relationship.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedByModule: string
  Title: Created by Application

  Maximum Length: 30

  Default Value: HZ_WS

  The application module that created the relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DependentFlag: string
  Title: Dependent Indicator

  Maximum Length: 1

  Default Value: N

  Indicates whether one party is a dependent on another.
• DirectionCode: string
  Read Only: true

  Maximum Length: 30

  The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.
• EndDate: string (date)
  Title: To Date

  The date when the relationship ends.
• HeadOfHouseholdFlag: string
  Title: Head of Household Indicator

  Maximum Length: 1

  Default Value: N

  Indicates whether a person is the head of the household that he belongs to.
• InfluenceLevel: string
  Title: Influence Level

  The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
• JobDefinitionName: string
  Maximum Length: 100

  The definition of the job name.
• JobDefinitionPackage: string
  Maximum Length: 900

  The definition of the job package.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectPartyId: integer (int64)
  The unique identifier of the object party in this relationship.
• ObjectPartyName: string
  Title: Object Party Name

  Read Only: true

  Maximum Length: 360

  The name of the object party of the relationship.
• ObjectPartyNumber: string
  Title: Object Registry ID

  Maximum Length: 30

  The alternate key identifier for the object party of the relationship.
• ObjectSourceSystem: string
  Title: Object Source System

  The name of the external source system for the object party in the relationship.
• ObjectSourceSystemReferenceValue: string
  Title: Object Source System Reference

  The identifier for the object party in the relationship from the external source system.
• ObjectTableName: string
  Maximum Length: 30

  The source table name of the object party in this relationship.
• ObjectType: string
  Maximum Length: 30

  The object type of the contact.
• ObjectUsageCode: string
  Maximum Length: 30

  The usage code of object party in the relationship.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumber1: integer (int32)
  Read Only: true

  The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried.
• ObjectVersionNumber2: integer (int32)
  Read Only: true

  The number to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party.
• PartyId1: integer (int64)
  Read Only: true

  The alternate unique identifier of the party.
• PercentageOwnership: number
  Title: Ownership Percentage

  The percentage of the child entity owned by the parent entity.
• PreferredContactFlag: boolean
  Maximum Length: 10

  Default Value: false

  Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
• PrimaryCustomerFlag: boolean
  Maximum Length: 10

  Default Value: false

  Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

  The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.
• RelationshipId: integer (int64)
  Read Only: true

  The unique identifier of the relationship.
• RelationshipRecId: integer (int64)
  The unique identifier of the relationship record.
• RelationshipSourceSystem: string
  The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
• RelationshipSourceSystemReferenceValue: string
  The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.
• RequestId: integer (int64)
  The unique identifier of the request.
• Role: string
  Title: Role

  The role between the subject and object party.
• SSROwnerTableName: string
  Read Only: true

  Maximum Length: 255

  Default Value: HZ_PARTIES

  The name of the table that holds the record data and is referenced to manage source system reference.
• StartDate: string (date)
  Title: From Date

  The date when the relationship was created.
• Status: string
  Read Only: true

  Maximum Length: 1

  Default Value: A

  Indicates if the relationship is active or inactive, such as A for active and I for inactive. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SubjectPartyId: integer (int64)
  The unique identifier of the subject party in this relationship.
• SubjectPartyName: string
  Title: Subject Party Name

  Read Only: true

  Maximum Length: 360

  The name of the subject party.
• SubjectPartyNumber: string
  Title: Subject Registry ID

  Maximum Length: 30

  The alternate key identifier for the subject party of the relationship.
• SubjectSourceSystem: string
  Title: Subject Source System

  The name of the external source system for the subject party in the relationship.
• SubjectSourceSystemReferenceValue: string
  Title: Subject Source System Reference

  The identifier for the subject party in the relationship from the external source system.
• SubjectTableName: string
  Maximum Length: 30

  The source table of the subject.
• SubjectType: string
  Maximum Length: 30

  The subject type of the contact.
• SubjectUsageCode: string
  Maximum Length: 30

  The usage code of subject party in the contact.

{
    "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
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.",
            "nullable":false,
            "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
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the relationship was created.",
            "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 the external source system for the subject party in the relationship.",
            "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 unique identifier of the subject party in this 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 relationship record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the relationship is active or inactive, such as A for active and I for inactive. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "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 the external source system.",
            "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 number to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "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 where the relationship is imported from. The values configured in setup task Trading Community Source System.",
            "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 the external source system.",
            "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 login of the user who last updated the 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 unique identifier of the object party in this 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 alternate key identifier for 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":"The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.",
            "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-provided comments for the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.",
            "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 the external source system for the object party in the relationship.",
            "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 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 : accounts-SalesTeamMember-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.
• AssignmentTypeCode: string
  Title: Assignment Type

  Maximum Length: 30

  Default Value: MANUAL

  The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• EndDateActive: string (date)
  Title: Archived Date

  The date when the resource is dissociated from the sales account.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockAssignmentFlag: boolean
  Title: Locked

  Maximum Length: 1

  Default Value: false

  Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OwnerFlag: boolean
  Title: Owner

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  The party number. 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 unique identifier of the relationship from external source system.
• ResourceEmailAddress: string
  Title: Resource Email

  The e-mail address of the resource.
• ResourceId: integer (int64)
  Title: Resource ID

  The resource identifier.
• ResourceName: string
  Title: Resource Name

  Read Only: true

  The name of the sales team member.
• ResourceOrgName: string
  Read Only: true

  The name of the organization that the sales team member belongs to.
• ResourcePartyNumber: string
  Title: Resource Party Number

  The unique public identifier of the resource record.
• ResourcePhoneNumber: string
  Title: Phone

  Read Only: true

  The primary phone number of the sales team member.
• ResourceRoleName: string
  Title: Role

  Read Only: true

  The roles assigned to the sales team member.
• SalesProfileId: integer (int64)
  Title: Sales Account ID

  The unique identifier of the sales account.
• StartDateActive: string (date)
  Title: Start Date

  The date when the resource is associated with the sales account.
• TeamMemberId: integer (int64)
  Title: Sales Account Resource ID

  The unique identifier of the member of the sales account resource team.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date on which the record was last updated by a specific user.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourcePhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The primary phone number of the sales team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "type":"string",
            "description":"The name of the sales team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date on which the record was last updated by a specific user.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.",
            "nullable":true,
            "default":"MANUAL",
            "x-queryable":false
        },
        "ResourceEmailAddress":{
            "title":"Resource Email",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "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-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the resource is associated with the sales account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TeamMemberId":{
            "title":"Sales Account Resource ID",
            "type":"integer",
            "description":"The unique identifier of the member of the sales account resource team.",
            "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-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "type":"string",
            "description":"The unique public identifier of the resource record.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceOrgName":{
            "type":"string",
            "description":"The name of the organization that  the sales team member belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "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":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SalesProfileId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ResourceRoleName":{
            "title":"Role",
            "type":"string",
            "description":"The roles assigned to the sales team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateActive":{
            "title":"Archived Date",
            "type":"string",
            "description":"The date when the resource is dissociated from the sales account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The resource identifier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Locked",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : accounts-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

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Indicates whether the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionURLBinding: array Smart Action REST Path Parameter Definitions
  Title: Smart Action REST Path Parameter Definitions

  The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-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":"The client applications that the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/accounts-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "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

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

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

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/accounts-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : accounts-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

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique system assigned identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "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":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "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 : accounts-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "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":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "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 : accounts-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "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":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"The value assigned to the name property of a name-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 : accounts-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 after which the record is inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
• PartyId: integer (int64)
  The unique identifier of the associated account.
• PartyNumber: string
  Title: Party Number

  The alternate unique identifier of the associated account. Inactive records can't be updated.
• PartySourceSystem: string
  Title: Party Source System

  The source system name for the account.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The identifier for the record from an external source system.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  The name of the source system.
• SourceSystemReferenceId: integer (int64)
  Read Only: true

  The unique identifier of the source system reference.
• SourceSystemReferenceValue: string
  Maximum Length: 255

  The source system reference value required to identify the associated account.
• StartDate: string (date)
  The date when the record was created.
• Status: string
  Maximum Length: 1

  Default Value: A

  Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.

{
    "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":"Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.",
            "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 unique identifier of the source system reference.",
            "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.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"The date after which the record is inactive.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The source system reference value required to identify the associated account.",
            "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 date when the record was created.",
            "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 alternate unique identifier of the associated account. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated account.",
            "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 comparedat 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 name of the source system.",
            "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"
    }
}

Links

AccountContact

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact

Parameters:

• PartyNumber: $request.path.PartyNumber

The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.

AccountExtensionBase

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase

Parameters:

• PartyNumber: $request.path.PartyNumber

The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.

AccountHierarchySummary

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountHierarchySummary

Parameters:

• PartyNumber: $request.path.PartyNumber

The account hierarchy summaries resource is used to view the account hierarchy information.

AccountRollup

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup

Parameters:

• PartyNumber: $request.path.PartyNumber

The account rollups resource is used to view, create, update, and delete an account rollup.

AccountTeam

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountTeam

Parameters:

• PartyNumber: $request.path.PartyNumber

The account team resource is used to view the team members and territory team members associated with an account.

AdditionalIdentifier

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

Parameters:

• PartyNumber: $request.path.PartyNumber

The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Address

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address

Parameters:

• PartyNumber: $request.path.PartyNumber

The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.

Attachment

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

Parameters:

• PartyNumber: $request.path.PartyNumber

The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.

CertificationLevelLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_LEVEL

The list of values indicating the certification level of the account, such as Minimum or Highest.

The following properties are defined on the LOV link relation:

• Source Attribute: CertificationLevel; Target Attribute: LookupCode
• Display Attribute: Meaning

CertificationReasonCodeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_REASON

The list of values indicating the current certification level assignment of the account, such as Manual or Third-Party.

The following properties are defined on the LOV link relation:

• Source Attribute: CertificationReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ContactPoint

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint

Parameters:

• PartyNumber: $request.path.PartyNumber

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

CountriesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

Parameters:

• finder: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryCode
• Display Attribute: TerritoryShortName

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/accounts/{PartyNumber}/child/CustomerClassification

Parameters:

• PartyNumber: $request.path.PartyNumber

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

DataCloudStatusLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DDATA_CLOUD_STATUS

The list of values indicating the enrichment status of the organization record, such as Enriched, Deleted, or Matched.

The following properties are defined on the LOV link relation:

• Source Attribute: DataCloudStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

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: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DEMP_AT_PRIMARY_ADR_EST_IND

The list of values indicating the number of employees in the organization at the primary location, such as minimum or maximum.

The following properties are defined on the LOV link relation:

• Source Attribute: EmployeesAtPrimaryAddressEstimation; Target Attribute: LookupCode
• Display Attribute: Meaning

EmployeeAtPrimaryAdrMinimumIndLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DEMP_AT_PRIMARY_ADR_MIN_IND

The list of values indicating the minimum number of employees in the organization at the primary location.

The following properties are defined on the LOV link relation:

• Source Attribute: EmployeesAtPrimaryAddressMinimum; Target Attribute: LookupCode
• Display Attribute: Meaning

EngagementLevelLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ZCA_ENGAGEMENT_LEVEL

The following properties are defined on the LOV link relation:

• Source Attribute: EngagementLevel; Target Attribute: LookupCode
• Display Attribute: Meaning

FavoriteAccountFlagLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating the account is a favorite account.

The following properties are defined on the LOV link relation:

• Source Attribute: FavoriteAccountFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

FaxCountryCodeLOV

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The list of values indicating the international country codes for the fax number.

The following properties are defined on the LOV link relation:

• Source Attribute: FaxCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

FaxVerificationStatusLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{FaxVerificationStatus}

The following properties are defined on the LOV link relation:

• Source Attribute: FaxVerificationStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

FiscalYearendMonthLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DMONTH

The list of values indicating the last fiscal month of the organization, such as March or December.

The following properties are defined on the LOV link relation:

• Source Attribute: FiscalYearendMonth; Target Attribute: LookupCode
• Display Attribute: Meaning

FuseTypeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeTagFinder%3BBindLookupType%3DPARTY_SITE_USE_CODE%2CBindTag%3DSALES_CLOUD

The following properties are defined on the LOV link relation:

• Source Attribute: AddressTypeList; Target Attribute: LookupCode
• Display Attribute: Meaning

HQBranchIndLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHQ_BRANCH_IND

The list of values indicating if the site is a headquarter or branch, such as Branch, Division, or Headquarters.

The following properties are defined on the LOV link relation:

• Source Attribute: HQBranchIndicator; Target Attribute: LookupCode
• Display Attribute: Meaning

IndustryCodeVA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: IndustryClassCategoryFinder

The list of values indicating the standard industry classification code.

The following properties are defined on the LOV link relation:

• Source Attribute: IndustryCode; Target Attribute: ClassCode
• Display Attribute: ClassCodeMeaning

LegalStatusLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DLEGAL_STATUS

The list of values indicating the legal status of the organization, such as Mutual Company, Cooperative, and General partnership.

The following properties are defined on the LOV link relation:

• Source Attribute: LegalStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

LocalBusIdenTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DLOCAL_BUS_IDEN_TYPE

The list of values indicating the most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan.

The following properties are defined on the LOV link relation:

• Source Attribute: LocalBusinessIdentifierType; Target Attribute: LookupCode
• Display Attribute: Meaning

Note

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note

Parameters:

• PartyNumber: $request.path.PartyNumber

The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.

OrgSizeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_ORGANIZATION_SIZE

The list of values indicating the organization size based on the revenue, number of employees, and so on. The sample values are Small, Medium, and Large.

The following properties are defined on the LOV link relation:

• Source Attribute: OrganizationSize; Target Attribute: LookupCode
• Display Attribute: Meaning

OrganizationTypeVA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: ClassCategoryFinder%3BBindClassCategory%3DORGANIZATION_TYPE

The list of values indicating the organization type classification for the account.

The following properties are defined on the LOV link relation:

• Source Attribute: OrganizationTypeCode; Target Attribute: ClassCode
• Display Attribute: ClassCodeMeaning

PhoneCountryCodeLOV

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The list of values indicating the international country codes for the phone number.

The following properties are defined on the LOV link relation:

• Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

PhoneVerificationStatusLookupVA

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: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_PREFERRED_CONTACT_METHOD

The list of values indicating the preferred contact method of the account, such as mail and phone.

The following properties are defined on the LOV link relation:

• Source Attribute: PreferredContactMethod; Target Attribute: LookupCode
• Display Attribute: Meaning

PrimaryAddress

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress

Parameters:

• PartyNumber: $request.path.PartyNumber

The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.

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: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DREGISTRATION_TYPE

The list of values indicating the registration status of the organization, such as Profit and Nonprofit.

The following properties are defined on the LOV link relation:

• Source Attribute: RegistrationType; Target Attribute: LookupCode
• Display Attribute: Meaning

Relationship

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship

Parameters:

• PartyNumber: $request.path.PartyNumber

The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.

RentOwnIndLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DOWN_RENT_IND

The list of values indicating if the organization owns or rents it current premises.

The following properties are defined on the LOV link relation:

• Source Attribute: RentOrOwnIndicator; Target Attribute: LookupCode
• Display Attribute: Meaning

SalesProfileStatusLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_SALES_ACCOUNT_STATUS

The list of values indicating the status of the account, such as active or inactive.

The following properties are defined on the LOV link relation:

• Source Attribute: SalesProfileStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

SalesProfileTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_ACCOUNT_TYPE

The list of values indicating if the type of the account, such as customer or prospect.

The following properties are defined on the LOV link relation:

• Source Attribute: Type; Target Attribute: LookupCode
• Display Attribute: Meaning

SalesTeamMember

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember

Parameters:

• PartyNumber: $request.path.PartyNumber

Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.

SearchFilters

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_ACCT_SRCH_RECORD_SET

The list of values indicating the record set to display search values, such as AllAccounts and MyAccounts.

The following properties are defined on the LOV link relation:

• Source Attribute: RecordSet; Target Attribute: LookupCode
• Display Attribute: Meaning

SourceSystemReference

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

Parameters:

• PartyNumber: $request.path.PartyNumber

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

StatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_STATUS

The list of values indicating the status of the account, such as active or inactive.

The following properties are defined on the LOV link relation:

• Source Attribute: PartyStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

TerritoriesLOV

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

TotalEmployeeEstIndLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DTOTAL_EMP_EST_IND

The list of values indicating the method used to calculate the total number of employees, such as actual or estimated.

The following properties are defined on the LOV link relation:

• Source Attribute: TotalEmployeesEstimatedIndicator; Target Attribute: LookupCode
• Display Attribute: Meaning

TotalEmployeeMinimumIndLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DTOTAL_EMP_MIN_IND

The list of values indicating if the total number of employees is a minimum, average, or maximum.

The following properties are defined on the LOV link relation:

• Source Attribute: TotalEmployeesMinimumIndicator; Target Attribute: LookupCode
• Display Attribute: Meaning

TotalEmployeesIndLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DTOTAL_EMPLOYEES_INDICATOR

The list of values indicating if the total number of employees includes employees from subsidiaries, such as Subsidiaries not included.

The following properties are defined on the LOV link relation:

• Source Attribute: TotalEmployeesIndicator; Target Attribute: LookupCode
• Display Attribute: Meaning

smartActions

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

Parameters:

• PartyNumber: $request.path.PartyNumber

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Back to Top

Examples

The following example shows how to update an account by submitting a patch request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_262783

Example of Request Body

The following shows an example of the request body in JSON format.

Content-Type: {
"OrganizationName": "Pinnacle Inc",
"Type": "ZCA_CUSTOMER",
"PrimaryAddress": [{
"AddressLine1": "600 oracle parkway",
"City": "Redwood Shores",
"State": "CA",
"Country": "US"
}]
}

Example of Response Body

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

Content-Type: {
PartyId: 300100039356037
PartyNumber: "CDRM_262783"
OrganizationName: "Pinnacle Flowers"
PrimaryAddress: 
[
{
AddressId: 300100039356039
AddressNumber: "CDRM_170960"
SourceSystem: null
SourceSystemReferenceValue: null
AddressLine1: "600 oracle parkway"
City: "Redwood Shores"
Country: "US"
State: "CA"
}
-
}

Convert a Prospect to an Account

The following example shows how to convert a prospect to an account by submitting a PUT request on the REST resource using cURL. For more such examples see Convert a Prospect to an Account.

cURL Command

crmRestApi/resources/11.13.18.05/accounts/CDRM_290880

Example of Request Body

The following an example of the request body in JSON format.

{
  "Type": "ZCA_CUSTOMER"
}

Example of Response Body

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

Content-Type: {
   "items" : [12]
   -0: {
      "PartyId" : 999997568799048,
      "PartyNumber" : "CDRM_290880",
      "SourceSystem" : null,
      "SourceSystemReferenceValue" : null,
      "OrganizationName" : "High Technology_102304669",
      "UniqueNameSuffix" : "(REDWOOD CITY, US)",
      "PartyUniqueName" : "High Technology_102304669 (REDWOOD CITY, US)",
      "Type" : "ZCA_CUSTOMER",
      "OwnerPartyId" : null,
      "OwnerPartyNumber" : null,
      "OwnerEmailAddress" : null,
      "OwnerName" : null
...
      }
    -1:
{
...
}
 ...
}

Back to Top