Page History

...

The result is mapped into the Bright-facing BrightInvoice model.

SonWin is a BALANCE-FORWARD ledger: payments are not matched per-invoice.
The "remaining amount" and the payment status are both derived from the running account balance (løbende saldo) as of each invoice line, computed in SQL.

DEV info

When running on local machine bypassing the Swagger UI:

Visibility/filtering is configuration-driven. Each filter toggle is resolved as "local appsettings config wins, otherwise defer to the company's BCHEC flag" (Sonlinc.BCHED, cached in memory).

The SQL is assembled from pure-SQL fragments so only the active clauses appear in the executed statement.

...

Body: none (GET)

Returns:

200 OK OK -> IEnumerable<BrightInvoice>
400 BadRequest -> DECLARED, never produced (catch commented out)
401 Unauthorized -> produced by [Authorize] framework, not by code
404 NotFound -> DECLARED, never produced (catch commented out)
500 500 -> any thrown exception (validation, SQL, mapping)

...

Validation that affects the result (all failures THROW -> surface as HTTP 500):

commonValidator.ValidateCustomer (via AccountValidator.ValidateAccountGetOutput,

invoked as "BrightInvoiceService.GetByCustomerAsync"):

...

Validation that affects the result (all surface as HTTP 500 with a message):

0 customer rows -> "No customer found with Id '{id}'."

...

1 customer rows -> "Unique active customer could not be identified. Id: '{id}'."

...

row has blank CustomerId -> "The customer returned did not have any CustomerId."

...

returned id != requested -> "Returned customer '{row}' does not match requested '{id}'."

...

MitId deactivated -> "The customer with Id '{id}' does not have an active MitId

...

registration." (skipped if Settings.IgnoreMitIdStatus)

InvoicesValidator.ValidateGetInvoicesInput (invoked as "GetInvoices"): -

blank customerId -> "Missing parameter 'AccountId'."

...

dateFrom out of SQL range -> "Missing or invalid parameter 'DateFrom'.

...

Provide a

...

date between 1753-01-01 and 9999-12-31 (e.g. 2000-01-01)."

...

dateTo out of SQL range -> "Missing or invalid parameter 'DateTo'.

...

Provide a date between 1753-01-01 and 9999-12-31 (e.g. 2030-12-31)."

...

dateFrom > dateTo -> "Parameter outside of allowed range:

...

'DateFrom' must

...

be earlier than or equal to 'DateTo'."

...

limit < 1 -> "Parameter outside of allowed range:

...

'Limit' must be 1 or greater."

