Interface IAnybillClientReceiptModule

Namespace

anybill.POS.Client.Modules

Assembly

anybill.POS.Client.Abstractions.dll

Module of the IAnybillClient for working with receipts.

public interface IAnybillClientReceiptModule

Methods

CancelReceiptAsync(Guid, CancellationToken)

Cancel a receipt with the given receipt id.

Task<ICancelReceiptResponse> CancelReceiptAsync(Guid receiptId, CancellationToken cancellationToken = default)

Parameters

receiptId Guid

Id of the receipt which should be cancelled.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICancelReceiptResponse>

A ICancelReceiptResponse.

CreateAsync(string, string, CancellationToken)

Creates a new receipt from a json.

Task<IReceiptResponse> CreateAsync(string receiptDtoJson, string addReceiptOptionsJson, CancellationToken cancellationToken = default)

Parameters

receiptDtoJson string

Details to add the new receipt as json.

addReceiptOptionsJson string

Options for the receipt like DisplayTarget as json.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IReceiptResponse>

A IReceiptResponse sub-type.

CreateAsync(AddReceipt, AddReceiptOptions, CancellationToken)

Creates a new receipt.

Task<IReceiptResponse> CreateAsync(AddReceipt receiptDto, AddReceiptOptions addReceiptOptions, CancellationToken cancellationToken = default)

Parameters

receiptDto AddReceipt

The details to add the new receipt.

addReceiptOptions AddReceiptOptions

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IReceiptResponse>

A IReceiptResponse sub-type.

PrintedReceiptAsync(Guid, CancellationToken)

Mark a receipt as printed with the given id.

Task<IPrintedReceiptResponse> PrintedReceiptAsync(Guid receiptId, CancellationToken cancellationToken = default)

Parameters

receiptId Guid

Id of the receipt which should be marked as printed.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IPrintedReceiptResponse>

A ICancelReceiptResponse.

RegisterIdAsync(RegisterReceiptId, CancellationToken)

Creates a pre generated receipt.

Task<IRegisterReceiptIdResponse> RegisterIdAsync(RegisterReceiptId registerReceiptId, CancellationToken cancellationToken = default)

Parameters

registerReceiptId RegisterReceiptId

The data to pre register a receipt.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IRegisterReceiptIdResponse>

Information to display the pre generated receipt.

VendorReceiptAsync(AddVendorReceipt, CancellationToken)

Creates a new vendor receipt.

Task<IVendorReceiptResponse> VendorReceiptAsync(AddVendorReceipt vendorReceiptDto, CancellationToken cancellationToken = default)

Parameters

vendorReceiptDto AddVendorReceipt

The details to add the new vendor receipt.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IVendorReceiptResponse>

A IVendorReceiptResponse.