Running Royalties - Revision history

PubGizmoSysop at 23:31, 5 October 2026

2026-10-05T23:31:03Z

PubGizmoSysop at 19:13, 4 October 2026

2026-10-04T19:13:25Z

← Older revision		Revision as of 15:13, 4 October 2026
Line 20:		Line 20:
	Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import. Each Sales Import includes a checkbox to confirm completeness and accuracy.		Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import. Each Sales Import includes a checkbox to confirm completeness and accuracy.

	'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since ~~strictly~~ PubGizmo filters the date range for the selected period to isolate sales for that period.		'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since PubGizmo filters the date range for the selected period to isolate sales for that period.

	== Ensure Correct Active Contract/Statements are Flagged to Calculate ==		== Ensure Correct Active Contract/Statements are Flagged to Calculate ==
	PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for ~~this~~ period (see below), ~~the~~ the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:		PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for the period (see below), the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:

	# on the Contract itself, at the upper-right,		# on the Contract itself, at the upper-right,
Line 32:		Line 32:

	== Flag Royalties to Pay This Period ==		== Flag Royalties to Pay This Period ==
	For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values~~, if any,~~ carried over until the next period.		For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values carried over until the next period.

	=== Flag Manually ===		=== Flag Manually ===
Line 40:		Line 40:

	=== Flag Automatically ===		=== Flag Automatically ===
	If you have many statements to pay, it's easiest to ~~flag the majority using of them using~~ the bulk Flag Eligible for Payout function, outlined below.		If you have many statements to pay, it's easiest to use the bulk Flag Eligible for Payout function, outlined below.

	== Apply Global Settings ==		== Apply Global Settings ==
Line 46:		Line 46:

	=== Set your Payout Threshold ===		=== Set your Payout Threshold ===
	You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you can hold payments until next period of the contractee is owed less than $25.		You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you can hold payments until next period if the contractee is owed less than $25.

	You can find the field to change this value in Admin > second tab > Minimum Royalty Payment. If you set this value for $0 and use the bulk process outlined below, all statements will be set to payout.		You can find the field to change this value in Admin > second tab > Minimum Royalty Payment.

			'''Hint:''' if you set this value for $0 and use the bulk process outlined below, all statements will be set to payout.

	=== Compose or Edit Stock Messages ===		=== Compose or Edit Stock Messages ===
Line 72:		Line 74:

	== Bulk Royalty Actions ==		== Bulk Royalty Actions ==
	While you can configure and send ~~individual~~ statements, PubGizmo's superpower is handling royalty functions in bulk – processes that might've taken days ~~are~~ weeks can be completed in minutes.		While you can configure and send statements individually, PubGizmo's superpower is handling royalty functions in bulk – processes that might've taken days or weeks can be completed in minutes.

	=== The Bulk Royalty Actions Popover ===		=== The Bulk Royalty Actions Popover ===
	These actions are ~~accessed and~~ executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.		These actions are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.
	[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]Actions are performed ~~only~~ on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the ~~top~~-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.		[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]Actions are performed for the set royalty period on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the upper-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.

	You have four ways to configure a Found Set to run the royalty buttons against:		You have four ways to configure a Found Set to run the royalty buttons against:
Line 83:		Line 85:
	# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshot sets)		# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshot sets)
	# close the Bulk Royalty Actions popover, and use the Find box with criteria to generate a Found Set of records you want to process		# close the Bulk Royalty Actions popover, and use the Find box with criteria to generate a Found Set of records you want to process
	# close the Bulk Royalty Actions popover, ~~and~~ Tag the records ~~you want~~, ~~then~~ show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)		# close the Bulk Royalty Actions popover, Tag the records, and show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records).

	== Bulk Processes ==		== Bulk Processes ==

	=== 1. Flag Eligible for Payout ===		=== 1. Flag Eligible for Payout ===
	~~==== Flag Automatically ====~~		The '''Flag Eligible for Payout''' button will auto-flag statements for payout in the selected period, as follows:
	The '''Flag Eligible for Payout''' button ~~in the Bulk Royalty Action popover~~ will auto-flag for the ~~payout~~ for the selected period ~~for~~ any ~~active~~ contract where the amount owing to one or more of the contractees exceeds the threshold (set in Admin), e.g., pay out only if the author is owed $25 or more, otherwise leave it unflagged, for the amount to carry over to the next royalty period (negative amounts always carry over).
			# Calc Royalty is flagged
			# the ''total amount payable for all contracts'' for at least one contractee on the statement equals or exceeds the Minimum Royalty Payment amount in Admin.

			Note for the second item it's the combined amount for all the contractee's statements, not just this statement, that determines whether or not that statement and all that contractee statements are flagged.

			Example:

			minimum royalty payment threshold is set for $25

			author has three statements, with the following amounts owing: $10, $12, $5

			All three statements will be flagged, because the total amount to pay that author is $27. The idea

			in the selected period any Calc Royalty contract where the amount owing to one or more of the contractees exceeds the threshold (set in Admin), e.g., pay out only if the author is owed $25 or more, otherwise leave it unflagged, for the amount to carry over to the next royalty period (negative amounts always carry over).

	To auto-flag:		To auto-flag:

