Accounts: Required Attributes and Path Parameters

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

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

Parent Level	Account
Child Resources	Address
	Address > Address Purpose
	Primary Address
	Relationship
	Sales Team Member
	Note
	Attachments
	AUX Classification

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

Resource	Attribute	Attribute Description
Account Note: When creating an account, the account type can be ZCA_CONTACT, ZCA_CUSTOMER OR ZCA_PROSPECT. If the account type is not provided, then the default account type is set as ZCA_PROSPECT.	Organization Name	The name of the account.

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

Resource	Attribute	Attribute Description
Account > Address For accounts, the address is required based on the profile option code ZCA_ACCOUNT_ADDRESS_REQUIRED_ENABLED. If the profile option is set as, NO: Address is not required. YES: Address is required for all account types (such as ZCA_PROSPECT, ZCA_CONTACT 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.	Address1	The first line of the address.
	Address2	The second line of the address.
	Country	The country code of the address. The list of values for countries is available in the CountryLOV..
Account > Address > Address Purpose	Purpose	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.
Account > Primary Address	AddressLine1	The first line of the primary address.
	AddressLine2	The second line of the primary address.
	Country	The country code of the primary address. The list of values for countries is available in the CountryLOV.
Account > Relationship	SubjectPartyNumber	The alternate key identifier for the subject party of the relationship.
	RelationshipType	The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. The list of values for relationship types is available in the RelationshipTypeLookupLOV.
	RelationshipCode	The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. The list of values for relationship codes is available in the RelationshipCodeLookupLOV.
Account > 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 contained in the ZCA_ACCESS_LEVEL lookup. The list of values for access level codes is available in the AccessLevelLOV.
	LockAssignmentFlag	The flag indicates automatic territory assignment cannot remove the sales account team resource when this flag is Y. 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 unique identifier for the resource.
Account > Note	NoteTxt	This is the column which will store the actual note text.
	NoteTypeCode	This is the note type code for categorization of note. The list of values for note type codes is available in the NoteSourceTypeVA.
	VisibilityCode	This is the attribute to specify the visibility level of the note. The list of values for visibility codes is available in the NoteVisibilityLookupVA.
Account > 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.
Account > Aux Classification	ClassCategory	The name of the classification category.
	ClassCode	A valid classification code corresponding to the classification category.

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

Resource	Path	Path Parameters
Account	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}	PartyNumber

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

Resource	Path	Path Parameters
Account > Address	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/Address/{AddressNumber}	PartyNumber AddressNumber
Account > Address > Address Purpose	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}	PartyNumber AddressNumber AddressPurposeId
Account > Primary Address	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}	PartyNumber AddressNumber
Account > Relationship	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}	PartyNumber RelationshipRecId
Account > SalesTeamMember	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/SalesTeamMember/{SalesTeamMemberId}	PartyNumber SalesTeamMemberId
Account > Note	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/Note/{NoteId}	PartyNumber NoteId
Account > Attachment	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}	PartyNumber AttachmentUniqID
Account > AUX Classification	/crmRestApi/resources/11.13.18.10/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}	PartyNumber CodeAssignmentId