This program recalculates and updates all royalty balances and can be re-run repeatedly. It updates the balance forward from previous royalty period’s carried forward and refers to the Royalties Movement details for the relevant period, in order to accumulate, offset and calculate royalties. Royalty offset applies to expired payees as well. The sequence of offsets when calculating the payment due to a payee within a contract is determined by the setup in control file TMSRY/RY-SEQ.
To calculate tax on payment the following criteria must apply:
- The agent invoice must have the field pay agent = Y.
- The tax category substitution rule must be set up in TMSRY/RY-DTTP.
Minimum payment amounts are based on the following configuration.
- Minimum payment amount is setup by contract or by payee in TMSRY/RY-APIF with the option to either always pay or pay positive amount or negative amount.
- TMSRY/RY-APIF2 can be setup to determine the minimum payment amount by payee company by contract currency. The payee company is the company for the payee defined on the Creditor masterfile. The company determines the currency that is being used. This amount overrides the minimum payment amount defined in TMSRY/RY-APIF, however if TMSRY-APIF is flagged to always pay then the minimum payment amount does not apply.
- Further override can be introduced to allow minimum payment processing to be determined by royalty contract group as setup in TMSRY/RY-RGRP; to always pay or pay if the calculated payment amount is positive. Royalty contract group setting will override the settings in TMSRY/RY-APIF and TMSRY/RY-APIF2.
- A further override can be optionally setup in TMSRY/RY-PAYC to determine the minimum pay by royalty group by payee.
When recovering taxable cost, system calculates the tax amount and puts it in deferred tax transfer out. Minimum payment will not include deferred tax amount.
- In the menu, expand Publishing Modules > Rights & Permission > Period Processing and Others > Close of Royalty Period and double-click Royalty Balance Update. RYO060 Royalty Balance Update panel appears.
| Field | Description |
| Royalty period ending | Enter the Royalty period ending to specify for what period the balances are to be updated, |
| Company | This is the Royalty contract company. You can run the balance update for a single company or a range of companies. Only transactions for the nominated company/companies would be selected for update. User access must be setup for the company/companies in control file TMSRY/UA-ACC and TMSRY/UA-ACT. |
| Royalty group | When a contract is established, the Royalty group is nominated. Contracts belonging to a single royalty group or a range of royalty groups can be selected for Royalty balance update. Leave blank to select all royalty groups. This field can be mandatory or optional as per the setup in TMSRY/RY-SEL. |
| Payment frequency | When a contract is established, the Payment frequency is nominated. Contracts for a range of payment frequencies can be selected for Royalty balance update. Leave blank to select all payment frequencies. This field can be mandatory or optional as per the setup in TMSRY/RY-SEL. |
| Payee | Balance update can be done for a payee or a range of payees. Leave blank to select all payees. |
- Enter the above information as required and click OK.

