Company
A Company represents a client organization. It serves as the top-level entity for organizing all business relationships, projects, briefs, quotes, and articles associated with a specific customer.
Main Purpose
Section titled “Main Purpose”- Represent client organizations
- Group all customer-related entities
- Manage customer relationships
- Organize business activities by client
- Support multi-tenant architecture
Main Relationships
Section titled “Main Relationships”| Relationship | Entity | Type | Description |
|---|---|---|---|
projects | Project[] | One-to-Many | Company projects |
briefs | Brief[] | One-to-Many | Company briefs |
quotes | Quote[] | One-to-Many | Company quotes |
articles | Article[] | One-to-Many | Company articles |
users | User[] | One-to-Many | Company users |
addresses | Address[] | One-to-Many | Company addresses |
Hierarchy
Section titled “Hierarchy”Company ├── Projects │ ├── Briefs │ └── Quotes ├── Articles (from briefs or standalone) ├── Users └── AddressesUse Cases
Section titled “Use Cases”- Customer Management: Centralize all customer data under company entity
- Multi-Tenant Access: Isolate data by company for security
- Reporting: Aggregate all business activities by customer
- ERP Integration: Map companies to ERP customer master data
- User Access Control: Manage user access at company level
ERP Integration
Section titled “ERP Integration”Field Mapping:
| HIPE Field | ERP Field | Notes |
|---|---|---|
company.id | External Reference ID | Store for traceability |
company.name | Customer Name | |
company.code | Customer Number | If available |
company.externalId | ERP Customer ID | Primary mapping field |
Recommended Sync Order:
- Companies → ERP Customers (first)
- Projects → ERP Projects/Orders
- Briefs → ERP Packaging Requests
- Quotes → ERP Quotes
Data Flow
Section titled “Data Flow”All packaging-related activities start with a Company:
- Company created/synced
- Project created for business opportunity
- Brief created to define packaging requirements
- Quote generated from brief
- Articles created from accepted briefs for production
Related Endpoints
Section titled “Related Endpoints”GET /companies- Get paginated companiesGET /companies/:id- Get company detailsPOST /companies- Create companyPUT /companies/:id- Update company
See Also
Section titled “See Also”- Project - Projects within company
- Brief - Briefs within company
- Brief Integration Guide - Complete integration documentation