u
This commit is contained in:
@@ -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`
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user