(A missing/unparseable date query param binds to DateTime.MinValue, which is below SQL Server's datetime min; the range check catches this up front to avoid a cryptic SQL error.)

NOTE on status codes:

The two domain catches in the controller are commented out ("we make use of the internalerror500 for all errors inside the api"),

so a bad date or an unknown customer returns 500 (not 400/404). The validation messages above are wrapped by ValidationHelper into:

--------------------------------------------------------------------------------

FILTER RESOLUTION (InvoiceListFilters) "The operation [{invokingMethodName}] could not be completed due to the following validation errors: \n <message(s)>" and that wrapped text becomes the 500 body.

--------------------------------------------------------------------------------

FILTER RESOLUTION (InvoiceListFilters)

--------------------------------------------------------------------------------

Resolved in BrightInvoiceRepository.GetByCustomerAsync as "local appsettings config (Settings.Invoices:*) ?? company BCHEC flag". The three

UDSMARK visibility variants are independent and compose. Each active flag appends its own SQL clause; inactive flags add nothing (no runtime OR-gates).

ExcludeParked = Settings.InvoiceExcludeParked ?? BCHEC VISEJPARKEREDE

-> AND (UDSMARK IS NULL OR UDSMARK <= 25) (hide UDSMARK > 25)

CheckUdsmark = Settings.InvoiceCheckUdsmark ?? BCHEC CHECKUDSMARK

-> AND (UDSMARK IS NULL OR = 0 OR BETWEEN 2 AND 25) (also drops UDSMARK = 1)

ShowOnlyDelivered = Settings.InvoiceShowOnlyDelivered ?? BCHEC VISKUNUDSKREVNE

-> UDSMARK <= 25 + SNEX/DSEND delivery check (DELIVERYSTATE IN (5,9))

ExcludeFutureDated = Settings.InvoiceExcludeFutureDated ?? BCHEC EJFREMTID

-> AND BILAGSDATO <= @Today

ExcludeAfregnTypes = Settings.InvoiceExcludeAfregnTypes (non-empty) ?? BCHEC W11_W12EJAFRTYP

-> AND AFREGNTYPE NOT IN @ExcludeAfregnTypes

OnlyRendered = !Settings.InvoiceShowAlsoInvoicesWithoutPdf (default true)

-> AND EXISTS (AKONDDOC -> BDOC, DOCTYPE=1, DATALENGTH(PAYLOAD)>0,

MIMETYPE LIKE @PdfMimeType)

Always-applied (Base query) filters, independent of the toggles above:

- FIRMANR = @CompanyId, KUNDENR = @CustomerId

- TARIFART IN ('A-TOT','A-FAK') (header rows only; S-TOT excluded)

- (SWIBASVIS IS NULL OR SWIBASVIS = 1) (exclude SWIB-internal, non-visible)

- (SAMLREGNINGNR IS NULL OR SAMLREGNINGNR <= 0) (hide bills folded into a collective invoice)

- BILAGSDATO BETWEEN @DateFrom AND @DateTo

- ORDER BY BILAGSDATO DESC, REGNINGNR DESC, SWCOUNT DESC

OFFSET 0 ROWS FETCH NEXT @Limit ROWS ONLY (@Limit = limit ?? 100)

Resolved in BrightInvoiceRepository.GetByCustomerAsync as "local appsettings config (Settings.Invoices:*) ?? company BCHEC flag".

The three UDSMARK visibility variants are independent and compose. Each active flag appends its own SQL clause; inactive flags add nothing (no runtime OR-gates).

ExcludeParked = Settings.InvoiceExcludeParked ?? BCHEC VISEJPARKEREDE -> AND (UDSMARK IS NULL OR UDSMARK <= 25) (hide UDSMARK > 25)
CheckUdsmark = Settings.InvoiceCheckUdsmark ?? BCHEC CHECKUDSMARK -> AND (UDSMARK IS NULL OR = 0 OR BETWEEN 2 AND 25) (also drops UDSMARK = 1)
ShowOnlyDelivered = Settings.InvoiceShowOnlyDelivered ?? BCHEC VISKUNUDSKREVNE -> UDSMARK <= 25 + SNEX/DSEND delivery check (DELIVERYSTATE IN (5,9))
ExcludeFutureDated = Settings.InvoiceExcludeFutureDated ?? BCHEC EJFREMTID -> AND BILAGSDATO <= @Today
ExcludeAfregnTypes = Settings.InvoiceExcludeAfregnTypes (non-empty) ?? BCHEC W11_W12EJAFRTYP -> AND AFREGNTYPE NOT IN @ExcludeAfregnTypes
OnlyRendered = !Settings.InvoiceShowAlsoInvoicesWithoutPdf (default true) -> AND EXISTS (AKONDDOC -> BDOC, DOCTYPE=1, DATALENGTH(PAYLOAD)>0, MIMETYPE LIKE @PdfMimeType) → @PdfMimeType defaults to application/pdf

Always-applied (Base query) filters, independent of the toggles above:

FIRMANR = @CompanyId, KUNDENR = @CustomerId
TARIFART IN ('A-TOT','A-FAK') (header rows only; S-TOT excluded)
(SWIBASVIS IS NULL OR SWIBASVIS = 1) (exclude SWIB-internal, non-visible)
(SAMLREGNINGNR IS NULL OR SAMLREGNINGNR <= 0) (hide bills folded into a collective invoice)
BILAGSDATO BETWEEN @DateFrom AND @DateTo
ORDER BY BILAGSDATO DESC, REGNINGNR DESC, SWCOUNT DESC
OFFSET 0 ROWS FETCH NEXT @Limit ROWS ONLY (@Limit = limit ?? 100)

--------------------------------------------------------------------------------

RESPONSE STRUCTURE (IEnumerable<BrightInvoice>)

---------------

RESPONSE STRUCTURE (IEnumerable<BrightInvoice>)

--------------------------------------------------------------------------------

The endpoint returns a JSON array of invoice objects (no wrapper). Each object contains a nested `Info` array of supplementary key/value (or title/value) entries.

----------------

The endpoint returns a JSON array of invoice objects. Each object contains a nested `Info` array of supplementary key/value (or title/value) entries.

Code Block

[
    {
      "Id":

Code Block

[
  {
    "Id":              "<InstNr>-<ForbnNr>-<UdebNr>-<Id>",  // Data: composite of AKOND.INSTNR + FORBNR + UDEBNR + REGNINGNR (REGNINGNR cast to varchar AS Id)
    "ServiceId":       "consumption_trade",                 // Data: AUDEBFORS.FORSYNINGSART (+ AKOND.AFREGNTYPE for KØL) via ForsyningsartMapper; null for unmapped/unknown/null supply types
    "DueDate":         "2026-01-31T00:00:00+00:00",         // Data: AKOND.FORFDATO (DateTimeOffset, UTC offset 0); null if NULL
    "InvoiceDate":     "2026-01-01T00:00:00+00:00",         // Data: AKOND.BILAGSDATO (DateTimeOffset, UTC offset 0); null if NULL
    "Period":          "1month",                            // Data: derived from AKOND.DATOFRA/DATOTIL month span (1/2/3/6/12month); defaults "1month" if either date null or span unmatched
<value>,    // Composite: $"{InstNr}-{ForbnNr}-{UdebNr}-{Id}" = AKOND.INSTNR-FORBNR-UDEBNR-REGNINGNR
      "StartDateServiceId":   <value>,    "2026-01-01T00:00:00+00:00",         // Data: AKOND.DATOFRA (DateTimeOffset, UTC offset 0); null if NULL
    "EndDate":   // HARDCODED NULL. Previous: AUDEBFORS.FORSYNINGSART (+AFREGNTYPE) via ForsyningsartMapper.
  El-only join => in practice "consumption_trade" or null (a supply type, not an identifier — omitted; see limitations).
      "InvoiceDate"2026-01-31T00:00:00+00:00",     : <value>,    // Data: AKOND.DATOTILBILAGSDATO  (DateTimeOffset, UTC offset 0); | null
 if NULL
    "RemainingAmountDueDate": 0.00     <value>,    // Data: AKOND.FORFDATO    (DateTimeOffset, UTC offset 0) | null
      "Period":       <value>,    // Data: AKOND.KR (TotalAmount) - PBSI PaidAmount; null unless BOTH present
    "TotalAmount":     1953.12, Derived from StartDate/EndDate month-span: "1month"/"2month"/"3month"/"6month"/"12month"
  (defaults to "1month" when dates missing or other span)
      "StartDate":   <value>,    // Data: AKOND.DATOFRA     (DateTimeOffset, UTC offset   0) |  // Data: AKOND.KR
null
      "InvoiceStatusEndDate":     "paid"<value>,    // Data: AKOND.DATOTIL     (DateTimeOffset, UTC offset 0) | null
      "RemainingAmount": <value>,// Data: running account saldo (SUM of // Data: derived (see MapInvoiceStatus); one of unpaid/paid/partly_paid/overdue/cancelled/credited only
    "InvoiceType":AKOND.KR up to this line) - NOT a per-invoice remaining
  figure.
      "pdfTotalAmount": <value>,    // Data: AKOND.KR (decimal) | null
      "InvoiceStatus": <value>,  // Derived (see status logic below): one of cancelled / credited / paid // Data:overdue derived from HasPdf EXISTS check -> "pdf" or "missing" ("html" never produced)
    "Info": [
      { "Key": "invoiceNumber",   "Value": "<REGNINGNR>" },/ unpaid
      "InvoiceType": <value>,    // Derived: "pdf" when a rendered PDF (non-empty BDOC.PAYLOAD with matching MIMETYPE) exists,
  else "missing"

      // Flat Data: AKOND.REGNINGNR (as Id) — NOTE: raw value, NOT the composite top-level Id
      { "Key": "invoiceDate",     "Value": "<offset>" }, supplementary list; mostly DUPLICATES the structured fields above, as strings/dates.
      // Every entry carries BOTH Key AND Title (EGCommon emits null for whichever is unset).
     // Data"Info": AKOND.BILAGSDATO (DateTimeOffset) or null
[
        { "Key": "dueDateinvoiceNumber",    "Title": "Invoice number",   "Value": "<offset>"<Id> },         // Data: AKOND.FORFDATOREGNINGNR (DateTimeOffsetstring)
 or null
      { "Key": "totalAmountinvoiceDate",     "ValueTitle": "1953.12" }Invoice date",       // Data: AKOND.KR (.ToString(), so a STRING here vs decimal at top level)
"Value": <InvoiceDate> },// Data: AKOND.BILAGSDATO
  (DateTimeOffset|null)
        { "Key": "perioddueDate",          "ValueTitle": "1month" },    Due date",         "Value": <DueDate> },    // Data: sameAKOND.FORFDATO
 derivation as top-level Period
 (DateTimeOffset|null)
        { "Key": "remainingAmounttotalAmount",     "ValueTitle": "0.00" }Total amount",     "Value": <TotalAmount>    },// Data: TotalAmount - PaidAmount (AKOND.KR .ToString(); | null unless both present)

        { "Key": "period",         { "KeyTitle": "statusPeriod",           "Value": "paid"<Period> },          // Data:Derived same derivation as top-level InvoiceStatus
period string
        { "Key": "descriptionremainingAmount", "Title": "Remaining  amount", "Value": "<Tekst>"<Saldo> },      // Data: running saldo .ToString() |
   // Data: AKOND.TEKST
null
        { "TitleKey": "Tekststatus",          "ValueTitle": "<Tekst>" }        // Data: AKOND.TEKST (DUPLICATE of description; uses Title (untranslated) instead of Key)
 Status",     // "ocr"  -> Not mapped (TODO"Value": source field in SonWin not yet identified)
 <InvoiceStatus> },// Derived status string
   ]
  }
]

Field origin detail (top-level BrightInvoice):
Id <- composite "{InstNr}-{ForbnNr}-{UdebNr}-{Id}" (Id = REGNINGNR)
ServiceId <- ForsyningsartMapper.MapToBrightServiceType(ForsyningsArt, AfregnType)
DueDate <- AKOND.FORFDATO
InvoiceDate <- AKOND.BILAGSDATO
Period <- MapPeriod(DATOFRA, DATOTIL)
StartDate <- AKOND.DATOFRA
EndDate <- AKOND.DATOTIL
RemainingAmount <- AKOND.KR - PBSI PaidAmount (null unless both present)
TotalAmount <- AKOND.KR
InvoiceStatus <- MapInvoiceStatus(row).GetDisplayName()
InvoiceType <- MapInvoiceType(row) ("pdf" if HasPdf else "missing")
Info <- list assembled in the mapper (see above)

     { "Key": "description",     "Title": "Description",      "Value": <Tekst> },      // Data: AKOND.TEKST
        { "Key": "tekst",           "Title": "Tekst",            "Value": <Tekst> }       // Data: AKOND.TEKST (duplicate of
  description)
        // NOTE: "ocr" key is NOT emitted (source field not yet identified - TODO)
      ]
    }
  ]

