Martin Renvoize
f4c6a5dfd5
This patch adds two new API endpoints for fetching a patrons credits and a patrons debits. Signed-off-by: Lucas Gass <lucas@bywatersolutions.com> Signed-off-by: Agustin Moyano <agustinmoyano@theke.io> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
107 lines
2.4 KiB
YAML
107 lines
2.4 KiB
YAML
---
|
|
type: object
|
|
properties:
|
|
account_line_id:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
readOnly: true
|
|
description: Internal account line identifier
|
|
amount:
|
|
type: number
|
|
description: Account line amount
|
|
amount_outstanding:
|
|
type: number
|
|
readOnly: true
|
|
description: Outstanding amount
|
|
cash_register_id:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Internal identifier for the cash register used for the payment (if any)
|
|
checkout_id:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Internal identifier for the checkout the account line is related to
|
|
credit_number:
|
|
type:
|
|
- string
|
|
- "null"
|
|
readOnly: true
|
|
description: Internally generated identifier for credits
|
|
credit_type:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Account line credit type
|
|
date:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
description: Date the account line was created
|
|
debit_type:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Account line debit type
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
readOnly: true
|
|
description: Account line description
|
|
interface:
|
|
type:
|
|
- string
|
|
- "null"
|
|
readOnly: true
|
|
description: 'Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)'
|
|
internal_note:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Internal note
|
|
item_id:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Internal identifier for the item the account line is related to
|
|
library_id:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Internal identifier for the library in which the transaction took place
|
|
patron_id:
|
|
type: integer
|
|
readOnly: true
|
|
description: Internal identifier for the patron the account line belongs to
|
|
payment_type:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Payment type
|
|
payout_type:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Payout type
|
|
status:
|
|
type:
|
|
- string
|
|
- "null"
|
|
readOnly: true
|
|
description: The credit/debit status
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
description: Timestamp for the latest line update
|
|
user_id:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Internal patron identifier for the staff member that introduced the account line
|
|
required:
|
|
- amount
|
|
additionalProperties: false
|