feat: implement global meta schema for credit module with audit information

app/credit_debit_notes/controllers/router.py

@@ -5,9 +5,11 @@ Complete invoice adjustment lifecycle endpoints
 import logging
 from typing import List, Dict, Any, AsyncGenerator
 from uuid import UUID
+from attrs import inspect
 from fastapi import APIRouter, Depends, HTTPException, status, Query
 from sqlalchemy.ext.asyncio import AsyncSession
 
+from app.core.utils import format_meta_field
 from app.sql import async_session
 from app.dependencies.auth import get_current_user, TokenUser
 from app.credit_debit_notes.services.service import CreditDebitNoteService
@@ -77,12 +79,13 @@ async def create_adjustment_note(
                     "errors": error_messages
                 }
             )
-        
+        formated_data = format_meta_field(note)
         return AdjustmentNoteCreateResponse(
             success=True,
             message="Draft adjustment note created successfully",
             note_id=note.note_id,
-            note_no=note.note_no
+            note_no=note.note_no,
+            data=formated_data
         )
         
     except HTTPException:
@@ -95,7 +98,7 @@ async def create_adjustment_note(
         )
 
 
-@router.get("/{note_id}", response_model=AdjustmentNoteDetailRead)
+@router.get("/{note_id}", response_model=dict)
 async def get_adjustment_note(
     note_id: UUID,
     include_logs: bool = Query(True, description="Include status logs"),
@@ -152,6 +155,9 @@ async def get_adjustment_note(
             "rejected_at": note.rejected_at,
             "applied_by": note.applied_by,
             "applied_at": note.applied_at,
+            "created_by_username": note.created_by_username,
+            "updated_by_username": note.updated_by_username,
+            "updated_by": note.updated_by,
             "status_logs": []
         }
         
@@ -169,9 +175,10 @@ async def get_adjustment_note(
                 }
                 for log in note.status_logs
             ]
-        
-        return AdjustmentNoteDetailRead(**response_data)
-        
+        response = AdjustmentNoteDetailRead(**response_data)
+        formated_data = format_meta_field(response.model_dump())
+        return formated_data
+
     except HTTPException:
         raise
     except Exception as e:
@@ -182,7 +189,7 @@ async def get_adjustment_note(
         )
 
 
-@router.put("/{note_id}", response_model=AdjustmentNoteActionResponse)
+@router.put("/{note_id}")
 async def update_adjustment_note(
     note_id: UUID,
     note_data: AdjustmentNoteUpdate,
@@ -217,12 +224,18 @@ async def update_adjustment_note(
                     "errors": error_messages
                 }
             )
-        
+        note_dict = {
+        column.key: getattr(note, column.key)
+        for column in inspect(note).mapper.column_attrs
+            }
+
+        formated_data = format_meta_field(note_dict)
         return AdjustmentNoteActionResponse(
             success=True,
             message="Adjustment note updated successfully",
             note_id=note.note_id,
-            new_status=note.status
+            new_status=note.status,
+            data=formated_data
         )
         
     except HTTPException:
@@ -268,42 +281,49 @@ async def list_adjustment_notes(
             db=db,
             filter_request=filter_request
         )