PubGizmoSysop at 18:57, 4 October 2026

2026-10-04T18:57:29Z

← Older revision		Revision as of 14:57, 4 October 2026
Line 2:		Line 2:
	Once all your data is in PubGizmo, you can run royalties. "Run" is a multi-step process.		Once all your data is in PubGizmo, you can run royalties. "Run" is a multi-step process.

	# ~~Ensure all editions are added to Title records – remember to add any that may have been released~~ since ~~your~~ last period, and ~~ensure that list prices are correctly set~~.		# Enter new Titles since the last period and configure Editions and Contracts.
	# ~~Ensure all contracts are configured and accurate~~.		# Apply changes that may affect existing Titles. Did you add new editions?
	# Complete importing and entering all sales ~~records~~ for the royalty period.		# Complete importing and entering all sales data for the royalty period.
	# Ensure all relevant contracts are flagged to Calc Royalty.		# Ensure all relevant contracts are flagged to Calc Royalty.
	# Flag which statements to pay out; any not paid out will have their amounts carried forward.		# Flag which statements to pay out; any not paid out will have their amounts carried forward.
Line 15:		Line 15:

	== Ensure Titles, Editions, and Contracts are Current and Accurate ==		== Ensure Titles, Editions, and Contracts are Current and Accurate ==
	Titles published since your last royalty run will need to be added, and changes to editions and/or contracts for previous titles need to be applied.		Titles published since your last royalty run will need to be added, and changes to editions and/or contracts for previous titles need to be applied.

	== Complete Input of Sales Data ==		== Complete Input of Sales Data ==
	Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import.		Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import. Each Sales Import includes a checkbox to confirm completeness and accuracy.

	'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since strictly PubGizmo filters the date range for the selected period to isolate sales for that period.		'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since strictly PubGizmo filters the date range for the selected period to isolate sales for that period.

PubGizmoSysop at 18:53, 4 October 2026

2026-10-04T18:53:29Z

PubGizmoSysop: /* The Process */

2026-10-04T18:04:23Z

The Process

← Older revision		Revision as of 14:04, 4 October 2026
Line 1:		Line 1:
	== The Process ==		== The Royalties Process ==
	Once all your data is in PubGizmo, you can run royalties. "Run" is a multi-step process.		Once all your data is in PubGizmo, you can run royalties. "Run" is a multi-step process.

			# Ensure all editions are added to Title records.
			# Ensure all contracts are configured.
	# Complete importing and entering all sales records for the royalty period.		# Complete importing and entering all sales records for the royalty period.
	# Ensure all relevant contracts are flagged active.		# Ensure all relevant contracts are flagged active.

PubGizmoSysop at 18:02, 4 October 2026

2026-10-04T18:02:35Z

PubGizmoSysop at 17:46, 4 October 2026

2026-10-04T17:46:31Z

← Older revision		Revision as of 13:46, 4 October 2026
Line 12:		Line 12:
	# Generate a spreadsheet that summarizes your royalties.		# Generate a spreadsheet that summarizes your royalties.

	~~== Accessing the Royalties Menu ==~~
	~~The steps below are activated via the crown popover available at the upper-right in Royalties list view.~~
	== Step-by-step ==		== Step-by-step ==

	=== Complete Input of Sales Data ===		=== Complete Input of Sales Data ===
	Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import.		Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import.
