GetHouseAccountPayments

This call is to retrieve an array of HouseAccountPayment objects for the location.

Request Parameters

Id int — Specify the Id of the HouseAccount you would like to retrieve HouseAccountPayments for

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Request went through successfully
- 1 — Request returned an unknown error
- 2 — Request was not valid
- 3 — Server is currently unavailable and unable to receive the request
- 4 — Access Denied
Payments Array of HouseAccountPayment — Payments for the house account specified
HouseAccountPayment Properties
- AccountId int — Maps to the Id of the HouseAccount that was charged
- Amount decimal — Amount of this HouseAccountPayment
- TransactionTime DateTime — Date and time of this HouseAccountPayment

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetHouseAccountPayments request with Id.

Responses

text/xml; charset=utf-8

post/GetHouseAccountPayments

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/HouseAccounts.svc?GetHouseAccountPayments' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/houseaccounts/IHouseAccountsWebService/GetHouseAccountPayments"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:hous="http://www.brinksoftware.com/webservices/houseaccounts">
    <soapenv:Header/>
    <soapenv:Body>
      <hous:GetHouseAccountPayments>
        <hous:request>
          <hous:Id>1</hous:Id>
        </hous:request>
      </hous:GetHouseAccountPayments>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetHouseAccountPaymentsResponse xmlns="http://www.brinksoftware.com/webservices/houseaccounts">
      <GetHouseAccountPaymentsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Payments>
          <HouseAccountPayment>
            <AccountId>1</AccountId>
            <Amount>100.00</Amount>
            <TransactionTime>2024-01-20T09:00:00</TransactionTime>
          </HouseAccountPayment>
        </Payments>
      </GetHouseAccountPaymentsResult>
    </GetHouseAccountPaymentsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of HouseAccountPayment objects.