GET api/patientpayments/search?q={q}&createdUtcOperator={createdUtcOperator}&createdUtc1={createdUtc1}&createdUtc2={createdUtc2}&processedAmountOperator={processedAmountOperator}&processedAmount1={processedAmount1}&processedAmount2={processedAmount2}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patients bill payments.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
q

string

Default value is

createdUtcOperator

ComparisonOperator

Default value is NotCompare

createdUtc1

date

None.

createdUtc2

date

None.

processedAmountOperator

ComparisonOperator

Default value is NotCompare

processedAmount1

decimal number

None.

processedAmount2

decimal number

None.

page

integer

Default value is 1

itemsPerPage

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfPatientPaymentModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of PatientPaymentModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": 1,
      "AccountId": "faf44a20-b3ca-4904-a742-75b3677f6b94",
      "CreatedUtc": "sample string 3",
      "PatientId": "c9a6a605-d5a8-4ee3-80da-eb23d7829428",
      "PatientExternalId": "sample string 5",
      "PatientFullName": "sample string 6",
      "PatientBirthday": "sample string 7",
      "PatientComments": "sample string 8",
      "ReferenceNumber": "sample string 9",
      "ReferenceName": "sample string 10",
      "CardholderName": "sample string 11",
      "CardholderAddress1": "sample string 12",
      "CardholderAddress2": "sample string 13",
      "CardholderCity": "sample string 14",
      "CardholderState": "sample string 15",
      "CardholderZip": "sample string 16",
      "CardholderPhoneNumber": "sample string 17",
      "CardholderEmail": "sample string 18",
      "CardType": "sample string 19",
      "Last4CardNumber": "sample string 20",
      "Amount": 21.0,
      "ProcessedAmount": 22.0,
      "TransactionId": "sample string 23",
      "PatientCommunicationsEmail": "sample string 24",
      "MessageToPracticeId": "e158c9eb-c770-43e1-88fe-aed3883c0475",
      "PaymentSuccessful": true,
      "AlreadySent": true,
      "SentOn": "sample string 27",
      "CardExpiration": "sample string 28"
    },
    {
      "Id": 1,
      "AccountId": "faf44a20-b3ca-4904-a742-75b3677f6b94",
      "CreatedUtc": "sample string 3",
      "PatientId": "c9a6a605-d5a8-4ee3-80da-eb23d7829428",
      "PatientExternalId": "sample string 5",
      "PatientFullName": "sample string 6",
      "PatientBirthday": "sample string 7",
      "PatientComments": "sample string 8",
      "ReferenceNumber": "sample string 9",
      "ReferenceName": "sample string 10",
      "CardholderName": "sample string 11",
      "CardholderAddress1": "sample string 12",
      "CardholderAddress2": "sample string 13",
      "CardholderCity": "sample string 14",
      "CardholderState": "sample string 15",
      "CardholderZip": "sample string 16",
      "CardholderPhoneNumber": "sample string 17",
      "CardholderEmail": "sample string 18",
      "CardType": "sample string 19",
      "Last4CardNumber": "sample string 20",
      "Amount": 21.0,
      "ProcessedAmount": 22.0,
      "TransactionId": "sample string 23",
      "PatientCommunicationsEmail": "sample string 24",
      "MessageToPracticeId": "e158c9eb-c770-43e1-88fe-aed3883c0475",
      "PaymentSuccessful": true,
      "AlreadySent": true,
      "SentOn": "sample string 27",
      "CardExpiration": "sample string 28"
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfPatientPaymentModela4LBtX2x xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.BillPayments">
    <d2p1:PatientPaymentModel>
      <d2p1:AccountId>faf44a20-b3ca-4904-a742-75b3677f6b94</d2p1:AccountId>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:Amount>21</d2p1:Amount>
      <d2p1:CardExpiration>sample string 28</d2p1:CardExpiration>
      <d2p1:CardType>sample string 19</d2p1:CardType>
      <d2p1:CardholderAddress1>sample string 12</d2p1:CardholderAddress1>
      <d2p1:CardholderAddress2>sample string 13</d2p1:CardholderAddress2>
      <d2p1:CardholderCity>sample string 14</d2p1:CardholderCity>
      <d2p1:CardholderEmail>sample string 18</d2p1:CardholderEmail>
      <d2p1:CardholderName>sample string 11</d2p1:CardholderName>
      <d2p1:CardholderPhoneNumber>sample string 17</d2p1:CardholderPhoneNumber>
      <d2p1:CardholderState>sample string 15</d2p1:CardholderState>
      <d2p1:CardholderZip>sample string 16</d2p1:CardholderZip>
      <d2p1:CreatedUtc>sample string 3</d2p1:CreatedUtc>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Last4CardNumber>sample string 20</d2p1:Last4CardNumber>
      <d2p1:MessageToPracticeId>e158c9eb-c770-43e1-88fe-aed3883c0475</d2p1:MessageToPracticeId>
      <d2p1:PatientBirthday>sample string 7</d2p1:PatientBirthday>
      <d2p1:PatientComments>sample string 8</d2p1:PatientComments>
      <d2p1:PatientCommunicationsEmail>sample string 24</d2p1:PatientCommunicationsEmail>
      <d2p1:PatientExternalId>sample string 5</d2p1:PatientExternalId>
      <d2p1:PatientFullName>sample string 6</d2p1:PatientFullName>
      <d2p1:PatientId>c9a6a605-d5a8-4ee3-80da-eb23d7829428</d2p1:PatientId>
      <d2p1:PaymentSuccessful>true</d2p1:PaymentSuccessful>
      <d2p1:ProcessedAmount>22</d2p1:ProcessedAmount>
      <d2p1:ReferenceName>sample string 10</d2p1:ReferenceName>
      <d2p1:ReferenceNumber>sample string 9</d2p1:ReferenceNumber>
      <d2p1:SentOn>sample string 27</d2p1:SentOn>
      <d2p1:TransactionId>sample string 23</d2p1:TransactionId>
    </d2p1:PatientPaymentModel>
    <d2p1:PatientPaymentModel>
      <d2p1:AccountId>faf44a20-b3ca-4904-a742-75b3677f6b94</d2p1:AccountId>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:Amount>21</d2p1:Amount>
      <d2p1:CardExpiration>sample string 28</d2p1:CardExpiration>
      <d2p1:CardType>sample string 19</d2p1:CardType>
      <d2p1:CardholderAddress1>sample string 12</d2p1:CardholderAddress1>
      <d2p1:CardholderAddress2>sample string 13</d2p1:CardholderAddress2>
      <d2p1:CardholderCity>sample string 14</d2p1:CardholderCity>
      <d2p1:CardholderEmail>sample string 18</d2p1:CardholderEmail>
      <d2p1:CardholderName>sample string 11</d2p1:CardholderName>
      <d2p1:CardholderPhoneNumber>sample string 17</d2p1:CardholderPhoneNumber>
      <d2p1:CardholderState>sample string 15</d2p1:CardholderState>
      <d2p1:CardholderZip>sample string 16</d2p1:CardholderZip>
      <d2p1:CreatedUtc>sample string 3</d2p1:CreatedUtc>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Last4CardNumber>sample string 20</d2p1:Last4CardNumber>
      <d2p1:MessageToPracticeId>e158c9eb-c770-43e1-88fe-aed3883c0475</d2p1:MessageToPracticeId>
      <d2p1:PatientBirthday>sample string 7</d2p1:PatientBirthday>
      <d2p1:PatientComments>sample string 8</d2p1:PatientComments>
      <d2p1:PatientCommunicationsEmail>sample string 24</d2p1:PatientCommunicationsEmail>
      <d2p1:PatientExternalId>sample string 5</d2p1:PatientExternalId>
      <d2p1:PatientFullName>sample string 6</d2p1:PatientFullName>
      <d2p1:PatientId>c9a6a605-d5a8-4ee3-80da-eb23d7829428</d2p1:PatientId>
      <d2p1:PaymentSuccessful>true</d2p1:PaymentSuccessful>
      <d2p1:ProcessedAmount>22</d2p1:ProcessedAmount>
      <d2p1:ReferenceName>sample string 10</d2p1:ReferenceName>
      <d2p1:ReferenceNumber>sample string 9</d2p1:ReferenceNumber>
      <d2p1:SentOn>sample string 27</d2p1:SentOn>
      <d2p1:TransactionId>sample string 23</d2p1:TransactionId>
    </d2p1:PatientPaymentModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientPaymentModela4LBtX2x>