Jump to

• Request
• Response
• Examples

Update a household

patch

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}

Request

Path Parameters

• PartyNumber(required): string
  The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. 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

• AdditionalIdentifier: array Additional Identifiers
  Title: Additional Identifiers

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

  The additional name resource is used to view, create, update, and delete additional names associated with an account. You can use the resource 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 a household. An address contains the detailed location information of a household.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  Additional address element to support flexible address format
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  First line of address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line of address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line of address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line of address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  Phonetic or Kana representation of the Kanji address lines (used in Japan)
• AddressType: string
  Title: Type

  Additional information as type of address like BillTo, ShipTo.
• AnnualIncome: integer (int64)
  Title: Annual Income

  The annual income of the household. If not provided, then the value is NULL.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.
• AverageAge: integer (int64)
  Title: Average Age

  The average age of the household.
• Building: string
  Title: Building

  Maximum Length: 240

  Specific building name or number at a given address.
• CertificationLevel: string
  Title: Certification Level

  Maximum Length: 30

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

  Maximum Length: 30

  The reason for the household 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 task, Manage Trading Community Common Lookups.
• Child0to6Number: integer (int64)
  Title: Children Below 7 Years of Age

  The number of children in the age range 0-6.
• Child13to18Number: integer (int64)
  Title: Children Aged 13 to 18 Years

  The number of children in the age range 13-18.
• Child7to12Number: integer (int64)
  Title: Children Aged 7 to 12 Years

  The number of children in the age range 7-12.
• City: string
  Title: City

  Maximum Length: 60

  The city element of address.
• ClassificationCategory: string
  Title: Classification Category

  A valid classification category code for the household which will be marked as primary and is defined by an admin.
• ClassificationCode: string
  Title: Classification Code

  A valid classification code corresponding to the classification category and which will be marked as primary.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The description for a group.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict for the household data record. This number is used by mobile or portable applications that consume the web service.
• 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.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the household. 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

  Country code of the address.
• County: string
  Title: County

  Maximum Length: 60

  County element of address.
• CreatedByModule: string
  Title: Created by Application

  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.
• CreatedByModule1: string
  Maximum Length: 30

  The application module that created the household record.
• CurcyConvRateType: string
  Maximum Length: 30

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

  Maximum Length: 15

  The currency code associated with the household. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.
• 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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
• DependentsNumber: integer (int64)
  Title: Number of Dependents

  The number of dependents on the household.
• EffectiveLatestChange: string
  Maximum Length: 1

  Default Value: Y

  Indicates whether the row has the latest change in the day. If the value is True, then this row has the latest change in the day.
• EffectiveSequence: integer (int32)
  The order of the different changes made during the day. The lowest value represents the earliest change in the day.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

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

  Maximum Length: 30

  The format for an e-mail preferred by the household, such as HTML or ASCII.
• EmailVerificationDate: string (date)
  Title: Email Verification Date

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

  Maximum Length: 30

  The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email.
• FavoriteHouseholdFlag: boolean
  Title: Favorite

  Maximum Length: 10

  Default Value: false

  Indicates if the household is a favorite household. The default value is false.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The specific floor number at a given address or in a particular building when the building number is provided.
• GroupPartyId: integer (int64)
  The unique identifier of the group party.
• HouseholdName: string
  Title: Name

  Maximum Length: 360

  The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES.
• HouseholdSize: integer (int64)
  Title: Size

  The size of the group.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization
• MedianAge: integer (int64)
  Title: Median Age

  The median age.
• NamedFlag: boolean
  Title: Named Household

  Maximum Length: 1

  Default Value: false

  Indicates whether a sales account is a named sales account. Possible values are True or False. If the value is True, then the sales account is a named sales account. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Note: array Notes
  Title: Notes

  The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.
• ObjectVersionNumberEmail: integer (int32)
  The internal version number for the email. It is 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.
• ObjectVersionNumberGroup: integer (int32)
  The internal version number for the group. The number is 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.
• ObjectVersionNumberParty: integer (int32)
  The internal version number for the party. The number is 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.
• ObjectVersionNumberPhone: integer (int32)
  The internal version number for the phone. The number is 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.
• ObjectVersionNumberSalesAccount: integer (int32)
  The internal version number for the sales account. The number is 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.
• OwnerPartyId: integer (int64)
  Title: Owner ID

  The unique identifier of sales account owner. To assign an owner to the sales account, you must provide either owner's party identifier, party number, or email address.
• PartyNumberKey: string
  Title: Registry ID

  Maximum Length: 30

  The alternate unique identifier of the household party record.
• PhoneAreaCode: string
  Title: 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: Extension

  Maximum Length: 20

  The additional number addressed after initial connection to an internal telephone system.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  A telephone number formatted 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 was last verified.
• PhoneVerificationStatus: string
  Title: Phone Verification Status

  Maximum Length: 30

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

  Maximum Length: 60

  The postal code as defined by the formal countrywide postal system.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

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

  Maximum Length: 30

  Indicates how a household prefers to be contacted. Validated against lookup type PREFERRED_CONTACT_METHOD. A list of valid codes is defined in the lookup HZ_PREFERENCE. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• PreferredFunctionalCurrency: string
  Title: Preferred Functional Currency

  Maximum Length: 15

  The code indicating the preferred currency for the group.
• PrimaryAddress: array Primary Addresses
  Title: Primary Addresses

  The primary addresses resource is used to view, create, update, and delete the primary addresses of the households. A primary address is the default communication address of a household.
• PrimaryContactPartyId: integer (int64)
  The unique identifier of the primary contact. To specify the contact for an household, you can provide either contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• PrimaryContactPartyNumber: string
  The alternate key identifier of the of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• PrimaryContactSourceSystem: string
  The SourceSystem of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• PrimaryContactSourceSystemReferenceValue: string
  The SourceSystemReference of the primary contact. To specify the contact for an household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• Province: string
  Title: Province

  Maximum Length: 60

  The province element of address.
• RawPhoneNumber: string
  Title: Raw Phone Number

  Maximum Length: 60

  The raw phone number.
• Relationship: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.
• SalesProfileNumber: string
  Title: Sales Account Number

  Maximum Length: 30

  The alternate unique identifier of the record.
• SalesProfileStatus: string
  Title: Status

  Maximum Length: 30

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

  Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
• 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.
• 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: Source System Reference

  The unique identifier for the household 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.
• State: string
  Title: State

  Maximum Length: 60

  The state element of address.
• Type: string
  Title: Type

  Maximum Length: 30

  The household party type that defines whether the household is a sales account or a prospect or any other user-defined party type as specified using the lookup type ZCA_ HOUSEHOLD _TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. Possible values are ZCA_CUSTOMER or ZCA_PROSPECT. A list of valid values is defined in the lookup ZCA_HOUSEHOLD_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• UniqueNameSuffix: string
  Title: Name Suffix

  Maximum Length: 540

  The system-generated or manually overridden suffix, that is concatenated to the householdName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
• WealthAmount: integer
  Title: Total Wealth

  The household wealth amount or net worth. If not provided, then the value is NULL.

