Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

KsefClient

OfficeIMO.Invoicing.KSeF

Namespace
OfficeIMO.Invoicing.KSeF
Assembly
OfficeIMO.Invoicing.KSeF
Source revision
ba882f6b0d07 with working tree changes
Implements
IDisposable
Modifiers
sealed

A bounded KSeF v2 client. It does not retry mutations or follow redirects. An injected transport is a trusted boundary and must preserve these rules.

Inheritance

  • object
  • KsefClient

Constructors

public KsefClient(KsefEnvironment environment = Test, HttpMessageHandler? handler = null, TimeProvider? clock = null, TimeSpan? requestTimeout = null) #

Creates a client for an explicit official environment. The optional handler and clock support integration hosts and credential-free tests.

Parameters

environment OfficeIMO.Invoicing.KSeF.KsefEnvironment = Test optional
handler System.Net.Http.HttpMessageHandler? = null optional
clock System.TimeProvider? = null optional
requestTimeout System.TimeSpan? = null optional

Methods

public async Task<KsefAuthentication> BeginTokenAuthenticationAsync(KsefContext context, KsefSecret ksefToken, CancellationToken cancellationToken = default) #

Starts token authentication using the server challenge timestamp and active token-encryption RSA certificate. Success is asynchronous.

Parameters

context OfficeIMO.Invoicing.KSeF.KsefContext required
ksefToken OfficeIMO.Invoicing.KSeF.KsefSecret required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefAuthentication>
public async Task<string> CheckEncryptionKeyAsync(CancellationToken cancellationToken = default) #

Checks the current public encryption certificates without credentials, returning the verified active RSA SPKI selector.

Parameters

cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<string>
public async Task CloseOnlineSessionAsync(KsefCredentials credentials, KsefOnlineSession session, CancellationToken cancellationToken = default) #

Closes a session once. An ambiguous close stops further mutation; status remains readable by reference.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
session OfficeIMO.Invoicing.KSeF.KsefOnlineSession required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task
public void Dispose() #

Disposes the owned HTTP transport; caller-owned credentials and sessions must be disposed separately.

public Task<KsefStatus> GetAuthenticationStatusAsync(KsefAuthentication authentication, CancellationToken cancellationToken = default) #

Reads authentication state without redeeming tokens or replaying authentication.

Parameters

authentication OfficeIMO.Invoicing.KSeF.KsefAuthentication required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefStatus>
public async Task<KsefReceipt> GetInvoiceReceiptAsync(KsefCredentials credentials, KsefSubmission submission, CancellationToken cancellationToken = default) #

Reads UPO through the direct authenticated official route after accepted status, with separate pinned schema and exact context/session/document binding results.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
submission OfficeIMO.Invoicing.KSeF.KsefSubmission required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefReceipt>
public Task<KsefInvoiceStatus> GetInvoiceStatusAsync(KsefCredentials credentials, KsefSubmission submission, CancellationToken cancellationToken = default) #

Reads invoice status and rejects a response bound to a different reference or plaintext hash.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
submission OfficeIMO.Invoicing.KSeF.KsefSubmission required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefInvoiceStatus>
public Task<KsefInvoicePage> GetSessionInvoicesAsync(KsefCredentials credentials, string sessionReference, int pageSize = 100, string? continuationToken = null, CancellationToken cancellationToken = default) #

Lists one bounded page for explicit ambiguous-submission reconciliation. It never resends an invoice and never follows a remote download URL.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
sessionReference string required
pageSize int = 100 optional
continuationToken string? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefInvoicePage>
public Task<KsefStatus> GetSessionStatusAsync(KsefCredentials credentials, string sessionReference, CancellationToken cancellationToken = default) #

Reads a session status by reference, including after close or an ambiguous mutation.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
sessionReference string required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefStatus>
public async Task<KsefOnlineSession> OpenOnlineSessionAsync(KsefCredentials credentials, CancellationToken cancellationToken = default) #

Opens an online FA(3) session with a fresh AES-256 key/IV, wrapped using the active official RSA certificate.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefOnlineSession>
public async Task<KsefCredentials> RedeemAsync(KsefAuthentication authentication, CancellationToken cancellationToken = default) #

Redeems a successful authentication once. Lost/malformed responses leave this handle consumed because server-side redemption may already have happened.

Parameters

authentication OfficeIMO.Invoicing.KSeF.KsefAuthentication required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefCredentials>
public async Task RefreshAsync(KsefCredentials credentials, CancellationToken cancellationToken = default) #

Refreshes access credentials using the current refresh token. No automatic retry occurs.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task
public KsefSubmission ResumeSubmission(KsefCredentials credentials, string sessionReference, string invoiceReference, string invoiceHash) #

Restores a status/receipt reference after a process restart using newly authenticated credentials. This neither reopens a session nor resubmits XML.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
sessionReference string required
invoiceReference string required
invoiceHash string required
public async Task<KsefSubmission> SubmitAsync(KsefCredentials credentials, KsefOnlineSession session, byte[] fa3Xml, Fa3SchemaValidator validator, CancellationToken cancellationToken = default) #

Validates a bounded defensive FA(3) snapshot before network mutation, then submits its exact encrypted bytes and digests. A returned reference is not acceptance.

Parameters

credentials OfficeIMO.Invoicing.KSeF.KsefCredentials required
session OfficeIMO.Invoicing.KSeF.KsefOnlineSession required
fa3Xml byte[] required
validator OfficeIMO.Invoicing.Validation.Fa3SchemaValidator required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<KsefSubmission>

Properties

public KsefEnvironment Environment { get; } #

Selected official environment.