-        
-        notes_data = [
-            AdjustmentNoteRead(
-                note_id=note.note_id,
-                note_no=note.note_no,
-                invoice_id=note.invoice_id,
-                supplier_id=note.supplier_id,
-                buyer_id=note.buyer_id,
-                category_code=note.category_code,
-                reason_code=note.reason_code,
-                note_type=note.note_type,
-                note_date=note.note_date,
-                original_amount=note.original_amount,
-                revised_amount=note.revised_amount,
-                adjustment_amount=note.adjustment_amount,
-                taxable_amount=note.taxable_amount,
-                original_tax_rate=note.original_tax_rate,
-                correct_tax_rate=note.correct_tax_rate,
-                tax_adjustment_amt=note.tax_adjustment_amt,
-                description=note.description,
-                remarks=note.remarks,
-                status=note.status,
-                created_by=note.created_by,
-                created_at=note.created_at,
-                updated_at=note.updated_at,
-                submitted_by=note.submitted_by,
-                submitted_at=note.submitted_at,
-                approved_by=note.approved_by,
-                approved_at=note.approved_at,
-                rejected_by=note.rejected_by,
-                rejected_at=note.rejected_at,
-                applied_by=note.applied_by,
-                applied_at=note.applied_at
-            )
-            for note in notes
-        ]
+
+        notes_data = []
+
+        for note in notes:
+            # Convert ORM object to dict
+            note_dict = {
+                "note_id": note.note_id,
+                "note_no": note.note_no,
+                "invoice_id": note.invoice_id,
+                "supplier_id": note.supplier_id,
+                "buyer_id": note.buyer_id,
+                "category_code": note.category_code,
+                "reason_code": note.reason_code,
+                "note_type": note.note_type,
+                "note_date": note.note_date,
+                "original_amount": note.original_amount,
+                "revised_amount": note.revised_amount,
+                "adjustment_amount": note.adjustment_amount,
+                "taxable_amount": note.taxable_amount,
+                "original_tax_rate": note.original_tax_rate,
+                "correct_tax_rate": note.correct_tax_rate,
+                "tax_adjustment_amt": note.tax_adjustment_amt,
+                "description": note.description,
+                "remarks": note.remarks,
+                "status": note.status,
+                "created_by": note.created_by,
+                "created_by_username": note.created_by_username,
+                "created_at": note.created_at,
+                "updated_by": note.updated_by,
+                "updated_by_username": note.updated_by_username,
+                "updated_at": note.updated_at,
+                "submitted_by": note.submitted_by,
+                "submitted_at": note.submitted_at,
+                "approved_by": note.approved_by,
+                "approved_at": note.approved_at,
+                "rejected_by": note.rejected_by,
+                "rejected_at": note.rejected_at,
+                "applied_by": note.applied_by,
+                "applied_at": note.applied_at,
+            }
+            formatted_note = format_meta_field(note_dict)
+            notes_data.append(formatted_note)
+
         page = (filter_request.skip // filter_request.limit) + 1 if filter_request.limit else 1
 
         return {
@@ -364,14 +384,15 @@ async def perform_note_action(
                     "errors": error_messages
                 }
             )
-        
+        formatted_data = format_meta_field(note.__dict__)
         message = ACTION_MESSAGES.get(action_request.action, "Action completed successfully")
         
         return AdjustmentNoteActionResponse(
             success=True,
             message=message,
             note_id=note.note_id,
-            new_status=note.status
+            new_status=note.status,
+            data=formatted_data
         )
         
     except HTTPException:

app/credit_debit_notes/models/model.py

@@ -75,6 +75,8 @@ class ScmInvoiceAdjustmentNote(Base):
     updated_at = Column(DateTime(timezone=True), nullable=False, server_default=func.now(), onupdate=func.now())
     
     # Approval tracking
+    updated_by = Column(String(64), nullable=True)
+    updated_by_username = Column(String(64), nullable=True)
     submitted_by = Column(String(64), nullable=True)
     submitted_at = Column(DateTime(timezone=True), nullable=True)
     approved_by = Column(String(64), nullable=True)

app/credit_debit_notes/schemas/schema.py

@@ -179,8 +179,12 @@ class AdjustmentNoteDetailRead(BaseModel):
     rejected_by: Optional[str]
     rejected_at: Optional[datetime]
     applied_by: Optional[str]
+    updated_by: Optional[str]
+    updated_by_username: Optional[str]
+    created_by_username: Optional[str]
     applied_at: Optional[datetime]
     status_logs: Optional[List[AdjustmentNoteStatusLogRead]] = None
+    meta: Optional[Dict[str, Any]] = None  # For any additional metadata
 
     class Config:
         from_attributes = True
@@ -238,6 +242,7 @@ class AdjustmentNoteCreateResponse(BaseModel):
     message: str
     note_id: UUID
     note_no: str
+    data:dict
 
     class Config:
         json_schema_extra = {
@@ -256,6 +261,7 @@ class AdjustmentNoteActionResponse(BaseModel):
     message: str
     note_id: UUID
     new_status: str
+    data:dict
 
     class Config:
         json_schema_extra = {
@@ -333,4 +339,4 @@ class ReasonsByCategoryResponse(BaseModel):
                     {"code": "OVERCHARGE", "description": "Overcharge Correction"}
                 ]
             }
-        }
+        }

app/credit_debit_notes/services/service.py

@@ -260,7 +260,7 @@ class CreditDebitNoteService:
                 return None, errors
         
         note.updated_at = datetime.now()
-        
+        note.updated_by = updated_by
         await db.commit()
         await db.refresh(note)