A valid request URL is required to generate request examples{
"items": [
{
"id": "dep-ok",
"orderId": "order-1",
"customerId": "cust-1",
"customerName": "Camille Laurent",
"storeId": "store-rivoli",
"currency": "EUR",
"orderTotalCents": 100000,
"payments": [
{
"amountCents": 30000,
"at": "2026-07-28T09:00:00.000Z"
}
],
"status": "open",
"actorId": "user-cashier-1",
"createdAt": "2026-07-28T09:00:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 20,
"pageCount": 1
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}List deposits (acomptes)
Returns one page of the special-order down-payments (acomptes), optionally narrowed by store and/or status (open | settled). Use page/pageSize (max 100) to walk the result; total/pageCount tell you when to stop.
A valid request URL is required to generate request examples{
"items": [
{
"id": "dep-ok",
"orderId": "order-1",
"customerId": "cust-1",
"customerName": "Camille Laurent",
"storeId": "store-rivoli",
"currency": "EUR",
"orderTotalCents": 100000,
"payments": [
{
"amountCents": 30000,
"at": "2026-07-28T09:00:00.000Z"
}
],
"status": "open",
"actorId": "user-cashier-1",
"createdAt": "2026-07-28T09:00:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 20,
"pageCount": 1
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.
Query Parameters
1-based page index to return. Defaults to 1.
1 <= x <= 9007199254740991Rows per page, 1..100. Defaults to 20.
1 <= x <= 100Narrow to one store's deposits (acomptes) by store id.
Filter by lifecycle status: open | settled.
open, settled Response
A page of deposits with the pagination totals.
A page of deposits with the pagination totals.
The rows on this page, in the query's sort order.
Show child attributes
Show child attributes
Total rows matching the filter across ALL pages, not just this one.
0 <= x <= 9007199254740991The 1-based page number served.
0 < x <= 9007199254740991Rows requested per page.
0 < x <= 9007199254740991Total number of pages; stop walking when page reaches it.
0 <= x <= 9007199254740991