The viewpaymenthistory operation allows you to view the payment history for a specific member, identified by the member agreement number.
| Service Type | SOAP |
| Service Name | Billing |
| Operation | viewpaymenthistory |
| Required Request Parameters |
|
Availability of Payment Data
Individual payments are only viewable after posting.
The request has the following parameters:
| Parameter Name | Required? | Format | Parent Parameter | Description |
|---|---|---|---|---|
| club | Y | club number | The number for the club. | |
| agreementNumber | Y | nine-digit agreement number | The agreement number for the membership agreement. | |
| startDate | Y | MM/DD/YYYY | The beginning of the date range from which the payment history is pulled. | |
| endDate | Y | MM/DD/YYYY | The end of the date range from which the payment history is pulled. |
This service may return zero, one, or many payments for the selected parameters.
The return data is included inside return parameters in the body of the response.
The data has the following parameter hierarchy:
| Parameter Name | Format | Parent Parameter | Description |
|---|---|---|---|
| club | club number | The number for the club. | |
| agreementNumber | nine-digit agreement number | The agreement number for the membership agreement. | |
| paymentHistory | Contains a list and details of one or more payments. Omitted if there are no payments on the member account in the range. | ||
| payment | paymentHistory | paymentHistory | Contains the details of an individual payment. |
| date | MM/DD/YYYY | payment | The date of the payment. |
| amount | two decimal number | payment | The amount of the payment. See note about negative payment amounts. |
| description | string | payment | The description of the payment. |
| lateFee | two decimal number | payment | The amount of the payment applied to late fees. |
| cancelFee | two decimal number | payment | The amount of the payment applied to cancellation fees. |
| status | Contains the details of a status message. | ||
| status | string | status |
Contains a status code.
Example:
|
| message | string | status | Contains any additional details about the status. |
Note: Using an invalid date format for either startDate or endDate will result in the following error:
Error: Internal error. Please contact ABC Financial.
If you see this error, make sure that the startDate and endDate parameters use the correct MM/DD/YYYY format.
Negative Payment Amounts: In some cases, a negative payment amount may appear in the results. This usually means the payment has been applied.
In the example below, the negative amount demonstrates a reversal.
Example:
<payment>
<date>12/12/2008</date>
<amount>0.00</amount>
<description>REVERSE CREDIT PAYMENT</description>
<lateFee>33.78</lateFee>
<cancelFee>0.00</cancelFee>
</payment>
<payment>
<date>12/12/2008</date>
<amount>0.00</amount>
<description>CREDIT - PAYMENT MADE AT CLUB</description>
<lateFee>-33.78</lateFee>
<cancelFee>0.00</cancelFee>
</payment>