Line 30:		Line 27:
	'''Hint:''' you can get a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.		'''Hint:''' you can get a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.

	=== ~~The Bulk Royalty Actions Popover~~ ===		=== Flag Royalties to Pay This Period ===
	~~The functions~~ to ~~complete royalties are executed in a popover accessed using~~ the ~~royalties~~ (~~crown~~) ~~button available in~~ the ~~List View~~ of the ~~Royalties module~~.		For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values, if any, carried over until the next period.
	[[File:~~Screenshot 2026-10-01 at 16.31.08~~.png~~\|none~~\|thumb\|~~631x631px]]These actions are performed only on~~ the ~~Found Set (~~the ~~records currently showing in~~ the ~~list) and then only on those records in the Found Set with~~ '''~~Calc Royalty~~''' ~~checked~~. ~~Statistics at~~ the ~~top-right of~~ the ~~popover describe the composition of your total and current Found Set of records~~, ~~and how many will be processed with the buttons~~.
			==== Flag Manually ====
			[[File:PayOutCheckbox.png\|thumb\|Without the Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' with this statement.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.

	~~You have four ways~~ to ~~configure a Found Set~~ to ~~run the royalty buttons against:~~		'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.

	~~# click the Show All Records button (hidden if you are already seeing all records) to do a complete run of all Calc Royalty statements~~		==== Flag Automatically ====
	~~# load a Snapshot of Royalty records~~ you have ~~created previously (see [[Tags & Snapshots]] on how~~ to ~~create Snapshot sets)~~		If you have many statements to pay, it's easiest to flag the majority using of them using the bulk Flag Eligible for Payout function, outlined below.
	~~# close the Bulk Royalty Actions popover~~, ~~and use~~ the ~~Find box with criteria to generate a Found Set~~ of ~~records you want to process~~
	~~# close the Bulk Royalty Actions popover, and Tag~~ the ~~records you want~~, ~~then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)~~

	== Apply Global Settings ==		=== Apply Global Settings ===
	Before running royalties, ensure you set up a couple of things in Admin (only users with Admin access can perform these actions).		Before running royalties, ensure you set up a couple of things in Admin (only users with Admin access can perform these actions).

	=== Set your Payout Threshold ===		=== Set your Payout Threshold ===
	For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkbox, you can payout

	You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you hold payments until next period of the contractee is owed less than $25.		You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you hold payments until next period of the contractee is owed less than $25.

	~~==== Flag Manually ====~~
	[[File:PayOutCheckbox.png\|thumb\|Without the Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' with this statement.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.

	'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.

	=== Compose or Edit Stock Messages ===		=== Compose or Edit Stock Messages ===
Line 74:		Line 64:
	* author/contractee has multiple active contracts		* author/contractee has multiple active contracts
	* literary agent is agent-of-record on multiple active contracts		* literary agent is agent-of-record on multiple active contracts

			=== The Bulk Royalty Actions Popover ===
			The functions to complete royalties are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.
			[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]These actions are performed only on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the top-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.

			You have four ways to configure a Found Set to run the royalty buttons against:

			# click the Show All Records button (hidden if you are already seeing all records) to do a complete run of all Calc Royalty statements
			# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshot sets)
			# close the Bulk Royalty Actions popover, and use the Find box with criteria to generate a Found Set of records you want to process
			# close the Bulk Royalty Actions popover, and Tag the records you want, then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)

			*

	== The Process ==		== The Process ==

PubGizmoSysop at 17:35, 4 October 2026

2026-10-04T17:35:13Z

← Older revision		Revision as of 13:35, 4 October 2026
Line 32:		Line 32:
	=== The Bulk Royalty Actions Popover ===		=== The Bulk Royalty Actions Popover ===
	The functions to complete royalties are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.		The functions to complete royalties are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.
	[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]These actions are performed only on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the top of the popover describe how many ~~records~~ will be processed with the buttons.		[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]These actions are performed only on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the top-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.

	You have four ways to configure a Found Set to run the royalty buttons against:		You have four ways to configure a Found Set to run the royalty buttons against:
Line 41:		Line 41:
	# close the Bulk Royalty Actions popover, and Tag the records you want, then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)		# close the Bulk Royalty Actions popover, and Tag the records you want, then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)

	==~~= Flag Statements to Pay Out =~~==		== Apply Global Settings ==
	~~Statements default to not being paid out. You'll notice that initially~~, ~~all statements are carrying over the earned amount to the next period. You~~ can ~~flag~~ these ~~either manually or automatically~~.		Before running royalties, ensure you set up a couple of things in Admin (only users with Admin access can perform these actions).

	===~~= Flag Automatically =~~===		=== Set your Payout Threshold ===
	~~PubGizmo~~ can ~~auto-flag for payout~~ any ~~active contract where the amount owing to the author (for all contracts~~) ~~exceeds a threshold, e.g., pay out only if the author is owed $25 or more, otherwise leave it unflagged, for the amount to carry over~~ to the next royalty period (~~negative amounts always carry over~~).		For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkbox, you can payout

	~~To auto-flag:~~		You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you hold payments until next period of the contractee is owed less than $25.

	~~# Set your threshold in Admin (bottom~~ of ~~main Admin screen).~~
	~~# Open~~ the ~~Royalties Menu.~~
	~~# Select '''Flag Eligible for Payout'''~~.

	==== Flag Manually ====		==== Flag Manually ====
	[[File:PayOutCheckbox.png\|thumb\|~~Carrying forward~~; check the box to '''Pay Out 2023''']]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.		[[File:PayOutCheckbox.png\|thumb\|Without the Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' with this statement.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.

	'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle on display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be ~~painfully~~ slow. Click the header again to turn off this display.		'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.

	=== Compose or Edit Stock Messages ===		=== Compose or Edit Stock Messages ===
Line 78:		Line 74:
	* author/contractee has multiple active contracts		* author/contractee has multiple active contracts
	* literary agent is agent-of-record on multiple active contracts		* literary agent is agent-of-record on multiple active contracts

			== The Process ==

			=== 1. Flag Eligible for Payout ===
			==== Flag Automatically ====
			The '''Flag Eligible for Payout''' button in the Bulk Royalty Action popover will auto-flag for the payout for the selected period for any active contract where the amount owing to one or more of the contractees exceeds the threshold (set in Admin), e.g., pay out only if the author is owed $25 or more, otherwise leave it unflagged, for the amount to carry over to the next royalty period (negative amounts always carry over).

			To auto-flag:

			# Set your threshold in Admin (bottom of main Admin screen).
			# Open the Royalties Menu.
			# Click the '''Flag Eligible for Payout''' button.

	=== Proof the Statements ===		=== Proof the Statements ===

PubGizmoSysop at 22:45, 3 October 2026

2026-10-03T22:45:03Z

← Older revision		Revision as of 18:45, 3 October 2026
Line 36:		Line 36:
	You have four ways to configure a Found Set to run the royalty buttons against:		You have four ways to configure a Found Set to run the royalty buttons against:

			# click the Show All Records button (hidden if you are already seeing all records) to do a complete run of all Calc Royalty statements
	# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshot sets)		# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshot sets)
	~~# click the Show All Records buttons to do a complete off all Calc Royalty statements~~		# close the Bulk Royalty Actions popover, and use the Find box with criteria to generate a Found Set of records you want to process
	# close the Bulk Royalty Actions popover, and ~~used~~ the Find box with criteria to generate a Found Set of records you want to process		# close the Bulk Royalty Actions popover, and Tag the records you want, then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)
	# close the Bulk Royalty Actions popover, and Tag the records you want, ~~and~~ show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag records)

	=== Flag Statements to Pay Out ===		=== Flag Statements to Pay Out ===

PubGizmoSysop at 22:34, 3 October 2026

2026-10-03T22:34:58Z

← Older revision		Revision as of 18:34, 3 October 2026
Line 21:		Line 21:
	'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since strictly PubGizmo filters the date range for the selected period to isolate sales for that period.		'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since strictly PubGizmo filters the date range for the selected period to isolate sales for that period.

	~~=== The Bulk Royalty Actions Popover ===~~		=== Ensure Correct Active Contract/Statements are Flagged to Calculate ===
	~~The primary functions to complete royalties are located in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.~~		PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for this period (see below), the the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:
	~~[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]~~

	=== Ensure ~~All~~ Active Contract/Statements are Flagged to Calculate ===
	PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run. Unlike flagging statements to pay out for this period (see below), the the status of the Calc Royalty flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:

	# on the Contract itself, at the upper-right,		# on the Contract itself, at the upper-right,
Line 32:		Line 28:
	# in Royalty list view.		# in Royalty list view.

	'''Hint:''' you can get a list of statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.		'''Hint:''' you can get a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.

			=== The Bulk Royalty Actions Popover ===
			The functions to complete royalties are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.
			[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]These actions are performed only on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the top of the popover describe how many records will be processed with the buttons.

			You have four ways to configure a Found Set to run the royalty buttons against:

			# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshot sets)
			# click the Show All Records buttons to do a complete off all Calc Royalty statements
			# close the Bulk Royalty Actions popover, and used the Find box with criteria to generate a Found Set of records you want to process
			# close the Bulk Royalty Actions popover, and Tag the records you want, and show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag records)

	=== Flag Statements to Pay Out ===		=== Flag Statements to Pay Out ===

← Older revision		Revision as of 19:31, 5 October 2026
Line 23:		Line 23:

	== Ensure Correct Active Contract/Statements are Flagged to Calculate ==		== Ensure Correct Active Contract/Statements are Flagged to Calculate ==
	PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for the period (see below), the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:		PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for the selected period (see below), the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:

	# on the Contract itself, at the upper-right,		# on the Contract itself, at the upper-right,
Line 29:		Line 29:
	# in Royalty list view.		# in Royalty list view.

	'''Hint:''' you can ~~get~~ a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.		'''Hint:''' you can yield a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.

	== Flag Royalties to Pay This Period ==		== Flag Royalties to Pay This Period ==
	For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where ~~they~~ will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values carried over until the next period.		For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where those values will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period, and must be set each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values carried over until the next period.

	=== Flag Manually ===		=== Flag Manually ===
	[[File:PayOutCheckbox.png\|thumb\|Without Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' during the 2023 period.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.		[[File:PayOutCheckbox.png\|thumb\|Without Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' during the 2023 period.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.

	'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.		'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header above the righthand column. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.

	=== Flag Automatically ===		=== Flag Automatically ===
	If you have many statements to pay, it's easiest to use the bulk Flag Eligible for Payout function, outlined below.		If you have many statements to pay, it's easiest to use the bulk Flag Eligible for Payout function, outlined below under Bulk Royalty Actions.

	== Apply Global Settings ==		== Apply Global Settings ==
Line 63:		Line 63:
	* '''<Year>''' The royalty year, if your press uses the calendar year for statement period, otherwise the start and end dates of the royalty period.		* '''<Year>''' The royalty year, if your press uses the calendar year for statement period, otherwise the start and end dates of the royalty period.
	* '''<Title>''' The book's title, or titles, if the author has multiple active contracts, in a comma-delimited list (Title1, Title2, etc.).		* '''<Title>''' The book's title, or titles, if the author has multiple active contracts, in a comma-delimited list (Title1, Title2, etc.).
	* '''<GreetingName>''' The value in the Correspondence Name field on the recipients Contact record (defaults to the ~~contact~~'s first name, but can be edited). For Organization contractees, ~~this~~ will attempt to use the email address of the Org's rep, if defined on the Contract, otherwise it will use the Org name.		* '''<GreetingName>''' The value in the Correspondence Name field on the recipients Contact record (defaults to the Contact's first name, but can be edited). For Organization contractees, the system will attempt to use the email address of the Org's rep, if defined on the Contract, otherwise it will use the Org name.
	* '''<Artist>''' The contractee's first and last name. Note: in the Agent email, this will substitute with the phrase "(refer to attached PDF)".		* '''<Artist>''' The contractee's first and last name. Note: in the Agent email, this will substitute with the phrase "(refer to attached PDF)".
	* '''<Address>''' Recipient's mailing address in one line.		* '''<Address>''' Recipient's mailing address in one line.
Line 70:		Line 70:
	Rather than sending out multiple individual statements to an author, PubGizmo "rolls up" statements, that is, gathers all relevant statements into a single PDF, and attaches them to one email message, under these circumstances:		Rather than sending out multiple individual statements to an author, PubGizmo "rolls up" statements, that is, gathers all relevant statements into a single PDF, and attaches them to one email message, under these circumstances:

	* author/contractee has multiple active contracts		* author/contractee has multiple active contracts (includes a summary page of all statements)
	* literary agent is agent-of-record on multiple active contracts		* literary agent is agent-of-record on multiple active contracts

	== Bulk Royalty Actions ==		== Bulk Royalty Actions ==
	While you can configure and send statements individually, PubGizmo's superpower is handling royalty functions in bulk – processes that might've taken days or weeks can be ~~completed~~ in minutes.		While you can configure and send statements individually, PubGizmo's superpower is handling royalty functions in bulk: processes that might've taken days or weeks can be accomplished in minutes.

	=== The Bulk Royalty Actions Popover ===		=== The Bulk Royalty Actions Popover ===
	~~These~~ actions are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.		Bulk actions are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.
	[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]Actions are performed for the set royalty period on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the upper-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.		[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]Actions are performed for the set royalty period on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the upper-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.

Line 83:		Line 83:

	# click the Show All Records button (hidden if you are already seeing all records) to do a complete run of all Calc Royalty statements		# click the Show All Records button (hidden if you are already seeing all records) to do a complete run of all Calc Royalty statements
	# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create ~~Snapshot sets~~)		# load a Snapshot of Royalty records you have created previously (see [[Tags & Snapshots]] on how to create Snapshots)
	# close the Bulk Royalty Actions popover, and use the Find box with criteria to generate a Found Set of records you want to process		# close the Bulk Royalty Actions popover, and use the Find box with criteria to generate a Found Set of records you want to process
	# close the Bulk Royalty Actions popover, Tag the records, and show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records).		# close the Bulk Royalty Actions popover, Tag the records, and show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records).

	== Bulk Processes ==		== Bulk Processes ==
			The processes are typically run in order. However, you can choose to perform the actions on a subset of records and then move on to another set and start again from the beginning of the process, handy if you are working with a large volume of statements and/or working as a team where different users handle different sets of records.

	=== 1. Flag Eligible for Payout ===		=== 1. Flag Eligible for Payout ===

← Older revision		Revision as of 14:53, 4 October 2026
Line 2:		Line 2:
	Once all your data is in PubGizmo, you can run royalties. "Run" is a multi-step process.		Once all your data is in PubGizmo, you can run royalties. "Run" is a multi-step process.

	# Ensure all editions are added to Title records.		# Ensure all editions are added to Title records – remember to add any that may have been released since your last period, and ensure that list prices are correctly set.
	# Ensure all contracts are configured.		# Ensure all contracts are configured and accurate.
	# Complete importing and entering all sales records for the royalty period.		# Complete importing and entering all sales records for the royalty period.
	# Ensure all relevant contracts are flagged ~~active~~.		# Ensure all relevant contracts are flagged to Calc Royalty.
	# Flag which statements to pay out; any not paid out will have their amounts carried forward.		# Flag which statements to pay out; any not paid out will have their amounts carried forward.
	# Compose (or edit) your stock messages, one for contract holders, and one for literary agents.		# Compose (or edit) your stock messages, one for contract holders, and one for literary agents.
Line 11:		Line 11:
	# Generate email messages with the statement attached.		# Generate email messages with the statement attached.
	# Personalize those messages as you like, and send them.		# Personalize those messages as you like, and send them.
	# Generate payment records, to lock-in the amounts for the next period.		# Generate payment records to lock-in the amounts for the next period.
	# ~~Generate~~ a spreadsheet that summarizes your royalties.		# Optionally generate a spreadsheet that summarizes your royalties.

			== Ensure Titles, Editions, and Contracts are Current and Accurate ==
			Titles published since your last royalty run will need to be added, and changes to editions and/or contracts for previous titles need to be applied.

	== Complete Input of Sales Data ==		== Complete Input of Sales Data ==

← Older revision		Revision as of 14:02, 4 October 2026
Line 12:		Line 12:
	# Generate a spreadsheet that summarizes your royalties.		# Generate a spreadsheet that summarizes your royalties.

	~~== Step-by-step ==~~		== Complete Input of Sales Data ==
	=== Complete Input of Sales Data ===
	Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import.		Ensure all sales during the royalty period have been input. This means [[Importing Sales Data\|importing all your sales sheets]], as well as inputting manually sales not covered by import.

	'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since strictly PubGizmo filters the date range for the selected period to isolate sales for that period.		'''Important:''' Any sheets with sales during a royalty period imported after that royalty run is complete will ''never be counted'', even in the next period, since strictly PubGizmo filters the date range for the selected period to isolate sales for that period.

	=== Ensure Correct Active Contract/Statements are Flagged to Calculate ===		== Ensure Correct Active Contract/Statements are Flagged to Calculate ==
	PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for this period (see below), the the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:		PubGizmo allows you flag active contracts, to determine if they get computed and included in your royalty run, by checking the '''Calc Royalty''' checkbox. Unlike flagging statements to pay out for this period (see below), the the status of the '''Calc Royalty''' flag persists through all royalty runs, i.e., contracts remain active or dormant/dead until you change them. You can set this flag in any of three locations:

Line 27:		Line 26:
	'''Hint:''' you can get a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.		'''Hint:''' you can get a list of '''Calc Royalty''' statements by their compute flag by entering either "calc" or "nocalc" in the search box below the Royalties button on the Home screen, or at the top of the Royalties window.

	=== Flag Royalties to Pay This Period ===		== Flag Royalties to Pay This Period ==
	For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values, if any, carried over until the next period.		For each royalty period, you can determine which statements will be paid out and which will carry forward their values (if any) to the next royalty period, where they will be added (or subtracted) from those statements. Unlike the Calc Royalty checkboxes, which persist until you change them, the statements you will actually pay varies each period. By default, when you start a new period, none of the statements are flagged to payout. You decide which ones get paid, and which ones will have their values, if any, carried over until the next period.

	==== Flag Manually ====		=== Flag Manually ===
	[[File:PayOutCheckbox.png\|thumb\|Without ~~the~~ Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' ~~with this statement~~.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.		[[File:PayOutCheckbox.png\|thumb\|Without Pay Out flagged, $137.34 will carry over to the next period; check the box to '''Pay Out 2023''' during the 2023 period.]]You can flag records manually by clicking the checkbox on the statement record itself, or in list view.

	'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.		'''Hint:''' in Royalty list view, you can see the Statement Amount for all listed records by clicking the header. That will toggle display of the amounts. This setting is off by default, because it requires PubGizmo to compute royalties for every statement in the list, which can be slow. Click the header again to turn off this display.

	==== Flag Automatically ====		=== Flag Automatically ===
	If you have many statements to pay, it's easiest to flag the majority using of them using the bulk Flag Eligible for Payout function, outlined below.		If you have many statements to pay, it's easiest to flag the majority using of them using the bulk Flag Eligible for Payout function, outlined below.

	=== Apply Global Settings ===		== Apply Global Settings ==
	Before running royalties, ensure you set up a couple of things in Admin (only users with Admin access can perform these actions).		Before running royalties, ensure you set up a couple of things in Admin (only users with Admin access can perform these actions).

	=== Set your Payout Threshold ===		=== Set your Payout Threshold ===
	You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you hold payments until next period of the contractee is owed less than $25.		You may not want to cut cheques or send payments for contractees owed less than a specific amount. For example, you can hold payments until next period of the contractee is owed less than $25.

			You can find the field to change this value in Admin > second tab > Minimum Royalty Payment. If you set this value for $0 and use the bulk process outlined below, all statements will be set to payout.

	=== Compose or Edit Stock Messages ===		=== Compose or Edit Stock Messages ===
	For bulk-sending royalty statements, PubGizmo offers two stock messages:		For bulk-sending royalty statements, PubGizmo offers two stock messages:

	# contractee (author, etc.),		# contractee (author, translator, editor, etc.).
	# literary agent of record for the contract, if relevant.		# literary agent of record for the contract, if relevant.

Line 64:		Line 65:
	* author/contractee has multiple active contracts		* author/contractee has multiple active contracts
	* literary agent is agent-of-record on multiple active contracts		* literary agent is agent-of-record on multiple active contracts

			== Bulk Royalty Actions ==
			While you can configure and send individual statements, PubGizmo's superpower is handling royalty functions in bulk – processes that might've taken days are weeks can be completed in minutes.

	=== The Bulk Royalty Actions Popover ===		=== The Bulk Royalty Actions Popover ===
	~~The functions to complete royalties~~ are executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.		These actions are accessed and executed in a popover accessed using the royalties (crown) button available in the List View of the Royalties module.
	[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]~~These actions~~ are performed only on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the top-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.		[[File:Screenshot 2026-10-01 at 16.31.08.png\|none\|thumb\|631x631px]]Actions are performed only on the Found Set (the records currently showing in the list) and then only on those records in the Found Set with '''Calc Royalty''' checked. Statistics at the top-right of the popover describe the composition of your total and current Found Set of records, and how many will be processed with the buttons.

	You have four ways to configure a Found Set to run the royalty buttons against:		You have four ways to configure a Found Set to run the royalty buttons against:
Line 76:		Line 80:
	# close the Bulk Royalty Actions popover, and Tag the records you want, then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)		# close the Bulk Royalty Actions popover, and Tag the records you want, then show only the tagged records you want to process (see [[Tags & Snapshots]] on how to Tag and show only tagged records)

	*		== Bulk Processes ==

	== ~~The Process~~ ==

	=== 1. Flag Eligible for Payout ===		=== 1. Flag Eligible for Payout ===