Koha/api/v1/swagger/definitions/patron_account_credit.json
Tomas Cohen Arazi 566badf12a Bug 20944: OpenAPI spec for /patrons/{patron_id}/account/credits
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2018-08-31 12:46:59 +00:00

39 lines
973 B
JSON

{
"type": "object",
"properties": {
"credit_type": {
"type": "string",
"description": "Type of credit ('credit', 'forgiven', 'lost_item_return', 'payment', 'writeoff' )"
},
"amount": {
"type": "number",
"minimum": 0,
"description": "Credit amount"
},
"account_lines_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of account line ids the credit goes against (optional)"
},
"payment_type": {
"type": "string",
"description": "Payment type (only applies when credit_type=payment)"
},
"date": {
"type": "string",
"format": "date",
"description": "Date the credit was recorded (optional)"
},
"description": {
"type": "string",
"description": "Description"
},
"note": {
"type": "string",
"description": "Internal note"
}
},
"required": [ "amount" ]
}