GET 17.0/app/paymentruns/statements/list?contactid={contactid}&propertyid={propertyid}&consolidatedaccount={consolidatedaccount}

Description

Gets all payment run statements for the passed contact

URI Parameters
Name Description Type Additional information
contactId

Id of the contact to retrieve statements for

 integer

Required
propertyId

Id of the property to retrieve statements for

 integer

Default value is -99
consolidatedAccount

Indicates whether the contact has a consolidated account or not

 boolean

Default value is False

None.

None.

Array of ID Description pairs containing statements that match the request parameters

Collection of IDDescriptionPair
Name Description Type Additional information
ID

integer

None.
Description

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 2"
  },
  {
    "id": 1,
    "description": "sample string 2"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfIDDescriptionPair xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IDDescriptionPair>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </IDDescriptionPair>
  <IDDescriptionPair>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </IDDescriptionPair>
</ArrayOfIDDescriptionPair>