Overview
It allows to export newly stored receipts in submission files, each submission may contains number of/array of receipts will be decided based on configuration setting.
• The developer/taxpayer will be able to select receipts since last export, or since a specific date/time or by providing a range of receipt internal IDs.
• API will generate the batch rar file (maximum file size 1.5 MB or 500 receipts) and it will generate based on Initialization API dynamic configuration .
• API will be updated the local cache database export table with “exported” status for the successful records.
Note!
• Compressing receipt file merged into a single submission file and it can be used for later submission from invoicing portal.
• Export all receipt(s) or export specific receipt(s) based on issuance date. It must be in a sequencial order.
• Batch rar file is a JSON formatted and array of all the selected receipts.
Signature
Signature:
GET /toolkit/exportreceipts
Inputs
This API should accept these headers supplied by eInvoicing:
| Header parameter | Type | Description | Value example |
|---|---|---|---|
| receiptCount | Number | receipt count of the export receipts | |
| version | String | version number of the toolkit |
Outputs
Upon successful submission, API must return 200 status code with the below mentioned output parameters.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| result | String |
If 400 code returned for bad request scenario.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| value | String | Export receipts output bad request value. | |
| formatters[] | Export receipts output bad request formatters. | ||
| contentTypes[] | String | Export receipts output bad request content types. | |
| declaredType | String | Export receipts output bad request declaration type. | |
| statusCode | int | Export receipts output bad request status code. |
If 404 code returned for not found scenario.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| statusCode | int | Export receipts not found status code. |
Additional considerations
This API is called only over protected HTTPS channel.