Field origin detail (top-level BrightInvoice):

Id <- composite "{InstNr}-{ForbnNr}-{UdebNr}-{Id}" (Id = REGNINGNR)
ServiceId <- ForsyningsartMapper.MapToBrightServiceType(ForsyningsArt, AfregnType)
DueDate <- AKOND.FORFDATO
InvoiceDate <- AKOND.BILAGSDATO
Period <- MapPeriod(DATOFRA, DATOTIL)
StartDate <- AKOND.DATOFRA
EndDate <- AKOND.DATOTIL
RemainingAmount <- AKOND.KR - PBSI PaidAmount (null unless both present)
TotalAmount <- AKOND.KR
InvoiceStatus <- MapInvoiceStatus(row).GetDisplayName()
InvoiceType <- MapInvoiceType(row) ("pdf" if HasPdf else "missing")
Info <- list assembled in the mapper (see above)

INVOICE STATUS LOGIC (MapInvoiceStatus, first match wins):

1. KORTSTATUS = 99 InvoiceStatus derivation (MapInvoiceStatus), in order:
1. KORTSTATUS == 99 -> "cancelled"
2. TotalAmount (KR) < 0 -> "credited"
3. SettlementDate (UDLIGNDATO) set -> "paid" (regardless of PaidAmount)
4. PaidAmount >= TotalAmount -> "paid"
5. DueDate < today (and not fully paid)-> "overdue"
6. PaidAmount > 0 -> "partly_paid"
7. otherwise -> "unpaid"
(collection / reminder / deferred_* / investigation / paid_out are never returned — TODO.)

