Class RegisterReceiptRequestBuilder

A builder that helps fluently compose an instance of RegisterReceiptRequest.

Inheritance

object

RegisterReceiptRequestBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: NineDigiteKasa

Assembly: NineDigit.eKasa.dll

Syntax

public sealed class RegisterReceiptRequestBuilder

Constructors

RegisterReceiptRequestBuilder(ORPCode)

Creates new instance of builder.

Declaration

public RegisterReceiptRequestBuilder(ORPCode cashRegisterCode)

Parameters

Type	Name	Description
ORPCode	cashRegisterCode	Cash register code

Properties

Items

Returns a deep clone of the collection of items added to the builder.

When the Build() method is invoked, a deep clone of such instances is used.

Declaration

public IEnumerable<ReceiptItem> Items { get; }

Property Value

Type	Description
IEnumerableReceiptItem

Methods

AddAdvanceItem(ReceiptItemName, UnitPriceAmount, VatRate, Quantity?, TaxFreeReason?, ReceiptText?, Seller?)

Declaration

public RegisterReceiptRequestBuilder AddAdvanceItem(ReceiptItemName name, UnitPriceAmount unitPrice, VatRate vatRate, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
VatRate	vatRate
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller

Returns

Type	Description
RegisterReceiptRequestBuilder

AddCorrectionItem(ReceiptItemName, UnitPriceAmount, VatRate, ReferenceReceiptId, Quantity?, TaxFreeReason?, ReceiptText?, Seller?, VoucherNumber?)

Declaration

public RegisterReceiptRequestBuilder AddCorrectionItem(ReceiptItemName name, UnitPriceAmount unitPrice, VatRate vatRate, ReferenceReceiptId referenceReceiptId, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null, VoucherNumber? voucherNumber = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
VatRate	vatRate
ReferenceReceiptId	referenceReceiptId
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller
VoucherNumber	voucherNumber

Returns

Type	Description
RegisterReceiptRequestBuilder

AddDiscountItem(ReceiptItemName, UnitPriceAmount, VatRate, Quantity?, TaxFreeReason?, ReceiptText?, Seller?)

Declaration

public RegisterReceiptRequestBuilder AddDiscountItem(ReceiptItemName name, UnitPriceAmount unitPrice, VatRate vatRate, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
VatRate	vatRate
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller

Returns

Type	Description
RegisterReceiptRequestBuilder

AddItem(ReceiptItem)

Declaration

public RegisterReceiptRequestBuilder AddItem(ReceiptItem item)

Parameters

Type	Name	Description
ReceiptItem	item

Returns

Type	Description
RegisterReceiptRequestBuilder

AddItem(ReceiptItemData)

Declaration

public RegisterReceiptRequestBuilder AddItem(ReceiptItemData itemData)

Parameters

Type	Name	Description
ReceiptItemData	itemData

Returns

Type	Description
RegisterReceiptRequestBuilder

AddItems(IEnumerable<ReceiptItem>)

Declaration

public RegisterReceiptRequestBuilder AddItems(IEnumerable<ReceiptItem> items)

Parameters

Type	Name	Description
IEnumerableReceiptItem	items

Returns

Type	Description
RegisterReceiptRequestBuilder

AddPayment(ReceiptPayment)

Declaration

public RegisterReceiptRequestBuilder AddPayment(ReceiptPayment payment)

Parameters

Type	Name	Description
ReceiptPayment	payment

Returns

Type	Description
RegisterReceiptRequestBuilder

AddPositiveItem(ReceiptItemName, UnitPriceAmount, VatRate, Quantity?, TaxFreeReason?, ReceiptText?, Seller?)

Declaration

public RegisterReceiptRequestBuilder AddPositiveItem(ReceiptItemName name, UnitPriceAmount unitPrice, VatRate vatRate, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
VatRate	vatRate
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller

Returns

Type	Description
RegisterReceiptRequestBuilder

AddReturnedContainerItem(ReceiptItemName, UnitPriceAmount, Quantity?, TaxFreeReason?, ReceiptText?, Seller?)

Declaration

public RegisterReceiptRequestBuilder AddReturnedContainerItem(ReceiptItemName name, UnitPriceAmount unitPrice, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller

Returns

Type	Description
RegisterReceiptRequestBuilder

AddReturnedItem(ReceiptItemName, UnitPriceAmount, VatRate, ReferenceReceiptId, Quantity?, TaxFreeReason?, ReceiptText?, Seller?)

Declaration

public RegisterReceiptRequestBuilder AddReturnedItem(ReceiptItemName name, UnitPriceAmount unitPrice, VatRate vatRate, ReferenceReceiptId referenceReceiptId, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
VatRate	vatRate
ReferenceReceiptId	referenceReceiptId
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller

Returns

Type	Description
RegisterReceiptRequestBuilder

AddVoucherItem(ReceiptItemName, UnitPriceAmount, VatRate, VoucherNumber, Quantity?, TaxFreeReason?, ReceiptText?, Seller?)

Declaration

public RegisterReceiptRequestBuilder AddVoucherItem(ReceiptItemName name, UnitPriceAmount unitPrice, VatRate vatRate, VoucherNumber voucherNumber, Quantity? quantity = null, TaxFreeReason? specialRegulation = null, ReceiptText? description = null, Seller? seller = null)

Parameters

Type	Name	Description
ReceiptItemName	name
UnitPriceAmount	unitPrice
VatRate	vatRate
VoucherNumber	voucherNumber
Quantity	quantity
TaxFreeReason	specialRegulation
ReceiptText	description
Seller	seller

Returns

Type	Description
RegisterReceiptRequestBuilder

AppendFooterLine(ReceiptText)

Declaration

public RegisterReceiptRequestBuilder AppendFooterLine(ReceiptText footer)

Parameters

Type	Name	Description
ReceiptText	footer

Returns

Type	Description
RegisterReceiptRequestBuilder

AppendFooterLineIfNotEmpty(ReceiptText?)

Declaration

public RegisterReceiptRequestBuilder AppendFooterLineIfNotEmpty(ReceiptText? footer)

Parameters

Type	Name	Description
ReceiptText	footer

Returns

Type	Description
RegisterReceiptRequestBuilder

AppendHeaderLine(ReceiptText)

Declaration

public RegisterReceiptRequestBuilder AppendHeaderLine(ReceiptText header)

Parameters

Type	Name	Description
ReceiptText	header

Returns

Type	Description
RegisterReceiptRequestBuilder

AppendHeaderLineIfNotEmpty(ReceiptText?)

Declaration

public RegisterReceiptRequestBuilder AppendHeaderLineIfNotEmpty(ReceiptText? header)

Parameters

Type	Name	Description
ReceiptText	header

Returns

Type	Description
RegisterReceiptRequestBuilder

Build()

Produces instance of RegisterReceiptRequest, that contains either CashRegisterReceipt, InvalidReceipt or ParagonReceipt receipt type.

Declaration

public RegisterReceiptRequest Build()

Returns

Type	Description
RegisterReceiptRequest

Exceptions

Type	Condition
InvalidOperationException	Thrown when no receipt items were added.

SetExternalId(ID)

Declaration

public RegisterReceiptRequestBuilder SetExternalId(ID externalId)

Parameters

Type	Name	Description
ID	externalId

Returns

Type	Description
RegisterReceiptRequestBuilder

SetFooter(ReceiptText)

Declaration

public RegisterReceiptRequestBuilder SetFooter(ReceiptText footer)

Parameters

Type	Name	Description
ReceiptText	footer

Returns

Type	Description
RegisterReceiptRequestBuilder

SetHeader(ReceiptText)

Declaration

public RegisterReceiptRequestBuilder SetHeader(ReceiptText header)

Parameters

Type	Name	Description
ReceiptText	header

Returns

Type	Description
RegisterReceiptRequestBuilder

SetIsTesting(bool)

Produces a receipt request containing InvalidReceipt if set to true. Otherwise, a receipt request containing CashRegisterReceipt is produced.

Do not use in combination with the SetParagon(DateTimeOffset, ParagonNumber) method call, as a paragon testing receipt is not allowed.

Declaration

public RegisterReceiptRequestBuilder SetIsTesting(bool isTesting = true)

Parameters

Type	Name	Description
bool	isTesting

Returns

Type	Description
RegisterReceiptRequestBuilder

Exceptions

Type	Condition
InvalidOperationException	Thrown when called on a builder instance containing paragon data set by SetParagon(DateTimeOffset, ParagonNumber).

SetParagon(DateTimeOffset, ParagonNumber)

Sets the paragon information.

Do not call this method on a builder instance previously marked to produce a testing receipt by providing a true value to the SetIsTesting(bool) method, as paragon testing receipts are not allowed.

Declaration

public RegisterReceiptRequestBuilder SetParagon(DateTimeOffset issueDate, ParagonNumber paragonNumber)

Parameters

Type	Name	Description
DateTimeOffset	issueDate	The date the paragon was issued.
ParagonNumber	paragonNumber	The paragon number.

Returns

Type	Description
RegisterReceiptRequestBuilder	The updated builder instance.

Exceptions

Type	Condition
InvalidOperationException	Thrown if called after the receipt has been marked as a testing receipt using the SetIsTesting(bool) method.

SetRoundingAmount(RoundingAmount)

Declaration

public RegisterReceiptRequestBuilder SetRoundingAmount(RoundingAmount roundingAmount)

Parameters

Type	Name	Description
RoundingAmount	roundingAmount

Returns

Type	Description
RegisterReceiptRequestBuilder