Bug 26274: Add cashups api routes
[koha.git] / api / v1 / swagger / paths / cash_registers.json
1 {
2     "/cash_registers/{cash_register_id}/cashups": {
3         "get": {
4             "x-mojo-to": "CashRegisters::Cashups#list",
5             "operationId": "listCashups",
6             "tags": ["cash_registers", "cashups"],
7             "produces": ["application/json"],
8             "parameters": [{
9                     "$ref": "../parameters.json#/cash_register_id_pp"
10                 },
11                 {
12                     "$ref": "../parameters.json#/match"
13                 },
14                 {
15                     "$ref": "../parameters.json#/order_by"
16                 },
17                 {
18                     "$ref": "../parameters.json#/page"
19                 },
20                 {
21                     "$ref": "../parameters.json#/per_page"
22                 },
23                 {
24                     "$ref": "../parameters.json#/q_param"
25                 },
26                 {
27                     "$ref": "../parameters.json#/q_body"
28                 },
29                 {
30                     "$ref": "../parameters.json#/q_header"
31                 }
32             ],
33             "responses": {
34                 "200": {
35                     "description": "Cashups performed on this register",
36                     "schema": {
37                         "type": "array",
38                         "items": {
39                             "$ref": "../definitions.json#/cashup"
40                         }
41                     }
42                 },
43                 "403": {
44                     "description": "Access forbidden",
45                     "schema": {
46                         "$ref": "../definitions.json#/error"
47                     }
48                 },
49                 "404": {
50                     "description": "Register not found",
51                     "schema": {
52                         "$ref": "../definitions.json#/error"
53                     }
54                 }
55             },
56             "x-koha-authorization": {
57                 "permissions": {
58                     "cash_management": "cashup"
59                 }
60             }
61         }
62     },
63     "/cashups/{cashup_id}": {
64         "get": {
65             "x-mojo-to": "CashRegisters::Cashups#get",
66             "operationId": "getCashup",
67             "tags": ["cash_registers", "cashups"],
68             "parameters": [{
69                 "$ref": "../parameters.json#/cashup_id_pp"
70             }],
71             "produces": [
72                 "application/json"
73             ],
74             "responses": {
75                 "200": {
76                     "description": "A cashup",
77                     "schema": {
78                         "$ref": "../definitions.json#/cashup"
79                     }
80                 },
81                 "403": {
82                     "description": "Access forbidden",
83                     "schema": {
84                         "$ref": "../definitions.json#/error"
85                     }
86                 },
87                 "404": {
88                     "description": "Patron not found",
89                     "schema": {
90                         "$ref": "../definitions.json#/error"
91                     }
92                 }
93             },
94             "x-koha-authorization": {
95                 "permissions": {
96                     "cash_management": "cashup"
97                 }
98             },
99             "x-koha-embed": [
100                 "summary"
101             ]
102         }
103     }
104 }