GET Vouchers/Download?apikey={apikey}&TrusteeID={TrusteeID}&CheckNumber={CheckNumber}&PaymentDT={PaymentDT}&SearchAllTime={SearchAllTime}

Returns detailed information about a set of Vouchers (By Check Number) and the Payments related to them.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

The apikey used for authentication. Required.

 string

Required
TrusteeID

Alphanumeric Trustee Identifier

 string

Required
CheckNumber

A single Check Number, a range of Check Numbers in the format StartCheck*EndCheck, or a comma-separated list of specific Check Numbers to find.

 string

None.
PaymentDT

A single Payment Date in the form of MM/DD/YYYY

 date

None.
SearchAllTime

If true, searches across all time, otherwise only searches back 6 months.

 boolean

Default value is False

Response Information

Response Schema Document

Resource Description

The Vouchers matched and the payments for those Vouchers.

Collection of Voucher
NameDescriptionTypeAdditional information
CheckNumber

string

None.
Payments

Collection of Payment

None.

Response Formats

application/xml, text/xml

Sample: 
<ArrayOfVoucher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <Voucher>
    <CheckNumber>sample string 1</CheckNumber>
    <Payments>
      <Payment>
        <AccountNumber>sample string 18</AccountNumber>
        <CaseNumber>sample string 5</CaseNumber>
        <CaseStatus>sample string 17</CaseStatus>
        <CheckAmount>7</CheckAmount>
        <ChkDate>sample string 19</ChkDate>
        <ClaimLevel>sample string 20</ClaimLevel>
        <ClaimNumber>sample string 6</ClaimNumber>
        <ClaimType>sample string 21</ClaimType>
        <Comment>sample string 22</Comment>
        <CredName>sample string 24</CredName>
        <CredNo>sample string 23</CredNo>
        <Deb1FirstName>sample string 12</Deb1FirstName>
        <Deb1LastName>sample string 11</Deb1LastName>
        <Deb1SSN>sample string 13</Deb1SSN>
        <Deb2FirstName>sample string 15</Deb2FirstName>
        <Deb2LastName>sample string 14</Deb2LastName>
        <Deb2SSN>sample string 16</Deb2SSN>
        <NDC_Case_ID>sample string 9</NDC_Case_ID>
        <NDC_Claim_ID>sample string 10</NDC_Claim_ID>
        <PaymentType>sample string 8</PaymentType>
        <TrusteeCity>sample string 3</TrusteeCity>
        <TrusteeID>sample string 1</TrusteeID>
        <TrusteeName>sample string 2</TrusteeName>
        <TrusteeState>sample string 4</TrusteeState>
      </Payment>
      <Payment>
        <AccountNumber>sample string 18</AccountNumber>
        <CaseNumber>sample string 5</CaseNumber>
        <CaseStatus>sample string 17</CaseStatus>
        <CheckAmount>7</CheckAmount>
        <ChkDate>sample string 19</ChkDate>
        <ClaimLevel>sample string 20</ClaimLevel>
        <ClaimNumber>sample string 6</ClaimNumber>
        <ClaimType>sample string 21</ClaimType>
        <Comment>sample string 22</Comment>
        <CredName>sample string 24</CredName>
        <CredNo>sample string 23</CredNo>
        <Deb1FirstName>sample string 12</Deb1FirstName>
        <Deb1LastName>sample string 11</Deb1LastName>
        <Deb1SSN>sample string 13</Deb1SSN>
        <Deb2FirstName>sample string 15</Deb2FirstName>
        <Deb2LastName>sample string 14</Deb2LastName>
        <Deb2SSN>sample string 16</Deb2SSN>
        <NDC_Case_ID>sample string 9</NDC_Case_ID>
        <NDC_Claim_ID>sample string 10</NDC_Claim_ID>
        <PaymentType>sample string 8</PaymentType>
        <TrusteeCity>sample string 3</TrusteeCity>
        <TrusteeID>sample string 1</TrusteeID>
        <TrusteeName>sample string 2</TrusteeName>
        <TrusteeState>sample string 4</TrusteeState>
      </Payment>
    </Payments>
  </Voucher>
  <Voucher>
    <CheckNumber>sample string 1</CheckNumber>
    <Payments>
      <Payment>
        <AccountNumber>sample string 18</AccountNumber>
        <CaseNumber>sample string 5</CaseNumber>
        <CaseStatus>sample string 17</CaseStatus>
        <CheckAmount>7</CheckAmount>
        <ChkDate>sample string 19</ChkDate>
        <ClaimLevel>sample string 20</ClaimLevel>
        <ClaimNumber>sample string 6</ClaimNumber>
        <ClaimType>sample string 21</ClaimType>
        <Comment>sample string 22</Comment>
        <CredName>sample string 24</CredName>
        <CredNo>sample string 23</CredNo>
        <Deb1FirstName>sample string 12</Deb1FirstName>
        <Deb1LastName>sample string 11</Deb1LastName>
        <Deb1SSN>sample string 13</Deb1SSN>
        <Deb2FirstName>sample string 15</Deb2FirstName>
        <Deb2LastName>sample string 14</Deb2LastName>
        <Deb2SSN>sample string 16</Deb2SSN>
        <NDC_Case_ID>sample string 9</NDC_Case_ID>
        <NDC_Claim_ID>sample string 10</NDC_Claim_ID>
        <PaymentType>sample string 8</PaymentType>
        <TrusteeCity>sample string 3</TrusteeCity>
        <TrusteeID>sample string 1</TrusteeID>
        <TrusteeName>sample string 2</TrusteeName>
        <TrusteeState>sample string 4</TrusteeState>
      </Payment>
      <Payment>
        <AccountNumber>sample string 18</AccountNumber>
        <CaseNumber>sample string 5</CaseNumber>
        <CaseStatus>sample string 17</CaseStatus>
        <CheckAmount>7</CheckAmount>
        <ChkDate>sample string 19</ChkDate>
        <ClaimLevel>sample string 20</ClaimLevel>
        <ClaimNumber>sample string 6</ClaimNumber>
        <ClaimType>sample string 21</ClaimType>
        <Comment>sample string 22</Comment>
        <CredName>sample string 24</CredName>
        <CredNo>sample string 23</CredNo>
        <Deb1FirstName>sample string 12</Deb1FirstName>
        <Deb1LastName>sample string 11</Deb1LastName>
        <Deb1SSN>sample string 13</Deb1SSN>
        <Deb2FirstName>sample string 15</Deb2FirstName>
        <Deb2LastName>sample string 14</Deb2LastName>
        <Deb2SSN>sample string 16</Deb2SSN>
        <NDC_Case_ID>sample string 9</NDC_Case_ID>
        <NDC_Claim_ID>sample string 10</NDC_Claim_ID>
        <PaymentType>sample string 8</PaymentType>
        <TrusteeCity>sample string 3</TrusteeCity>
        <TrusteeID>sample string 1</TrusteeID>
        <TrusteeName>sample string 2</TrusteeName>
        <TrusteeState>sample string 4</TrusteeState>
      </Payment>
    </Payments>
  </Voucher>
