| Bookmark Name | Actions |
|---|
Enterprise APIs
The Receipting microservice exposes the following business and internal APIs as the REST endpoints. The table below summarizes the APIs. For the complete APIs specification, see Service Specification (Swagger) - Receipting. (ADD LINK)
Version 0.8.0
| CATEGORY | OPERATION ID | URI | API DESCRIPTION | TABLE DESCRIPTION |
|---|---|---|---|---|
|
Forms |
registerForm | /origination/receipts/form | Creates a new form or form version. |
These APIs are intended to be used in design time. The user creates and registers a form using which receipts could be generated during runtime. A Form is the identifier of a template. It could have multiple versions and each version has its own formAchive and other details. Receipts are generated using a specific version of the form template. |
| getFormArchive | /origination/receipts/forms | Fetches form archive of the given form code and version. | ||
| getForm | /origination/receipts/forms | Fetches details of a form version. | ||
| updateFormDetails | /origination/receipts/forms | Update details of a form version. | ||
| deleteForm | /origination/receipts/forms | Deletes form version or form. | ||
|
Receipts |
generateReceipt |
/origination/receipts |
Generate a PDF receipt. |
These APIs are intended to be used in the runtime to either generate a receipt or concatenate them. The user has to pass the information on which form version has to be used for the generation along with the form data. Utilizing this information the receipt MS fetches the form template, overlays the provided data over it, and generates a PDF receipt. This file is then stored in the Document MS and the Identifier of which is returned to the user. |
| getReceipt | /origination/receipts/transactions | Get a generated receipt. | ||
| concatReceipts |
/origination/receipts/concat |
Concatenate multiple PDF receipts. | ||
| System | generateReceiptAction | /system/receipts/generate | Generate a receipt event handler. | These APIs are system APIs and are not intended to be called by the user directly. These event handlers are called in different stages of the receipt generation for performing business actions. |
| updateReceiptStorageStatus | /system/receipts/updateStorageStatus | Update status after storage sucessful/failed. | ||
| uploadReceiptAction | /system/receipts/upload | Calls the receipt upload implementation which in turn invokes document storage. | ||
| concatReceiptAction | /system/receipts/concat | Concatenate receipts event handler. |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file. (CHECK LINK)
Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?