Brief

A Brief represents a packaging request/quote containing one or more configured products (BriefElements). It includes configuration details, logistics information, and computed pricing data. The brief serves as the root entity for packaging requests and automatically generates price predictions and manufacturing process recommendations when submitted.

Main Purpose

• Capture client packaging requirements and specifications
• Group multiple products (BriefElements) into a single request
• Track logistics and delivery preferences
• Manage packing and pallet configurations
• Monitor pricing calculation status and CAD file generation

Key Properties

Property	Type	Description
id	UUID	Unique identifier
code	number	Sequential brief identifier (auto-generated)
name	string	Brief name
predictionStatus	PredictionStatus	Async pricing status (PENDING, PROCESSING, COMPLETED, FAILED)
hasPrice	boolean	Pricing complete flag
packingType	PackingTypeName	Packing type (BOX_CASE, BUNDLE)
palletType	PalletTypeName	Pallet type (EURO, STANDARD, CUSTOM)
deliveryDecision	boolean	Delivery requested
intercom	Intercom	International commercial terms (EXW, FOB, CIF, etc.)
createdAt	Date	Creation timestamp
updatedAt	Date	Last update timestamp

Main Relationships

Relationship	Entity	Type	Description
briefElements	BriefElement	One-to-Many	Configured products in this brief (required, min: 1)
briefComputed	BriefComputed	One-to-One	Computed pricing and logistics data
predictionRequest	BriefPrice	One-to-One	Pricing request details (also known as BriefPrice)
project	Project	Many-to-One	Associated project
company	Company	Many-to-One	Associated company
status	Status	Many-to-One	Workflow status
user	User	Many-to-One	Creator
quoteItems	QuoteItem	One-to-Many	Quote items created from this brief
deliveryAddress	Address	Many-to-One	Delivery address

Workflow

1. Create brief with one or more BriefElements
2. Submit for processing (pricing calculation begins)
3. Monitor predictionStatus until COMPLETED
4. Access pricing via predictionRequest
5. Access logistics via briefComputed
6. Convert to Quote if accepted

Related Endpoints

• POST /briefs - Create brief (synchronous)
• POST /briefs/async - Create brief (asynchronous)
• GET /briefs/:id - Get basic brief data
• GET /briefs/:id/details - Get complete brief with all relations
• PUT /briefs/:id - Update brief
• DELETE /briefs/:id - Soft delete brief

See Also

• BriefElement - Individual products within a brief
• BriefComputed - Computed logistics data
• BriefPrice - Pricing and prediction data
• Brief Integration Guide - Complete integration documentation