GetHouseAccountCharges

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

Request Parameters

EndDate DateTime — Specify the end date to which you would like to see HouseAccountCharges made for this location
Id int — (optional) Specify the Id of the House Account you would like to see HouseAccountCharges for. If left null, HouseAccountCharges will not be filtered by HouseAccount.
StartDate DateTime — Specify the start date from which you would like to see HouseAccountCharges made for this location

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
Charges Array of HouseAccountCharge — Charges within the date range for the location or for the house account specified.
HouseAccountCharge Properties
- AccountId int — Maps to the Id of the HouseAccount that was charged
- Amount decimal — Amount charged to the HouseAccount
- OrderId long — Maps to the Id of the Order the charge occurred for
- PaymentId int — Maps to the Id of the HouseAccountPayment
- TransactionTime DateTime — Date and time of this HouseAccountCharge

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetHouseAccountCharges request with Id, StartDate, and EndDate.

Responses

text/xml; charset=utf-8

post/GetHouseAccountCharges

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/HouseAccounts.svc?GetHouseAccountCharges' \
  --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/GetHouseAccountCharges"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:hous="http://www.brinksoftware.com/webservices/houseaccounts">
    <soapenv:Header/>
    <soapenv:Body>
      <hous:GetHouseAccountCharges>
        <hous:request>
          <hous:Id>1</hous:Id>
          <hous:StartDate>2024-01-01</hous:StartDate>
          <hous:EndDate>2024-01-31</hous:EndDate>
        </hous:request>
      </hous:GetHouseAccountCharges>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetHouseAccountChargesResponse xmlns="http://www.brinksoftware.com/webservices/houseaccounts">
      <GetHouseAccountChargesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Charges>
          <HouseAccountCharge>
            <AccountId>1</AccountId>
            <Amount>45.50</Amount>
            <OrderId>100012345</OrderId>
            <PaymentId>5</PaymentId>
            <TransactionTime>2024-01-15T12:30:00</TransactionTime>
          </HouseAccountCharge>
        </Charges>
      </GetHouseAccountChargesResult>
    </GetHouseAccountChargesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of HouseAccountCharge objects.