This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Account Customer Relationship


This is object used to describe the account customer relationship details

root allOf item 0
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 0 if
Type: object

root allOf item 0 if scope
Type: array
No Additional Items

At least one of the items must be:

root allOf item 0 if scope contains
Type: const
Specific value: "SEGMENTATION"
root allOf item 0 then
Type: object

The following properties are required:

  • accountSegmentationArea
root allOf item 1
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 1 if
Type: object

root allOf item 1 if scope
Type: array
No Additional Items

At least one of the items must be:

root allOf item 1 if scope contains
Type: const
Specific value: "OWNERSHIP"
root allOf item 1 then
Type: object

The following properties are required:

  • accountOwnershipArea
root allOf item 2
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 2 if
Type: object

root allOf item 2 if scope
Type: array
No Additional Items

At least one of the items must be:

root allOf item 2 if scope contains
Type: const
Specific value: "CONTRACT"
root allOf item 2 then
Type: object

The following properties are required:

  • accountContractArea
root allOf item 3
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 3 if
Type: object

root allOf item 3 if scope
Type: array
No Additional Items

At least one of the items must be:

root allOf item 3 if scope contains
Type: const
Specific value: "VENDOR"
root allOf item 3 then
Type: object

The following properties are required:

  • accountVendorArea
root allOf item 4
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root allOf item 4 if
Type: object

root allOf item 4 if scope
Type: array
No Additional Items

At least one of the items must be:

root allOf item 4 if scope contains
Type: const
Specific value: "KEY_ACCOUNT"
root allOf item 4 then
Type: object

The following properties are required:

  • accountKeyAccountArea

root eventHeader
Type: object

This object is used to describe some technical meta information related to the event

root eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK_AX"
  • "OPCO"

root eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root opCoAccountId
Type: string

OpCo's organizational customer number that uniquely identifies its account. This contains the master account id, the master can be the ERP or in the future AX.
In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA

Must be at least 1 characters long


Examples:

"1234567"

"1234567_OVIA"

root scope
Type: array of enum (of string)

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root scope scope items
Type: enum (of string)

Must be one of:

  • "SEGMENTATION"
  • "OWNERSHIP"
  • "KEY_ACCOUNT"
  • "CONTRACT"
  • "VENDOR"

root accountOwnershipArea
Type: object

This area covers all data related to account ownership

 No Additional Properties

root accountOwnershipArea salesRepresentative
Type: object

The sale representative of the account

 No Additional Properties

root accountOwnershipArea salesRepresentative firstname
Type: string

firstname of the sale representative

Must be at least 1 characters long


Example:

"John"

root accountOwnershipArea salesRepresentative lastname
Type: string

lastname of the sale representative

Must be at least 1 characters long


Example:

"Doe"

root accountOwnershipArea salesRepresentative phoneNumber
Type: string

phone number of the sale representative
Example:

"0683906389"

root accountOwnershipArea salesRepresentative email
Type: stringFormat: email

email of the sale representative
Example:

"john.doe@standelec.com"

root accountOwnershipArea insideSalesRepresentative
Type: object

The inside sale representative of the account (object for future-proofing)

 No Additional Properties

root accountOwnershipArea insideSalesRepresentative email
Type: stringFormat: email

email of the inside sale representative (one person or team)

Must be at least 1 characters long


Example:

"john.doe@standelec.com"

root accountOwnershipArea serviceCenterId
Type: string

A facility id with capability SERVICE_CENTER.
A service center is the entity to represent the Sonepar venue in charge of managing the customer relationships for any physical touch point regarding sales or services aspects.
Can be represented by a Sonepar Branch for Small or Middle size account or by a Hub for larger accounts.
Then, in some cases, this service center can be different from the default facility id already provided in account feed.

Must be at least 1 characters long


Example:

"4335"

root accountSegmentationArea
Type: object

This area covers all data related to account segmentation

 No Additional Properties

root accountSegmentationArea activityCode
Type: string

Code that identifies the main branch of activity of customer, like NAF code for france or like the European (NACE) and international (CITI) classifications

Must be at least 1 characters long


Examples:

"2101"

"21.11"

"21.1A"

root accountSegmentationArea numberOfEmployees
Type: integer

number of employees in the company.
Example:

1234

root accountSegmentationArea endMarketSegmentation
Type: string

The lowest level code of the end market segment where the account is attached (installers, medium or large scale), as defined on Opco Territory record. The code provided must match this level for the OPCO. AX will populate the account with the higher levels as per the defined hierarchy. A code for an incorrect level will result in an incorrect hierarchy update on the Account record.

Must be at least 1 characters long


Examples:

"111-1"

