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:
GET /toolkit/searchreceipts
Inputs
This API should accept these headers supplied by eInvoicing:
| Header parameter | Type | Description | Value example |
|---|---|---|---|
| version | String | toolkit version | 1.0 |
Body of the request contains a single object that contains these fields:
| 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
Upon successful submission, API must return 200 status code with the below mentioned output parameters.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| data | Array of receipt | List of all the receipts that match the search criteria | |
| pagesCount | integer | Total number of pages. This number will be calculated based on the totalCount and the pageSize | 5 |
| totalCount | integer | Search result total number of receipts | 120 |
receipt
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| uuid | String | Uuid of the receipt | 999fd4e6-1a40-40e4-9b86-3f28aafa5529 |
| submissionUuid | String | submission uuid of the receipt | |
| receiptNumber | String | receipt number of the receipt | |
| dateTimeIssued | DateTime | issued date time of the receipt | |
| receiptType | String | receipt type of the receipt | |
| typeVersion | String | type version of the receipt | |
| buyerType | String | buyer type of the receipt | |
| buyerId | String | buyer id of the receipt | |
| buyerName | String | buyer name of the receipt | |
| paymentMethod | String | payment method of the receipt | |
| totalAmountEGP | Decimal | total amount EGP of the receipt | |
| localStatus | string | local status of the receipt | Possible values are: Exported / New / Submitted / Valid / Invalid / Cancelled |
Additional considerations
This API is called only over protected HTTPS channel.