RebateProgram

The rebate program your organization runs with a single account, all accounts, or specific list of accounts. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Description

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description of the rebate program.

EndDate

Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The end date of the rebate program.

Frequency

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The frequency of rebate program.
Possible values:
- Annually
- Biannually
- CustomPeriods
- Monthly
- OnDemand
- ProgramStartAndEndDate
- Quarterly

GracePeriodDayCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Number of days from end date of an instance of a payout period. Transactions submitted until this day are considered for rebate calculation. For example, a value of 5 implies that channel partners can submit transactions for a monthly period before the 5th of the next month. This isn’t enforced in the system but can be used as information for channel partners.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the rebate program.

PayoutCalculationDayCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Number of days from period end date. The payment will be calculated after this date. For example, a payout calculation day count of 14 means 14 days after period end date.

ProgramReferenceNumber

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The reference number assigned to this rebate program. This field is unique within your organization. This field is available in API version 52.0 and later.

RebateProgramUrl

Type: url
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: URL of the rebate program.

StartDate

Type: date
Properties: Create, Filter, Group, Sort, Update
Description: Start date of rebate program.

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: Possible states of rebate program.
Possible values:
- Active
- Draft
- Inactive

StatusCode

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: Current status of program.
Possible values:
- Active
- Draft
- Inactive
- Approved
- Expired

Type

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of the rebate program.
Possible values:
- ShipAndDebit
- StandardRebate
- PriceProtection
- StockRotation
- TradeScheme

AccrualFrequency

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The frequency at which rebate amounts are accrued for the program.
Possible values:
- Weekly
- Monthly
- Quarterly
- Biannually
- Annually
- ProgramStartandEnd Date
- CustomPeriods

ExecutionType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the execution platform used to calculate payout and accrual amounts.
Possible values:
- Classic
- NextGen

AccrualCalculationDayCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of days after the period end date when accruals are calculated. For example, 14 means the accrual is calculated 14 days after the period ends.