</ArrayOfVoucher>

application/json, text/json

Sample: 
[
  {
    "CheckNumber": "sample string 1",
    "Payments": [
      {
        "TrusteeID": "sample string 1",
        "TrusteeName": "sample string 2",
        "TrusteeCity": "sample string 3",
        "TrusteeState": "sample string 4",
        "CaseNumber": "sample string 5",
        "ClaimNumber": "sample string 6",
        "CheckAmount": 7.0,
        "PaymentType": "sample string 8",
        "NDC_Case_ID": "sample string 9",
        "NDC_Claim_ID": "sample string 10",
        "Deb1LastName": "sample string 11",
        "Deb1FirstName": "sample string 12",
        "Deb1SSN": "sample string 13",
        "Deb2LastName": "sample string 14",
        "Deb2FirstName": "sample string 15",
        "Deb2SSN": "sample string 16",
        "CaseStatus": "sample string 17",
        "AccountNumber": "sample string 18",
        "ChkDate": "sample string 19",
        "ClaimLevel": "sample string 20",
        "ClaimType": "sample string 21",
        "Comment": "sample string 22",
        "CredNo": "sample string 23",
        "CredName": "sample string 24"
      },
      {
        "TrusteeID": "sample string 1",
        "TrusteeName": "sample string 2",
        "TrusteeCity": "sample string 3",
        "TrusteeState": "sample string 4",
        "CaseNumber": "sample string 5",
        "ClaimNumber": "sample string 6",
        "CheckAmount": 7.0,
        "PaymentType": "sample string 8",
        "NDC_Case_ID": "sample string 9",
        "NDC_Claim_ID": "sample string 10",
        "Deb1LastName": "sample string 11",
        "Deb1FirstName": "sample string 12",
        "Deb1SSN": "sample string 13",
        "Deb2LastName": "sample string 14",
        "Deb2FirstName": "sample string 15",
        "Deb2SSN": "sample string 16",
        "CaseStatus": "sample string 17",
        "AccountNumber": "sample string 18",
        "ChkDate": "sample string 19",
        "ClaimLevel": "sample string 20",
        "ClaimType": "sample string 21",
        "Comment": "sample string 22",
        "CredNo": "sample string 23",
        "CredName": "sample string 24"
      }
    ]
  },
  {
    "CheckNumber": "sample string 1",
    "Payments": [
      {
        "TrusteeID": "sample string 1",
        "TrusteeName": "sample string 2",
        "TrusteeCity": "sample string 3",
        "TrusteeState": "sample string 4",
        "CaseNumber": "sample string 5",
        "ClaimNumber": "sample string 6",
        "CheckAmount": 7.0,
        "PaymentType": "sample string 8",
        "NDC_Case_ID": "sample string 9",
        "NDC_Claim_ID": "sample string 10",
        "Deb1LastName": "sample string 11",
        "Deb1FirstName": "sample string 12",
        "Deb1SSN": "sample string 13",
        "Deb2LastName": "sample string 14",
        "Deb2FirstName": "sample string 15",
        "Deb2SSN": "sample string 16",
        "CaseStatus": "sample string 17",
        "AccountNumber": "sample string 18",
        "ChkDate": "sample string 19",
        "ClaimLevel": "sample string 20",
        "ClaimType": "sample string 21",
        "Comment": "sample string 22",
        "CredNo": "sample string 23",
        "CredName": "sample string 24"
      },
      {
        "TrusteeID": "sample string 1",
        "TrusteeName": "sample string 2",
        "TrusteeCity": "sample string 3",
        "TrusteeState": "sample string 4",
        "CaseNumber": "sample string 5",
        "ClaimNumber": "sample string 6",
        "CheckAmount": 7.0,
        "PaymentType": "sample string 8",
        "NDC_Case_ID": "sample string 9",
        "NDC_Claim_ID": "sample string 10",
        "Deb1LastName": "sample string 11",
        "Deb1FirstName": "sample string 12",
        "Deb1SSN": "sample string 13",
        "Deb2LastName": "sample string 14",
        "Deb2FirstName": "sample string 15",
        "Deb2SSN": "sample string 16",
        "CaseStatus": "sample string 17",
        "AccountNumber": "sample string 18",
        "ChkDate": "sample string 19",
        "ClaimLevel": "sample string 20",
        "ClaimType": "sample string 21",
        "Comment": "sample string 22",
        "CredNo": "sample string 23",
        "CredName": "sample string 24"
      }
    ]
  }
]