Table of Contents

Class FiscalResponse

Namespace
RetailForce.Fiscalisation
Assembly
RetailForce.Fiscalisation.Model.dll

The fiscal response of the fiscalisation system.

[StorageName("Response")]
public sealed class FiscalResponse
Inheritance
FiscalResponse
Inherited Members
Extension Methods

Remarks

Can be

Properties

AdditionalFields 

[JsonIgnore]
public ReadOnlyDictionary<string, object> AdditionalFields { get; set; }

Property Value

ReadOnlyDictionary<string, object>

AssignedFiscalUniqueId

Unique ID assigned by the fiscal system.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string? AssignedFiscalUniqueId { get; }

Property Value

string

Remarks

This is the internal document identifier generated and assigned by the fiscal authorities, if applicable. (may be null) This may be used by the fiscal authorities as unique document id in their database.

CashRegisterId

Returns the cash register id.

[JsonProperty]
public string CashRegisterId { get; }

Property Value

string

ErrorDescription

The error description if the fiscalisation process failed. Empty if everything went well.

[JsonProperty]
public string ErrorDescription { get; }

Property Value

string

FiscalCountry

The fiscal country for this response.

[JsonProperty]
public FiscalCountry FiscalCountry { get; }

Property Value

FiscalCountry

FiscalDocumentNumber

The fiscalisation document number as string.

[JsonProperty]
public string FiscalDocumentNumber { get; }

Property Value

string

FiscalDocumentStartTime

The start time of the fiscal document (this property will be set when document is created).

[JsonProperty]
public long FiscalDocumentStartTime { get; }

Property Value

long

FiscalisationDocumentNumber

The fiscalisation document number.

[JsonProperty]
[Obsolete("Will be replaced by string property FiscalDocumentNumber in further versions.")]
public int FiscalisationDocumentNumber { get; }

Property Value

int

PrintMessage

The print message to print out on the customer receipt. In several countries you have to print out this message, otherwise the implementation is not according to the law.

[JsonProperty]
public string PrintMessage { get; }

Property Value

string

Remarks

It is strongly recommended to print out this message in every country.

PrintingFields

Additional fields to print on the receipt.

[JsonProperty]
public Dictionary<string, string> PrintingFields { get; }

Property Value

Dictionary<string, string>

Remarks

If any key/value pair is delivered it has to be printed on the receipt.
If there are no additional fields to print, this Dictionary is empty.
if the printing fields are not implemented in the country, dictionary returns one value "NOT IMPLEMENTED".

Note: PrintingFields in general consist of three types of elements:

  • elements where ONLY the value should be printed, these elements start with "Np_" followed by a designation.
  • elements where both key and value should be printed, these values do NOT contain "Np_".
  • elements where a full line of the value should be printed, these are seperator lines and start with "Lp_"

Note: Printing fields should be printed in the order they appear in the printingFields element Some elements have a numbers after the designation "01", "02", ... in this way elements with (logically) belong together are marked.

ProcessStartTime

The date of the first receipt for the whole process.

[JsonProperty]
public long ProcessStartTime { get; }

Property Value

long

Remarks

This field is used for long-term orders (eg. gastronomy) for print out in germany (mandatory if long-term orders are used).

QrCode

A possible qr code (if applicable at respective country). If set, QrCode has to be printed out.

[JsonProperty]
public string QrCode { get; }

Property Value

string

RequestCompletionTime

Gets or sets the request completion time of the fiscal response request.

[JsonProperty]
public DateTime RequestCompletionTime { get; set; }

Property Value

DateTime

RequestTime

Gets or sets the request time of the fiscal response request.

[JsonProperty]
public DateTime RequestTime { get; set; }

Property Value

DateTime

RetailForceReceiptId

Contains the global unique receipt id (containing terminalId and document number sequence number). Can be created when creating a transaction (with create document).

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string RetailForceReceiptId { get; set; }

Property Value

string

Remarks

Necessary for digital receipt

Signature

The signature of the security device (country-specific)

[JsonProperty]
public string Signature { get; }

Property Value

string

TaxPositions

Tax positions calculated by fiscal system.

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public List<DocumentTaxPosition> TaxPositions { get; }

Property Value

List<DocumentTaxPosition>

UserMessage

The message which must be shown to the user of the cash register system.

[JsonProperty]
public string UserMessage { get; }

Property Value

string
Edit this page