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

Account Additional Data

Type: object

Account additional data object to be sent by Opco during AX initialization/migration phase.

 No Additional Properties

root opCoAccountId
Type: string

OpCo's organizatinal customer number that uniquely identifies its account. 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 customerSystems
Type: array of object

Used to migrate existing information on customer’s systems or where the customers are present on: ERP, S2S systems, or B2B Marketplaces customer is present on. It is an array with details for each system

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root customerSystems customerSystems items
Type: object

This object contains customer's system information

root customerSystems customerSystems items type
Type: enum (of string)

Type of System

Must be one of:

  • "ERP"
  • "S2S"
  • "B2B_MARKETPLACE"

root customerSystems customerSystems items code
Type: string

Code supplied must match the technical identifier of the system as defined in the AX reference data (and present as column 'code'). If you want to enter system names not present in the reference list, the recommendation is to ensure you have in the AX reference data a record with name='others', and use the 'additionalInformation' field to put the name into.

Must be at least 1 characters long


Examples:

"SYS-00054"

"SYS-00038"

"SYS-00064"

root customerSystems customerSystems items additionalInformation
Type: string

Additional information that you might want to provide for the system. Especially useful to put the name of a system that is not present in the reference list, by associating it with a reference record with code='others'.

Must be at least 1 characters long


Examples:

"Dolibarr"

"Ciel"

root mainCompetitors
Type: array of object

An array of objects containing main competitors details

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root mainCompetitors mainCompetitors items
Type: object

This object contains information about main competitors

root mainCompetitors mainCompetitors items companyRegistrationID
Type: string

Registration Id of the company within its country. For countries with an hierarchical registration ID system like France, OpCo can use the HQ Registration ID (SIREN in FR) instead of the location specific one (SIRET in FR) if they want and do not care about differentiating between subsidiaries as competitors. The important thing is to have the same IDs used as in the reference data.

Must be at least 1 characters long


Example:

"12356894100056"

root mainCompetitors mainCompetitors items marketShare
Type: number

Represents the proportion or percentage of the total market that a particular competitor is estimated to control or have. Market share is a key metric in understanding a company's position in the market relative to its competitors.

Value must be greater or equal to 0 and lesser or equal to 100


Examples:

25.5

50

75.75