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.
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : Additional Identifiers
Type:
array
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional 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
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
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
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
Show Source
Nested Schema : Aux Classifications
Type:
array
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The 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
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
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
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
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. Review the list of country codes using the Manage Geographies task. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of 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.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : households-AdditionalName-item-patch-request
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The 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.
Nested Schema : households-Address-item-patch-request
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
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. -
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. -
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.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type:
array
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : households-Address-AddressPurpose-item-patch-request
Type:
Show Source
object
-
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.
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type. 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. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict 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
Indicates whether the record can be contacted.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
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)
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)
The unique identifier of the associated party record for contact point.
-
PartyNumber: string
The public unique identifier of the associated party record.
-
PartySourceSystem: string
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
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
Maximum Length:
255
The area code for the phone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
The type of 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
Maximum Length:
255
The raw phone number on the contact point record of type phone. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of external source system, which is defined by an 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
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
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
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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.
Nested Schema : households-PrimaryAddress-item-patch-request
Type:
Show Source
object
-
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : households-SalesTeamMember-item-patch-request
Type:
Show Source
object
-
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.
Nested Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
EndDate: string
(date)
The date after which the record is inactive.
-
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated account.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated account. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : households-item-response
Type:
Show Source
object
-
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. -
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.
Nested Schema : Additional Identifiers
Type:
array
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional 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
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
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
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
Show Source
Nested Schema : Aux Classifications
Type:
array
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The 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
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
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
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
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Show Source
Nested Schema : households-AdditionalIdentifier-item-response
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. Review the list of country codes using the Manage Geographies task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the additional identifier. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Read Only:
true
The date when the additional identifier was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the additional identifier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the additional identifier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the additional identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of 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.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : households-AdditionalName-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Address-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressId: integer
(int64)
Read Only:
true
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. -
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. -
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.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type:
array
Title:
Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Address-AddressLocale-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The specific name of the country in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address locale record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address locale record was created. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
FormattedAddress: string
Read Only:
true
The formatted read only version of the locale address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address locale was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address locale record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address locale record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
LocationLocaleId: integer
(int64)
Read Only:
true
The unique identifier of the location locale record. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Address-AddressPurpose-item-response
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
-
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update. -
AddressPurposeId: integer
(int64)
Read Only:
true
The unique identifier of the address purpose. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address purpose record. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address purpose record was created. -
DeleteFlag: boolean
Indicates whether the address purpose is to be deleted. If the value is 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type. 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. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-ContactPoint-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
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)
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. The values can be PHONE, EMAIL, WEB, and so on. -
CreatedBy: string
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)
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
Indicates whether the record can be contacted.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
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
Read Only:
true
Maximum Length:255
The formatted phone number of the contact point. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact point 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 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)
The unique identifier of the associated party record for contact point.
-
PartyNumber: string
The public unique identifier of the associated party record.
-
PartySourceSystem: string
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
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
Maximum Length:
255
The area code for the phone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
The type of 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
Maximum Length:
255
The raw phone number on the contact point record of type phone. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of external source system, which is defined by an 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
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
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
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
The code indicating the classification category. For example, High Technology, Customer, or Telecom. -
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. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-PrimaryAddress-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-Relationship-item-response
Type:
Show Source
object
-
BackwardRole: string
Title:
Backward Role
Read Only:true
The backward relationship code used to describe relationships. For example, SUPPLIER_OF. -
Comments: string
Title:
Comments
Maximum Length:2000
The 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-SalesTeamMember-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-SourceSystemReference-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDate: string
(date)
The date after which the record is inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated account.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated account. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The name of the source system. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The unique identifier of the source system reference. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated account. -
StartDate: string
(date)
The date when the record was created.
-
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AdditionalIdentifier
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
An object that includes attributes used to store details of additional identifiers associated to a Party. For example, if the customer would like to capture the Drivers License or the passport information for a party, this information would be stored as a Additional Identifier. - PartyNumber:
- AdditionalName
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The additional name resource is used to view, create, update, and delete additional names associated with an account. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name. - PartyNumber:
- Address
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The addresses resource is used to view, create, update, and delete addresses of a household. An address contains the detailed location information of a household. - PartyNumber:
- 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. - PartyNumber:
- CertificationLevelLookupLOV
-
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
- finder:
- CertificationReasonCodeLookupLOV
-
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
- finder:
- ContactPoint
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
An object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone,email,web etc. - PartyNumber:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- CurrenciesLOV
-
Parameters:
- finder:
EnabledFlagFinder%3BBindEnabledFlag%3DY
The list of values 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
- finder:
- CustomerClassification
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private. - PartyNumber:
- EmailVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{EmailVerificationStatus}
The following properties are defined on the LOV link relation:- Source Attribute: EmailVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FavoriteHouseholdFlagLookupLOV
-
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
- finder:
- GroupTypeLookupLOV
-
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
- finder:
- 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. - PartyNumber:
- PhoneCountryCodeLOV
-
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
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{PhoneVerificationStatus}
The following properties are defined on the LOV link relation:- Source Attribute: PhoneVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PreferredContactMethodLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PREFERRED_CONTACT_METHOD
The list of values 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
- finder:
- 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. - PartyNumber:
- RatedCurrenciesLOV
-
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
-
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. - PartyNumber:
- SalesProfileStatusLookupLOV
-
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
- finder:
- SalesProfileTypeLookupLOV
-
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
- finder:
- 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. - PartyNumber:
- SearchFilters
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_ACCT_SRCH_RECORD_SET
The list of values indicating the record set to display search values, such as AllAccounts and MyAccounts.
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceSystemReference
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
An external system from which data can be imported into the trading community registry. - PartyNumber:
- StatusLOV
-
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
- finder: