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     x-koha-embed:
  61       - manager
  62 "/cashups/{cashup_id}":
  63   get:
  64     x-mojo-to: CashRegisters::Cashups#get
  65     operationId: getCashup
  66     tags:
  67       - cashups
  68     summary: Get cashup
  69     parameters:
  70       - $ref: "../swagger.yaml#/parameters/cashup_id_pp"
  71       - name: x-koha-embed
  72         in: header
  73         required: false
  74         description: Embed list sent as a request header
  75         type: array
  76         items:
  77           type: string
  78           enum:
  79             - summary
  80         collectionFormat: csv
  81     produces:
  82       - application/json
  83     responses:
  84       "200":
  85         description: A cashup
  86         schema:
  87           $ref: "../swagger.yaml#/definitions/cashup"
  88       "403":
  89         description: Access forbidden
  90         schema:
  91           $ref: "../swagger.yaml#/definitions/error"
  92       "404":
  93         description: Patron not found
  94         schema:
  95           $ref: "../swagger.yaml#/definitions/error"
  96       "500":
  97         description: |
  98           Internal server error. Possible `error_code` attribute values:
  99
 100           * `internal_server_error`
 101         schema:
 102           $ref: "../swagger.yaml#/definitions/error"
 103       "503":
 104         description: Under maintenance
 105         schema:
 106           $ref: "../swagger.yaml#/definitions/error"
 107     x-koha-authorization:
 108       permissions:
 109         cash_management: cashup
 110     x-koha-embed:
 111       - summary