Billing Models

Company

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
footerText	Invoice footer text	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

Detailed charges

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
sale	Sale	int	yes	no
parent		int	no	no
payment	Payment	int	yes	no
units	Units	float	yes	no
amount	Amount	currency	yes	no
refunded	Discarded	bool	yes	yes
virtual	Virtual	bool	yes	yes
paymentMethodName	Payment method	string	yes	no
customer	Customer	int	yes	no
customerName	Customer	string	yes	no
useDate	Production date	date	yes	no
productName	Product	string	yes	no
familyName	Family	string	yes	no
subfamilyName	Subfamily	string	yes	no
invoice	Invoice	int	no	yes
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

Family

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	yes	no
code	Code	string	no	no
useStock	Manage stock	bool	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

Payment

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
customer	Customer	int	no	yes
method	Payment method	int	yes	no
amount	Amount	currency	yes	yes
refunded	Returned	bool	yes	yes
compensation	Compensation	bool	yes	yes
online	Online	bool	yes	yes
virtual	Virtual	bool	yes	yes
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

Payment method

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	yes	no
consumerName	Consumer name	string	no	no
color	Color	color	no	no
type	Type	select	yes	no
maxAmount	Maximum amount allowed	float	no	no
priority	Priority	int	yes	no
consumer	Available online	bool	yes	no
pos	POS	bool	yes	no
unattended	Automatizable	bool	yes	no
refund	Refund at POS	bool	yes	no
refundProvider	Refund supplier	bool	yes	no
productTag	Product Tag	int	no	no
virtual	Virtual	bool	yes	no
apiEnabled	Valid in API	bool	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

Values for type

Value	Name
0	Customized
1	Money
2	Card
3	Transfer
4	Direct debit
5	Gateway
6	Deposit
7	Voucher
8	Opera

Product

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	yes	no
image	Image	image	no	no
price	Price	currency	yes	no
taxes	Taxes	manyToMany	no	no
tags	Tags	manyToMany	no	no
perHour	By hours	bool	yes	no
subfamily	Subfamily	int	no	no
roundingError		bool	yes	no
priority	Priority	int	no	no
sid		string	yes	no
account	Accounting account	string	no	no
divisible	Divisible	bool	yes	no
shipping	Shipping costs	bool	yes	no
ballsQuantity	Balls amount	int	no	no
hasIngredients	Has ingredients	bool	yes	no
barcode	Barcode	string	no	no
sku	SKU code	string	no	no
supplier	Supplier	int	no	no
supplierBarcode	Supplier barcode	string	no	no
useStock	Manage stock	bool	yes	no
costPrice	Last purchase price	currency	no	yes
inDeposit	In deposit	bool	yes	no
buyTax	Purchase tax	int	no	no
baseProduct	Base product	int	no	no
basePercent	Base percentage	percent	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

Product tag

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	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

ProductToTag

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
product		int	yes	no
productTag		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

Sale

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	no	no
customer	Customer	int	no	no
customerTaxNumber	ID	string	no	no
beneficiary	Beneficiary	int	no	no
paidFor	Paid to	int	no	yes
taxExempt	Tax exempt	bool	yes	yes
description	Description	string	yes	no
product	Product	int	yes	no
price	Unit price	currency	yes	no
units	Units	float	yes	no
discountRate	% Discount	percent	yes	no
taxes	Taxes	SaleTax[]	no	no
total	Total	currency	yes	no
totalBeforeTaxes	Total before taxes	currency	yes	no
allowPaymentPending	Allow pending payment	bool	yes	no
status	Status	select	yes	yes
cancelationOf	Cancellation of	int	no	yes
parent	Line on which it depends	int	no	yes
link	Linked to	int	no	yes
dueDate	Due date	date	yes	no
useDate	Production date	datetime	yes	no
timeout	Expiration	datetime	no	no
fkModel		fkModel	no	yes
fkId		int	no	yes
online	Online	bool	yes	yes
company	Company	int	no	no
comments	Observations	text	no	no
publicComments	Public comments	text	no	no
invoice	Invoice	int	no	yes
proforma	Proforma	int	no	yes
invoiced	Billed	bool	yes	yes
invoiceDate	Invoice date	date	no	yes
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 status

Value	Name
0	Draft
1	For free
2	Not paid
3	Paid
4	Discarded
5	Cancellation

Subfamily

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
family	Family	int	yes	no
name	Name	string	yes	no
code	Code	string	no	no
company	Company	int	no	no
supply	Supplies	bool	yes	no
account	Accounting account	string	no	no
recommendedTag	Recommended products	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