{
    "type":"object",
    "properties":{
        "PartyNumberKey":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the household party record.",
            "nullable":false
        },
        "EffectiveLatestChange":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the row has the latest change in the day. If the value is True, then this row has the latest change in the day.",
            "nullable":false,
            "default":"Y"
        },
        "Address":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource is used to view, create, update, and delete addresses of a household. An address contains the detailed location information of a household.",
            "items":{
                "$ref":"#/components/schemas/households-Address-item-patch-request"
            }
        },
        "NamedFlag":{
            "title":"Named Household",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a sales account is a named sales account. Possible values are True or False. If the value is True, then the sales account is a named sales account. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"NamedFlag",
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.",
            "items":{
                "$ref":"#/components/schemas/households-Attachment-item-patch-request"
            }
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the household. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "EmailFormat":{
            "title":"Email Format",
            "maxLength":"30",
            "type":"string",
            "description":"The format for an e-mail preferred by the household, such as HTML or ASCII.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the household data record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumberEmail":{
            "type":"integer",
            "description":"The internal version number for the email. It is 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"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the household. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CurrencyCode",
                "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
        },
        "DependentsNumber":{
            "title":"Number of Dependents",
            "type":"integer",
            "description":"The number of dependents on the household.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DependentsNumber",
                "precision":"18"
            }
        },
        "ClassificationCode":{
            "title":"Classification Code",
            "type":"string",
            "description":"A valid classification code corresponding to the classification category and which will be marked as primary.",
            "nullable":true,
            "x-queryable":false
        },
        "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":[
                    "=",
                    "<>"
                ]
            }
        },
        "Child7to12Number":{
            "title":"Children Aged 7 to 12 Years",
            "type":"integer",
            "description":"The number of children in the age range 7-12.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Child7to12Number",
                "precision":"18"
            }
        },
        "EffectiveSequence":{
            "type":"integer",
            "description":"The order of the different changes made during the day. The lowest value represents the earliest change in the day.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            }
        },
        "EmailVerificationStatus":{
            "title":"Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "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":false
        },
        "PrimaryContactPartyId":{
            "type":"integer",
            "description":"The unique identifier of the primary contact. To specify the contact for an household, you can provide either contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PreferredContactId",
                "precision":"18"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the household. 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
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates how a household prefers to be contacted. Validated against lookup type PREFERRED_CONTACT_METHOD. A list of valid codes is defined in the lookup HZ_PREFERENCE.  Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PreferredContactMethod",
                "controlType":"choice"
            }
        },
        "ObjectVersionNumberSalesAccount":{
            "type":"integer",
            "description":"The internal version number for the sales account. The number is 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"
            }
        },
        "PreferredFunctionalCurrency":{
            "title":"Preferred Functional Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the preferred currency for the group.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PreferredFunctionalCurrency",
                "controlType":"choice"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AverageAge":{
            "title":"Average Age",
            "type":"integer",
            "description":"The average age of the household.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AverageAge",
                "precision":"18"
            }
        },
        "CertificationLevel":{
            "title":"Certification Level",
            "maxLength":"30",
            "type":"string",
            "description":"The certification level of a household. 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"
            }
        },
        "ClassificationCategory":{
            "title":"Classification Category",
            "type":"string",
            "description":"A valid classification category code for the household which will be marked as primary and is defined by an admin.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact point.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The additional number addressed after initial connection to an internal telephone system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            }
        },
        "PhoneVerificationStatus":{
            "title":"Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the phone number verification. The values based on lookup are valid and invalid for phone.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PrimaryContactPartyNumber":{
            "type":"string",
            "description":"The alternate key identifier of the of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second line of 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":"First line of 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":"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"
            }
        },
        "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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
            "items":{
                "$ref":"#/components/schemas/households-CustomerClassification-item-patch-request"
            }
        },
        "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"
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of 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 note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.",
            "items":{
                "$ref":"#/components/schemas/households-Note-item-patch-request"
            }
        },
        "UniqueNameSuffix":{
            "title":"Name Suffix",
            "maxLength":"540",
            "type":"string",
            "description":"The system-generated or manually overridden suffix, that is concatenated to the householdName 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":"Additional address element to support flexible address format",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"Country code of the address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The date when email address was last verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":true
        },
        "SalesTeamMember":{
            "title":"Sales Account Resources",
            "type":"array",
            "description":"Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
            "items":{
                "$ref":"#/components/schemas/households-SalesTeamMember-item-patch-request"
            }
        },
        "RawPhoneNumber":{
            "title":"Raw Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The raw phone number.",
            "nullable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Specific building name or number at a given address.",
            "nullable":true
        },
        "ObjectVersionNumberPhone":{
            "type":"integer",
            "description":"The internal version number for the phone. The number is 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"
            }
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true
        },
        "PrimaryAddress":{
            "title":"Primary Addresses",
            "type":"array",
            "description":"The primary addresses resource is used to view, create, update, and delete the primary addresses of the households. A primary address is the default communication address of a household.",
            "items":{
                "$ref":"#/components/schemas/households-PrimaryAddress-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "Child13to18Number":{
            "title":"Children Aged 13 to 18 Years",
            "type":"integer",
            "description":"The number of children in the age range 13-18.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Child13to18Number",
                "precision":"18"
            }
        },
        "CertificationReasonCode":{
            "title":"Certification Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for the household 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 task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CertificationReasonCode",
                "controlType":"choice"
            }
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":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. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.",
            "items":{
                "$ref":"#/components/schemas/households-AdditionalName-item-patch-request"
            }
        },
        "HouseholdSize":{
            "title":"Size",
            "type":"integer",
            "description":"The size of the group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"GroupSize",
                "precision":"18"
            }
        },
        "SalesProfileNumber":{
            "title":"Sales Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the record.",
            "nullable":false
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":true
        },
        "ObjectVersionNumberGroup":{
            "type":"integer",
            "description":"The internal version number for the group. The number is 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"
            }
        },
        "HouseholdName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES.",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"GroupName",
                "protectionKey":"GroupDEO.GroupName",
                "protectionObjectTitle":"Household",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "PrimaryContactSourceSystem":{
            "type":"string",
            "description":"The SourceSystem of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"County element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "ObjectVersionNumberParty":{
            "type":"integer",
            "description":"The internal version number for the party. The number is 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"
            }
        },
        "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":"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"
            }
        },
        "AdditionalIdentifier":{
            "title":"Additional Identifiers",
            "type":"array",
            "description":"The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.",
            "items":{
                "$ref":"#/components/schemas/households-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/households-ContactPoint-item-patch-request"
            }
        },
        "Child0to6Number":{
            "title":"Children Below 7 Years of Age",
            "type":"integer",
            "description":"The number of children in the age range 0-6.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Child0to6Number",
                "precision":"18"
            }
        },
        "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/households-SourceSystemReference-item-patch-request"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"Phonetic or Kana representation of the Kanji address lines (used in Japan)",
            "nullable":true
        },
        "CreatedByModule1":{
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created the household record.",
            "nullable":true
        },
        "MedianAge":{
            "title":"Median Age",
            "type":"integer",
            "description":"The median age.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"MedianAge",
                "precision":"18"
            }
        },
        "OwnerPartyId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of sales account owner. To assign an owner to the sales account, you must provide either owner's party identifier, party number, or email address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"OwnerPartyId",
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The description for a group.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Comments",
                "protectionKey":"GroupDEO.Comments",
                "protectionObjectTitle":"Household",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Comments"
            }
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference",
            "type":"string",
            "description":"The unique identifier for the household 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
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The household party type that defines whether the household is a sales account or a prospect or any other user-defined party type as specified using the lookup type ZCA_ HOUSEHOLD _TYPE.  It is defaulted to ZCA_CUSTOMER if no value is provided. Possible values are ZCA_CUSTOMER or ZCA_PROSPECT. A list of valid values is defined in the lookup ZCA_HOUSEHOLD_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SalesProfileType",
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "GroupPartyId":{
            "type":"integer",
            "description":"The unique identifier of the group party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"PartyId",
                "precision":"18"
            }
        },
        "PrimaryContactSourceSystemReferenceValue":{
            "type":"string",
            "description":"The SourceSystemReference of the primary contact. To specify the contact for an household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "Relationship":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.",
            "items":{
                "$ref":"#/components/schemas/households-Relationship-item-patch-request"
            }
        },
        "WealthAmount":{
            "title":"Total Wealth",
            "type":"integer",
            "description":"The household wealth amount or net worth. If not provided, then the value is NULL.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"WealthAmount"
            }
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"A telephone number formatted 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"
            }
        },
        "FavoriteHouseholdFlag":{
            "title":"Favorite",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates if the household is a favorite household. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"Additional information as type of address like BillTo, ShipTo.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneVerificationDate":{
            "title":"Phone Verification Date",
            "type":"string",
            "description":"The date when phone number was last verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "AnnualIncome":{
            "title":"Annual Income",
            "type":"integer",
            "description":"The annual income of the household. If not provided, then the value is NULL.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AnnualIncome",
                "precision":"18"
            }
        }
    }
}

Nested Schema : Additional Identifiers

Type: array

Title: Additional Identifiers

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

Show Source

• Array of: object schema

{
    "title":"Additional Identifiers",
    "type":"array",
    "description":"The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.",
    "items":{
        "$ref":"#/components/schemas/households-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. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.

Show Source

• Array of: object households-AdditionalName-item-patch-request

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

Nested Schema : Addresses

Type: array

Title: Addresses

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

Show Source

• Array of: object households-Address-item-patch-request

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

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.",
    "items":{
        "$ref":"#/components/schemas/households-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 schema

{
    "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/households-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 households. 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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
    "items":{
        "$ref":"#/components/schemas/households-CustomerClassification-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

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

Show Source

• Array of: object schema

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.",
    "items":{
        "$ref":"#/components/schemas/households-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 households. A primary address is the default communication address of a household.

Show Source

• Array of: object households-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 households. A primary address is the default communication address of a household.",
    "items":{
        "$ref":"#/components/schemas/households-PrimaryAddress-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.

Show Source

• Array of: object schema

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.",
    "items":{
        "$ref":"#/components/schemas/households-Relationship-item-patch-request"
    }
}

Nested Schema : Sales Account Resources

Type: array

Title: Sales Account Resources

Sales account resources is used to view, create, update, and delete a resource party that is 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 households-SalesTeamMember-item-patch-request

{
    "title":"Sales Account Resources",
    "type":"array",
    "description":"Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
    "items":{
        "$ref":"#/components/schemas/households-SalesTeamMember-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/households-SourceSystemReference-item-patch-request"
    }
}

Nested Schema : schema

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 the party identifier.
• PartyIdentifierValue: string
  Title: Identifier Value

  Maximum Length: 60

  The value of the party identifier.
• PartyNumber: string
  The party number of the additional identifier. 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 the 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 of the additional identifier. 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 : households-AdditionalName-item-patch-request

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 attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
• 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 of a person.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of a person.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of a person.
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the record.
• PartySourceSystem: string
  The source system name.
• PartySourceSystemReferenceValue: string
  The identifier for the record from the original system.
• 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 the source system for the associated party.
• SourceSystemReferenceValue: string
  The identifier of the source system reference for the associated party.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A.
• 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 source system name.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of a person.",
            "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 of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"The attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier of the source system reference for the associated party.",
            "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 record.",
            "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 identifier for the record from the original system.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of the source system for the associated party.",
            "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 : households-Address-item-patch-request

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 560

  Phonetic or Kana representation of the Kanji address lines (used 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 address type as a string.
• Building: string
  Title: Building

  Maximum Length: 240

  Specific building name or number at a given address.
• CalculateFormattedAddress: boolean
  The indicator to process formatted address of the party record.
• City: string
  Title: City

  Maximum Length: 60

  The city element of address.
• ClliCode: string
  Title: CLLI Code

  Maximum Length: 60

  The Common Language Location Identifier (CLLI) code 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 for the address record. 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 address. 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 element of address.
• CreatedByModule: string
  Default Value: HZ_WS

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

  Maximum Length: 30

  The module that created the record.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

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

  Maximum Length: 15

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

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

  Maximum Length: 2000

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

  Default Value: false

  Indicates whether the address should not be used for mailing. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null.
• 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 this address is rendered inactive.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The specific floor number at a given address or in a particular building when building number is provided.
• 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. This is used for spatial proximity and containment purposes.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

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

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

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

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization.
• ObjectVersionNumber: integer (int32)
  The 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.
• ObjectVersionNumber1: integer (int32)
  The number used to implement optimistic locking for address record. 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, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.
• PartyNumber: string
  Title: Party Number

  The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

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

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

  The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code as defined by the formal countrywide postal system.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

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

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Province: string
  Title: Province

  Maximum Length: 60

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

  Maximum Length: 60

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

  Maximum Length: 1

  Default Value: A

  An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. 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":{
        "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/households-Address-AddressPurpose-item-patch-request"
            }
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. This 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 associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the address record. 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/households-Address-AddressLocale-item-patch-request"
            }
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code related to the address. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "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":"A user-defined code to indicate a mail drop point within their 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 this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES.  Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the address. 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. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A"
        },
        "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
        },
        "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":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. This is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing.",
            "nullable":true,
            "default":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for address record. 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 this address is rendered inactive.",
            "format":"date",
            "nullable":true
        },
        "CalculateFormattedAddress":{
            "type":"boolean",
            "description":"The indicator to process formatted address of the party record.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":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"
            }
        },
        "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":"Specific building name or number at a given address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "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
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":false,
            "default":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"An extensive description of the location.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "ObjectVersionNumber":{
            "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"
            }
        },
        "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":"Phonetic or Kana representation of the Kanji address lines (used 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 module that created the record.",
            "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 this 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. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.",
            "nullable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The address type as a string.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true
        },
        "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/households-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 households-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/households-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 : households-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 True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• 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 True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "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. For example, a 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 attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

  The URL of the attachment.

{
    "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. For example, a 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 attachment.",
            "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 : schema

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.
• CreatedByModule: string
  Title: Created by Application

  Default Value: HZ_WS

  The application module that created this contact point 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.
• DoContactPreferenceFlag: boolean
  Title: OK to Contact

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

  Indicates whether the record can be contacted.
• 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 record of type email.
• EmailPurpose: string
  Title: Email Purpose

  Maximum Length: 30

  The purpose of using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The number used to implement optimistic locking for contact point record. 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 associated party record for contact point.
• PartyNumber: string
  Title: Registry ID

  The public unique identifier of the associated party record.
• PartySourceSystem: string
  Title: Party Source System

  The name of external source system of the account, contact or household with which the contact point 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 from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 255

  The area code for the phone 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 phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.
• 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 this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.
• RawPhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The raw phone number on the contact point record of type phone.
• 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 administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
• SourceSystemReferenceValue: string
  Title: Source System Reference Value

  The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.
• URL: string
  Title: URL

  The URL of 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 this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "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 of the contact point.",
            "nullable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"255",
            "type":"string",
            "description":"The area code for the phone 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 optimistic locking for contact point record. 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"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The application module that created this contact point 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
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.",
            "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 contact point 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 record of type email.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't 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 public unique identifier of the associated party record.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the associated party record for contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The type of phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoNotContactPreferenceFlag":{
            "title":"Do Not Contact",
            "type":"boolean",
            "description":"Indicates whether the record can be contacted.",
            "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 using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.",
            "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 raw phone number on the contact point record of type phone.",
            "nullable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of external source system, which is defined by an administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't 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 note. 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 identifier of the person who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

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

  Maximum Length: 15

  The currency code attribute associated with the note. 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.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

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

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

  Maximum Length: 30

  The code used to classify a note, as asset or adjustment.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

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

  Maximum Length: 30

  Default Value: INTERNAL

  Specifies the visibility level of the note.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code attribute associated with the note. 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"
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc.",
            "nullable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the person who created the\nnote.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code used to classify a note, as asset or adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the note. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the note. 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":"Specifies 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":"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 : households-PrimaryAddress-item-patch-request

Type: object

Show Source

• Addressee: string
  Title: Addressee

  Maximum Length: 360

  The addressee of the household.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  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

  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. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix is defined as in profile option ZCA_PUID_PREFIX, concatenated with an internally generated unique sequence number.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given 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 for the primary address record. This number is used by mobile or portable applications that consume the web service.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• 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 element of the primary address.
• CurcyConvRateType: string
  Maximum Length: 30

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

  Maximum Length: 15

  The currency code associated with the primary address. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.
• DateValidated: string (date)
  Title: Validated Date

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

  Indicates whether the primary address is to be deleted. If the value is True, then the primary address will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Description: string
  Title: Description

  Maximum Length: 2000

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

  Maximum Length: 1

  Indicator to specify that a particular location isn't eligible for address validation irrespective of the current validation.
• EndDateActive: string (date)
  Title: To Date

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

  Maximum Length: 40

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

  Maximum Length: 30

  The type of the building mentioned 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. This 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 location.
• LocationId: integer (int64)
  The unique identifier for the location record for this address.
• LocationIntegrationKey: string
  The integration key for the location record.
• LocationLocationId: integer (int64)
  Title: Location ID

  The system identifier for the location record of the primary address.
• 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 location record of primary address.
• Longitude: number
  Title: Longitude

  The longitude information for the address. This 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 for the primary address. The number is 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 for primary address. The number is 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 for the primary address.
• PartySiteType: string
  Title: One-Time Address

  Maximum Length: 30

  The type of the party site. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

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

  Maximum Length: 20

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

  Maximum Length: 60

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

  Maximum Length: 240

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

  Maximum Length: 60

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

  Default Value: A

  Indicates the status of the primary address. Status codes are defined by the lookup HZ_STATUS.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 64

  The code of the time zone associated with the primary address.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to NULL.
• 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. This is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the primary address record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"The short description of the primary address.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the primary address. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the\norganization.",
            "nullable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicator to specify that a particular location isn't eligible for address validation irrespective of the current validation.",
            "nullable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the party site for the primary address.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the status of the primary address. Status codes are defined by the lookup HZ_STATUS.",
            "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 of the primary address.",
            "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. This is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "LocationStatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The location record of primary address.",
            "nullable":false,
            "default":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element 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 True, then the primary address will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":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"
            }
        },
        "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 was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to NULL.",
            "nullable":true,
            "default":false
        },
        "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"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a primary address record in active status.",
            "format":"date",
            "nullable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state element 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 for 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 alternate key identifier of the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix is defined as in profile option ZCA_PUID_PREFIX, concatenated with an internally generated unique sequence number.",
            "nullable":false
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"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":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "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
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The code of the time zone associated with the primary address.",
            "nullable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"An extensive description of the location.",
            "nullable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location for the primary address. The number is 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":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code element 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 element 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 of the party site. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.",
            "nullable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the building mentioned 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":"Phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the 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 addressee of the household.",
            "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 record for this address.",
            "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 for primary address. The number is 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. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 2000

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

  The unique identifier of the conflict for the relationship record. 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 dependent on another. Default value is N.
• 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. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.
• 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 in this relationship.
• ObjectPartyNumber: string
  Title: Object Registry ID

  Maximum Length: 30

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

  The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.
• ObjectSourceSystemReferenceValue: string
  Title: Object Source System Reference

  The unique identifier for the object party in the relationship from external source system.
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking for relationship record. 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.
• 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 the external source system for the relationship, which are defined by an admin as part of the system setup.
• RelationshipSourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• RequestId: integer (int64)
  The unique identifier of the request on relationship record.
• SubjectPartyId: integer (int64)
  The unique identifier of the subject in this relationship.
• SubjectPartyNumber: string
  Title: Subject Registry ID

  Maximum Length: 30

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

  The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.
• SubjectSourceSystemReferenceValue: string
  Title: Subject Source System Reference

  The unique identifier of the subject party in the relationship from 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 of the subject party of the relationship.",
            "nullable":false
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request on relationship record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments provided by the user.",
            "nullable":true
        },
        "JobDefinitionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The unique identifier of the subject party in the relationship from 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 for the relationship record. 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 the external source system for the relationship, which are defined by an admin as part of the system setup.",
            "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. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.",
            "nullable":true,
            "default":"N"
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the object 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 external source system for the object party in the relationship, which are defined by an admin as part of system setup.",
            "nullable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the object party of the relationship.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for relationship record. 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"
            }
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.",
            "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 in this relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The unique identifier for the object party in the relationship from external source system.",
            "nullable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is dependent on another. Default value is N.",
            "nullable":true,
            "default":"N"
        }
    }
}

Nested Schema : households-SalesTeamMember-item-patch-request

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• 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 sales team member. 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 associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the sales team member of the household object. 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.
• 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. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• ObjectVersionNumber: 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.
• OwnerFlag: boolean
  Title: Owner

  Default Value: false

  Indicates whether the resource is the owner.
