api/v1/swagger/paths/cash_registers.yaml

   1 ---
   2 "/cash_registers/{cash_register_id}/cashups":
   3   get:
   4     x-mojo-to: CashRegisters::Cashups#list
   5     operationId: listCashups
   6     tags:
   7       - cashups
   8     summary: List cashups for the cash register
   9     produces:
  10       - application/json
  11     parameters:
  12       - $ref: "../swagger.yaml#/parameters/cash_register_id_pp"
  13       - $ref: "../swagger.yaml#/parameters/match"
  14       - $ref: "../swagger.yaml#/parameters/order_by"
  15       - $ref: "../swagger.yaml#/parameters/page"
  16       - $ref: "../swagger.yaml#/parameters/per_page"
  17       - $ref: "../swagger.yaml#/parameters/q_param"
  18       - $ref: "../swagger.yaml#/parameters/q_body"
  19       - $ref: "../swagger.yaml#/parameters/q_header"
  20       - $ref: "../swagger.yaml#/parameters/request_id_header"
  21     responses:
  22       "200":
  23         description: Cashups performed on this register
  24         schema:
  25           type: array
  26           items:
  27             $ref: "../swagger.yaml#/definitions/cashup"
  28       "403":
  29         description: Access forbidden
  30         schema:
  31           $ref: "../swagger.yaml#/definitions/error"
  32       "404":
  33         description: Register not found
  34         schema:
  35           $ref: "../swagger.yaml#/definitions/error"
  36       "500":
  37         description: |
  38           Internal server error. Possible `error_code` attribute values:
  39
  40           * `internal_server_error`
  41         schema:
  42           $ref: "../swagger.yaml#/definitions/error"
  43       "503":
  44         description: Under maintenance
  45         schema:
  46           $ref: "../swagger.yaml#/definitions/error"
  47     x-koha-authorization:
  48       permissions:
  49         cash_management: cashup
  50     x-koha-embed:
  51       - manager
  52 "/cashups/{cashup_id}":
  53   get:
  54     x-mojo-to: CashRegisters::Cashups#get
  55     operationId: getCashup
  56     tags:
  57       - cashups
  58     summary: Get cashup
  59     parameters:
  60       - $ref: "../swagger.yaml#/parameters/cashup_id_pp"
  61     produces:
  62       - application/json
  63     responses:
  64       "200":
  65         description: A cashup
  66         schema:
  67           $ref: "../swagger.yaml#/definitions/cashup"
  68       "403":
  69         description: Access forbidden
  70         schema:
  71           $ref: "../swagger.yaml#/definitions/error"
  72       "404":
  73         description: Patron not found
  74         schema:
  75           $ref: "../swagger.yaml#/definitions/error"
  76       "500":
  77         description: |
  78           Internal server error. Possible `error_code` attribute values:
  79
  80           * `internal_server_error`
  81         schema:
  82           $ref: "../swagger.yaml#/definitions/error"
  83       "503":
  84         description: Under maintenance
  85         schema:
  86           $ref: "../swagger.yaml#/definitions/error"
  87     x-koha-authorization:
  88       permissions:
  89         cash_management: cashup
  90     x-koha-embed:
  91       - summary