What it is
This report seeks to provide a comprehensive look at multiple aspects of credits in one place. You choose a time period to report on, and it will tell you:
- What credits were created
- What credit redemptions occurred
- What refunds of credit redemptions occurred (these refunds go back into the member's balance)
- What credit expirations occurred
- At the current point in time, what credits are still active (this does not refer to the selected time period)
In November of 2021, a new system was introduced into Harvie: the member balance. Credits from that point on were logged in the member balance system instead of the prior "legacy" way. For pretty much all purposes, this is just a piece of trivia, but the difference between the two systems is made visible in the type ("legacy_credit" or "balance_credit") column to help with any potential debugging of the report.
Parameters
Start Date: Selects the starting date for the date range in which to look for credit events
End Date: Selects the ending date for the date range in which to look for credit events
Output
The output will be an Excel .xlsx file with multiple sheets. Each sheet and its columns will be outlined below:
Credits Created
- credit_id - the unique id of the credit created
- type - "legacy_credit" or "balance_credit", see note above
- user_id - the unique id of the user to which the credit belongs
- email - the email of the user
- first_name - the first name of the user
- last_name - the last name of the user
- amount - the amount of the credit at creation. Some or all of it may have been used, see amount_remaining to see how much is left. Also the credit might have expired, see is_expired
- created_at - when the credit was created, in your farm's timezone
- created_at_utc - when the credit was created, in the UTC timezone
- reason - category of the reason for the credit's creation
- reason_details - details of the reason for the credit's creation. This field is not intended to be private, and it is possible that a member may view it. Contrast with internal_note
- internal_note - an internal note for your farm about the credit's creation. This field is intended to be private and not seen by the member
- creator - the name and email of the account which created the credit
- is_expired - True or False, whether the credit has passed its expiration date, if it has one
- expires_at - the expiration date of the credit, if it has one
- amount_remaining - the amount of the credit that has not yet been used
Credit Redemptions
- redemption_id - the unique id of the credit redemption
- source_credit_id - the unique id of the original credit from which the redemption was drawn
- source_credit_reason - category of the reason for the original credit's creation
- source_credit_creator - the name and email of the account which created the original credit
- source_credit_type - "legacy_credit" or "balance_credit", see note above
- user_id - the unique id of the user to which the credit belongs
- email - the email of the user
- first_name - the first name of the user
- last_name - the last name of the user
- amount - the amount of the credit redemption
- redeemed_at - when the redemption happened, in your farm's timezone
- redeemed_at_utc - when the redemption happened, in the UTC timezone
Credit Redemption Refunds
- refund_id - the unique id of the credit redemption refund
- redemption_id - the unique id of the credit redemption which was refunded
- source_credit_id - the unique id of the original credit from which the redemption was drawn
- source_credit_reason - category of the reason for the original credit's creation
- source_credit_creator - the name and email of the account which created the original credit
- source_credit_type - "legacy_credit" or "balance_credit", see note above
- user_id - the unique id of the user to which the credit belongs
- email - the email of the user
- first_name - the first name of the user
- last_name - the last name of the user
- amount - the amount of the credit redemption being refunded
- refunded_at - when the redemption happened, in your farm's timezone
- refunded_at_utc - when the redemption happened, in the UTC timezone
Credit Expirations
- source_credit_id - the unique id of the original credit which has expired
- source_credit_reason - category of the reason for the original credit's creation
- source_credit_creator - the name and email of the account which created the original credit
- source_credit_type - "legacy_credit" or "balance_credit", see note above
- user_id - the unique id of the user to which the credit belongs
- email - the email of the user
- first_name - the first name of the user
- last_name - the last name of the user
- amount - the amount of the credit which has expired
- expired_at - when the redemption happened, in your farm's timezone
- expired_at_utc - when the redemption happened, in the UTC timezone
Extant Credits
- credit_id - the unique id of the credit
- type - "legacy_credit" or "balance_credit", see note above
- user_id - the unique id of the user to which the credit belongs
- email - the email of the user
- first_name - the first name of the user
- last_name - the last name of the user
- amount - the amount of the credit at creation. Some or all of it may have been used, see amount_remaining to see how much is left. Also the credit might have expired, see is_expired
- created_at - when the credit was created, in your farm's timezone
- created_at_utc - when the credit was created, in the UTC timezone
- reason - category of the reason for the credit's creation
- reason_details - details of the reason for the credit's creation. This field is not intended to be private, and it is possible that a member may view it. Contrast with internal_note
- internal_note - an internal note for your farm about the credit's creation. This field is intended to be private and not seen by the member
- creator - the name and email of the account which created the credit
- is_expired - True or False, whether the credit has passed its expiration date, if it has one
- expires_at - the expiration date of the credit, if it has one
- amount_remaining - the amount of the credit that has not yet been used
Summary Statistics
This sheet provides the details of your report parameters, and also some summary info for the other sheets.
- Farm - This is the name of your farm
- Start Date - This is the starting date of the date range you selected for the report
- End Date - This is the ending date of the date range you selected for the report
- Total Credit Created - This is the Sum of amount for each credit in Credits Created
- Total Credit Redeemed - This is the Sum of amount for all redemptions in Credit Redemptions
- Total Credit Redemption Refunded - This is the Sum of amount for all redemption refunds in Credit Redemption Refunds
- Total Credit Expired - This is the Sum of amount for all expirations in Credit Expirations
- Total Credit Change - This is the formula: = Total Credit Created + Total Credit Redemption Refunded - Total Credit Redeemed - Total Credit Expired. This should reflect how much your overall extant credit value changed over the date range
- Total Credit Extant - This is the Sum of amount_remaining for each extant credit in Extant Credits. This shows (at the time of the report being run) how much credit is currently active for your farm.
Interpretation
There are many different questions which this report can help to answer. For example:
- "Were there a lot of issues in the packing this past week, leading to missing items that were compensated by credits?"
- "How much credit was awarded this month for Refer-A-Friend?"
- "How much credit was redeemed this month, and from what reason categories?"
- "What was the overall change in credit balances for my members over the last month?"
- "What credits are still active, and when are they set to expire?"