Payout Records

Payout Records are lightweight Rebate Records which are useful in situations when you need to generate thousands of Rebate Records that represent all possible combinations of several attributes (customer, product, period, etc.). To avoid overloading the system, you can use lightweight Payout Records with a lot simpler data structure.

A Payout Record has the following features:

• It is an attributed object that stores the calculated rebate amount(s) (accruals) + customer (e.g., store) and product level attributes, i.e., primitive values – it is not intended for large data structures.
  A total of 100 generic attributes are available for this purpose.

• It has built-in fields to reference the original Rebate Record and identify the Payout Record by name, within the scope of the (top level) Rebate Record. This is the list of available built-in fields:

  Field name	Label	Type
  rebateRecordUN	Rebate Record	String
  type	Type	String
  name	Name	String
  label	Description	String
  startDate	Start Date	Date
  endDate	End Date	Date
  payoutDate	Payout Date	Date
  rebateTypeUN	Rebate Type	String
  status	Status	String
  intgStatus	Integration Status	String
  intgStatusDetails	Int. Status Details	String
  intgStatusErpReference	Int. ERP Ref.	String

  

• Global attribute metadata, i.e., a single set of attribute meta config (not per agreement or any other level). 
• There are no predefined Payout Record types or statuses. The rebate logic decides which Type and Status to initialize or update a Payout Record with. In the UI, there is an option of limited control on visibility of the records by Type and Business Roles, as well a status transitions when using the Mass-Edit functionality.
• There is no workflow available (see the Configuration section).
• Payout Records are created by the RebateRecord logic, i.e., in the context of the Rebate Record Calculation task (given that this is a background job, large amounts of records can be created). The logic bears the full responsibility for the Payout Record creation, update and deletion (by name).
  It has also full control over the content (field values) of the records.

 For step-by-step instructions see How to Configure Payout Records.