> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bango.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Entitlement reports

> Understand the entitlement reports Bango provides for reconciliation and data analysis.

# Entitlement reports

Bango provides entitlement reports to support reconciliation, operational review, and data analysis.

These reports help you understand entitlement status, status movement, entitlement update events, and entitlement totals grouped by product and status.

<CardGroup cols={2}>
  <Card title="Active report" icon="circle-check" href="/active-change-event-reports">
    Lists entitlements that were `ACTIVE` at the end of the reporting period.
  </Card>

  <Card title="Status change report" icon="arrows-rotate" href="/active-change-event-reports">
    Lists entitlements that changed status during the reporting period. The status shown is the entitlement status at the end of the period.
  </Card>

  <Card title="Entitlement update event report" icon="calendar-lines-pen" href="/active-change-event-reports">
    Lists entitlements updated during the reporting period, including status changes and other changes such as `productKey` updates.
  </Card>

  <Card title="Summary report" icon="chart-simple" href="/summary-report-format">
    Groups entitlements by `productKey` and status, including total counts and movement into each status during the reporting period.
  </Card>
</CardGroup>

<Note>
  An entitlement can appear more than once in the entitlement update event report if it was updated multiple times during the reporting period.
</Note>

## Report frequency

Entitlement reports can be generated on one or more of the following schedules:

| Frequency | Description |
| - | - |
| Daily | One report per day |
| Weekly | One report per weekly reporting period |
| Monthly | One report per monthly reporting period |

Your preferred reporting frequency is configured during onboarding or support setup.

## Delivery location

Reports are published to a dedicated Amazon S3 bucket.

Bango Support provides the S3 URL and credentials required to access the bucket.

Reports are split by route and organised by partner and frequency:

```text theme={null}
s3://{s3-bucket}/EntitlementReports/{partner}/{frequency}
```

| Path variable | Description |
| - | - |
| `{s3-bucket}` | Your dedicated report bucket |
| `{partner}` | The partner folder for the route |
| `{frequency}` | The configured report frequency: `daily`, `weekly`, or `monthly` |

## File naming convention

Entitlement reports use the following file naming convention:

```text theme={null}
{report-type}_V1_{frequency}_{date}.csv
```

| Segment | Description |
| - | - |
| `{report-type}` | The report type code |
| `V1` | Report format version |
| `{frequency}` | Report frequency code |
| `{date}` | Reporting period date |

## Report type codes

| Code | Report |
| - | - |
| `AR` | Active report |
| `CR` | Status change report |
| `ER` | Entitlement update event report |
| `SR` | Summary report |

## Frequency codes

| Code | Frequency |
| - | - |
| `D` | Daily |
| `W` | Weekly |
| `M` | Monthly |

## File name examples

| File name | Description |
| - | - |
| `AR_V1_M_202401.csv` | Monthly active report for January 2024 |
| `CR_V1_W_20240617.csv` | Weekly status change report for the week commencing 17 June 2024 |
| `ER_V1_D_20240528.csv` | Daily entitlement update event report for 28 May 2024 |
| `SR_V1_M_202412.csv` | Monthly summary report for December 2024 |

## Related formats

<CardGroup cols={2}>
  <Card title="Active, change & event report format" icon="table" href="/active-change-event-reports">
    Column format used by the active, status change, and entitlement update event reports.
  </Card>

  <Card title="Summary report format" icon="table-list" href="/summary-report-format">
    Column format used by the summary report.
  </Card>
</CardGroup>