# KsefClient

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.

Class 

`OfficeIMO.Invoicing.KSeF`

**Namespace**

`OfficeIMO.Invoicing.KSeF`

**Assembly**

`OfficeIMO.Invoicing.KSeF`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[KsefClient.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.cs#L10)

**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

Filter members 

Show inherited

## Constructors

`public KsefClient(KsefEnvironment environment = Test, HttpMessageHandler? handler = null, TimeProvider? clock = null, TimeSpan? requestTimeout = null)` [#](#constructor-ctor-officeimo-invoicing-ksef-ksefenvironment-net-http-httpmessagehandler-timeprovider-nullable-system-timespan)

[KsefClient.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.cs#L10)

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)` [#](#method-begintokenauthenticationasync-officeimo-invoicing-ksef-ksefcontext-officeimo-invoicing-ksef-ksefsecret-threading-cancellationtoken)

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)` [#](#method-checkencryptionkeyasync-threading-cancellationtoken)

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)` [#](#method-closeonlinesessionasync-officeimo-invoicing-ksef-ksefcredentials-officeimo-invoicing-ksef-ksefonlinesession-threading-cancellationtoken)

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()` [#](#method-dispose)

[KsefClient.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.cs#L72)

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

`public Task<KsefStatus> GetAuthenticationStatusAsync(KsefAuthentication authentication, CancellationToken cancellationToken = default)` [#](#method-getauthenticationstatusasync-officeimo-invoicing-ksef-ksefauthentication-threading-cancellationtoken)

[KsefClient.Authentication.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.Authentication.cs#L38)

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)` [#](#method-getinvoicereceiptasync-officeimo-invoicing-ksef-ksefcredentials-officeimo-invoicing-ksef-ksefsubmission-threading-cancellationtoken)

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)` [#](#method-getinvoicestatusasync-officeimo-invoicing-ksef-ksefcredentials-officeimo-invoicing-ksef-ksefsubmission-threading-cancellationtoken)

[KsefClient.Status.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.Status.cs#L16)

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)` [#](#method-getsessioninvoicesasync-officeimo-invoicing-ksef-ksefcredentials-string-int32-string-threading-cancellationtoken)

[KsefClient.Status.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.Status.cs#L25)

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)` [#](#method-getsessionstatusasync-officeimo-invoicing-ksef-ksefcredentials-string-threading-cancellationtoken)

[KsefClient.Status.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.Status.cs#L13)

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)` [#](#method-openonlinesessionasync-officeimo-invoicing-ksef-ksefcredentials-threading-cancellationtoken)

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)` [#](#method-redeemasync-officeimo-invoicing-ksef-ksefauthentication-threading-cancellationtoken)

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)` [#](#method-refreshasync-officeimo-invoicing-ksef-ksefcredentials-threading-cancellationtoken)

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)` [#](#method-resumesubmission-officeimo-invoicing-ksef-ksefcredentials-string-string-string)

[KsefClient.Status.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.Status.cs#L8)

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**

Returns

`KsefSubmission`

`public async Task<KsefSubmission> SubmitAsync(KsefCredentials credentials, KsefOnlineSession session, byte[] fa3Xml, Fa3SchemaValidator validator, CancellationToken cancellationToken = default)` [#](#method-submitasync-officeimo-invoicing-ksef-ksefcredentials-officeimo-invoicing-ksef-ksefonlinesession-byte-officeimo-invoicing-validation-fa3schemavalidator-threading-cancellationtoken)

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>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public KsefEnvironment Environment { get; }` [#](#property-environment)

[KsefClient.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Invoicing.KSeF/KsefClient.cs#L21)

Selected official environment.

<!-- PowerForge markdown artifact sha256:89475EC54E517C2AFAF4B5F3D6C57706534A1CFEFD56C27B9F5A8CC17B3F35CE -->
