The recordPayments operation allows you to record payments for multiple bills in a single call. Web Services attempts to record payments for all Credit Account payments before the monetary payments since bill reasons may preclude payment from a credit account for certain Bill Reason IDs.
Although it is possible to mix payments with applied credits, SirsiDynix recommends that you record them in separate requests.
Synopsis
Service |
|||||||
Namespace |
http://schemas.sirsidynix.com/symws/circulation |
||||||
Prerequisites |
|
||||||
Request |
|||||||
Response |
|||||||
Operation faults |
None (see Faults) |
TheRecordPaymentsRequest has the following request parameters:
Parameter |
Type |
Description |
Required? |
Specifies the user ID of the patron who the bill is for. |
Y |
||
Specifies the bill number that was paid. You can include 1 or more billKey elements in the request. The billNumber is returned for each bill in lookupMyAccountInfo or lookupPatronInfowhen includeFeeInfo is specified. |
Y |
||
Specifies the entry or entries for the fee payments. |
Y |
||
Specifies if the payment is made by a patron through an OPAC, Web Services application, or similar(true) or by the patron directly to a staff member (false). Note: If you do not specify selfPaid, the system will assume “false” by default. |
N |
||
Specifies whether the "paid at" library is also the billing library (true) or not (false). This allows the client to force the paid library to be the same as the billing library. Note: If you do not specify paidAtBillingLibrary, the system assumes “false” by default. |
N |
The RecordPaymentsResponse returns the following elements:
Element |
Type |
Occ. |
Description |
0..* |
Displays a list of payments that were successfully recorded. |
||
0..* |
Displays a list of payments that had problems, if any. |
||
1 |
Displays the amount of money recorded as paid toward the bill or bills. |
||
0..1 |
Displays the amount of money paid toward a bill or bills that was not used. |
Related topics
© 2009-2012 SirsiDynix