Integration Model

Data Transfer Objects (DTOs) java library for comerzzia integrations. This project contains typed data models that define the message structure exchanged between external ERP systems and comerzzia.

Purpose

This library provides validated, typed models for bidirectional ERP integration:

Technologies

  • Java 8+

  • Jackson: JSON/XML serialization

  • Bean Validation API: Data validation

  • JAXB: JAXB annotations for XSD schema generation

  • Maven: Dependency management

<dependency>
  <groupId>com.comerzzia.integrations</groupId>
  <artifactId>comerzzia-model</artifactId>
  <version>1.3</version>
</dependency>

Features

  • Automatic Validation: Bean Validation API (@NotNull, @Valid, etc.)

  • JSON/XML Serialization: Jackson-compatible

  • XSD Schema Generation: For XML validation

  • Type Safety: Strongly typed models with clear contracts

  • Javadoc Documentation: Comprehensive inline documentation

ERP to comerzzia (Inbound)

Data flowing from external ERP systems into comerzzia:

  • Catalog: Product catalog management

    • Items, barcodes, prices, tags, brands

    • Promotions model

    • Categories, families, sections, suppliers

    • Measurement units, taxes

    • Sales channel configuration

  • Sales: Sales documents input

    • Sales documents

    • Sales documents files and attachments

  • Warehouse: Inventory and stock management

    • Stock levels by location

    • Inventory movements

    • Warehouse operations

comerzzia to ERP (Outbound)

Data flowing from comerzzia back to external ERP systems:

  • ETicket: Sales documents issued by comerzzia

    • Ticket headers and lines

    • Payment information

    • Customer data

  • CashJournal: Cash register journal

    • Payment transactions

    • Cash movements

    • Daily closing information

OpenAPI model structure

OpenAPI endpoints and model for input

XSD Schemas for XML

XSD schemas for XML:

JSON Schemas

json-schema format:

Breaking Changes

Version-specific breaking changes:

Related Projects