"1be9366881063c8e18457f29b5e1f0db"

root accountSegmentationArea customerSegmentation
Type: string

The lowest level code of the customer segment where the account is attached, as defined on Opco Territory record. The code provided must match this level for the OPCO. AX will populate the account with the higher levels as per the defined hierarchy. A code for an incorrect level will result in an incorrect hierarchy update on the Account record.

Must be at least 1 characters long


Examples:

"111-1"

"1be9366881063c8e18457f29b5e1f0db"

root accountKeyAccountArea
Type: object

This area covers all data related to key account information

 No Additional Properties

root accountKeyAccountArea isKeyAccount
Type: boolean Default: false

Boolean field stating whether the account is a key account.
WARNING: If set to

true (= the account is a key account), the following fields must be provided:

  • keyAccountManager

  • keyAccountBusinessUnit

  • hasKeyAccountContract

  • keyAccountExtraSegmentationData
    If set to

false (=the account is a child of a key account), the following fields must be provided:

  • keyAccountId

  • isPartOfKeyAccountContract In case keyAccountId cannot be provided and then is empty, then these additional fields are required

  • keyAccountName

  • keyAccountManager

  • keyAccountBusinessUnit

  • keyAccountExtraSegmentationData

root accountKeyAccountArea keyAccountManager
Type: stringFormat: email

In case the key account manager is different from the account's owner. represented by key account manager's email
Example:

"jean.dupont@sonepar.fr"

root accountKeyAccountArea keyAccountBusinessUnit
Type: string

Business unit in which the key acocunt resides.

Must be at least 1 characters long


Example:

"Vinci Solar panel"

root accountKeyAccountArea hasKeyAccountContract
Type: boolean Default: false

Boolean field to represent if the account is a key account (i.e. isKeyAccount=true) and has a dedicated key account contract.

root accountKeyAccountArea keyAccountExtraSegmentationData
Type: array

The code of the customer segment where the account is attached.

 No Additional Items

Each item of this array must be:

root accountKeyAccountArea keyAccountExtraSegmentationData additionalInformation
Type: object

This object represents any extra data Opco for segmentation

 No Additional Properties

root accountKeyAccountArea keyAccountExtraSegmentationData keyAccountExtraSegmentationData items value
Type: string

any information that needs to be attached to the key account

root accountKeyAccountArea keyAccountId
Type: string

If the account is a child of a key Account (isKeyAccount=false), the Account id of the parent key account (must have isKeyAccount=true) must be provided

root accountKeyAccountArea keyAccountName
Type: string

To be sent only, if keyAccountId cannot be provided. This field will only display the name and must be maintained manually.
If the account is a child of a key Account (isKeyAccount=false) and id of key account parent cannot be provided, the name of this key account parent can be provided.

root accountKeyAccountArea isPartOfKeyAccountContract
Type: boolean Default: false

Boolean field to represent if the account is a child of a key account (i.e. isKeyAccount=false) and part of the key account's contract.

root accountContractArea
Type: object

This area covers all data related to contract information related to account

 No Additional Properties

root accountContractArea purchaseGroup
Type: object

The purchase group if the customer belongs to one

 No Additional Properties

root accountContractArea purchaseGroup id
Type: string

id of the purchase group

Must be at least 1 characters long


Example:

"1234"

root accountContractArea purchaseGroup name
Type: string

name of the purchase group to be displayed

Must be at least 1 characters long


Example:

"Doe"

root accountContractArea contractedItems
Type: array of string

The list of key contractual terms between opco and this account.The contract term code are getting added to AX via account-references feed.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root accountContractArea contractedItems contractedItems items
Type: string

'The code of the contract term.

Examples:

"SIC"

"ISO"

root accountContractArea systemToSystem

systemToSystem

Type: object

If opcos have their accounts active on S2S they send us the information else not

root accountContractArea systemToSystem isActive
Type: boolean Default: false

Shows if system to system integration channel is active between Customer and OpCo. If customers are not active on S2S, then OpCo's sales representatives can chase the customers via AX

root accountVendorArea
Type: object

In Pilot: This area covers all data related to vendor information related to account

 No Additional Properties

root accountVendorArea vendorData
Type: array of object
No Additional Items

Each item of this array must be:

root accountVendorArea vendorData vendorData items
Type: object

root accountVendorArea vendorData vendorData items vendorId
Type: string

The vendor id of the account

Must be at least 1 characters long


Example:

"1234567"

root accountVendorArea vendorData vendorData items key
Type: string

any key for extra data
Example:

"CustomerType"

root accountVendorArea vendorData vendorData items value
Type: string

any information that needs to be attached to the vendor area
Example:

"Contractor"