Project234.Reporting.Contracts
1.1.0
dotnet add package Project234.Reporting.Contracts --version 1.1.0
NuGet\Install-Package Project234.Reporting.Contracts -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Project234.Reporting.Contracts" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Project234.Reporting.Contracts" Version="1.1.0" />
<PackageReference Include="Project234.Reporting.Contracts" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Project234.Reporting.Contracts --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Project234.Reporting.Contracts, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Project234.Reporting.Contracts@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Project234.Reporting.Contracts&version=1.1.0
#tool nuget:?package=Project234.Reporting.Contracts&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Project234.Reporting.Contracts
Shared cloud-event document contract used to transport reports from the LMS to the generic reporting translator (AML).
Getting started
Install the package:
dotnet add package Project234.Reporting.Contracts
Overview
This package provides the ReportDocument cloud-event contract and typed report payloads used across the reporting pipeline. It is transport-agnostic (SQS-ready) and does not depend on a specific runtime.
ReportDocument— the envelope carrying a report eventReportTypes— report type identifiersReports/*— typed payloads for each report type (e.g.AgentProfitPayload,CoopChargesPayload,DashboardSnapshotPayload)Reports/Acct/*— accounting figures published by the Account system (AcctPeriodSummaryPayloadfor theAcct.DailySummaryandAcct.MonthlySummaryreport types,AcctCaseSummaryPayloadforAcct.CaseSummary)Financial/FinancialAggregationPayload— financial aggregation payloadSerialization/ReportDocumentSerializer— serialization helpers forReportDocument
Example
using System.Text.Json;
using Project234.Reporting.Contracts;
using Project234.Reporting.Contracts.Reports;
var document = new ReportDocument
{
ReportType = ReportTypes.AgentProfit,
TenantId = "dev",
SourceSystem = "LMS",
IdempotencyKey = Guid.NewGuid().ToString("N"),
Payload = JsonSerializer.SerializeToElement(new AgentProfitPayload { /* ... */ })
};
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.