diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index 6991a19..4d00a4c 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -590,7 +590,7 @@ _none_ #### List orders — `GET /order` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` -- Returns: `200 { orders: T2[], total: int, offset: int, limit: int }` +- Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` - Params: `body: { number: str, date: str, lines: T30[], entityId?: int|null }` - Returns: `201 T1` diff --git a/docs/api/routes.md b/docs/api/routes.md index ceea607..d5b7dca 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -491,7 +491,7 @@ _none_ #### List orders — `GET /order` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` -- Returns: `200 { orders: T2[], total: int, offset: int, limit: int }` +- Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` - Params: `body: { number: str, date: str, lines: T27[], entityId?: int|null }` - Returns: `201 T1` diff --git a/docs/api/routes/order/list.md b/docs/api/routes/order/list.md index 807464d..9715d99 100644 --- a/docs/api/routes/order/list.md +++ b/docs/api/routes/order/list.md @@ -6,7 +6,7 @@ List orders Lists sales orders (`manifest` rows with `type = 'order'`) for the authenticated user's selected company. -Results are paged, include line items, shipping, payment, and provide total unpaged count. +Results are paged, include line items, shipping, payment, and provide total unpaged count as well as unfiltered count. ## Query parameters @@ -130,6 +130,7 @@ Order list } ], "total": 1, + "unfilteredTotal": 1, "offset": 1, "limit": 1 } diff --git a/src/api/routes/order.js b/src/api/routes/order.js index fde6cd5..4159844 100644 --- a/src/api/routes/order.js +++ b/src/api/routes/order.js @@ -44,7 +44,7 @@ export function register(app, basePath = '') { * description: | * Lists sales orders (`manifest` rows with `type = 'order'`) * for the authenticated user's selected company. - * Results are paged, include line items, shipping, payment, and provide total unpaged count. + * Results are paged, include line items, shipping, payment, and provide total unpaged count as well as unfiltered count. * security: * - cookieAuth: [] * parameters: @@ -93,7 +93,7 @@ export function register(app, basePath = '') { * application/json: * schema: * type: object - * required: [orders, total, offset, limit] + * required: [orders, total, unfilteredTotal, offset, limit] * properties: * orders: * type: array @@ -102,6 +102,9 @@ export function register(app, basePath = '') { * total: * type: integer * description: Total number of filtered orders + * unfilteredTotal: + * type: integer + * description: Total number of orders without any filters applied * offset: * type: integer * description: Number of orders skipped