# SET_IRSR_LOOP_NSP_ALLOCATION

> This report contains Inter-Regional Negative Residue Amounts to allocate to TNSPs.

## Column Schema

### INTERCONNECTORLOOPID

> The Interconnector Loop Identifier

SQL Type: `VARCHAR2(20)`
Polars Type: `str`

This column is mandatory, and a primary key.

### PARTICIPANTID

> The TNSP Participant Identifier

For more information, see the [dedicated documentation page](../../guide/querying.md#duid-genset-id-etc).

SQL Type: `VARCHAR2(20)`
Polars Type: `pl.Categorical`

This column is mandatory, and a primary key.

### PERIODID

> The Settlement Period Id(1-288)

SQL Type: `NUMBER(3,0)`
Polars Type: `pl.Int16`

This column is mandatory, and a primary key.

### REGIONID

> The Region Identifier

For more information, see the [dedicated documentation page](../../guide/querying.md#region-id).

The SQL type is `VARCHAR2(20)`.
This is actually a factor/enum, with values:

- `QLD1`

- `VIC1`

- `TAS1`

- `NSW1`

- `SA1`

- `SNOWY1`

This column is mandatory, and a primary key.

### SETTLEMENTDATE

> The Settlement Date of the Billing Week

!!! danger "Warning"
    Despite what the name suggests, this is a datetime, not a date.

SQL Type: `DATE`
Polars Type: `pl.Datetime()`

This column is mandatory, and a primary key.

Example: `2026/01/20 00:05:00`

### VERSIONNO

> The Settlement Run No

SQL Type: `NUMBER(3,0)`
Polars Type: `pl.UInt16`

This column is mandatory, and a primary key.

### ALLOCATION

> Participant Portion %(e.g. 100)

SQL Type: `NUMBER(18,8)`
Polars Type: `pl.Float64`

This column is not mandatory.

### AVGREGION_MWH

> Annual Regional Demand for the Region

SQL Type: `NUMBER(18,8)`
Polars Type: `pl.Float64`

This column is not mandatory.

### LASTCHANGED

> The last changed date time of the record.

For more information, see the [dedicated documentation page](../../guide/querying.md#deduplication).

SQL Type: `DATE`
Polars Type: `pl.Datetime()`

This column is not mandatory.

Example: `2026/01/20 00:05:00`

### NLA

> Net Loop Allocation(negative only)

SQL Type: `NUMBER(18,8)`
Polars Type: `pl.Float64`

This column is not mandatory.

### RESIDUE_AMOUNT

> Calculated Negative Residue Amount based on regional share

SQL Type: `NUMBER(18,8)`
Polars Type: `pl.Float64`

This column is not mandatory.

### TOTALREGION_MWH

> Total Annual Regional Demand for all Regions in the Loop

SQL Type: `NUMBER(18,8)`
Polars Type: `pl.Float64`

This column is not mandatory.

## New Data Timing

> Daily Billing Run & Posting a PRELIM/FINAL and REVISE Billing Run

## Code Examples

### Polars

Explicitly listing every column, casting to enums, categoricals etc is not essential, but may speed up parsing.
Swapping `int` for `pl.UInt16`, `pl.Int32` would also speed up parsing. However some of the datatypes are inferred, so they may be wrong.

This code deduplicates for you.
Deduplication is normally only required across multiple months.

This code assumes that all columns are present, which may not be true for older files.

```python
import polars as pl
import polars.selectors as cs

# e.g. "2029/03/15 00:05:00"
dt_s_fmt = "%Y/%m/%d %H:%M:%S"

csv_paths = ["SOMEFILE.CSV", "OTHERFILE.CSV"]

lf = (
    pl.concat(
        [
            pl.scan_csv(
                csv_path,  # must be unzipped beforehand
                skip_rows=1,  # skip the header
                infer_schema=False,  # much faster
            )
            .filter(cs.by_index(0) == "D")  # drop the footer
            .select(~cs.by_index(range(4)))  # drop metadata columns
            for csv_path in csv_paths
        ],
        how="diagonal_relaxed",
    )
    .with_columns(
        pl.col("SETTLEMENTDATE", "LASTCHANGED").str.strptime(pl.Datetime, dt_s_fmt),
    )
    .cast(
        {
            "INTERCONNECTORLOOPID": str,
            "PARTICIPANTID": pl.Categorical,
            "PERIODID": int,  # or pl.Int16
            "REGIONID": pl.Enum(["QLD1", "VIC1", "TAS1", "NSW1", "SA1", "SNOWY1"]),
            "VERSIONNO": int,  # or pl.UInt16
            "ALLOCATION": pl.Float64,
            "AVGREGION_MWH": pl.Float64,
            "NLA": pl.Float64,
            "RESIDUE_AMOUNT": pl.Float64,
            "TOTALREGION_MWH": pl.Float64,
        }
    )
    # Deduplicate
    # We want one row per ['INTERCONNECTORLOOPID', 'PARTICIPANTID', 'PERIODID', 'REGIONID', 'SETTLEMENTDATE', 'VERSIONNO']
    # Tie-breaker: greatest value of LASTCHANGED
    .sort(LASTCHANGED, descending=False)
    .unique(
        subset=[
            "INTERCONNECTORLOOPID",
            "PARTICIPANTID",
            "PERIODID",
            "REGIONID",
            "SETTLEMENTDATE",
            "VERSIONNO",
        ],
        keep="last",
    )
)

```

### Nemosis

This table is not yet available in [Nemosis](https://github.com/UNSW-CEEM/NEMOSIS/#static_table).

## Availability

Visibility: Private

This table is not available in the public monthly [MMSDM archive](https://www.nemweb.com.au/Data_Archive/Wholesale_Electricity/MMSDM/).
Is is only available to registered market participants over FTP inside a VPN.

## Deduplication and PDR Loader Configuration

The primary keys are:

- [`INTERCONNECTORLOOPID`](#interconnectorloopid)

- [`PARTICIPANTID`](#participantid)

- [`PERIODID`](#periodid)

- [`REGIONID`](#regionid)

- [`SETTLEMENTDATE`](#settlementdate)

- [`VERSIONNO`](#versionno)

The transaction type is ["insert"](https://di-help.docs.public.aemo.com.au/Content/pdrLoader/How_it_works.htm?TocPath=pdrLoader%7CAbout+pdrLoader%7C_____5#INSERT), which means that you will usually not see duplicate data.
If you do, you can deduplicate based on the primary keys, without sorting first.
Rows from different files with the same primary keys should have the same values.

[PDR Loader configuration](https://nemweb.com.au/Reports/Current/MMSDataModelReport/PDRCONFIG/PROD_PUBLIC_PDR_CONFIG_FULL.zip) is:

| Report Name | Report Subtype | Version |
|---------------|-------------------|-----------|
| SETTLEMENTS | IRSR_LOOP_NSP_ALLOCATION  | 1 |

This means that the CSV files start with metadata columns:

```csv
I,SETTLEMENTS,IRSR_LOOP_NSP_ALLOCATION,1,...
D,SETTLEMENTS,IRSR_LOOP_NSP_ALLOCATION,1,...
```

## Links

[This page as JSON](../json/tables/SET_IRSR_LOOP_NSP_ALLOCATION/bespoke.json) (schema documented [here](https://gitlab.com/MatthewDavis/mms-schema/-/blob/master/schema.py?ref_type=heads), but may change)

Download a [JSON Schema](../json/tables/SET_IRSR_LOOP_NSP_ALLOCATION/json-schema.json) specification for this table.

[Official AEMO schema documentation](https://nemweb.com.au/Reports/Current/MMSDataModelReport/Electricity/ElectricityDataModelReport_files/Elec57.htm#142)

## Other Information

Package: [SETTLEMENT_DATA](../packages/SETTLEMENT_DATA.md)
