GetHouseAccount

This call is to retrieve a HouseAccount object of the location. Provide either Id or AccountNumber - the other may be omitted.

Request Parameters

AccountNumber string — (optional) Specify the account number of the HouseAccount you would like to retrieve. This can be null if Id is specified.
Id int — (optional) Specify the Id of the HouseAccount you would like to retrieve. This can be null if AccountNumber is specified.

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
Account HouseAccount — Information about this HouseAccount
HouseAccount Properties
- Id int — Unique Id of this HouseAccount
- AccountNumber string — Unique Account Number of this HouseAccount
- Active bool — True if House Account is active, False if not
- Address1 string — Address for this HouseAccount
- Address2 string — Address for this HouseAccount
- Address3 string — Address for this HouseAccount
- Address4 string — Address for this HouseAccount
- Balance decimal — Balance of this HouseAccount
- City string — City of this HouseAccount
- EmailAddress string — Email address for this HouseAccount
- EnforceLimit bool — True if value in the Limit field is enforced, False if not
- FirstName string — First name of the person who owns this HouseAccount
- LastName string — Last name of the person who owns this HouseAccount
- Limit decimal — Limit for this HouseAccount, or 0 if there is no limit
- MiddleName string — Middle name of the person who owns this HouseAccount
- Name string — Name of the person who owns this HouseAccount
- PhoneNumber string — Phone number for this HouseAccount
- State string — State of this HouseAccount
- Zip string — Zip code of this HouseAccount

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetHouseAccount request with either Id or AccountNumber.

Responses

text/xml; charset=utf-8

post/GetHouseAccount

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetHouseAccountResponse xmlns="http://www.brinksoftware.com/webservices/houseaccounts">
      <GetHouseAccountResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Account>
          <Id>1</Id>
          <AccountNumber>HA-1001</AccountNumber>
          <Active>true</Active>
          <Balance>150.00</Balance>
          <Name>John Smith</Name>
          <FirstName>John</FirstName>
          <MiddleName></MiddleName>
          <LastName>Smith</LastName>
          <Address1>123 Main Street</Address1>
          <Address2>Suite 100</Address2>
          <Address3></Address3>
          <Address4></Address4>
          <City>Atlanta</City>
          <State>GA</State>
          <Zip>30301</Zip>
          <EmailAddress>john.smith@example.com</EmailAddress>
          <PhoneNumber>555-123-4567</PhoneNumber>
          <Limit>500.00</Limit>
          <EnforceLimit>true</EnforceLimit>
        </Account>
      </GetHouseAccountResult>
    </GetHouseAccountResponse>
  </s:Body>
</s:Envelope>

SOAP response containing the HouseAccount object.