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