In-Portal User Manual

This is a wiki-based User Manual for In-Portal Open Source CMS. It is written and maintained by the community and covers every aspect of working with In-Portal. It takes many volunteers to keep it up to date and if you something missing, please consider contributing to our documentation writing effort.

Affiliates edit

From In-Portal User Manual

Revision as of 14:06, 8 August 2011 by Alex (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search

Affiliates Add/Edit form

This form has two tabs. The General tab with all of the properties of the affiliate user, and the Payments tab listing all of the payments, which have been issued to the current affiliate.
The General Tab has the following fields:

  • Affiliate ID – the internal ID used by the system
  • Username – allows you to select the In-portal user, which will become the affiliate. You may also use the User Selector by clicking on the icon next to the field
  • Affiliate plan – the drop-down with a selection of the Affiliate Plans defined in the system. The affiliate plan is used for calculating the affiliate commission
  • SSN/Tax Id/VAT Number – applicable identification number for the affiliate
  • Status – the affiliate’s status. Pending and Disabled affiliates do not earn commission. When a new affiliate is registered, he or she becomes pending. The administrator has to approve the affiliate by making him or her active before they can access the “My Affiliate Section” on the front-end and start earning commission.
  • Comments/Instructions – comments or special instructions editable by the affiliate during the registration or while changing payment types from the “My Account” section of the front end. This field may be used for storing bank details and other information associated with affiliate payments
  • Affiliate Link – the URL which should be used by the affiliate for referring visitors to the site (only on the edit form)
  • Affiliate Code – the code identifying the affiliate, may be used in other links to the site (only on the edit form)
  • Accumulated Amount – the total amount of orders made by the customers referred by this affiliate since the beginning of current period as defined by Affiliate Plan (only on the edit form)
  • Items Sold – the total number of items purchased by the customers referred by this affiliate since the beginning of current period as defined by Affiliate Plan (only on the edit form)
  • Amount to Pay – outstanding amount of commission earned by the affiliate, but not paid out (only on the edit form)
  • Last Payment Date – the date when the last payment to the affiliate has been made (only on the edit form)


In addition to the standard Save/Cancel buttons there is also a “Pay Out” button on this tab. The button is used to make a payment to the affiliate. The button opens the payment form with the following fields:

  • Username – (not editable), the username of the affiliate
  • Amount – the amount to pay out. By default, the current outstanding amount is pre-filled into the field. You may change this amount, and you may also enter a negative amount to perform a manual deduction of affiliate commission.
  • Payment Type – the drop-down with selection of payment types available in the system. The drop-down is pre-selected to the payment type the affiliate has selected.
  • Payment Date – the date payment should be made, defaults to the current date
  • Payment reference – the reference number such as a check number, wire transfer or other transaction number. This field is displayed to the affiliate in the Payments subsection of My Account on the front end
  • Comment – internal comment for the payment (not displayed to the affiliate)


Please note that the payment made using this form is only recorded when you click on the affiliate Add/Edit form.