Vouchers Models

Product filter

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
type	Type	int	yes	no
product	Product	int	yes	no
ratio	Ratio	float	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Transaction

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
voucher	Voucher	int	yes	no
description	Description	string	yes	no
sale	Sale	int	no	no
salePayment		int	no	no
payment	Payment	int	no	no
amount	Amount	float	yes	no
balanceAfter	Balance	float	yes	no
unitPrice		currency	yes	no
useDate	Production date	datetime	yes	no
fkModel		fkModel	no	yes
fkId		int	no	yes
ratio	Ratio	float	no	no
refunded	Back	bool	yes	no
type	Type	select	yes	no
voucherType	Type	string	yes	no
customerName	Customer	string	yes	no
beneficiary	Beneficiary	int	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Values for type

Value	Name
1	Recarga
2	Consumption
3	Manual
4	Bulk Top up

Voucher

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
customer	Customer	int	yes	no
type	Type	int	yes	no
unitPrice	Price per unit	currency	yes	no
balance	Balance	float	yes	no
startDate	Valid from	date	no	no
endDate	Valid until	date	no	no
startTime	Time from	time	no	no
endTime	Time until	time	no	no
daysOfWeek	Days of the week	daysOfWeek	no	no
comments	Observations	text	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Voucher beneficiary

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
customer	Holder	int	yes	no
beneficiary	Beneficiary	int	yes	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Voucher type

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	yes	no
kind	Type	select	yes	no
product	Product	int	yes	no
shortDescription	Short description	string	no	no
expiration	Expiration	duration	no	no
startTime	Time from	time	no	no
endTime	Time until	time	no	no
daysOfWeek	Days of the week	daysOfWeek	no	no
customerTag	Will assign this tag	int	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Values for kind

Value	Name
1	Money
3	Units

VoucherPrice

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
type	Type	int	yes	no
tagFilter	Filter tag	int	no	no
amount	Top up amount	float	yes	no
price	Price	currency	yes	no
online	Available online	bool	yes	no
minAge	Minimum age	int	no	no
maxAge	Maximum age	int	no	no
description	Description	text	no	no
priority	Priority	int	yes	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes