Overview
This method provides the capability to search the receipts stored in the local database giving any of the search parameters or combination of parameters. Receipts will be sorted by receipt issuance date in descending order.
Note!
• Search functionality is case-insensitive.
• Toolkit doesn't change the status of the locally stored receipts due to the search execution.
• Toolkit supports the search only for the taxpayer linked with the POS used when the toolkit was initialized.
Signature
Signature:
SearchReceiptsResponseDto result=_toolkitHandler.SearchReceipts(searchReceiptsRequestDto)
public class SearchReceiptsRequestDto
{
public string? Uuid { get; set; }
public string? ReferenceUuid { get; set; }
public string? SubmissionUuid { get; set; }
public string? BuyerType { get; set; }
public string? BuyerId { get; set; }
public string? ReceiptNumber { get; set; }
public DateTime? DateTimeIssued { get; set; }
public decimal? TotalAmountEGP { get; set; }
public Domain.Enums.ReceiptStatus? LocalStatus { get; set; }
public int? PageNumber { get; set; }
public int? PageSize { get; set; }
}
public class SearchReceiptsResponseDto : QueryListResult<ReceiptItem>
{
public SearchReceiptsResponseDto()
{
}
}
public class ReceiptItem
{
public string Uuid { get; set; } = null!;
public string? SubmissionUuid { get; set; } = null!;
public string ReceiptNumber { get; set; } = null!;
public DateTime DateTimeIssued { get; set; }
public string ReceiptType { get; set; } = null!;
public string TypeVersion { get; set; } = null!;
public string? BuyerType { get; set; } = null!;
public string? BuyerId { get; set; } = null!;
public string? BuyerName { get; set; } = null!;
public string PaymentMethod { get; set; } = null!;
public decimal TotalAmountEGP { get; set; }
public Domain.Enums.ReceiptStatus LocalStatus { get; set; }
}
Inputs
searchReceiptsRequestDto object takes below inputs:
| Input parameter | Type | Description | Value example |
|---|---|---|---|
| Uuid | String | Optional, Uuid of the receipt | 999fd4e6-1a40-40e4-9b86-3f28aafa5529 |
| ReferenceUuid | String | Optional, reference uuid of the receipt | |
| SubmissionUuid | String | Optional, submission uuid of the receipt | |
| BuyerType | String | Optional, buyer type of the receipt | |
| BuyerId | String | Optional, buyer id of the receipt | |
| ReceiptNumber | String | Optional, receipt number of the receipt | |
| DateTimeIssued | DateTime | Optional, issued date time of the receipt. Search functionality will ignore the time part, and find all the receipts which are issued on the same date | |
| TotalAmountEGP | Decimal | Optional, total amount EGP of the receipt | |
| LocalStatus | string | Optional, local status of the receipt | Possible values are: Exported / New / Submitted / Valid / Invalid / Cancelled |
| PageNumber | int | Optional, page number of the receipt list | |
| PageSize | int | Optional, page size of the receipt list |
Outputs
searchReceiptsResponseDto contains the queryable list of receiptitem object and it consists of below output parameters:
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| Uuid | String | Uuid of the receipt | 999fd4e6-1a40-40e4-9b86-3f28aafa5529 |
| SubmissionUuid | String | submission uuid of the receipt | |
| ReferenceUuid | String | reference uuid of the receipt | |
| DateTimeIssued | DateTime | issued date time of the receipt | |
| ReceiptType | String | type of the receipt | |
| TypeVersion | String | type version of the receipt | |
| BuyerType | String | buyer type of the receipt | |
| BuyerId | String | Optional, buyer id of the receipt | |
| BuyerName | String | buyer name of the receipt | |
| PaymentMethod | String | payment method of the receipt | |
| TotalAmountEGP | Decimal | Optional, total amount EGP of the receipt | |
| LocalStatus | int | Optional, local status of the receipt | Possible values are: Exported / New / Submitted / Valid / Invalid / Cancelled / Rejected / Flagged / ValidToCancelled / ValidToRejected |