• PartyId: integer
  The unique identifier of the associated party record for sales team member record.
• PartyNumber: string
  The public identifier of the associated party record.
• PartySourceSystem: string
  The name of external source system of the associated party record.
• PartySourceSystemReferenceValue: string
  The unique identifier from external source system of the associated party record.
• ResourceEmailAddress: string
  Title: Resource Email

  The email address of the resource.
• ResourcePartyNumber: string
  Title: Resource Party Number

  The alternate key identifier of the resource that this team member belongs to.
• StartDateActive: string (date)
  Title: Start Date

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

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

  The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system of the associated party record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the resource is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":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 email address of the resource.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the sales team member of the household object. 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"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier from external source system of the associated party record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the resource is associated with a 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 accounts 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 public identifier of the associated party record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated party record for sales team member record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            }
        },
        "ObjectVersionNumber":{
            "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-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "type":"string",
            "description":"The alternate key identifier of the resource that this team member belongs to.",
            "nullable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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. 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 sales team member. 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 : 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 : households-item-response

Type: object

Show Source

• AdditionalIdentifier: array Additional Identifiers
  Title: Additional Identifiers

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

  The additional name resource is used to view, create, update, and delete additional names associated with an account. You can use the resource 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 a household. An address contains the detailed location information of a household.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  Additional address element to support flexible address format
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  First line of address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line of address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line of address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line of address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  Phonetic or Kana representation of the Kanji address lines (used in Japan)
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

  Alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• AddressType: string
  Title: Type

  Additional information as type of address like BillTo, ShipTo.
• AnnualIncome: integer (int64)
  Title: Annual Income

  The annual income of the household. If not provided, then the value is NULL.
• AssignmentExceptionFlag: boolean
  Title: Assignment Exception Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the sales account has the required dimensions to allow assignment manager to assign territories to the sales account. The default value is false.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.
• AverageAge: integer (int64)
  Title: Average Age

  The average age of the household.
• Building: string
  Title: Building

  Maximum Length: 240

  Specific building name or number at a given address.
• CertificationLevel: string
  Title: Certification Level

  Maximum Length: 30

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

  Maximum Length: 30

  The reason for the household 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 task, Manage Trading Community Common Lookups.
• Child0to6Number: integer (int64)
  Title: Children Below 7 Years of Age

  The number of children in the age range 0-6.
• Child13to18Number: integer (int64)
  Title: Children Aged 13 to 18 Years

  The number of children in the age range 13-18.
• Child7to12Number: integer (int64)
  Title: Children Aged 7 to 12 Years

  The number of children in the age range 7-12.
• City: string
  Title: City

  Maximum Length: 60

  The city element of address.
• ClassificationCategory: string
  Title: Classification Category

  A valid classification category code for the household which will be marked as primary and is defined by an admin.
• ClassificationCode: string
  Title: Classification Code

  A valid classification code corresponding to the classification category and which will be marked as primary.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The description for a group.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict for the household data record. This number is used by mobile or portable applications that consume the web service.
• 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.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the household. 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

  Country code of the address.
• County: string
  Title: County

  Maximum Length: 60

  County element of address.
• 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 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.
• CreatedByModule1: string
  Maximum Length: 30

  The application module that created the household record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurcyConvRateType: string
  Maximum Length: 30

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

  Maximum Length: 15

  The currency code associated with the household. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.
• 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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the household can be deleted. The default value is false.
• DependentsNumber: integer (int64)
  Title: Number of Dependents

  The number of dependents on the household.
• EffectiveLatestChange: string
  Maximum Length: 1

  Default Value: Y

  Indicates whether the row has the latest change in the day. If the value is True, then this row has the latest change in the day.
• EffectiveSequence: integer (int32)
  The order of the different changes made during the day. The lowest value represents the earliest change in the day.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The e-mail address of the contact point.
• EmailContactPointId: integer (int64)
  Read Only: true

  The unique identifier of the email contact point.
• EmailContactPointType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: EMAIL

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

  Maximum Length: 30

  The format for an e-mail preferred by the household, such as HTML or ASCII.
• EmailVerificationDate: string (date)
  Title: Email Verification Date

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

  Maximum Length: 30

  The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email.
• ExistingCustomerFlag: boolean
  Title: Existing Sales Account

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether there is an existing selling or billing 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 modified.
• FavoriteHouseholdFlag: boolean
  Title: Favorite

  Maximum Length: 10

  Default Value: false

  Indicates if the household is a favorite household. The default value is false.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

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

  Read Only: true

  The formatted version of the primary address.
• FormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The formatted phone number information.
• GroupPartyId: integer (int64)
  The unique identifier of the group party.
• GroupType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: HOUSEHOLD

  The type of the group.
• HouseholdName: string
  Title: Name

  Maximum Length: 360

  The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES.
• HouseholdProfileId: integer (int64)
  The unique identifier of the household profile.
• HouseholdSize: integer (int64)
  Title: Size

  The size of the group.
• LastAssignmentDate: string (date)
  Title: Last Assigned Date

  Read Only: true

  The date when the sales account territory assignment was last run by the assignment manager.
• LastAssignmentDateTime: string (date-time)
  Read Only: true

  The timestamp when the sales account territory assignment was last run by the assignment manager.
• 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 details of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization
• MedianAge: integer (int64)
  Title: Median Age

  The median age.
• NamedFlag: boolean
  Title: Named Household

  Maximum Length: 1

  Default Value: false

  Indicates whether a sales account is a named sales account. Possible values are True or False. If the value is True, then the sales account is a named sales account. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Note: array Notes
  Title: Notes

  The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.
• ObjectVersionNumberEmail: integer (int32)
  The internal version number for the email. It is 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.
• ObjectVersionNumberGroup: integer (int32)
  The internal version number for the group. The number is 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.
• ObjectVersionNumberOwner: integer (int32)
  Read Only: true

  The internal version number for the owner. The number is 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.
• ObjectVersionNumberParty: integer (int32)
  The internal version number for the party. The number is 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.
• ObjectVersionNumberPhone: integer (int32)
  The internal version number for the phone. The number is 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.
• ObjectVersionNumberSalesAccount: integer (int32)
  The internal version number for the sales account. The number is 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.
• OwnerEmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of sales account owner. To assign an owner to the sales account, you can either provide owner's party ID, party number, or email address.
• OwnerName: string
  Read Only: true

  Maximum Length: 360

  The name of the sales account owner.
• OwnerPartyId: integer (int64)
  Title: Owner ID

  The unique identifier of sales account owner. To assign an owner to the sales account, you must provide either owner's party identifier, party number, or email address.
• OwnerPartyId1: integer (int64)
  Read Only: true

  The unique identifier of the owner party.
• OwnerPartyNumber: string
  Read Only: true

  Maximum Length: 30

  The party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, you can either provide owner's party ID, party number, or email address.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

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

  Maximum Length: 30

  The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
• PartyNumberKey: string
  Title: Registry ID

  Maximum Length: 30

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

  Maximum Length: 1

  Default Value: A

  The status of the household.
• PartyType: string
  Title: Party Type

  Read Only: true

  Maximum Length: 30

  Default Value: GROUP

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

  Read Only: true

  Maximum Length: 900

  This is the derived column. For Organization, it is concatenation of unique_name_alias and suffix. For Person, this is concatenation of person_name and suffix.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code for the telephone number.
• PhoneContactPointId: integer (int64)
  Read Only: true

  The unique identifier of the phone contact point.
• PhoneContactPointType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: PHONE

  The type of the phone 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: Extension

  Maximum Length: 20

  The additional number addressed after initial connection to an internal telephone system.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  A telephone number formatted 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 was last verified.
• PhoneVerificationStatus: string
  Title: Phone Verification Status

  Maximum Length: 30

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

  Maximum Length: 60

  The postal code as defined by the formal countrywide postal system.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

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

  Maximum Length: 30

  Indicates how a household prefers to be contacted. Validated against lookup type PREFERRED_CONTACT_METHOD. A list of valid codes is defined in the lookup HZ_PREFERENCE. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• PreferredFunctionalCurrency: string
  Title: Preferred Functional Currency

  Maximum Length: 15

  The code indicating the preferred currency for the group.
• PrimaryAddress: array Primary Addresses
  Title: Primary Addresses

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

  The unique identifier of the primary address.
• PrimaryContactEmail: string
  Title: Contact Email

  Read Only: true

  The e-mail address of the primary contact.
• PrimaryContactName: string
  Read Only: true

  Maximum Length: 255

  The name of the primary contact.
• PrimaryContactPartyId: integer (int64)
  The unique identifier of the primary contact. To specify the contact for an household, you can provide either contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• PrimaryContactPartyNumber: string
  The alternate key identifier of the of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• PrimaryContactPhone: string
  Title: Contact Phone

  Read Only: true

  The phone number of the primary contact.
• PrimaryContactSourceSystem: string
  The SourceSystem of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• PrimaryContactSourceSystemReferenceValue: string
  The SourceSystemReference of the primary contact. To specify the contact for an household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .
• Province: string
  Title: Province

  Maximum Length: 60

  The province element of address.
• RawPhoneNumber: string
  Title: Raw Phone Number

  Maximum Length: 60

  The raw phone number.
• RecordSet: string
  Title: Record Set

  Read Only: true

  Maximum Length: 30

  Displays the search results under the selected record set.
• Relationship: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.
• SalesProfileId: integer (int64)
  The unique identifier of the sales profile on the household record.
• SalesProfileNumber: string
  Title: Sales Account Number

  Maximum Length: 30

  The alternate unique identifier of the record.
• SalesProfileStatus: string
  Title: Status

  Maximum Length: 30

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

  Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
• SellToPartySiteId: integer (int64)
  Title: Sell to Address

  Read Only: true

  The unique identifier of the sell to party site on the household record.
• SourceObjectType: string
  Read Only: true

  Maximum Length: 255

  Default Value: SALES_PARTY

  The type of the source object.
• 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.
• 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: Source System Reference

  The unique identifier for the household 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.
• SSROwnerTableName: string
  Read Only: true

  Maximum Length: 30

  Default Value: HZ_PARTIES

  The name of the table that holds the record data and is referenced to manage source system reference.
• State: string
  Title: State

  Maximum Length: 60

  The state element of address.
• StringPartyId: string
  Read Only: true

  Maximum Length: 255

  The unique identifier of the string on the household record..
• Type: string
  Title: Type

  Maximum Length: 30

  The household party type that defines whether the household is a sales account or a prospect or any other user-defined party type as specified using the lookup type ZCA_ HOUSEHOLD _TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. Possible values are ZCA_CUSTOMER or ZCA_PROSPECT. A list of valid values is defined in the lookup ZCA_HOUSEHOLD_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• UniqueNameSuffix: string
  Title: Name Suffix

  Maximum Length: 540

  The system-generated or manually overridden suffix, that is concatenated to the householdName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the record can be updated. The default value is false.
• WealthAmount: integer
  Title: Total Wealth

  The household wealth amount or net worth. If not provided, then the value is NULL.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"ProfileCreationDate"
            },
            "x-queryable":true
        },
        "PartyNumberKey":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the household party record.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveLatestChange":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the row has the latest change in the day. If the value is True, then this row has the latest change in the day.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Address":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource is used to view, create, update, and delete addresses of a household. An address contains the detailed location information of a household.",
            "items":{
                "$ref":"#/components/schemas/households-Address-item-response"
            }
        },
        "PrimaryContactEmail":{
            "title":"Contact Email",
            "type":"string",
            "description":"The e-mail address of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"PreferredContactPersonEmail"
            }
        },
        "NamedFlag":{
            "title":"Named Household",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a sales account is a named sales account. Possible values are True or False. If the value is True, then the sales account is a named sales account. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PrimaryAttributeName":"NamedFlag",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the household. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the household data record. 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
        },
        "ObjectVersionNumberEmail":{
            "type":"integer",
            "description":"The internal version number for the email. It is 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
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the household. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CurrencyCode",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryAddressId":{
            "type":"integer",
            "description":"The unique identifier of the primary address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"PrimaryAddressPartySiteId",
                "precision":"18"
            },
            "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
        },
        "ClassificationCode":{
            "title":"Classification Code",
            "type":"string",
            "description":"A valid classification code corresponding to the classification category and which will be marked as primary.",
            "nullable":true,
            "x-queryable":false
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The formatted phone number information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PhoneAreaCode",
                    "PhoneCountryCode",
                    "PhoneExtension",
                    "PhoneLineType",
                    "PhoneNumber"
                ]
            }
        },
        "OwnerPartyId1":{
            "type":"integer",
            "description":"The unique identifier of the owner party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactPartyId":{
            "type":"integer",
            "description":"The unique identifier of the primary contact. To specify the contact for an household, you can provide either contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PreferredContactId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates how a household prefers to be contacted. Validated against lookup type PREFERRED_CONTACT_METHOD. A list of valid codes is defined in the lookup HZ_PREFERENCE.  Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "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":"ProfileLastUpdatedBy"
            },
            "x-queryable":true
        },
        "PrimaryContactName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"ProfileCreatedBy"
            },
            "x-queryable":true
        },
        "SalesProfileId":{
            "type":"integer",
            "description":"The unique identifier of the sales profile on the household record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumberSalesAccount":{
            "type":"integer",
            "description":"The internal version number for the sales account. The number is 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
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AverageAge":{
            "title":"Average Age",
            "type":"integer",
            "description":"The average age of the household.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AverageAge",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CertificationLevel":{
            "title":"Certification Level",
            "maxLength":"30",
            "type":"string",
            "description":"The certification level of a household. 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
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the household can be deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the contact point.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The additional number addressed after initial connection to an internal telephone system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "type":"string",
            "description":"The alternate key identifier of the of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            },
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second line of 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":"First line of 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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
            "items":{
                "$ref":"#/components/schemas/households-CustomerClassification-item-response"
            }
        },
        "GroupType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the group.",
            "nullable":false,
            "readOnly":true,
            "default":"HOUSEHOLD",
            "x-hints":{
                "PrimaryAttributeName":"GroupType",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastAssignmentDate":{
            "title":"Last Assigned Date",
            "type":"string",
            "description":"The date when the sales account territory assignment was last run by the assignment manager.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.",
            "items":{
                "$ref":"#/components/schemas/households-Note-item-response"
            }
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"Alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"Country code of the address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The date when email address was last verified.",
            "format":"date",
            "nullable":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-hints":{
                "PrimaryAttributeName":"ProfileLastUpdateLogin"
            },
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberPhone":{
            "type":"integer",
            "description":"The internal version number for the phone. The number is 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
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, you can either provide owner's party ID, party number, or email address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Child13to18Number":{
            "title":"Children Aged 13 to 18 Years",
            "type":"integer",
            "description":"The number of children in the age range 13-18.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Child13to18Number",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CertificationReasonCode":{
            "title":"Certification Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for the household 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 task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"CertificationReasonCode",
                "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. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.",
            "items":{
                "$ref":"#/components/schemas/households-AdditionalName-item-response"
            }
        },
        "SalesProfileNumber":{
            "title":"Sales Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "HouseholdName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES.",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"GroupName",
                "protectionKey":"GroupDEO.GroupName",
                "protectionObjectTitle":"Household",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name"
            },
            "x-queryable":true
        },
        "AdditionalIdentifier":{
            "title":"Additional Identifiers",
            "type":"array",
            "description":"The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.",
            "items":{
                "$ref":"#/components/schemas/households-AdditionalIdentifier-item-response"
            }
        },
        "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/households-ContactPoint-item-response"
            }
        },
        "Child0to6Number":{
            "title":"Children Below 7 Years of Age",
            "type":"integer",
            "description":"The number of children in the age range 0-6.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Child0to6Number",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"Phonetic or Kana representation of the Kanji address lines (used in Japan)",
            "nullable":true,
            "x-queryable":true
        },
        "MedianAge":{
            "title":"Median Age",
            "type":"integer",
            "description":"The median age.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"MedianAge",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerPartyId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of sales account owner. To assign an owner to the sales account, you must provide either owner's party identifier, party number, or email address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"OwnerPartyId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the email contact point.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The household party type that defines whether the household is a sales account or a prospect or any other user-defined party type as specified using the lookup type ZCA_ HOUSEHOLD _TYPE.  It is defaulted to ZCA_CUSTOMER if no value is provided. Possible values are ZCA_CUSTOMER or ZCA_PROSPECT. A list of valid values is defined in the lookup ZCA_HOUSEHOLD_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"SalesProfileType",
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"ProfilePartyId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryContactSourceSystemReferenceValue":{
            "type":"string",
            "description":"The SourceSystemReference of the primary contact. To specify the contact for an household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            },
            "x-queryable":true
        },
        "Relationship":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.",
            "items":{
                "$ref":"#/components/schemas/households-Relationship-item-response"
            }
        },
        "WealthAmount":{
            "title":"Total Wealth",
            "type":"integer",
            "description":"The household wealth amount or net worth. If not provided, then the value is NULL.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"WealthAmount"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"A telephone number formatted 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
        },
        "FavoriteHouseholdFlag":{
            "title":"Favorite",
            "maxLength":"10",
            "type":"boolean",
            "description":"Indicates if the household is a favorite household. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"Additional information as type of address like BillTo, ShipTo.",
            "nullable":true,
            "x-queryable":false
        },
        "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":true
        },
        "SellToPartySiteId":{
            "title":"Sell to Address",
            "type":"integer",
            "description":"The unique identifier of the sell to party site on the household record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"ProfileLastUpdateDate"
            },
            "x-queryable":true
        },
        "PartyStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the household.",
            "nullable":true,
            "readOnly":true,
            "default":"A",
            "x-hints":{
                "PrimaryAttributeName":"ProfileStatus",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.",
            "items":{
                "$ref":"#/components/schemas/households-Attachment-item-response"
            }
        },
        "EmailFormat":{
            "title":"Email Format",
            "maxLength":"30",
            "type":"string",
            "description":"The format for an e-mail preferred by the household, such as HTML or ASCII.",
            "nullable":true,
            "x-queryable":true
        },
        "DependentsNumber":{
            "title":"Number of Dependents",
            "type":"integer",
            "description":"The number of dependents on the household.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"DependentsNumber",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumberOwner":{
            "type":"integer",
            "description":"The internal version number for the owner. The number is 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-hints":{
                "precision":"9"
            },
            "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
        },
        "Child7to12Number":{
            "title":"Children Aged 7 to 12 Years",
            "type":"integer",
            "description":"The number of children in the age range 7-12.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Child7to12Number",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveSequence":{
            "type":"integer",
            "description":"The order of the different changes made during the day. The lowest value represents the earliest change in the day.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "maxLength":"30",
            "type":"string",
            "description":"Displays the search results under the selected record set.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"SearchFilter",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailVerificationStatus":{
            "title":"Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "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":false
        },
        "PhoneContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the phone contact point.",
            "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 household. 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
        },
        "ExistingCustomerFlag":{
            "title":"Existing Sales Account",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether there is an existing selling or billing relationship with the sales account. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "EmailContactPointType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the email contact point.",
            "nullable":false,
            "readOnly":true,
            "default":"EMAIL",
            "x-queryable":true
        },
        "PreferredFunctionalCurrency":{
            "title":"Preferred Functional Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the preferred currency for the group.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"PreferredFunctionalCurrency",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ClassificationCategory":{
            "title":"Classification Category",
            "type":"string",
            "description":"A valid classification category code for the household which will be marked as primary and is defined by an admin.",
            "nullable":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "PhoneVerificationStatus":{
            "title":"Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the phone number verification. The values based on lookup are valid and invalid for phone.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"Four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":"30",
            "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":false
        },
        "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 system-generated or manually overridden suffix, that is concatenated to the householdName 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":"Additional address element to support flexible address format",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerEmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The email address of sales account owner. To assign an owner to the sales account, you can either provide owner's party ID, party number, or email address.",
            "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":"Additional address element to support flexible address format",
            "nullable":true,
            "x-queryable":true
        },
        "SalesTeamMember":{
            "title":"Sales Account Resources",
            "type":"array",
            "description":"Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
            "items":{
                "$ref":"#/components/schemas/households-SalesTeamMember-item-response"
            }
        },
        "RawPhoneNumber":{
            "title":"Raw Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The raw phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "ExistingCustomerFlagLastUpdateDate":{
            "title":"Existing Indicator Last Update Date",
            "type":"string",
            "description":"The date when the existing customer flag was last modified.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the sales account owner.",
            "nullable":false,
            "readOnly":true,
            "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 households. A primary address is the default communication address of a household.",
            "items":{
                "$ref":"#/components/schemas/households-PrimaryAddress-item-response"
            },
            "x-cardinality":"1"
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":true,
            "x-queryable":true
        },
        "LastAssignmentDateTime":{
            "type":"string",
            "description":"The timestamp when the sales account territory assignment was last run by the assignment manager.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseholdSize":{
            "title":"Size",
            "type":"integer",
            "description":"The size of the group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"GroupSize",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format",
            "nullable":true,
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Name",
            "maxLength":"900",
            "type":"string",
            "description":"This is the derived column. For Organization, it is concatenation of unique_name_alias and suffix. For Person, this is concatenation of person_name and suffix.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PrimaryAttributeName":"PartyUniqueName"
            },
            "x-queryable":true
        },
        "AssignmentExceptionFlag":{
            "title":"Assignment Exception Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales account has the required dimensions to allow assignment manager to assign territories to the sales account. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectVersionNumberGroup":{
            "type":"integer",
            "description":"The internal version number for the group. The number is 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
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PrimaryContactSourceSystem":{
            "type":"string",
            "description":"The SourceSystem of the primary contact. To specify the contact for a household, you can either provide contact's party ID, PartyNumber, or (SourceSystem, SourceSystemReference) .",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"County element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "PhoneContactPointType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the phone contact point.",
            "nullable":false,
            "readOnly":true,
            "default":"PHONE",
            "x-queryable":true
        },
        "SourceObjectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of the source object.",
            "nullable":true,
            "readOnly":true,
            "default":"SALES_PARTY",
            "x-queryable":false
        },
        "ObjectVersionNumberParty":{
            "type":"integer",
            "description":"The internal version number for the party. The number is 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
        },
        "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":"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":{
            "type":"boolean",
            "description":"Indicates if the record can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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/households-SourceSystemReference-item-response"
            }
        },
        "StringPartyId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the string on the household record..",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party.",
            "nullable":false,
            "readOnly":true,
            "default":"GROUP",
            "x-hints":{
                "PrimaryAttributeName":"PartyType"
            },
            "x-queryable":true
        },
        "PrimaryContactPhone":{
            "title":"Contact Phone",
            "type":"string",
            "description":"The phone number of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PrimaryAttributeName":"PreferredContactPhone"
            }
        },
        "CreatedByModule1":{
            "maxLength":"30",
            "type":"string",
            "description":"The application module that created the household record.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The description for a group.",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"Comments",
                "protectionKey":"GroupDEO.Comments",
                "protectionObjectTitle":"Household",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Comments"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference",
            "type":"string",
            "description":"The unique identifier for the household 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":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"PartyNumber"
            },
            "x-queryable":true
        },
        "GroupPartyId":{
            "type":"integer",
            "description":"The unique identifier of the group party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"PartyId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "HouseholdProfileId":{
            "type":"integer",
            "description":"The unique identifier of the household profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "PrimaryAttributeName":"GroupProfileId",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneVerificationDate":{
            "title":"Phone Verification Date",
            "type":"string",
            "description":"The date when phone number was last verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AnnualIncome":{
            "title":"Annual Income",
            "type":"integer",
            "description":"The annual income of the household. If not provided, then the value is NULL.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "PrimaryAttributeName":"AnnualIncome",
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Additional Identifiers

Type: array

Title: Additional Identifiers

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

Show Source

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

{
    "title":"Additional Identifiers",
    "type":"array",
    "description":"The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.",
    "items":{
        "$ref":"#/components/schemas/households-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. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.

Show Source

• Array of: object households-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. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.",
    "items":{
        "$ref":"#/components/schemas/households-AdditionalName-item-response"
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

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

Show Source

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

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

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.",
    "items":{
        "$ref":"#/components/schemas/households-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 households-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/households-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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Show Source

• Array of: object households-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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.",
    "items":{
        "$ref":"#/components/schemas/households-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 note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.

Show Source

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

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.",
    "items":{
        "$ref":"#/components/schemas/households-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 households. A primary address is the default communication address of a household.

Show Source

• Array of: object households-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 households. A primary address is the default communication address of a household.",
    "items":{
        "$ref":"#/components/schemas/households-PrimaryAddress-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.

Show Source

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

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.",
    "items":{
        "$ref":"#/components/schemas/households-Relationship-item-response"
    }
}

Nested Schema : Sales Account Resources

Type: array

Title: Sales Account Resources

Sales account resources is used to view, create, update, and delete a resource party that is 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 households-SalesTeamMember-item-response

{
    "title":"Sales Account Resources",
    "type":"array",
    "description":"Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.",
    "items":{
        "$ref":"#/components/schemas/households-SalesTeamMember-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 households-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/households-SourceSystemReference-item-response"
    }
}

Nested Schema : households-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 the party identifier.
• PartyIdentifierValue: string
  Title: Identifier Value

  Maximum Length: 60

  The value of the party identifier.
• PartyNumber: string
  The party number of the additional identifier. 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 the party identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number of the additional identifier. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the additional identifier will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Issuing Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the additional identifier was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the additional identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : households-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 attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the additional name record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the additional name 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 of a person.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of a person.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the additional name record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the additional name 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 of a person.
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the record.
• NameId: integer (int64)
  Read Only: true

  The unique identifier of the name.
• NameType: string
  Title: Additional Name Type

  Maximum Length: 30

  Determines the AdditionalName Types. Can be validated against HZ_NAME_AND_ID_TYPES_VL.TYPE_CODE. Sample values: LEGAL,PRIMARY etc..
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the party.
• PartySourceSystem: string
  The source system name.
• PartySourceSystemReferenceValue: string
  The identifier for the record from the original system.
• 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 the source system for the associated party.
• SourceSystemReferenceValue: string
  The identifier of the source system reference for the associated party.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A.
• 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 additional name record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the additional name record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the additional name 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 source system name.",
            "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 of a person.",
            "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":"Determines the AdditionalName Types. Can be validated against HZ_NAME_AND_ID_TYPES_VL.TYPE_CODE. Sample values: LEGAL,PRIMARY etc..",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier of the source system reference for the associated party.",
            "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 record.",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":"30",
            "type":"string",
            "description":"The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from the original system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the party.",
            "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 of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of the source system for the associated party.",
            "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 when the additional name 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 : households-Address-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The fourth line for address.
• AddressId: integer (int64)
  Read Only: true

  Address internal unique identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  Phonetic or Kana representation of the Kanji address lines (used 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 unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• 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 address type as a string.
• Building: string
  Title: Building

  Maximum Length: 240

  Specific building name or number at a given address.
• CalculateFormattedAddress: boolean
  The indicator to process formatted address of the party record.
• City: string
  Title: City

  Maximum Length: 60

  The city element of address.
• ClliCode: string
  Title: CLLI Code

  Maximum Length: 60

  The Common Language Location Identifier (CLLI) code 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 for the address record. 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 address. 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 element of address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedByModule: string
  Default Value: HZ_WS

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

  Maximum Length: 30

  The module that created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

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

  Maximum Length: 15

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

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

  Maximum Length: 2000

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

  Default Value: false

  Indicates whether the address should not be used for mailing. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null.
• 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 this address is rendered inactive.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

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

  Read Only: true

  The formatted address information.
• FormattedAddress1: string
  Title: Formatted Address 1

  Read Only: true

  The formatted version of the address.
• FormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The formatted multiple line address information.
• FormattedMultilineAddress1: string
  Title: Address

  Read Only: true

  The formatted multiline version 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.
• 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 details of the user who last updated the record.
• Latitude: number
  Title: Latitude

  The latitude information for the address. This 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 location.
• LocationId: integer (int64)
  Title: Location ID

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

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

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization.
• ObjectVersionNumber: integer (int32)
  The 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.
• ObjectVersionNumber1: integer (int32)
  The number used to implement optimistic locking for address record. 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, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.
• PartyNumber: string
  Title: Party Number

  The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

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

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

  The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code as defined by the formal countrywide postal system.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

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

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Province: string
  Title: Province

  Maximum Length: 60

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

  Maximum Length: 255

  The name of the table that holds the address record data and is referenced to manage source system reference.
• SSRPartyOwnerTableName: string
  Read Only: true

  Maximum Length: 255

  Default Value: HZ_PARTIES

  The name of the table that holds the party record data and is referenced to manage source system reference.
• StartDateActive: string (date)
  Title: Start Date

  The date from which this address is active. This value is defaulted to the current system date if not provided during create.
• State: string
  Title: State

  Maximum Length: 60

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

  Maximum Length: 1

  Default Value: A

  An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing.
• ValidationStartDate: string (date)
  Read Only: true

  The date on which the validation starts. This attribute is internally set by the 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 and time 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/households-Address-AddressPurpose-item-response"
            }
        },
        "FormattedMultilineAddress1":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. This 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 associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the address record. 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/households-Address-AddressLocale-item-response"
            }
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code related to the address. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":"60",
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code 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":"A user-defined code to indicate a mail drop point within their organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"User-defined name for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES.  Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "AddressId":{
            "type":"integer",
            "description":"Address internal unique identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the address. 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. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationStartDate":{
            "type":"string",
            "description":"The date on which the validation starts. This attribute is internally set by the system during address cleansing.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of external source system of the account, contact or household with which the address is associated.  Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":"30",
            "type":"string",
            "description":"The 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 address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. This is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for address record. 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 this address is rendered inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateFormattedAddress":{
            "type":"boolean",
            "description":"The indicator to process formatted address of the party record.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the address record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated.  Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address. 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 details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"An extensive description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which this address is active. This value is defaulted to the current system date if not provided during create.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "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
        },
        "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":"Phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "DunsNumberC":{
            "title":"D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"The D-U-N-S number of the business location.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule1":{
            "title":"Created by Application",
            "maxLength":"30",
            "type":"string",
            "description":"The module that created the record.",
            "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 this 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. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The address type as a string.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "SSRPartyOwnerTableName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the table that holds the party record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress1":{
            "title":"Formatted Address 1",
            "type":"string",
            "description":"The formatted version of the address.",
            "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 households-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/households-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 households-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/households-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 : households-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 : households-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 True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• 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 True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "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 : households-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. For example, a 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 attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user 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. For example, a 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 attachment.",
            "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 : households-ContactPoint-item-response

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.
• 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 record. The accepted values are defined in the lookup type COMMUNICATION_TYPE. Sample values include PHONE, EMAIL, and WEB.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Default Value: HZ_WS

  The application module that created this contact point 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.
• DoContactPreferenceFlag: boolean
  Title: OK to Contact

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

  Indicates whether the record can be contacted.
• 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 record of type email.
• EmailPurpose: string
  Title: Email Purpose

  Maximum Length: 30

  The purpose of using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.
• 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 record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the contact point 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.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The number used to implement optimistic locking for contact point record. 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 associated party record for contact point.
• PartyNumber: string
  Title: Registry ID

  The public unique identifier of the associated party record.
• PartySourceSystem: string
  Title: Party Source System

  The name of external source system of the account, contact or household with which the contact point 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 from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 255

  The area code for the phone 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 phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.
• 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 this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.
• RawPhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The raw phone number on the contact point record of type phone.
• 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 administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
• SourceSystemReferenceValue: string
  Title: Source System Reference Value

  The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.
• URL: string
  Title: URL

  The URL of 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 this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "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 of the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The unique identifier of the conflict for the contact point record. 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
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"255",
            "type":"string",
            "description":"The area code for the phone 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 optimistic locking for contact point record. 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
        },
        "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 application module that created this contact point 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact point record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.",
            "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 contact point 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 contact point 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 record of type email.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't 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 public unique identifier of the associated party record.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the associated party record for contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The type of phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotContactPreferenceFlag":{
            "title":"Do Not Contact",
            "type":"boolean",
            "description":"Indicates whether the record can be contacted.",
            "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 using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.",
            "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 record. The accepted values are defined in the lookup type COMMUNICATION_TYPE. Sample values include PHONE, EMAIL, and WEB.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The raw phone number on the contact point record of type phone.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of external source system, which is defined by an administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update 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 : households-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

  The code indicating the classification category. For example, High Technology, Customer, or Telecom.
• 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 for the classification record. 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 with which the classification is associated.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 30

  The unique alternate identifier of the account, contact, or household with 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

  Indicates 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 for the classification record. 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":"Indicates the type of the party, such as account, contact, or household.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsIndustryFlag":{
            "title":"Industry Type Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an industry group classification category. 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 with 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":"The code indicating the classification category. For example, High Technology, Customer, or Telecom.",
            "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 with 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 : households-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 note. 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 when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the person who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

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

  Maximum Length: 15

  The currency code attribute associated with the note. 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.
• 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 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.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

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

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

  Maximum Length: 30

  The code used to classify a note, as asset or adjustment.
• 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 for the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the author of the note.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, etc.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc.
• 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

  Specifies the visibility level of the note.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the author of the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the note. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies 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 attribute associated with the note. 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"
            }
        },
        "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 code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, etc.",
            "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 note. 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":"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. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the person who created the\nnote.",
            "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":"The code used to classify a note, as asset or adjustment.",
            "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 as defined in OBJECTS Metadata, such as activities, opportunities, etc.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The 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 : households-PrimaryAddress-item-response

Type: object

Show Source

• Addressee: string
  Title: Addressee

  Maximum Length: 360

  The addressee of the household.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddressId: integer (int64)
  Read Only: true

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

  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. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix is defined as in profile option ZCA_PUID_PREFIX, concatenated with an internally generated unique sequence number.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given 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 for the primary address record. This number is used by mobile or portable applications that consume the web service.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• 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 element of the primary address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurcyConvRateType: string
  Maximum Length: 30

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

  Maximum Length: 15

  The currency code associated with the primary address. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.
• DateValidated: string (date)
  Title: Validated Date

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

  Indicates whether the primary address is to be deleted. If the value is True, then the primary address will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Description: string
  Title: Description

  Maximum Length: 2000

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

  Maximum Length: 1

  Indicator to specify that a particular location isn't eligible for address validation irrespective of the current validation.
• EndDateActive: string (date)
  Title: To Date

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

  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 address information.
• FormattedMultiLineAddress: string
  Title: Address

  Read Only: true

  The formatted multiple line address information.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  The type of the building mentioned 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 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 details of the user who last updated the record.
• Latitude: number
  Title: Latitude

  The latitude information for the address. This 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 location.
• LocationId: integer (int64)
  The unique identifier for the location record for this address.
• LocationIntegrationKey: string
  The integration key for the location record.
• LocationLocationId: integer (int64)
  Title: Location ID

  The system identifier for the location record of the primary address.
• 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 location record of primary address.
• Longitude: number
  Title: Longitude

  The longitude information for the address. This 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 for the primary address. The number is 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 for primary address. The number is 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, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

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

  Maximum Length: 30

  The type of the party site. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

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

  Maximum Length: 20

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

  Maximum Length: 60

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

  Maximum Length: 240

  The short description of the primary address.
• SourceSystem: string
  The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• StartDateActive: string (date)
  Title: From Date

  The date on which the resource is associated with a sales account.
• State: string
  Title: State

  Maximum Length: 60

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

  Default Value: A

  Indicates the status of the primary address. Status codes are defined by the lookup HZ_STATUS.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 64

  The code of the time zone associated with the primary address.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to NULL.
• 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 and time 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. This is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the primary address record. 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
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"The short description of the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the primary address. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.",
            "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\norganization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicator to specify that a particular location isn't eligible for address validation irrespective of the current validation.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the party site for the primary 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"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique 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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "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 the status of the primary address. Status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the 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 of the primary address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address information.",
            "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. This is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationStatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The location record of primary address.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province element 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 True, then the primary address will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":true,
            "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
        },
        "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 was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to NULL.",
            "nullable":true,
            "default":false,
            "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
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a primary address record in active status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state element of 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 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. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix is defined as in profile option ZCA_PUID_PREFIX, concatenated with an internally generated unique sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"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":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"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 details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The code of the time zone associated with the primary address.",
            "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":"An extensive description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location for the primary address. The number is 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":"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 element 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 element 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 resource is associated with a sales account.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party site. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the building mentioned 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":"Phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "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
        },
        "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 addressee of the household.",
            "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 record for this address.",
            "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 for primary address. The number is 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. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultiLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : households-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 comments provided by the user.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict for the relationship record. 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 and time when the record was created.
• DependentFlag: string
  Title: Dependent Indicator

  Maximum Length: 1

  Default Value: N

  Indicates whether one party is dependent on another. Default value is N.
• DirectionCode: string
  Read Only: true

  Maximum Length: 30

  The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-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. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.
• InfluenceLevel: string
  Title: Influence Level

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

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

  The definition of the job package.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  The login details 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 in this relationship.
• ObjectPartyName: string
  Title: Object Party Name

  Read Only: true

  Maximum Length: 360

  The name of the object party.
• ObjectPartyNumber: string
  Title: Object Registry ID

  Maximum Length: 30

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

  The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.
• ObjectSourceSystemReferenceValue: string
  Title: Object Source System Reference

  The unique identifier for the object party in the relationship from 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 relationship like ORGANIZATION, PERSON.
• ObjectUsageCode: string
  Maximum Length: 30

  The usage code of object party in the relationship.
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking for relationship record. 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.
• ObjectVersionNumber1: integer (int32)
  Read Only: true

  The alternate number used to implement optimistic locking for relationship record.
• ObjectVersionNumber2: integer (int32)
  Read Only: true

  The alternate number to implement optimistic locking for relationship record.
• PartyId: integer (int64)
  Read Only: true

  The alternate unique identifier of the associated party record.
• PartyId1: integer (int64)
  Read Only: true

  The alternate identifier of the associated party record.
• 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 indicating whether this is a forward or a backward relationship code.
• 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 the external source system for the relationship, which are defined by an admin as part of the system setup.
• RelationshipSourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The name of the type of the relationship. For example, CUSTOMER_SUPPLIER.
• RequestId: integer (int64)
  The unique identifier of the request on relationship record.
• 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 begins.
• Status: string
  Read Only: true

  Maximum Length: 1

  Default Value: A

  The status of the relationship, A for active, I for inactive.
• SubjectPartyId: integer (int64)
  The unique identifier of the subject 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 of the subject party of the relationship.
• SubjectSourceSystem: string
  Title: Subject Source System

  The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.
• SubjectSourceSystemReferenceValue: string
  Title: Subject Source System Reference

  The unique identifier of the subject party in the relationship from external source system.
• SubjectTableName: string
  Maximum Length: 30

  The source table name of the subject party in this relationship.
• SubjectType: string
  Maximum Length: 30

  The subject type of the relationship like ORGANIZATION, PERSON.
• SubjectUsageCode: string
  Maximum Length: 30

  The usage code of subject party in the relationship.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the type of the relationship. For example, CUSTOMER_SUPPLIER.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the relationship record. 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 begins.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The subject type of the relationship like ORGANIZATION, PERSON.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup.",
            "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 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 relationship.",
            "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":"The status of the relationship, A for active, I for inactive.",
            "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 on relationship record.",
            "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 unique identifier of the subject party in the relationship from 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 alternate number to implement optimistic locking for relationship record.",
            "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 the external source system for the relationship, which are defined by an admin as part of the system setup.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The alternate number used to implement optimistic locking for relationship record.",
            "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. It's applicable only in the MEMBERSHIP relationship, and will be used to indicate which members are the head of household. There may be multiple heads of households, depending on the deploying company's implementation.",
            "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 unique identifier for the object party in the relationship from external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectTableName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source table name of the subject party in this relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether one party is dependent on another. Default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "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":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 relationship like ORGANIZATION, PERSON.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The unique identifier of the object 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 of 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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for relationship record. 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
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether this is a forward or a backward relationship code.",
            "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 comments provided by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the relationship direction. The list of accepted values are defined in the lookup DIRECTION_CODE. Valid values are P-Parent, C-Child, N-Not Directional.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId1":{
            "type":"integer",
            "description":"The alternate identifier of the associated party record.",
            "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 alternate unique identifier of the associated party record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : households-SalesTeamMember-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• 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 sales team member. 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 when the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

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

  Maximum Length: 15

  The currency code associated with the sales team member of the household object. 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.
• 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 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 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. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• ObjectVersionNumber: 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.
• OwnerFlag: boolean
  Title: Owner

  Default Value: false

  Indicates whether the resource is the owner.
• PartyId: integer
  The unique identifier of the associated party record for sales team member record.
• PartyNumber: string
  The public identifier of the associated party record.
• PartySourceSystem: string
  The name of external source system of the associated party record.
• PartySourceSystemReferenceValue: string
  The unique identifier from external source system of the associated party record.
• ResourceEmailAddress: string
  Title: Resource Email

  The email address of the resource.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the household resource.
• 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 alternate key identifier of the resource that this team member belongs to.
• ResourcePhoneNumber: string
  Title: Phone

  Read Only: true

  The primary phone number of the sales team member.
• ResourceRoleName: string
  Title: Role

  Read Only: true

  The names of the roles assigned to the sales team member.
• SalesProfileId: integer (int64)
  Title: Sales Account ID

  The unique identifier for the sales account.
• StartDateActive: string (date)
  Title: Start Date

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

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

  The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":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 level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "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 and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":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 email address of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the sales team member of the household object. 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"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier from external source system of the associated party record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the resource is associated with a 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 accounts resource team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "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-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "type":"string",
            "description":"The alternate key identifier of the resource that this team member belongs to.",
            "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 sales team member. 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 for 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 associated party record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the resource is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ResourceRoleName":{
            "title":"Role",
            "type":"string",
            "description":"The names of 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 public identifier of the associated party record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated party record for sales team member record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the household resource.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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. 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 and time when 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 : households-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

AdditionalIdentifier

Operation: /crmRestApi/resources/11.13.18.05/households/{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/households/{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. You can use the resource 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/households/{PartyNumber}/child/Address

Parameters:

• PartyNumber: $request.path.PartyNumber

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

Attachment

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

Parameters:

• PartyNumber: $request.path.PartyNumber

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

CertificationLevelLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_LEVEL

The list of values for the certification level of the household, such as Not Met or Minimum.

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 for the reason for household current certification level assignment, such as Third party content or Manual.

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/households/{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 for the default currency code for this group, such as US Dollar or Indian Rupee.

The following properties are defined on the LOV link relation:

• Source Attribute: PreferredFunctionalCurrency; Target Attribute: CurrencyCode
• Display Attribute: Name

CustomerClassification

Operation: /crmRestApi/resources/11.13.18.05/households/{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 households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

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

FavoriteHouseholdFlagLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating the household is a favorite household.

The following properties are defined on the LOV link relation:

• Source Attribute: FavoriteHouseholdFlag; Target Attribute: LookupCode
• Display Attribute: LookupCode

GroupTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_PARTY_GROUP_TYPES

The list of values for the group type, such as household, family, or group housing.

The following properties are defined on the LOV link relation:

• Source Attribute: GroupType; Target Attribute: LookupCode
• Display Attribute: Meaning

Note

Operation: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note

Parameters:

• PartyNumber: $request.path.PartyNumber

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

PhoneCountryCodeLOV

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The list of values indicating the international country codes for the household's 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 that indicate how a household prefers to be contacted, such as Mail or 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/households/{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 households. A primary address is the default communication address of a household.

RatedCurrenciesLOV

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The list of values for the corporate currency code, such as US Dollar or Indian Rupee.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: Name

Relationship

Operation: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship

Parameters:

• PartyNumber: $request.path.PartyNumber

The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.

SalesProfileStatusLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_SALES_ACCOUNT_STATUS

The list of values for the valid user-defined statuses of the sales account that this household belongs to, such as active or inactive.

The following properties are defined on the LOV link relation:

• Source Attribute: SalesProfileStatus; Target Attribute: LookupCode
• Display Attribute: LookupCode

SalesProfileTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_HOUSEHOLD_TYPE

The list of values for the household party type that defines whether the household is a sales account or a prospect or any other user-defined party type.

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/households/{PartyNumber}/child/SalesTeamMember

Parameters:

• PartyNumber: $request.path.PartyNumber

Sales account resources is used to view, create, update, and delete a resource party that is 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/households/{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 for the status of the status of the household, such as Active or Inactive.

The following properties are defined on the LOV link relation:

• Source Attribute: PartyStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

cURL Command

The following example shows how to update a household by submitting a patch request on the REST resource using cURL.

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_9049

Example of Request Body

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

{
    "HouseholdName": "Pinnacle Inc",
    "CreatedByModule": "HZ_WS",
    "Type": "ZCA_CUSTOMER",
    "YearIncorporated": "2000",
    "PhoneCountryCode": "1",
    "PhoneAreaCode": "408",
    "PhoneNumber": "9991111",
    "PhoneExtension": "56",
    "EmailAddress": "[e-mail]",
    "URL": "www.oracle-upd.com"
}

Example of Response Body

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

{
    "HouseholdName": "Pinnacle Inc",
    "UniqueNameSuffix": "(Redwood Shores, US)",
    "PartyUniqueName": "Pinnacle Flowers (Redwood Shores, US)",
    "Type": "ZCA_CUSTOMER",
    "OwnerEmailAddress": "[e-mail] ",
    "CreatedByModule": "HZ_WS",
    ...
}

Back to Top