.. _royalties:

Royalty statements
##################

Concepts
========

.. image:: statements.png

The calculation of royalty statements takes each line of right of the selected period and applies rules to
determine :

* who should be paid
* at what rate

Rights
------

The rights can be manually input by adding lines in **direct rights** or, preferably, by importing files
from rights providers. Every line of right has, at least, the following information :

* a period
* a **type of right**
* a work to which it applies
* an amount received

Rules
-----

The rules are either assigned directly to an individual work or to a **contract**. Both work in exactly the
same way. But, as you can see on the above figure, the link between the rules (in purple) and the works is
indirect : works are put in a group and this group is attached to a contract.

.. important:: Rules tied to a work always have precedence over rules defined in a contract

This means that if a work is a member of a group linked to a contract and this work also has specific royalty rules
defined, these specific rules supersede the ones defined in the contract (the contract is ignored for this 
particular work). You can see them as exceptions.

.. danger:: Be aware that if a work if present in two groups connected to contracts, both contracts will apply (you can
adjust this by using **floors** on contracts though)



At least, a rule defines :

* the **shareholder** who will receive the share
* the rates to be paid for each type of right
  
Rules can also have **conditions** : the rule will apply only if the condition(s) is/are met. For example, you can define
that a rule only applies when rights come from a specific provider. The rules that don't have conditions defined are "default" 
rules.

Calculation
===========

Le Sage takes each shareholder one by one, determines the works on which he could be paid and looks if there are rights for these works
for the period. Then, for each of these works, it will analyze all the rules for this shareholder and assign a weight to
each rule. Rules with many conditions have a higher weight and default rules have the lowest weight. Finally, Le Sage selects the
rule(s) with the highest weight and calculates the shares due. Of course, the rules that have unmet conditions are ignored.

Customization
=============

Royalty statements can be customized in many ways :

* Headers and footers (either images or texts) can be printed on the first page
* The title and subtitle of the statement are free texts
* You can show or hide the country of origin of the rights (and a subtotal by country)
* You can show or hide the film from which the work is part (if the information is available)
  
For each shareholder, you can also choose individually :

* The level of detail printed
* The statement can be printed in two languages (one of them is english, the other is french by default but can be fully translated)
* Summaries can be shown or hidden
* Taxes and (french) social insurance calculations can be enabled/disabled

.. image:: shareholder_customization.png



.. toctree::
	:maxdepth: 3

	importrepart
	../analyse/visualisation_droits
	contrats
	decomptes_details