Entities
Entities in Flowlyze are canonical data models used in integration flows (import, export, transforms) between sources and destinations. Each definition is documented with a JSON example that matches the file under static/assets/entities/.
Asset layout
- Business area: a folder under
static/assets/entities/(e.g.ecommerce). The folder name is the area slug (lowercase, no spaces). - One file per entity:
static/assets/entities/<area>/<entity>.json— the reference schema and samples must stay valid JSON and aligned with product behavior.
E-commerce area
| Entity | File | Summary |
|---|---|---|
| Customer | customer.json | Customer master data, marketing, order metrics |
| Fulfillment | fullfillment.json | Shipment payload, line items, tracking |
| Inventory | inventory.json | SKU quantity at a location |
| Price list | priceList.json | Price and compare-at price for a SKU |
| Order | order.json | Full order with lines, payments, returns, refunds |
| Product | product.json | Catalog with variants, media, metafields |
| Product translation | productTranslation.json | Locale-keyed product content |
Open the E-commerce pages in the sidebar for full explanations, the complete JSON sample, and operational notes.
CRM area
| Entity | File | Summary |
|---|---|---|
| Contact | contact.json | Person, account, role, and channels |
| Lead | lead.json | Inbound contact, status, score, owner |
| Opportunity | opportunity.json | Deal, amount, stage, line items |
| Prospect | prospect.json | Target organization, firmographics, address |
| Quote | quote.json | Offer with lines and totals |
Open the CRM pages in the sidebar for full explanations, the complete JSON sample, and operational notes.
ERP area
| Entity | File | Summary |
|---|---|---|
| Delivery note | deliveryNote.json | Goods issue, sales order link, tracking |
| Purchase invoice | purchaseInvoice.json | Vendor bill, PO link, totals |
| Purchase order | purchaseOrder.json | Supplier order, lines and receipts |
| Sales invoice | salesInvoice.json | Customer invoice, order and delivery note |
| Sales order | salesOrder.json | Customer order, lines and warehouse |
Open the ERP pages in the sidebar for full explanations, the complete JSON sample, and operational notes.
Organization area
The organization area (static/assets/entities/organization/) groups geographic and organizational master data: country (macro rules), address (structured place), location (generic container for sites, offices, warehouses, and similar via kind).
| Entity | File | Summary |
|---|---|---|
| Address | address.json | Street, number, locality, postal code, country, coordinates |
| Country | country.json | ISO codes, default currency and tax hints |
| Location | location.json | Operational place; kind selects site / office / warehouse |
Open the Organization section in the sidebar (label Organizzazione in the default Italian UI) for full explanations, the complete JSON sample, and operational notes.
HR area
The hr area (static/assets/entities/hr/) covers people master data, job definitions, and absence workflows.
| Entity | File | Summary |
|---|---|---|
| Employee | employee.json | Staff master record, role, manager, work location |
| Position / job title | position.json | Organizational role (e.g. Warehouse Manager) |
| Leave request | leaveRequest.json | Vacation, leave, sick days (dates and workflow) |
Open the HR pages in the sidebar for full explanations, the complete JSON sample, and operational notes.