Skip to content

5092 Add visual learning aids to documentation - Compliance - #5093

Merged
shon-button merged 1 commit into
developfrom
docs-compliance-penalty-infographic
Aug 19, 2026
Merged

5092 Add visual learning aids to documentation - Compliance#5093
shon-button merged 1 commit into
developfrom
docs-compliance-penalty-infographic

Conversation

@shon-button

@shon-button shon-button commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Ticket: 5092

🚀 Impact

  • Adds infographics to compliance docs

🔬 Local Testing:

Use Open Preview on files:

  • docs/compliance/automated_process_compliance_handlers.md
  • docs/compliance/penalties.md
  • docs/compliance/supplementary_report_handlers.md
    Expected Results
  • Infographic displays and correctly details the related documentation
  • Infographic includes AI generation details

@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch 2 times, most recently from a0d3e2f to c27b875 Compare August 14, 2026 17:04
@shon-button shon-button changed the title 5092 Add visual learning aids to documentation 5092 Add visual learning aids to documentation - Compliance Aug 14, 2026
@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch from c27b875 to 6f05126 Compare August 14, 2026 17:07
@fviduya

fviduya commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

This is amazing, @shon-button! A few things I noticed:

  1. The scheduled compliance sync is scheduled at 2AM as denoted in tasks.py file instead of 4AM
  2. To clarify, if user submits report after the compliance deadline:
  • If non-supplementary > Automatic Overdue Penalty only regardless if paid before or after the invoice due date
  • Else > GGEAPAR Interest calculated from compliance_deadline + 1 day until the obligation is paid. Automatic Overdue Penalty comes in if obligation is paid after the invoice_due_date.
  1. Not covered in these (not sure if needed) is the back-dating logic for when user submits a supplementary report that decreases the outstanding balance > penalty calculation will use the adjusted amount from the start (fee_date) instead of the base amount being reduced on the day the supplementary report was submitted.

@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch 6 times, most recently from 6147da5 to f76071c Compare August 14, 2026 18:09
@shon-button

Copy link
Copy Markdown
Contributor Author

This is amazing, @shon-button! A few things I noticed:

  1. The scheduled compliance sync is scheduled at 2AM as denoted in tasks.py file instead of 4AM
  2. To clarify, if user submits report after the compliance deadline:
  • If non-supplementary > Automatic Overdue Penalty only regardless if paid before or after the invoice due date
  • Else > GGEAPAR Interest calculated from compliance_deadline + 1 day until the obligation is paid. Automatic Overdue Penalty comes in if obligation is paid after the invoice_due_date.
  1. Not covered in these (not sure if needed) is the back-dating logic for when user submits a supplementary report that decreases the outstanding balance > penalty calculation will use the adjusted amount from the start (fee_date) instead of the base amount being reduced on the day the supplementary report was submitted.

@fviduya

Thanks very much for reviewing the images, your knowledgeable insights are very appreciated!

I have updated images:

  • docs/compliance/images/bciers-compliance-cycle.png
  • docs/compliance/images/bciers-penalties-overview.png

@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch from f76071c to 1b57db5 Compare August 14, 2026 18:22
@fviduya

fviduya commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Thanks for the updates, @shon-button! Looks good! I couldn't see the other images you had earlier, there was one that illustrates the calculation of penalty when partial payments are made which I think would also be helpful. Not sure if that image also illustrated the part about how penalties were determined if it's not a special case (such as user submitted the report before the compliance deadline). Suggesting to still add those if possible, but overall it all looks clear on my end 🤩

@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch 2 times, most recently from 3336d36 to a89bc0d Compare August 18, 2026 12:52
@shon-button

shon-button commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the updates, @shon-button! Looks good! I couldn't see the other images you had earlier, there was one that illustrates the calculation of penalty when partial payments are made which I think would also be helpful. Not sure if that image also illustrated the part about how penalties were determined if it's not a special case (such as user submitted the report before the compliance deadline). Suggesting to still add those if possible, but overall it all looks clear on my end 🤩

Thank-you very, very much @fviduya

Reverted to initial penalty infographic including:

  • standard case for reports submitted on or before the compliance deadline: Automatic Overdue begins the day after the compliance deadline if an outstanding balance remains.
  • late-report scenarios, distinguishing non-supplementary from supplementary reports.
  • partial payment example
  • supplementary balance-decrease back-dating, showing that the adjusted amount applies from the fee_date.

@fviduya fviduya left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥇

@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch from a89bc0d to 86fee90 Compare August 19, 2026 17:19
@shon-button
shon-button force-pushed the docs-compliance-penalty-infographic branch from 86fee90 to 161538c Compare August 19, 2026 19:12
@shon-button
shon-button merged commit 98edfd7 into develop Aug 19, 2026
39 of 40 checks passed
@shon-button
shon-button deleted the docs-compliance-penalty-infographic branch August 19, 2026 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants