PUT /api/.../patrons/{id}/accounttransactions/finesfees?action=bill&overpayment={false}&circ={false}&reload={true}
This method allows the caller to bill an existing charge to the patron.
Name | Type | Required | Description |
---|---|---|---|
fineData | DtoFineData | Yes | Define this parameter in the request body. |
id | Integer | Yes | The unique id assigned to the patron. |
action | String | Yes | Define this parameter in the request query string. Possible value is 'bill' |
overpayment | Bool | Yes | Define this parameter in the request query string. Possible value: false |
circ | Bool | Yes | Define this parameter in the request query string. Possible value: false |
reload | Bool | Yes | Define this parameter in the request query string. If set true, updated fines and fees list is returned |
Property | Type | Nullable | Description |
---|---|---|---|
TxnAmount | Decimal | Yes | Not required. |
MainTxnIDs | Int | No | Required. List of transaction IDs. Unique identifier for each transaction, only one ID can be sent. |
PatronPaymentMethod | Int | Yes | Not required. |
FreeTextNote | String | Yes | Notes |
AddedMsg | String | Yes | Additional message to be displayed on the patron's bill |
{
TxnAmount: 0,
FreeTextNote: "Fee for missing parts",
PatronPaymentMethod: null,
MainTxnIDs:
[
3
],
AddedMsg: "Your library account has been billed for this charge."
}
{
"FinesAndFees": [
{
"ItemRecordID":0,
"TxnID":3665717,
"TxnCodeID":1,
"CallNumber":null,
"MaterialType":null,
"TxnDate":"2013-05-29T17:11:59.33",
"Type":"Charge",
"FeeDescription":"Damage",
"BrowseTitle":"",
"Barcode":null,
"TxnAmount":6.0000,
"OutstandingAmount":6.0000,
"Organization":"Schenectady County Public Library - Central",
"TxnOrgID":null,
"FreeTextNote":"damage fine from NextGen",
"WaiverRequestID": null,
"HasPendingWaiverRequest": false
},
{
"ItemRecordID":0,
"TxnID":3665712,
"TxnCodeID":1,
"CallNumber":null,
"MaterialType":null,
"TxnDate":"2013-05-29T16:29:29.633",
"Type":"Charge",
"FeeDescription":"Damage",
"BrowseTitle":"",
"Barcode":null,
"TxnAmount":6.0000,
"OutstandingAmount":6.0000,
"Organization":"Schenectady County Public Library - Central",
"TxnOrgID":null,
"FreeTextNote":"damage fine from NextGen",
"WaiverRequestID": null,
"HasPendingWaiverRequest": false
},
{
"ItemRecordID":0,
"TxnID":3665709,
"TxnCodeID":1,
"CallNumber":null,
"MaterialType":null,
"TxnDate":"2013-05-29T16:20:19.28",
"Type":"Charge",
"FeeDescription":"Misc Charge",
"BrowseTitle":"",
"Barcode":null,
"TxnAmount":4.0000,
"OutstandingAmount":4.0000,
"Organization":"Schenectady County Public Library - Central",
"TxnOrgID":null,
"FreeTextNote":"charge",
"WaiverRequestID": null,
"HasPendingWaiverRequest": false
}
],
"TxnIds": [
1,
2
]
}
enum PatronAccountTxnCode
{
Charge = 1,
Payment = 2,
Return = 3,
Deposit = 4,
Waive = 5,
WaiveExistingCharge = 6,
Forfeit = 7,
Credit = 8,
PayRefund = 9,
AutoWaive = 10
}
enum PatronPaymentMethod
{
PayFrmCredit = 1,
PayFrmDeposit = 2,
DepositFrmCredit = 3,
CreditFrmDeposit = 4,
CreditFrmPAY = 5,
StoredValue = 6,
Cash = 11,
CreditCard = 12,
DebitCard = 13,
Check = 14,
Voucher = 15,
CollectionAgency = 16,
SmartCard = 17
}
Code | Description |
---|---|
200 | OK. Success |
400 | Null object. Bad request |
409 | CONFLICT. Patron record is secured. |