koha-dev.rot13.org Git - srvgit/blob - 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       - name: x-koha-embed
  22         in: header
  23         required: false
  24         description: Embed list sent as a request header
  25         type: array
  26         items:
  27           type: string
  28           enum:
  29             - manager
  30         collectionFormat: csv
  31     responses:
  32       "200":
  33         description: Cashups performed on this register
  34         schema:
  35           type: array
  36           items:
  37             $ref: "../swagger.yaml#/definitions/cashup"
  38       "403":
  39         description: Access forbidden
  40         schema:
  41           $ref: "../swagger.yaml#/definitions/error"
  42       "404":
  43         description: Register not found
  44         schema:
  45           $ref: "../swagger.yaml#/definitions/error"
  46       "500":
  47         description: |
  48           Internal server error. Possible `error_code` attribute values:
  49
  50           * `internal_server_error`
  51         schema:
  52           $ref: "../swagger.yaml#/definitions/error"
  53       "503":
  54         description: Under maintenance
  55         schema:
  56           $ref: "../swagger.yaml#/definitions/error"
  57     x-koha-authorization:
  58       permissions:
  59         cash_management: cashup
  60 "/cashups/{cashup_id}":
  61   get:
  62     x-mojo-to: CashRegisters::Cashups#get
  63     operationId: getCashup
  64     tags:
  65       - cashups
  66     summary: Get cashup
  67     parameters:
  68       - $ref: "../swagger.yaml#/parameters/cashup_id_pp"
  69       - name: x-koha-embed
  70         in: header
  71         required: false
  72         description: Embed list sent as a request header
  73         type: array
  74         items:
  75           type: string
  76           enum:
  77             - summary
  78         collectionFormat: csv
  79     produces:
  80       - application/json
  81     responses:
  82       "200":
  83         description: A cashup
  84         schema:
  85           $ref: "../swagger.yaml#/definitions/cashup"
  86       "403":
  87         description: Access forbidden
  88         schema:
  89           $ref: "../swagger.yaml#/definitions/error"
  90       "404":
  91         description: Patron not found
  92         schema:
  93           $ref: "../swagger.yaml#/definitions/error"
  94       "500":
  95         description: |
  96           Internal server error. Possible `error_code` attribute values:
  97
  98           * `internal_server_error`
  99         schema:
 100           $ref: "../swagger.yaml#/definitions/error"
 101       "503":
 102         description: Under maintenance
 103         schema:
 104           $ref: "../swagger.yaml#/definitions/error"
 105     x-koha-authorization:
 106       permissions:
 107         cash_management: cashup