account-person.schema.md

XDM Business Account Person Relation Schema

https://ns.adobe.com/xdm/classes/account-person

XDM Business Account Person Relation is a standard Experience Data Model (XDM) class that captures the minimum required properties of a person that is associated with a business account. This XDM class can only be included in the profile for customers with the B2B or B2P Edition.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	classes/b2b/account-person.schema.json

Schema Hierarchy

• XDM Business Account Person Relation https://ns.adobe.com/xdm/classes/account-person
  • Record Schema https://ns.adobe.com/xdm/data/record
  • B2B Source https://ns.adobe.com/xdm/datatypes/b2b-source
  • External Source System Audit Details https://ns.adobe.com/xdm/common/external-source-system-audit-details
  • Record Status https://ns.adobe.com/xdm/mixins/record-status

XDM Business Account Person Relation Example

{
  "xdm:accountPersonID": "AAAPPP111"
}

XDM Business Account Person Relation Properties

Property	Type	Required	Defined by
@id	string	Optional	Record Schema
xdm:accountID	string	Optional	XDM Business Account Person Relation (this schema)
xdm:accountKey	B2B Source	Optional	XDM Business Account Person Relation (this schema)
xdm:accountPersonID	string	Optional	XDM Business Account Person Relation (this schema)
xdm:accountPersonKey	B2B Source	Optional	XDM Business Account Person Relation (this schema)
xdm:currencyCode	string	Optional	XDM Business Account Person Relation (this schema)
xdm:extSourceSystemAudit	External Source System Audit Attributes	Optional	External Source System Audit Details
xdm:isActive	boolean	Optional	XDM Business Account Person Relation (this schema)
xdm:isDeleted	boolean	Optional	Record Status
xdm:isDirect	boolean	Optional	XDM Business Account Person Relation (this schema)
xdm:isPrimary	boolean	Optional	XDM Business Account Person Relation (this schema)
xdm:personID	string	Optional	XDM Business Account Person Relation (this schema)
xdm:personKey	B2B Source	Optional	XDM Business Account Person Relation (this schema)
xdm:personRole	string	Optional	XDM Business Account Person Relation (this schema)
xdm:personRoles	string[]	Optional	XDM Business Account Person Relation (this schema)
xdm:relationEndDate	string	Optional	XDM Business Account Person Relation (this schema)
xdm:relationStartDate	string	Optional	XDM Business Account Person Relation (this schema)
xdm:relationshipSource	string	Optional	XDM Business Account Person Relation (this schema)
*	any	Additional	this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

• is optional
• type: string
• defined in Record Schema

@id Type

string

• format: uri-reference – URI Reference (according to RFC3986)

xdm:accountID

Account ID

Unique identifier for the account in this account person relationship.

xdm:accountID

• is optional
• type: string
• defined in this schema

xdm:accountID Type

string

xdm:accountKey

Account Key

Unique composite identifier for the account in this account person relationship.

xdm:accountKey

• is optional
• type: B2B Source
• defined in this schema

xdm:accountKey Type

• B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:accountPersonID

Account Person ID

Unique identifier for this relationship between an account and a person.

xdm:accountPersonID

• is optional
• type: string
• defined in this schema

xdm:accountPersonID Type

string

xdm:accountPersonKey

Account Person Key

Unique composite identifier for this relationship between an account and a person.

xdm:accountPersonKey

• is optional
• type: B2B Source
• defined in this schema

xdm:accountPersonKey Type

• B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:currencyCode

Currency Code

The ISO 4217 currency code used for the relationship between the account and the person.

xdm:currencyCode

• is optional
• type: string
• defined in this schema

xdm:currencyCode Type

string

All instances must conform to this regular expression

^[A-Z]{3}$

• test example: USD
• test example: EUR

xdm:currencyCode Examples

"USD"

"EUR"

xdm:extSourceSystemAudit

External Source System Audit Properties

Audit attributes for external sources.

xdm:extSourceSystemAudit

• is optional
• type: External Source System Audit Attributes
• defined in External Source System Audit Details

xdm:extSourceSystemAudit Type

• External Source System Audit Attributes – https://ns.adobe.com/xdm/common/external-source-system-audit

xdm:isActive

Active Flag

Boolean to indicate if this relationship between the account and the person is active.

xdm:isActive

• is optional
• type: boolean
• defined in this schema

xdm:isActive Type

boolean

xdm:isDeleted

Soft Delete Flag

Soft delete flag to indicate if the record is marked for deletion.

xdm:isDeleted

• is optional
• type: boolean
• defined in Record Status

xdm:isDeleted Type

boolean

xdm:isDirect

Direct Flag

Boolean to indicate if this is a direct relationship between the account and the person.

xdm:isDirect

• is optional
• type: boolean
• defined in this schema

xdm:isDirect Type

boolean

xdm:isPrimary

Primary Flag

Boolean to indicate if the person is the primary contact on the account.

xdm:isPrimary

• is optional
• type: boolean
• defined in this schema

xdm:isPrimary Type

boolean

xdm:personID

Person ID

Unique identifier for the person in this account person relationship.

xdm:personID

• is optional
• type: string
• defined in this schema

xdm:personID Type

string

xdm:personKey

Person Key

Unique composite identifier for the person in this account person relationship.

xdm:personKey

• is optional
• type: B2B Source
• defined in this schema

xdm:personKey Type

• B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:personRole

Person Role

Role of the person on this account.

xdm:personRole

• is optional
• type: string
• defined in this schema

xdm:personRole Type

string

xdm:personRoles

Person Roles

An array of roles of the person on this account.

xdm:personRoles

• is optional

• type: string[]

• defined in this schema

xdm:personRoles Type

Array type: string[]

All items must be of the type: string

xdm:relationEndDate

Relationship End Date

The date when the relationship between the account and the person ended.

xdm:relationEndDate

• is optional
• type: string
• defined in this schema

xdm:relationEndDate Type

string

• format: date-time – date and time (according to RFC 3339, section 5.6)

xdm:relationStartDate

Relationship Start Date

The date when the relationship between the account and the person started.

xdm:relationStartDate

• is optional
• type: string
• defined in this schema

xdm:relationStartDate Type

string

• format: date-time – date and time (according to RFC 3339, section 5.6)

xdm:relationshipSource

Relationship Source

Source of Account Person relation.

xdm:relationshipSource

• is optional
• type: string
• defined in this schema

xdm:relationshipSource Type

string