u

README.md

@@ -323,13 +323,31 @@ Company-scoped goods receipts on `manifest` / `manifestarticle` with fixed `type
 
 | Method | Signature | Returns |
 | --- | --- | --- |
-| `list` | `(googleAuthId)` | `DeliverySummary[]` |
+| `list` | `(googleAuthId, opts?: DeliveryListOpts)` | `DeliverySummary[] | WindowedDeliveries` |
 | `getById` | `(googleAuthId, id)` | `Delivery` |
 | `create` | `(googleAuthId, { date, supplierId?, externalNumber?, lines })` | `Delivery` |
 | `update` | `(googleAuthId, id, { number?, date?, supplierId?, externalNumber?, lines? })` | `Delivery` |
 | `delete` | `(googleAuthId, id)` | `void` |
+| `rebuildSummaries` | `(googleAuthId)` | `{ ok: boolean, companyId: number }` |
 
 ```ts
+type DeliveryListOpts = {
+  offset?: number,
+  limit?: number,
+  search?: string,
+  onlyUnbooked?: boolean,
+  supplierId?: number,
+  seekMonths?: number,
+}
+
+type WindowedDeliveries = {
+  deliveries: DeliverySummary[],
+  total: number,
+  unfilteredTotal: number,
+  offset: number,
+  limit: number,
+}
+
 type DeliverySummary = {
   id: number,
   number: string,
@@ -337,6 +355,31 @@ type DeliverySummary = {
   supplierId: number | null,   // manifest.entity_id
   externalNumber: string | null,   // manifest.external_number
   date: Date,
+  createdAt?: string,
+  supplierName?: string | null,
+  summary?: {
+    positions: number,
+    grossTotal: number,
+    netTotal: number,
+    totalQuantity: number,
+    stockPositions: number,
+    bookedPositions: number,
+    unbookedPositions: number,
+    stockQuantity: number,
+    bookedQuantity: number,
+    unbookedQuantity: number,
+    isBooked: boolean,
+  },
+  ledger?: {
+    totalPositions: number,
+    completelyOnLedgerPositions: number,
+    bookedPositions: number,
+    unbookedPositions: number,
+    totalQuantity: number,
+    bookedQuantity: number,
+    unbookedQuantity: number,
+    isBooked: boolean,
+  },
 }
 
 type DeliveryLine = {
@@ -779,7 +822,8 @@ Company-scoped number sequences (`numbers` table). Auth via selected company (`g
 | `PATCH /api/article/:sku/supplier/:id` | `articlesupplier.update(googleAuthId, sku, id, patch)` |
 | `PUT /api/article/:sku/supplier/order` | `articlesupplier.order(googleAuthId, sku, { ids })` |
 | `DELETE /api/article/:sku/supplier/:id` | `articlesupplier.delete(googleAuthId, sku, id)` |
-| `GET /api/delivery` | `delivery.list(googleAuthId)` |
+| `GET /api/delivery` | `delivery.list(googleAuthId, opts)` |
+| `POST /api/delivery/rebuild-summaries` | `delivery.rebuildSummaries(googleAuthId)` |
 | `GET /api/delivery/:id` | `delivery.getById(googleAuthId, id)` |
 | `POST /api/delivery` | `delivery.create(googleAuthId, { number, date, supplierId?, lines })` |
 | `PATCH /api/delivery/:id` | `delivery.update(googleAuthId, id, { number?, date?, supplierId?, lines? })` |