% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/settlement.R
\name{aemo_settlement}
\alias{aemo_settlement}
\title{Settlement cash-flow and residue tables}
\source{
AEMO NEMweb MMSDM archive, SETCFM /
SETFCASREGIONRECOVERY / SETRESIDUECONTRACTPAYMENT.
AEMO Copyright Permissions Notice.
}
\usage{
aemo_settlement(table = c("cashflow", "fcas_recovery", "residues"), start, end)
}
\arguments{
\item{table}{One of \code{"cashflow"}, \code{"fcas_recovery"}, or
\code{"residues"}.}

\item{start, end}{Window (inclusive) applied to
\code{SETTLEMENTDATE} / \code{PAYMENTDATE}.}
}
\value{
An \code{aemo_tbl} with the raw MMSDM columns for the
requested table.
}
\description{
Returns settlement reconciliation tables from MMSDM. Three
views are exposed, corresponding to the three tables gentailer
hedging workflows most commonly need:
}
\details{
\itemize{
\item \code{"cashflow"} (default): \code{SETCFM} (NEMDE-derived energy
settlement amounts per participant per trading interval).
\item \code{"fcas_recovery"}: \code{SETFCASREGIONRECOVERY} (the recovery
allocation of FCAS costs to customer load per region per
trading interval).
\item \code{"residues"}: \code{SETRESIDUECONTRACTPAYMENT} (settlement
residue auction (SRA) contract payments against
interconnector settlement residues).
}

\strong{Access.} These tables are in the MMSDM monthly archive
(not the NEMweb Current retention). Expect two-month latency
between trading date and availability.
}
\examples{
\donttest{
op <- options(aemo.cache_dir = tempdir())
try({
  s <- aemo_settlement(table = "cashflow",
                        start = "2024-06-01",
                        end   = "2024-06-02")
  head(s)
})
options(op)
}
}
\seealso{
\code{\link[=aemo_mlf]{aemo_mlf()}} for the transmission loss factors that
scale settlement amounts; \code{\link[=aemo_interconnector]{aemo_interconnector()}} for the
flow side of the residue calculation.

Other reference: 
\code{\link{aemo_dlf}()},
\code{\link{aemo_interconnectors}()},
\code{\link{aemo_mlf}()},
\code{\link{aemo_participants}()},
\code{\link{aemo_price_caps}()},
\code{\link{aemo_regions}()},
\code{\link{aemo_snapshot}()},
\code{\link{aemo_units}()}
}
\concept{reference}
