Patron fine

Charge patron fine

POST /api/.../patrons/{id}/fees?type=newfee;

This method allows the caller to add fine to patron account.

Request Information

Parameters
Name Type Required Description
id int Yes patron identifier
chargeFines DtoPatronChargesFines Yes Define this parameter in the request body.
type string Yes Define this parameter in the request query string. "newfee" adds a new fee to the patron account
DtoPatronChargesFines
Property Type Nullable Description
FeeReasonCodeID Int No Required.
Amount Decimal No Required.
ItemBarcode String Yes Charging against an item
ItemRecordID Int Yes Charging against an item
Date DateTime No Fine Date
Note String Yes Notes
Request body
Example
application/json, text/json 
{
"FeeReasonCodeID": -10,
"Amount": 1.50,
"ItemBarcode": "0000413817446",
"ItemRecordID": 2494818,
"Date": "2023-03-01T16:31:24.666Z",
"Note": "test notes"
}

Response Information

Returns fine information
Example
application/json, text/json 
{
  "TxnID": 3765768,
  "TxnDate": "2023-03-01T21:44:34.273+01:00",
  "FeeReasonCodeID": -10,
  "TotalAmountBaseAmount": 1.5,
  "TotalAmountAppliedTaxAmount": 0.03,
  "TotalAmount": 1.53,
  "AmountWaived": 0,
  "AmountPayableBaseAmount": 1.5,
  "AmountPayableAppliedTaxAmount": 0.03,
  "AmountPayableAmount": 1.53,
  "AmountPaid": 0,
  "ItemBarcode": null,
  "BibliographicRecordID": 673382,
  "Title": "Behind rebel lines : the incredible story of Emma Edmonds, Civil War spy",
  "NativeTitle": null,
  "VolumeName": null
}

Reference for Polaris enum values:

enum PatronAccountTxnCode
{	
    Charge = 1,
    Payment = 2,
    Return = 3,
    Deposit = 4,
    Waive = 5,
    WaiveExistingCharge = 6,
    Forfeit = 7,
    Credit = 8,
    PayRefund = 9,
    AutoWaive = 10
}

public enum FeeReasonCode
{
    ItemCheckoutCharge = -11,
    BorrowByMailCharge = -10,
    RegistrationFee = -9,
    FusionCharge = -8,
    CreditCardProcessingCharge = -7,
    ProcessingCharge = -6,
    OverpaymentCredit = -5,
    CreditRefund = -4,
    HoldRequest = -3,
    CollectionAgency = -2,
    ReplacementCost = -1,
    OverdueItem = 0,
    CaseCover = 1,
    CopyPrint = 2,
    Damage = 3,
    ILL = 4,
    ManualFee = 5,
    NewCard = 6,
    PhoneFax = 7,
    Postage = 8,
    Rental = 9,
    MiscCharge = 10,
    MiscTestCharge = 11,
    Mm = 12,
    Misc = 13,
    Test1 = 14,
    Test2 = 15        
}

HTTP Response Codes

Code Description
200 OK. Success
409 CONFLICT. Patron record is secured.