Invoicing Models

Invoice

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
type	Type	int	yes	no
customer	Customer	int	no	no
paidFor	Paid to	int	no	no
name	Name or Social reason	string	no	no
taxNumber	Tax number	string	no	no
address	Address	text	no	no
street	Street	string	no	no
street2	Street 2	string	no	no
zipCode	Zip Code	string	no	no
city	City	string	no	no
regionName	Region	string	no	no
country	Country	int	no	no
countryIsoCode	Country	string	no	no
countryName	Country	string	no	no
company	Company	int	no	no
companyName	Company name	string	no	no
companyTaxNumber	NIF company	string	no	no
companyAddress	Company address	text	no	no
companyStreet	Company street	string	no	no
companyStreet2	Company street 2	string	no	no
companyZipCode	Company Zip Code	string	no	no
companyCity	Company city	string	no	no
companyRegionName	Company region	string	no	no
companyCountry	Country	int	no	no
companyCountryIsoCode	Company Country Code	string	no	no
companyCountryName	Company country	string	no	no
companyPhone	Company telephone	string	no	no
guid		string	yes	yes
number	Invoice number	string	no	yes
sequenceNumber	Number	int	no	no
counter	Serie	int	no	no
totalBeforeTaxes	Total before taxes	currency	yes	yes
total	Total	currency	yes	yes
pending	Pending	currency	yes	yes
discounts	Discounts	currency	yes	yes
companyInfo	Company information	text	no	no
date	Date	date	no	no
dueDate	Due date	date	no	yes
lines	Lines	InvoiceLine[]	yes	no
taxExempt	Tax exempt	bool	yes	no
taxes		InvoiceTax[]	no	no
publicComments	Public comments	text	no	no
comments	Observations	text	no	no
isCreditNote	It is cancellation	bool	yes	yes
isInternal	It is internal	bool	yes	yes
isReceipt	It is receipt	bool	yes	yes
isProforma	It is proforma	bool	yes	yes
isSummary	It is global	bool	yes	yes
isReplace	Exchange invoice	bool	yes	no
manual	Created manually	bool	yes	yes
online	Created online	bool	yes	yes
printed	Printed	bool	yes	yes
purchaseOrder	Order number	string	no	no
status	Status	select	yes	yes
paymentCondition	Payment conditions	select	no	yes
paymentStatus	Payment status	select	no	yes
sendStatus	Shipping status	select	no	yes
paymentMethods	Payment methods	string	no	yes
initialized		bool	yes	yes
convertedTo	Converted to	int	no	yes
summaryInvoice	Global	int	no	yes
source	Original	int	no	yes
convertedFrom		int	no	yes
originalNumber	Original number	string	no	yes
skipValidations	Ignore validations	bool	yes	no
convertibleInto		int	no	no
pricesTaxIncluded		bool	yes	no
discountColumn		bool	yes	no
convertibleIntoName		string	no	no
relations		Invoice[]	no	no
document		blob	no	yes
paymentMethod		int	yes	no
logo		string	yes	no
copyNumber		string	yes	no
payments		InvoicePayment[]	yes	no
discountTotal		float	yes	no
customerStreet1		string	yes	no
customerStreet2		string	yes	no
customerCity		string	yes	no
customerRegion		string	yes	no
customerZipcode		string	yes	no
customerCountry		string	yes	no
companyEmail		string	yes	no
companyWeb		string	yes	no
companyCost		string	yes	no
currency		string	yes	no
copyLabels		any[]	yes	no
numberOfCopies		int	yes	no
invoiceFooterText		string	yes	no
taxTotal		float	yes	no
skipRecalculate		bool	yes	no
customerMemberCode		string	yes	no
data		any	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

Values for status

Value	Name
0	Draft
1	Confirmed
2	Discarded

Values for paymentCondition

Value	Name
0	Early payment
1	15 days
2	30 days
3	60 days
4	90 days

Values for paymentStatus

Value	Name
0	Not paid
1	Partially paid
2	Paid

Values for sendStatus

Value	Name
1	Sending pending
2	Sent
3	Shipping error

Invoice line

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
invoice	Invoice	int	yes	yes
invoiceStatus	Invoice	int	yes	no
description	Description	string	yes	no
product	Product	int	no	no
price	Price	currency	yes	no
priceBeforeTaxes	Price without taxes	currency	yes	no
units	Units	float	yes	no
minutes	Minutes	int	yes	no
taxes	Taxes	InvoiceLineTax[]	yes	no
tax	Taxes	string	no	no
discountRate	% Discount	percent	yes	no
taxRate	Taxes	percent	yes	no
taxAmount	Tax Amount	currency	yes	yes
totalBeforeTaxes	Total before taxes	currency	yes	no
total	Total	currency	yes	no
canceled	Discarded	bool	yes	yes
credited	Subscriber	currency	yes	no
allowPaymentPending	Allow pending payment	bool	yes	no
parentLine		int	no	no
uuid		any	yes	no
parentUuid		any	yes	no
parent		InvoiceLine	no	no
useDate	Production date	datetime	no	no
timeout	Expiration	datetime	no	yes
supply	Supply	bool	yes	no
hasChildren		bool	yes	no
source	Original line	int	no	no
sourceInvoice	Original invoice	string	yes	no
sale	Sale	int	no	no
fkModel		fkModel	no	yes
fkId		int	no	no
parentFkModel		fkModel	no	yes
parentFkId		int	no	yes
options		any[]	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

Invoice payment

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
receipt	Invoice	int	no	no
invoice	Invoice	int	yes	no
paymentMethod	Payment method	int	yes	no
payment	Payment	int	no	no
amount	Amount	currency	yes	no
comments	Observations	text	no	no
isFTR	Of invoice receipt	bool	yes	no
salePayment		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

Invoice series

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
company	Company	int	no	no
type	Type	int	yes	no
format	Format	string	no	no
zeros	Number of ceros to the left	int	yes	no
prefix	Prefix	bool	yes	no
initialValue	Initial value	int	no	no
lastValue	Last value	int	yes	no
lastDate	Last date	date	no	no
reset	Reset	select	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 reset

Value	Name
1	Year

Invoice type

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
code	Code	string	no	no
name	Name	string	yes	no
reverseType	Cancellation by	int	no	no
convertibleInto	Convertible into	int	no	no
isReceipt	Invoice receipt	bool	yes	no
isCreditNote	Rectifying invoice	bool	yes	no
isProforma	Proforma invoice	bool	yes	no
isInternal	Internal document	bool	yes	no
isSummary	Global invoice	bool	yes	no
isReplace	Exchange invoice	bool	yes	no
preventNegative	Prevent negative total	bool	yes	no
preventPositive	Prevent positive total	bool	yes	no
preventPositiveLines	Prevent positive lines	bool	yes	no
preventNegativeLines	Prevent negative lines	bool	yes	no
skipValidations	Ignore validations	bool	yes	no
maxAmount	Maximum limit	currency	no	no
customerRequired	Require a client	bool	yes	no
taxNumberRequired	Require Tax Number ID	bool	yes	no
addressRequired	Require an address	bool	yes	no
allowReceipts	Allows receipts	bool	yes	no
template	Invoice template A4	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

Receipt

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
customer	Customer	int	no	no
number	Receipt number	string	yes	no
sequenceNumber	Number	int	yes	no
amount	Amount	currency	yes	no
comments	Observations	text	no	no
payments		InvoicePayment[]	yes	no
isFTR	Of invoice receipt	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