Skip to main content

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

EntityFileSummary
Customercustomer.jsonCustomer master data, marketing, order metrics
Fulfillmentfullfillment.jsonShipment payload, line items, tracking
Inventoryinventory.jsonSKU quantity at a location
Price listpriceList.jsonPrice and compare-at price for a SKU
Orderorder.jsonFull order with lines, payments, returns, refunds
Productproduct.jsonCatalog with variants, media, metafields
Product translationproductTranslation.jsonLocale-keyed product content

Open the E-commerce pages in the sidebar for full explanations, the complete JSON sample, and operational notes.

CRM area

EntityFileSummary
Contactcontact.jsonPerson, account, role, and channels
Leadlead.jsonInbound contact, status, score, owner
Opportunityopportunity.jsonDeal, amount, stage, line items
Prospectprospect.jsonTarget organization, firmographics, address
Quotequote.jsonOffer with lines and totals

Open the CRM pages in the sidebar for full explanations, the complete JSON sample, and operational notes.

ERP area

EntityFileSummary
Delivery notedeliveryNote.jsonGoods issue, sales order link, tracking
Purchase invoicepurchaseInvoice.jsonVendor bill, PO link, totals
Purchase orderpurchaseOrder.jsonSupplier order, lines and receipts
Sales invoicesalesInvoice.jsonCustomer invoice, order and delivery note
Sales ordersalesOrder.jsonCustomer 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).

EntityFileSummary
Addressaddress.jsonStreet, number, locality, postal code, country, coordinates
Countrycountry.jsonISO codes, default currency and tax hints
Locationlocation.jsonOperational 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.

EntityFileSummary
Employeeemployee.jsonStaff master record, role, manager, work location
Position / job titleposition.jsonOrganizational role (e.g. Warehouse Manager)
Leave requestleaveRequest.jsonVacation, leave, sick days (dates and workflow)

Open the HR pages in the sidebar for full explanations, the complete JSON sample, and operational notes.