Invoicex v1.0.0-rc.4 API Reference

Modules

Main invoicex module

A helper module for Document context

Stores address data presented on invoice

Stores contact data presented on invoice

Group is a special type of Invoicex.Document.Invoice item. It allows to collect other items, but alos discount and taxes. It’s helpful if you want to organise and style items in invoice

Stores invoice data

Stores invoice item data

Optional data which could be add to Invoicex.Document.Invoice

Invoicex.Document.Invoice number allows to assign a generated number of specified type to invoice

A helper module for Ecommerce context

An e-commerce version of Invoicex.Document.Contact. The only difference is one extra fields which is useful

Defines discounts for Invoicex.Ecommerce.Source which belongs to specified Invoicex.Ecommerce.Region

Defines Invoicex.Document.Number interval. It created to simplify working with recurring invoices

Optional data which could be add to Invoicex.Document.Invoice

Regions keep relations to discounts and taxes for specified Invoicex.Ecommerce.Set of Invoicex.Ecommerce.Source

Set is simple group of Invoicex.Ecommerce.Region which is defined to separate selling regions for specified Invoicex.Ecommerce.Source type

Defines source schema.. Source basic information of invoice item source. For example type could be a database table name and value could be database row id

Covers lots of scenarios for working with various taxes

A helper e-commerce model to group addresses and invoices

Stores supported contact number types

This enum stores country codes provided by ex_cldr_territories hex package

This enum stores currencies provided by ex_cldr hex package

Stores event types that could be optionally used in Invoicex.Extra.Email in regard to invoice event notification

A helper module for Extra context

Helper model to store and validate contact numbers

Helper email model

Special model to store and validate moeny with currency or its percentage value

Stores edit and correct reasons in Invoicex.Document.Invoice

Extra embedded copy of Invoicex.Ecommerce.Tax which is used by Invoicex.Document.Group

Module which runs Invoicex-specific migrations