Overview
This API will generate and assign UUID to the receipt/return receipt which is a hash formatted based on the receipt base structure + hash as per the previously issued receipt from the same POS device (except for the first generating receipt/return receipt from the POS).
Note!
• It accepts single receipt json as a payload and it shouldn't contain uuid value in it.
• It will gives an error if the structure of the receipt is not correct.
Signature
Signature:
POST /toolkit/uuid
Inputs
This API should accept these headers supplied by eInvoicing:
| Header parameter | Type | Description | Value example |
|---|---|---|---|
| version | String | version number of the toolkit. |
Body of the request contains a single object that contains these fields:
| Input parameter | Type | Description | Value example |
|---|---|---|---|
| receipt/return receipt json | String | Receipt input json . |
Outputs
It will generate the UUID and given it as a response and updated receipt json will contain the generated UUID value.
Upon successful submission, API must return 200 status code with the below mentioned output parameters.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| uuid | String | UUID output of the receipt. | 999fd4e6-1a40-40e4-9b86-3f28aafa5529 |
| updatedReceiptJson | String | updated output json with the uuid of the receipt. | |
| correlationId | String | Correlation id of the successful receipt. | |
| target | String | receipt output target. | |
| code | String | Success code | 200 Ok / 201 Created etc., |
| message | String | Success message | |
| details | String | Additional details |
If 4xx or 5xx codes appeared as a result, It will be mentioned with the below error output parameters.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| correlationId | String | Correlation id of the receipt error. | |
| target | String | Error occurred field information | |
| code | String | Error code | bad request/invalid data etc., |
| message | String | Error message | |
| details | String | Error additional details, useful for further investigation |
Additional considerations
This API is called only over protected HTTPS channel.