Error
A valid request URL is required to generate request examples{
"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"
},
{
"amountCents": 70000,
"at": "2026-07-28T10:00:00.000Z"
}
],
"status": "settled",
"actorId": "user-cashier-1",
"createdAt": "2026-07-28T09:00:00.000Z"
}{
"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
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Checkout
Settle a deposit (acompte)
Settles a fully-paid open deposit (acompte), flipping it to settled — the terminal state that closes the down-payment once the special order is collected. Sends no body; the deposit is addressed by the PATH id. 404s for an unknown deposit; 422s when the deposit still carries a non-zero outstanding balance, or is already settled.
POST
/
v1
/
deposits
/
{depositId}
/
settle
Error
A valid request URL is required to generate request examples{
"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"
},
{
"amountCents": 70000,
"at": "2026-07-28T10:00:00.000Z"
}
],
"status": "settled",
"actorId": "user-cashier-1",
"createdAt": "2026-07-28T09:00:00.000Z"
}{
"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
}
}{
"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.
Path Parameters
Id of the deposit (acompte) to read or transition.
Minimum string length:
1Response
The deposit, now settled.
The deposit, now settled.
Required range:
0 < x <= 9007199254740991Show child attributes
Show child attributes
Available options:
open, settled 
