Skip to main content

List Financial Alerts

GET 
/api/financial-alerts

Returns a paginated list of financial alerts (low margin or loss alerts on sales order lines). Uses Spatie QueryBuilder for filtering and sorting.

Authentication: Requires Bearer token.

Available sorts: id, created_at, updated_at, alert_type, note, archived_at, total_revenue, cogs, cogs_returned, cost_allocated, total_cost, profit, profit_margin, salesOrder, sku, classification

Default sort: -created_at (newest first)

Alert types: LOSS (profit < 0), LOW_MARGIN (profit >= 0 but margin below threshold)

Request​

Responses​

Successful response