Skip to content

Commit a89bc0d

Browse files
committed
chore: update compliance docs
1 parent b39292f commit a89bc0d

6 files changed

Lines changed: 34 additions & 2 deletions

docs/compliance/automated_process_compliance_handlers.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ This `can_handle()` function will return true if the ComplianceObligation's invo
4646
This `handle()` function does the following:
4747

4848
1. Check if the ComplianceObligation's invoice has FAA interest owing
49+
4950
- if it does, it sets the ComplianceReportVersion's status to `Obligation Met, Interest Not Paid`
5051
- otherwise, it sets the status to `Obligation Met`
5152

5253
2. Determines whether the ComplianceObligation should be charged GGEAPAR Interest (Was the obligation the result of a supplementary report submitted beyond the compliance deadline)
54+
5355
- if it does, it will call the PenaltyCalculationService with the appropriate parameters to create a GGEAPAR Interest penalty & invoice in eLicensing
5456

5557
3. Determines whether the ComplianceObligation should be charged an Automatic Overdue Penalty (Original obligation paid past the deadline, or supplementary obligation paid after custom due date)
@@ -64,3 +66,13 @@ This `can_handle()` function will return true if the ComplianceObligation's invo
6466
#### What does it do
6567

6668
This `handle()` function will flip the status of the ComplianceReportVersion from `Obligation Met, Interest Not Paid` to `Obligation Met`.
69+
70+
![4 AM Compliance Cycle](./images/bciers-compliance-cycle.png)
71+
72+
#### Image Generation details
73+
74+
- **Tool:** ChatGPT (OpenAI), including AI image generation
75+
- **Input:** Technical information contained in this document
76+
77+
> [!NOTE]
78+
> AI-generated diagrams are for explanatory purposes only. If a diagram conflicts with the application code, technical documentation, or applicable regulations, those sources take precedence.
1.79 MB
Loading
1.89 MB
Loading
1.74 MB
Loading

docs/compliance/penalties.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ This document describes penalties as defined in the [Greenhouse Gas Emission Adm
55
## Accruing vs Existing
66

77
Penalties begin _ACCRUING_ as soon as an obligation owes a balance beyond the due date.
8-
However, a penalty data object in the BCIERS system and a related invoice in eLicensing will not be created until the obligation triggering the penalty has been paid in full (elicensinginvoice.fee_amount_balance == $0.00).
9-
As far as BCIERS is concerned, A penalty does not _EXIST_ while it is _ACCRUING_. It only becomes data in the system and has an invoice once the triggering obligation is paid in full.
8+
However, a penalty data object in the BCIERS system and a related invoice in eLicensing will not be created until the obligation triggering the penalty has been paid in full (elicensinginvoice.fee*amount_balance == $0.00).
9+
As far as BCIERS is concerned, A penalty does not \_EXIST* while it is _ACCRUING_. It only becomes data in the system and has an invoice once the triggering obligation is paid in full.
1010

1111
## Types of Penalties
1212

@@ -101,3 +101,13 @@ The penalty will be calculated with a base of:
101101
$800,000.00 from Dec 1 - Dec 20
102102
$300,000.00 from Dec 21 - Jan 25
103103
```
104+
105+
![Understanding Compliance Penalties](./images/bciers-penalties-overview.png)
106+
107+
#### Image Generation details
108+
109+
- **Tool:** ChatGPT (OpenAI), including AI image generation
110+
- **Input:** Technical information contained in this document
111+
112+
> [!NOTE]
113+
> AI-generated diagrams are for explanatory purposes only. If a diagram conflicts with the application code, technical documentation, or applicable regulations, those sources take precedence.

docs/compliance/supplementary_report_handlers.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,13 @@ This `can_handle()` function will return true if the credited_emission values an
190190
#### What does it do
191191

192192
This `handle()` function will create a compliance report version with the No Obligation or Earned Credits status. No related obligation or earned credit record will be created in this case.
193+
194+
![Supplementary Report Engine](./images/bciers-supplementary-report-engine.png)
195+
196+
#### Image Generation details
197+
198+
- **Tool:** ChatGPT (OpenAI), including AI image generation
199+
- **Input:** Technical information contained in this document
200+
201+
> [!NOTE]
202+
> AI-generated diagrams are for explanatory purposes only. If a diagram conflicts with the application code, technical documentation, or applicable regulations, those sources take precedence.

0 commit comments

Comments
 (0)