NameDescriptionTypeAdditional information
SchemeName

Name of the Scheme

string

Required

SchemeERPId

ERP ID of the Scheme

string

None.

StartDate

Start Date of Scheme

date

Required

EndDate

End Date of Scheme

date

Required

SchemeCategory

Scheme Category: "Primary"=1, "Secondary"=2, "Tertiary"=3, "Uncategorised"=0

SchemeCategorization

Required

SchemeDescription

Description of the Scheme getting created

string

None.

PayOutType

PayOut Type of Scheme: "Discount", "FOC", "FixedValueDiscount"

PayoutType

Required

PayOutCalculationType

Calculation Type: "Step"=1, "Continous"=2, "Recurring=4"

PayoutCalculationType

Required

ConstraintOn

Constraint On: "Amount"=1, "Quantity"=2, "Standard_Unit"=3

ConstraintType

Required

PayOutIn

PayOut in: "Amount"=1, "Quantity"=2, "Standard_Unit"=3 (Valid for Payout: FOC)

PayoutIn

None.

SchemeBudget

Budget of Schemes

decimal number

None.

ApplicableAtLevel

Scheme is Applicable on: "Company"=0, "Zone"=1, "Region"=2, "Distributor"=3

SchemeApplicableAtLevel

Required

ApplicableOnEntity

Multiple Region Names, Zone Names, or Distributor ERPIDs in which Scheme is to be applied

Collection of string

Required

SchemeOn

DiscountBlock

Required

SchemeOnEntity

Multiple Product or Category names in which scheme is to be applied

Collection of string

Required

EligibleOn

DiscountBlock

None.

EligibleOnEntity

Multiple Product or Category names in which scheme is to be applied

Collection of string

None.

SchemeType

Primary = 1, Secondary = 2,

SchemeType

None.

SchemeSubType1

NonExtendable = 1, NonExtendableCompanytoSSandStockistonly = 2

SchemeSubType

None.

SchemeSubType2

Claimable = 3, NonClaimable = 4

SchemeSubType

None.

IsInclusive

Is Inclusive

boolean

None.

OutletConstraints

Outlet Constraints

SchemeOutletConstraintDb

None.

ProductFilterConstraints

Product Filter Constraints (for the Products defined in the "Scheme On Entity")

SchemeProductFilterConstraintDb

None.

SchemeSlabs

Collection of V3.SchemeSlabCreate

None.