Patron Credit

Add Patron Credit

POST /api/.../patrons/{id}/accounttransactions/credit?action=add

Add's patron credit.

Permissions

    CR_AccessPatronServices_Allow
    CR_PatronStatus_Access
    CR_PatronStatus_ModifyPatronAccount
    CR_CreatePatronAccountCredit_Allow

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron code. Used to return a single object.
action String Yes (possible values {add, refund}) action identifier
DtoCreditData
Property Type Nullable Description
TxnAmount Decimal No Required. (Has to be greater than 0)
PatronPaymentMethod Int No Yes. (11 for cash, only supported)
FreeTextNote String Yes Notes
Request body
Example
application/json, text/json 
{ 
TxnAmount :8.50, 
FreeTextNote : "Fiddler add credit",
PatronPaymentMethod: 11,
}

Response Information

Example
application/json, text/json 
{
    "PatronID":85616,
    "TxnAmount":8.50,
    "FreeTextNote":"Fiddler add credit",
    "PatronPaymentMethod":11,
    "MainTxnIDs":[3666715]
}
MainTxnIds is an array on integer, in this call it returns the Main Txn Ids of successfully added credit.

HTTP Response Codes

Code Description
200 OK. Success
403 Forbidden (privileges).
404 Not Found. Patron not found
409 CONFLICT. Patron record is secured.