orchardcore-receipts

CrestApps Orchard Core Receipts

Receipts turns purchase data a module already holds into a branded, printable document. It stores nothing: the consumer's ledger stays the source of truth and the receipt is built on demand. Transactions (payment receipts and invoices), Orders (invoices and packing slips) and Point of Sale use it.

Related skills: orchardcore-transactions (printable invoices and receipts, the Send Payment Receipts feature and R-/INV- numbering), orchardcore-orders, orchardcore-commerce (store setup step that fills the store details).

Feature

Feature ID	Name	Category
CrestApps.OrchardCore.Receipts	Receipts	Commerce

ReceiptsConstants.Feature.Area; settings group receipts (ReceiptsConstants.SettingsGroupId). Subscriptions depends on it. Install CrestApps.OrchardCore.Receipts in the web project; a module that only builds receipts references CrestApps.OrchardCore.Receipts.Abstractions (no commerce dependencies).

{
  "steps": [
    {
      "name": "Feature",
      "enable": [ "CrestApps.OrchardCore.Receipts" ],
      "disable": []
    }
  ]
}

Layers

• CrestApps.OrchardCore.Receipts.Abstractions: IReceiptService, IReceiptHtmlRenderer (namespace CrestApps.OrchardCore.Receipts) and ReceiptRequest, ReceiptDocument, ReceiptLineItem, ReceiptTaxLine, ReceiptStatus (namespace CrestApps.OrchardCore.Receipts.Models).
• CrestApps.OrchardCore.Receipts.Core: DefaultReceiptService, ReceiptSettings, ReceiptsPermissions.
• CrestApps.OrchardCore.Receipts: settings driver, admin menu, permission provider, DefaultReceiptHtmlRenderer, and Views/ReceiptDocument.cshtml.

Building a receipt

using CrestApps.OrchardCore.Receipts;
using CrestApps.OrchardCore.Receipts.Models;
using Microsoft.AspNetCore.Mvc;

namespace Contoso.Registrations.Controllers;

public sealed class RegistrationReceiptController : Controller
{
    private readonly IReceiptService _receiptService;

    public RegistrationReceiptController(IReceiptService receiptService)
    {
        _receiptService = receiptService;
    }

    [HttpGet("registrations/{id}/receipt")]
    public async Task<IActionResult> Receipt(string id)
    {
        // Load your own record and check its owner first.
        var document = await _receiptService.BuildAsync(new ReceiptRequest
        {
            BilledToName = "Ada Lovelace",
            BilledToEmail = "[email protected]",
            Reference = "REG-1024",
            SourceLabel = "Registration",
            IssuedAt = DateTime.Today,
            Currency = "USD",
            LineItems =
            [
                new ReceiptLineItem { Description = "Season fee", Quantity = 1, UnitAmount = 100m, Amount = 100m },
            ],
            TaxLines =
            [
                new ReceiptTaxLine { Description = "HST", Amount = 13m },
            ],
            TaxAmount = 13m,
            Total = 113m,
            Status = ReceiptStatus.Paid,
            IsTest = false,
        });

        return View(document);
    }
}