BriefComputed
BriefComputed contains computed formulas for the product and the result design when the product is from a CAD (Computer-Aided Design) system. It also stores logistical computations including packing configurations, pallet specifications, delivery costs, and handling costs. This entity does not include pricing information - prices are stored in BriefPrice.
Main Purpose
Section titled “Main Purpose”- Store computed product formulas and CAD design results
- Execute standard formulas when product is CAD-based
- Calculate logistics data for the brief
- Calculate delivery costs based on region and weight
- Determine packing and bundling requirements
- Compute pallet configurations and counts
- Provide logistical cost breakdowns (excluding pricing)
Key Properties
Section titled “Key Properties”Core Properties
Section titled “Core Properties”| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier |
createdAt | Date | Creation timestamp |
updatedAt | Date | Update timestamp |
Logistics Data
Section titled “Logistics Data”| Property | Type | Description |
|---|---|---|
packing_type | enum | Packing type (BOX_CASE, BUNDLE) |
pallet_type | enum | Pallet type (EURO, STANDARD, CUSTOM) |
pallet_format | AliciaPalletFormat | Computed pallet format |
allow_pallet_stacking | boolean | Stacking allowed |
max_overhang_pallet | number | Max overhang (mm) |
max_underload_pallet | number | Max underload (kg) |
Cost Computations
Section titled “Cost Computations”| Property | Type | Description |
|---|---|---|
delivery_costs | ComputedDeliveryCost | Delivery cost breakdown |
logistic_costs | ComputedLogisticCost | Logistics cost breakdown |
Main Relationships
Section titled “Main Relationships”| Relationship | Entity | Type | Description |
|---|---|---|---|
brief | Brief | One-to-One | Parent brief |
briefElements | BriefElementComputed[] | One-to-Many | Computed data for each element |
Schema Types
Section titled “Schema Types”ComputedDeliveryCost:
{ baseRate: number; // Base delivery rate distanceCost: number; // Distance-based cost weightCost: number; // Weight-based cost palletCount: number; // Number of pallets totalCost: number; // Total delivery cost deliveryTime: number; // Estimated days}ComputedLogisticCost:
{ packingCost: number; // Packing cost bundlingCost: number; // Bundling cost palletizationCost: number; // Palletization cost handlingCost: number; // Handling cost totalCost: number; // Total logistics cost}AliciaPalletFormat:
- Contains computed pallet specifications including dimensions and capacity
Use Cases
Section titled “Use Cases”- CAD Product Processing: Access computed formulas and design results for CAD-based products
- Standard Formula Execution: Get results of standard product formulas applied to the brief
- Calculate Delivery Costs: Get total delivery cost based on region, distance, weight, and pallet count
- Determine Packing Requirements: Understand how products will be packed and palletized
- Logistics Planning: Access detailed breakdown of logistics costs for budgeting (excluding pricing)
- ERP Integration: Map delivery and logistics costs to ERP logistics module
Important Notes
Section titled “Important Notes”- Does NOT include pricing: Pricing information is stored in BriefPrice, not BriefComputed
- CAD Integration: Contains computed design results when products are CAD-based
- Formula Results: Stores the output of standard product formulas
- Logistics Only: Focuses on physical logistics, packing, and delivery calculations
Accessing Data
Section titled “Accessing Data”BriefComputed data is included when fetching brief details:
GET /briefs/:id/detailsReturns brief with nested briefComputed object containing all logistics calculations.
Related Endpoints
Section titled “Related Endpoints”GET /briefs/:id/details- Get complete brief including BriefComputed
See Also
Section titled “See Also”- Brief - Parent brief entity
- BriefElementComputed - Computed element data
- Brief Integration Guide - Complete integration documentation