Ready to Learn?Ex Libris products all provide open APIs


General Purpose

Retrieves a specific patron's cash charge information. The cash charge information may be retrieved as a patron's cash charges list, or as specific cash charge information. The cash charge list information is exported per institution (ADM library).


Product Version Compatibility

Versions 18, 20.1 and later


Interface Type




patrons patron_id circ_actions cash



Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Cash ID: The ID of the specific loan that is requested. May be used to fetch a specific loan's information.

URL Parameters:

institution: The ID of an institution (ADM library) for which the information is requested. Optional.

view: The format in which the cash charge list will be displayed. Possible values are brief and full. Optional.

Input URI

Cash Charge List:

<Base URL>:/patron/<patron ID>/circulationActions/cash?institution=<Institution ID>

For example:

To retrieve the cash charges list for the patron ID 00000036, use:

To retrieve the cash charges list for the patron ID 00000036 for a specific institution, use:

To retrieve the cash charges list for the patron ID 00000036 in brief format, use:

To retrieve the cash charges list for the patron ID 00000036 in full format, use:

Two parameters (separated by the "&" sign):

The "institute"  and the "view" parameters can be used together - separated by the "&" sign:

Specific Cash Charge:

<Base URL>:/patron/<patron ID>/circulationActions/cash/<cash id>

For example:

To retrieve a specific cash charge information for the patron ID 00000036, use:

Input XML - PUT (update) action:

In Aleph 22.1 and later it is possible to send an update - from external system - that the Patron has payed the cash debit.

To update Aleph that the Patron has paid a debit sum - use the same URL with a PUT method of HTTP.

Note that the payment is done for a specific ADM library, and the institution parameter of the URL is mandatory for the PUT action.

The PUT action receives the following XML input (example):

post_xml=<pay-cash-parameters> <sum>121.13</sum> <pay-reference>54144</pay-reference></pay-cash-parameters>


  • The "sum" is a mandatory tag.
  • The "pay-reference" is an optional tag. It can be used to provide the receipt or reference number of the pay action as provided by the external system. 
  • The payment is NOT done for a specific cash transaction (and can not be activated from a specific cash charge retrieval).
    It is done only from the list of all patron's charges per institution (ADM library).  For example (see above): .

Output XML Format

The returned XML includes the patron's cash charge list per institution, including balance information per sublibrary, or a specific cash charge information. The information is exported as Z31,Z30 and Z13 tags. When setting the view parameter to full, the records are fully extracted. When setting the view parameter to brief, only some of the elements are extracted, in addition to balance tags that report the cash balance per sublibrary.

The list of institutes can be limited to those in which the patron is active, depending on the institute's setup of the FILTER-LIBRARY-CARD tab100 variable.

Cash charges list example:

<?xml version="1.0" encoding="UTF-8"?>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
        <sublibrary code="USM50">
          <sublib-name>Exlibris Demo Libraries</sublib-name>
          <open-sum>-           1.00</open-sum>
        <sublibrary code="HYL  ">
          <sublib-name>East Asian Library</sublib-name>
          <open-sum>-           5.00</open-sum>
        <sublibrary code="HIL  ">
          <sublib-name>Humanities Library and Reading</sublib-name>
          <open-sum>-           5.00</open-sum>
        <sublibrary code="HILR ">
          <sublib-name>Humanities Library and Reading</sublib-name>
          <open-sum>-          31.50</open-sum>
        <sublibrary code="LAW  ">
          <sublib-name>Law Library</sublib-name>
          <open-sum>           18.90</open-sum>
        <sublibrary code="WID  ">
          <sublib-name>Main Library</sublib-name>
          <open-sum>-          30.52</open-sum>
        <sublibrary code="MED  ">
          <sublib-name>Medicine Library</sublib-name>
          <open-sum>-           5.00</open-sum>
    <institution code="USM51">
      <inst-name>USM51 Demo Libraries</inst-name>
        <sublibrary code="EDUC5">
          <sublib-name>Education Library 51</sublib-name>
          <open-sum>-           2.00</open-sum>
        <sublibrary code="LINC5">
          <sublib-name>Lincoln Library 51</sublib-name>
          <open-sum>-           2.00</open-sum>
    <institution code="MAB50">
      <inst-name>MAB Demo Library</inst-name>


Specific cash charge example:

<?xml version="1.0" encoding="UTF-8"?>
  <cash type="debit" transferred="N">
      <z31-status>Not paid by/credited to patron</z31-status>
      <z31-sub-library>Medicine Library</z31-sub-library>
      <z31-type>Local Patron Registration</z31-type>
      <z31-payment-target>Medicine Library</z31-payment-target>
      <z31-description>Local Patron Registration</z31-description>

Output XML - PUT (update) action:

In case where the PUT action successfully updated Aleph data, the following response is reported:

<?xml version = "1.0" encoding = "UTF-8"?>

In case where Aleph data is failed to be updated, the following response is reported (failure can be a result of rare cases like non-responding server):

<?xml version = "1.0" encoding = "UTF-8"?>
    <reply-text>fail to update cash balance</reply-text>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

04 : Cash charge does not belong to the requested patron

07 : Cash charge does not exist