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

Sales Projects

Type: object

Represents a sales project in Spark AX

 No Additional Properties

root name
Type: string

Must be at least 0 characters long


Example:

"my project name"

root description
Type: string

Description of the sales project.

Must be at most 10000 characters long

root owner
Type: stringFormat: email

Enter the email address of the user who is assigned to manage the sales project.

Must be at most 254 characters long

root opcoSalesProjectId
Type: string

An Id that refers to the sales project in a legacy system. Could be e.g. either CRM legacy Id or ERP Id

Must be at least 0 characters long


Example:

"12345"

root projectComplexity
Type: enum (of string) Default: "STANDARD"

Deprecated Complexity of the project

Must be one of:

  • "STANDARD"
  • "HIGH"

Example:

"STANDARD"

root estimatedProjectImplementationDate
Type: stringFormat: date-time

Estimated start date of the project implementation. Date shall be provided in as local date adn time.
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root contractorCompanyRegistrationId
Type: string

Registration ID of the company, acting as the general Contractor for the project, within its country. Like siret number in France. It will only be matched against third party accounts.
Example:

"12356894100056"

root contractorCompanyHQRegistrationId
Type: string

Registration ID of the headquarter of a company, acting as the general Contractor for the project, within its country. Like siret number in France. It will only be matched against third party accounts.
Example:

"12356894100056"

root contractorCompanyVATNumber
Type: string

VAT Number of the general contractor company. It will only be matched against third party accounts.

Must be at most 20 characters long

root location
Type: string

Location of the future sales project.

root projectSuccessProbability
Type: enum (of string)

Estimated probability that the sales project will be implemented and sold

Must be one of:

  • "HIGH"
  • "MEDIUM"
  • "LOW"

Example:

"MEDIUM"

root estimatedProjectCost

Price

Type: object

Type the estimated revenue amount to indicate the potential sale or value of the sales project for revenue forecasting.

root estimatedProjectCost amount
Type: integer

The actual unscaled amount
Example:

205987

root estimatedProjectCost scale
Type: integer

The scale to be applied on the unscaled amount
Example:

2

root estimatedProjectCost currency
Type: string

The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Example:

"EUR"

root projectStatusReason
Type: enum (of string)

Type the estimated revenue amount to indicate the potential sale or value of the project for revenue forecasting.

Must be one of:

  • "PARTIALLY_AWARDED"
  • "FULLY_AWARDED"
  • "NOT_AWARDED"
  • "ON_HOLD"
  • "WON"
  • "CANCELED"
  • "LOST"

Example:

"WON"

root productCategories
Type: array

List of Product Categories related to the project by Id. Each item must match to one of the product categories configured for Spark AX.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root productCategories ProductCategory
Type: object

root productCategories productCategories items categoryCode
Type: string

The technical ID of the Product Category (field ‘code’)

Must be at least 1 characters long


Examples:

"231"

"820"

"000"

root productCategories productCategories items status
Type: enum (of string)

Current status of the product category for this project. The statuses "IN_PROGRESS", "ALLOCATED" were deprecated

Must be one of:

  • "NOT_AWARDED"
  • "AWARDED"
  • "ON_HOLD"
  • "CANCELED"
  • "LOST"
  • "WON"

root productCategories productCategories items estimatedBidDate
Type: stringFormat: date-time

Estimated date and time for the bid for the product category for this project.
Examples:

"2021-10-12T08:30:22.804Z"

"2018-11-13T20:20:39+02:00"

root productCategories productCategories items estimatedRevenue
Type: number

Estimated revenue from the product category for this project.
Examples:

12000

3500

root productCategories productCategories items successProbability
Type: enum (of string)

Probability of success of winning the product category for this project. The probability values "VERY_LOW", "VERY_HIGH" were deprecated

Must be one of:

  • "LOW"
  • "MEDIUM"
  • "HIGH"

Example:

"MEDIUM"

root productCategories productCategories items specialistEmail
Type: string

The email of the Specialist user (AX User) or name of the Specialist Team (AX Team) related to the product category for this project.
Examples:

"expert@sonepar.com"

"marketingTeam"

root stakeHolders
Type: array

List of Stake Holders to the project by Id.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root stakeHolders StakeHolder
Type: object

It is to capture all the stake holders related to project which can be contact,user and team.

root stakeHolders stakeHolders items stakeHolderType
Type: enum (of string)

Enter the stakeholder type that the project relates to.

Must be one of:

  • "USER"
  • "TEAM"
  • "CONTACT"

Example:

"TEAM"

root stakeHolders stakeHolders items stakeHolderId
Type: string

Enter the stakeholder id that the project relates to. It must be an email address matching to either a user, team or contact in AX.
Example:

"user@mail.com"

Examples:

{
    "stakeHolderType": "CONTACT",
    "stakeHolderId": "some@email.com"
}

{
    "stakeHolderType": "TEAM",
    "stakeHolderId": "sales_team"
}