GET {version}/Receipts?fromDateTime={fromDateTime}&toDateTime={toDateTime}&size={size}&includeUdf={includeUdf}

This method will retrieve all the receipts (and their properties) between the time. See PBI 144884 Sample call: http://localhost:54445/v1/Receipts/GetReceiptsByDates?fromDate=06/15/2015&toDate=06/26/2015&limit=1000&includeUdf=true

Request Information

URI Parameters

Name	Description	Type	Additional information
fromDateTime	from date time	date	Required
toDateTime	until date time. If no time component is specified, it will default to the end of the day.	date	Required
size	cut off number of result. Optional. Default is 500	integer	Default value is 500
includeUdf	whether or not to include Receipt UDF within the result. Optional. Default is False.	boolean	Default value is False
version		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Aristotle.P6.Model.Client.Receipt.CustomReceipt

Name	Type	Additional information
ReceiptGuid	globally unique identifier	None.
FilingCommittee	string	None.
BankAccount	string	None.
ReceiptDate	date	None.
ReceiptAmount	decimal number	None.
ReceiptCreatedOnDate	date	None.
ReceiptSourceId	string	None.
ReceiptSource	string	None.
WebformName	string	None.
ReceiptType	string	None.
ReceiptSubType	string	None.
ElectionPeriod	integer	None.
ElectionPeriodText	string	None.
ReceiptCheckNumber	string	None.
ReceiptPurpose	string	None.
ContributorGUID	globally unique identifier	None.
ContributorFirstName	string	None.
ContributorLastName	string	None.
ContributorSourceId	string	None.
BatchName	string	None.
AdvocateID	string	None.
CompanyName	string	None.
CompanySourceId	string	None.
PoliticalCommitteeName	string	None.
PoliticalCommitteeSourceId	string	None.
RecurrenceType	string	None.
Duration	string	None.
NumberOfPayments	integer	None.
CommittedAmount	decimal number	None.
DurationDate	date	None.
Udf	Collection of Aristotle.P6.Model.Client.Receipt.ReceiptUdf	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ReceiptGuid": "604862f8-748f-4de8-a34c-1e24b31dd5ce",
    "FilingCommittee": "sample string 2",
    "BankAccount": "sample string 3",
    "ReceiptDate": "2025-06-28T00:09:07.0040718-04:00",
    "ReceiptAmount": 5.0,
    "ReceiptCreatedOnDate": "2025-06-28T00:09:07.0040718-04:00",
    "ReceiptSourceId": "sample string 7",
    "ReceiptSource": "sample string 8",
    "WebformName": "sample string 9",
    "ReceiptType": "sample string 10",
    "ReceiptSubType": "sample string 11",
    "ElectionPeriod": 1,
    "ElectionPeriodText": "sample string 12",
    "ReceiptCheckNumber": "sample string 13",
    "ReceiptPurpose": "sample string 14",
    "ContributorGUID": "298e51ec-46f9-4721-b2e1-f0b60b042b2a",
    "ContributorFirstName": "sample string 15",
    "ContributorLastName": "sample string 16",
    "ContributorSourceId": "sample string 17",
    "BatchName": "sample string 18",
    "AdvocateID": "sample string 19",
    "CompanyName": "sample string 20",
    "CompanySourceId": "sample string 21",
    "PoliticalCommitteeName": "sample string 22",
    "PoliticalCommitteeSourceId": "sample string 23",
    "RecurrenceType": "sample string 24",
    "Duration": "sample string 25",
    "NumberOfPayments": 1,
    "CommittedAmount": 1.0,
    "DurationDate": "2025-06-28T00:09:07.0197008-04:00",
    "Udf": [
      {
        "UdfText": "sample string 1",
        "UdfValue": "sample string 2"
      },
      {
        "UdfText": "sample string 1",
        "UdfValue": "sample string 2"
      }
    ]
  },
  {
    "ReceiptGuid": "604862f8-748f-4de8-a34c-1e24b31dd5ce",
    "FilingCommittee": "sample string 2",
    "BankAccount": "sample string 3",
    "ReceiptDate": "2025-06-28T00:09:07.0040718-04:00",
    "ReceiptAmount": 5.0,
    "ReceiptCreatedOnDate": "2025-06-28T00:09:07.0040718-04:00",
    "ReceiptSourceId": "sample string 7",
    "ReceiptSource": "sample string 8",
    "WebformName": "sample string 9",
    "ReceiptType": "sample string 10",
    "ReceiptSubType": "sample string 11",
    "ElectionPeriod": 1,
    "ElectionPeriodText": "sample string 12",
    "ReceiptCheckNumber": "sample string 13",
    "ReceiptPurpose": "sample string 14",
    "ContributorGUID": "298e51ec-46f9-4721-b2e1-f0b60b042b2a",
    "ContributorFirstName": "sample string 15",
    "ContributorLastName": "sample string 16",
    "ContributorSourceId": "sample string 17",
    "BatchName": "sample string 18",
    "AdvocateID": "sample string 19",
    "CompanyName": "sample string 20",
    "CompanySourceId": "sample string 21",
    "PoliticalCommitteeName": "sample string 22",
    "PoliticalCommitteeSourceId": "sample string 23",
    "RecurrenceType": "sample string 24",
    "Duration": "sample string 25",
    "NumberOfPayments": 1,
    "CommittedAmount": 1.0,
    "DurationDate": "2025-06-28T00:09:07.0197008-04:00",
    "Udf": [
      {
        "UdfText": "sample string 1",
        "UdfValue": "sample string 2"
      },
      {
        "UdfText": "sample string 1",
        "UdfValue": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomReceipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.P6.Model.Client.Receipt">
  <CustomReceipt>
    <AdvocateID>sample string 19</AdvocateID>
    <BankAccount>sample string 3</BankAccount>
    <BatchName>sample string 18</BatchName>
    <CommittedAmount>1</CommittedAmount>
    <CompanyName>sample string 20</CompanyName>
    <CompanySourceId>sample string 21</CompanySourceId>
    <ContributorFirstName>sample string 15</ContributorFirstName>
    <ContributorGUID>298e51ec-46f9-4721-b2e1-f0b60b042b2a</ContributorGUID>
    <ContributorLastName>sample string 16</ContributorLastName>
    <ContributorSourceId>sample string 17</ContributorSourceId>
    <Duration>sample string 25</Duration>
    <DurationDate>2025-06-28T00:09:07.0197008-04:00</DurationDate>
    <ElectionPeriod>1</ElectionPeriod>
    <ElectionPeriodText>sample string 12</ElectionPeriodText>
    <FilingCommittee>sample string 2</FilingCommittee>
    <NumberOfPayments>1</NumberOfPayments>
    <PoliticalCommitteeName>sample string 22</PoliticalCommitteeName>
    <PoliticalCommitteeSourceId>sample string 23</PoliticalCommitteeSourceId>
    <ReceiptAmount>5</ReceiptAmount>
    <ReceiptCheckNumber>sample string 13</ReceiptCheckNumber>
    <ReceiptCreatedOnDate>2025-06-28T00:09:07.0040718-04:00</ReceiptCreatedOnDate>
    <ReceiptDate>2025-06-28T00:09:07.0040718-04:00</ReceiptDate>
    <ReceiptGuid>604862f8-748f-4de8-a34c-1e24b31dd5ce</ReceiptGuid>
    <ReceiptPurpose>sample string 14</ReceiptPurpose>
    <ReceiptSource>sample string 8</ReceiptSource>
    <ReceiptSourceId>sample string 7</ReceiptSourceId>
    <ReceiptSubType>sample string 11</ReceiptSubType>
    <ReceiptType>sample string 10</ReceiptType>
    <RecurrenceType>sample string 24</RecurrenceType>
    <Udf>
      <ReceiptUdf>
        <UdfText>sample string 1</UdfText>
        <UdfValue>sample string 2</UdfValue>
      </ReceiptUdf>
      <ReceiptUdf>
        <UdfText>sample string 1</UdfText>
        <UdfValue>sample string 2</UdfValue>
      </ReceiptUdf>
    </Udf>
    <WebformName>sample string 9</WebformName>
  </CustomReceipt>
  <CustomReceipt>
    <AdvocateID>sample string 19</AdvocateID>
    <BankAccount>sample string 3</BankAccount>
    <BatchName>sample string 18</BatchName>
    <CommittedAmount>1</CommittedAmount>
    <CompanyName>sample string 20</CompanyName>
    <CompanySourceId>sample string 21</CompanySourceId>
    <ContributorFirstName>sample string 15</ContributorFirstName>
    <ContributorGUID>298e51ec-46f9-4721-b2e1-f0b60b042b2a</ContributorGUID>
    <ContributorLastName>sample string 16</ContributorLastName>
    <ContributorSourceId>sample string 17</ContributorSourceId>
    <Duration>sample string 25</Duration>
    <DurationDate>2025-06-28T00:09:07.0197008-04:00</DurationDate>
    <ElectionPeriod>1</ElectionPeriod>
    <ElectionPeriodText>sample string 12</ElectionPeriodText>
    <FilingCommittee>sample string 2</FilingCommittee>
    <NumberOfPayments>1</NumberOfPayments>
    <PoliticalCommitteeName>sample string 22</PoliticalCommitteeName>
    <PoliticalCommitteeSourceId>sample string 23</PoliticalCommitteeSourceId>
    <ReceiptAmount>5</ReceiptAmount>
    <ReceiptCheckNumber>sample string 13</ReceiptCheckNumber>
    <ReceiptCreatedOnDate>2025-06-28T00:09:07.0040718-04:00</ReceiptCreatedOnDate>
    <ReceiptDate>2025-06-28T00:09:07.0040718-04:00</ReceiptDate>
    <ReceiptGuid>604862f8-748f-4de8-a34c-1e24b31dd5ce</ReceiptGuid>
    <ReceiptPurpose>sample string 14</ReceiptPurpose>
    <ReceiptSource>sample string 8</ReceiptSource>
    <ReceiptSourceId>sample string 7</ReceiptSourceId>
    <ReceiptSubType>sample string 11</ReceiptSubType>
    <ReceiptType>sample string 10</ReceiptType>
    <RecurrenceType>sample string 24</RecurrenceType>
    <Udf>
      <ReceiptUdf>
        <UdfText>sample string 1</UdfText>
        <UdfValue>sample string 2</UdfValue>
      </ReceiptUdf>
      <ReceiptUdf>
        <UdfText>sample string 1</UdfText>
        <UdfValue>sample string 2</UdfValue>
      </ReceiptUdf>
    </Udf>
    <WebformName>sample string 9</WebformName>
  </CustomReceipt>
</ArrayOfCustomReceipt>