Households: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Households resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Household
Child Resources	Address
	Household > Address > Address Purpose
	Primary Address
	Relationship
	SalesTeamMember
	Note
	Aux Classification
	Attachment

The following table lists the attributes required for the POST method for Households resource.

Resource	Attribute	Attribute Description
Households	HouseholdName	The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES.
	GroupType	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. The list of values for group types is available in the GroupTypeLookupLOV.

The following table lists the attributes required for the POST method for Households child resources.

Resource	Attribute	Attribute Description
Households > Address For households, the address is required based on the profile option code ZCA_HOUSEHOLD_ADDRESS_REQUIRED_ENABLED. If the profile option is set as, NO: Address is not required. Yes: Address is required for all household types(such as ZCA_PROSPECT and ZCA_CUSTOMER). Required for Customer: Address is necessary for the account type ZCA_CUSTOMER, in which case Address1 and Country is required, while Address2 is optional.	AddressLine1	The first line for address.
	AddressLine2	The second line for address.
	Country	The country code of the address. The list of values for countries is available in the CountryLOV.
Households > Address > Address Purpose	Purpose	Indicates the use or purpose of the address. For example billing, shipping etc.
Households > Primary Address	AddressLine1	The first line for the primary address.
	AddressLine2	The second line for the primary address.
	Country	The country code of the primary address. The list of values for countries is available in the CountryLOV.
Households > Relationship	SubjectPartyNumber	The unique identification number for the subject party of the relationship.
	RelationshipType	The relationship type name. For example, CUSTOMER_SUPPLIER. The list of values for relationship types is available in the RelationshipTypeLookupLOV.
	RelationshipCode	Indicates whether this is a forward or a backward relationship code. The list of values for relationship codes is available in the RelationshipTypeLookupLOV.
Households > Sales Team Member	AccessLevelCode	The access level determines the type 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. The list of values for access level codes is available in the AccessLevelLOV.
	LockAssignmentFlag	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.
	AssignmentTypeCode	The code indicating how the resource is assigned to the sales account team. The possible values are available in the ZCA_ASSIGNMENT_TYPE lookup.
	ResourceEmailAddress	The email address of the resource.
Households > Note	NoteTxt	The column to store the note text.
	NoteTypeCode	The note type code for categorization of the note. The list of values for the note type code is available in the NoteSourceTypeVA.
	VisibilityCode	The visibility level of the note. The list of values for the visibility code is available in the NoteVisibilityLookupVA.
Households > Aux Classification	ClassCategory	The name of the classification category.
	ClassCode	A valid classification code corresponding to the classification category.
Households > Attachments	DatatypeCode	A value that indicates the data type.
	FileName	The file name of the attachment.
	UploadedText	The text of the attachment.
	CategoryName	The category of the attachment.

The following table lists the path parameters required for the PATCH method for Households resource.

Resource	Path	Path Parameters
Households	/crmRestApi/resources/11.13.18.10/households/{PartyNumber}	PartyNumber

The following table lists the path parameters required for the PATCH method for Households child resources.

Resource	Path	Path Parameters
Households > Address	/crmRestApi/resources/11.13.18.10/households/{PartyNumber}/child/Address/{AddressNumber}	PartyNumber AddressNumber
Households > Address > Address Purpose	/crmRestApi/resources/11.13.18.10//households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{ AddressPurposeId }	PartyNumber AddressNumber AddressPurposeId
Households > Primary Address	/crmRestApi/resources/11.13.18.10/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}	PartyNumber AddressNumber
Households > Relationship	The Relationship child resource supports only GET action.	The Relationship child resource supports only GET action.
Households > Sales Team Member	/crmRestApi/resources/11.13.18.10/households/{PartyNumber}/child/SalesTeamMember/{SalesTeamMemberId}	PartyNumber SalesTeamMemberId
Households > Note	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Note/{NoteId}	PartyNumber NoteId
Households > Aux Classification	/crmRestApi/resources/11.13.18.10//households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}	PartyNumber CodeAssignmentId
Households > Attachments	/crmRestApi/resources/11.13.18.10//households/{PartyNumber}/child/Attachment/{AttachmentUniqID}	PartyNumber AttachmentUniqID