GET AutomaticSettlements/Residents

Request Information

URI Parameters

Name	Type	Additional information
ClientLastName	string	None.
BusinessUnitIDs	Collection of integer	None.
ClientNumber	string	None.
ClientFacilityStatuses	Collection of string	None.
OutstandingAmountRange	RangeCriteria	None.
UnappliedReceiptsRange	RangeCriteria	None.
AmountRemainingRange	RangeCriteria	None.
ReceiptsRemainingRange	RangeCriteria	None.
AmountExcludedRange	RangeCriteria	None.
FunderIDs	Collection of integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of AutomaticSettlementsDTO

Name	Type	Additional information
ClientName	string	None.
ClientID	integer	None.
ClientFacilityStatus	string	None.
FacilityName	string	None.
FacilityID	integer	None.
ClientNumber	string	None.
OutstandingAmount	decimal number	None.
UnappliedReceipts	decimal number	None.
AmountRemaining	decimal number	None.
ReceiptsRemaining	decimal number	None.
AmountExcluded	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "clientName": "sample string 1",
    "clientID": 2,
    "clientFacilityStatus": "sample string 3",
    "facilityName": "sample string 4",
    "facilityID": 5,
    "clientNumber": "sample string 6",
    "outstandingAmount": 7.0,
    "unappliedReceipts": 8.0,
    "amountRemaining": 9.0,
    "receiptsRemaining": 10.0,
    "amountExcluded": 11.0
  },
  {
    "clientName": "sample string 1",
    "clientID": 2,
    "clientFacilityStatus": "sample string 3",
    "facilityName": "sample string 4",
    "facilityID": 5,
    "clientNumber": "sample string 6",
    "outstandingAmount": 7.0,
    "unappliedReceipts": 8.0,
    "amountRemaining": 9.0,
    "receiptsRemaining": 10.0,
    "amountExcluded": 11.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfAutomaticSettlementsDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Billings.Models">
  <AutomaticSettlementsDTO>
    <AmountExcluded>11</AmountExcluded>
    <AmountRemaining>9</AmountRemaining>
    <ClientFacilityStatus>sample string 3</ClientFacilityStatus>
    <ClientID>2</ClientID>
    <ClientName>sample string 1</ClientName>
    <ClientNumber>sample string 6</ClientNumber>
    <FacilityID>5</FacilityID>
    <FacilityName>sample string 4</FacilityName>
    <OutstandingAmount>7</OutstandingAmount>
    <ReceiptsRemaining>10</ReceiptsRemaining>
    <UnappliedReceipts>8</UnappliedReceipts>
  </AutomaticSettlementsDTO>
  <AutomaticSettlementsDTO>
    <AmountExcluded>11</AmountExcluded>
    <AmountRemaining>9</AmountRemaining>
    <ClientFacilityStatus>sample string 3</ClientFacilityStatus>
    <ClientID>2</ClientID>
    <ClientName>sample string 1</ClientName>
    <ClientNumber>sample string 6</ClientNumber>
    <FacilityID>5</FacilityID>
    <FacilityName>sample string 4</FacilityName>
    <OutstandingAmount>7</OutstandingAmount>
    <ReceiptsRemaining>10</ReceiptsRemaining>
    <UnappliedReceipts>8</UnappliedReceipts>
  </AutomaticSettlementsDTO>
</ArrayOfAutomaticSettlementsDTO>

application/x-compressed-json

Sample:

�{�{t�RrNfj^�_bn���RqbnAN�BqIQf^����T��E���qKL���,�.I,)-��eԕU��X$ �Ma���&�a�7��/-).I�K�s�K�J����t�J�
��S�R�S3J�α�'���&f��(YY�D�����

�]+�sJSRS���z�:���;pbn�>>