PaidAmount source: OUTER APPLY over Sonlinc.AKOND where TARIFART='PBSI' for the same INSTNR+FORBNR+UDEBNR+REGNINGNR+FIRMANR; SUM(KR*ANTAL)*-1

(PBSI rows are negative), ISNULL(...,0). Not exposed as its own response field — only feeds RemainingAmount and the status derivation.

cancelled" (confirmed cancelled)
2. TotalAmount (KR) < 0 -> "credited" (credit note)
3. UDLIGNDATO set OR running saldo <= 0 -> "paid" (account square through this line; balance-forward)
4. DueDate (FORFDATO) in the past -> "overdue"
5. otherwise -> "unpaid"
('partly_paid' is intentionally never produced.)

PERIOD LOGIC (MapPeriod): month span = (EndDate - StartDate) in whole months;

2→"2month"
3→"3month"
6→"6month"
12→"12month"
anything else (incl. missing dates or 1-month) -> "1month".

(PBSI rows are negative), ISNULL(...,0). Not exposed as its own response field — only feeds RemainingAmount and the status derivation.DbInvoice columns selected but NOT surfaced as their own response field:
- AfregnType (AKOND.AFREGNTYPE) used only by ServiceId (KØL -> cooling)
- KortStatus (AKOND.KORTSTATUS) used only by status (== 99 -> cancelled)
- KortType (AKOND.KORTTYPE) selected, currently unused in mapping
- SettlementDate (AKOND.UDLIGNDATO) used only by status
- CollectiveBillNr (AKOND.SAMLREGNINGNR) selected; also used as a WHERE filter
- HasPdf (EXISTS check) used only by InvoiceType
- PaidAmount (PBSI sum) used by RemainingAmount + status

Page tree

Versions Compared

Old Version 7

New Version Current

Key