api

Documentation

Index

• type EStatementController
  • func (*EStatementController) Construct() interface{}
  • func (c *EStatementController) EStatementFindAll(ctx *fiber.Ctx) error
  • func (c *EStatementController) EStatementGetSumary(ctx *fiber.Ctx) error
  • func (c *EStatementController) EStatementScan(ctx *fiber.Ctx) error

Types

type EStatementController

type EStatementController struct {
	*app.App
	// contains filtered or unexported fields
}

func (*EStatementController) Construct

func (*EStatementController) Construct() interface{}

func (*EStatementController) EStatementFindAll

func (c *EStatementController) EStatementFindAll(ctx *fiber.Ctx) error

EStatementFindAll godoc

@Summary		Get all e-statements
@Description	Retrieve a list of all e-statements with pagination
@Tags			E-Statements
@Accept			json
@Produce		json
@Param			page		query		int																false	"Page number"
@Param			per_page	query		int																false	"Number of items per page"
@Success		200			{object}	types.Response{data=[]models.EStatement,meta=types.PaginationMeta}	"Successfully retrieved e-statements"
@Failure		500			{object}	validator.GlobalErrorResponse									"Internal server error"
@Router			/e-statement [get]

func (*EStatementController) EStatementGetSumary

func (c *EStatementController) EStatementGetSumary(ctx *fiber.Ctx) error

EStatementGetSumary godoc

@Summary		Get an e-statement summary
@Description	Get an e-statement summary
@Tags			E-Statements
@Accept			json
@Produce		json
@Param			id	path		int	true	"E-Statement ID"
@Success		200	{object}	types.Response{data=estatement.OverallSummary}	"Successfully retrieved e-statement summary"
@Failure		400	{object}	validator.GlobalErrorResponse		"Bad request"
@Failure		500	{object}	validator.GlobalErrorResponse		"Internal server error"
@Router			/e-statement/{id}/summary [get]

func (*EStatementController) EStatementScan

func (c *EStatementController) EStatementScan(ctx *fiber.Ctx) error

EStatementScan godoc

@Summary		Scan an e-statement
@Description	Scan an e-statement and return the result
@Tags			E-Statements
@Accept			multipart/form-data
@Produce		json
@Param			file		formData	file		true	"PDF file to scan"
@Param			pdf_library	formData	string		true	"PDF library to use"
@Param			bank		formData	string		false	"Bank name"
@Param			time_bomb	formData	string		false	"Time bomb"
@Param			summary		formData	string		false	"Summary"
@Param			scan_only	formData	bool		false	"Only scan the e-statement"
@Success		200		{object}	types.Response{data=estatement.ScanEStatementResponse}	"Successfully scanned e-statement"
@Failure		400		{object}	validator.GlobalErrorResponse		"Bad request"
@Failure		500		{object}	validator.GlobalErrorResponse		"Internal server error"
@Router			/e-statement/scan [post]