Overview
It will refresh all the cached lookups like country, currency, documenttype, documenttype version, activity code, documenttype work flow parameter, document validation, itemcode, measurecode, delivery unit, payment type, tax type, taxsubtype etc.,
Note! • Even caching expires also toolkit can issue receipt.
Signature
Signature:
PUT /toolkit/refreshcache
Inputs
This API should accept these headers supplied by eInvoicing:
| Header parameter | Type | Description | Value example |
|---|---|---|---|
| version | String | version number of the toolkit. |
Outputs
Upon successful execution, Lookups cachingexpirydate will get as a response and generated cache data will be stored in their respective cache tables.
Upon successful submission, API must return 200 status code with the below mentioned output parameters.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| cachingexpiryDate | String | refresh cache expiry date output value | “2022-10-03T12:57:10.111Z” |
| correlationId | String | Correlation id of the successful receipt. | |
| target | String | refresh cache output target. | |
| code | String | Success code of the refresh cache. | 200 Ok / 201 Created etc., |
| message | String | Success message of the refresh cache. | |
| details | String | Additional details of the refresh cache. |
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 refresh cache 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.