Api module - AdrianC2000/InvoiceScannerApp GitHub Wiki
Documentation for the api module - actual supported endpoints below.
For swagger run the application locally and go to http://localhost:5000/doc
Version: 1.0
/healthcheck/
GET
Description:
Check if application is up
Responses
| Code | Description |
|---|---|
| 200 | Success |
/invoices/
POST
Description:
Processing multiple invoices
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| file | formData | Yes | [ file ] |
Responses
| Code | Description |
|---|---|
| 200 | Success |
| 206 | Some of the results are not complete due to the input bad format - check messages for details |
| 415 | One of the files is in the wrong format |
/request/
POST
Description:
Send request with your invoice info to endpoint from settings.
Responses
| Code | Description |
|---|---|
| 200 | Success |
/settings/
POST Description:
Set new settings
Responses
| Code | Description |
|---|---|
| 200 | Success |
| 304 | Not modified |
GET
Description:
Get actual settings
Responses
| Code | Description |
|---|---|
| 200 | Success |
/settings/customize_json
POST
Description:
Customize extracted invoice information by the current settings.
Responses
| Code | Description |
|---|---|
| 200 | Success |