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

Returns detailed information about a set of Vouchers. Specify a TrusteeID and either a CheckNumber OR PaymentDT ** 10/20/2015 - Added additional elements to Voucher Header **

Request Information

URI Parameters

Name	Description	Type	Additional 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 Voucher3

Name	Type	Additional information
CheckNumber	string	None.
CheckTrusteeID	string	None.
CheckTrusteeName	string	None.
CheckTrusteeCity	string	None.
CheckTrusteeState	string	None.
CheckTotalItems	string	None.
CheckTotalAmount	string	None.
Payments	Collection of Payment3	None.

Response Formats

application/xml, text/xml

Sample:

<ArrayOfVoucher3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <Voucher3>
    <CheckNumber>sample string 1</CheckNumber>
    <CheckTotalAmount>sample string 7</CheckTotalAmount>
    <CheckTotalItems>sample string 6</CheckTotalItems>
    <CheckTrusteeCity>sample string 4</CheckTrusteeCity>
    <CheckTrusteeID>sample string 2</CheckTrusteeID>
    <CheckTrusteeName>sample string 3</CheckTrusteeName>
    <CheckTrusteeState>sample string 5</CheckTrusteeState>
    <Payments>
      <Payment3>
        <AccountNumber>sample string 14</AccountNumber>
        <CaseNumber>sample string 1</CaseNumber>
        <CaseStatus>sample string 13</CaseStatus>
        <CheckAmount>3</CheckAmount>
        <CheckDate>sample string 19</CheckDate>
        <ClaimAmount>sample string 22</ClaimAmount>
        <ClaimLevel>sample string 15</ClaimLevel>
        <ClaimNumber>sample string 2</ClaimNumber>
        <ClaimTag>sample string 35</ClaimTag>
        <ClaimTagClaimIdentifier>sample string 33</ClaimTagClaimIdentifier>
        <ClaimTagPaymentType>sample string 34</ClaimTagPaymentType>
        <ClaimType>sample string 16</ClaimType>
        <ClaimTypeCode>sample string 36</ClaimTypeCode>
        <ClassType>sample string 38</ClassType>
        <ClassTypeCode>sample string 37</ClassTypeCode>
        <Comment>sample string 17</Comment>
        <CredNo>sample string 18</CredNo>
        <CreditorName>sample string 20</CreditorName>
        <Deb1FirstName>sample string 8</Deb1FirstName>
        <Deb1LastName>sample string 7</Deb1LastName>
        <Deb1SSN>sample string 9</Deb1SSN>
        <Deb2FirstName>sample string 11</Deb2FirstName>
        <Deb2LastName>sample string 10</Deb2LastName>
        <Deb2SSN>sample string 12</Deb2SSN>
        <Interest_AMT>sample string 25</Interest_AMT>
        <NDC_Case_ID>sample string 5</NDC_Case_ID>
        <NDC_Claim_ID>sample string 6</NDC_Claim_ID>
        <Payee_Address_Line1>sample string 27</Payee_Address_Line1>
        <Payee_Address_Line2>sample string 28</Payee_Address_Line2>
        <Payee_City>sample string 29</Payee_City>
        <Payee_Name>sample string 26</Payee_Name>
        <Payee_State>sample string 30</Payee_State>
        <Payee_ZipCode>sample string 31</Payee_ZipCode>
        <PaymentType>sample string 4</PaymentType>
        <Post_DT>sample string 23</Post_DT>
        <Principal_AMT>sample string 24</Principal_AMT>
        <Transaction_Status>sample string 32</Transaction_Status>
        <UCI>sample string 21</UCI>
      </Payment3>
      <Payment3>
        <AccountNumber>sample string 14</AccountNumber>
        <CaseNumber>sample string 1</CaseNumber>
        <CaseStatus>sample string 13</CaseStatus>
        <CheckAmount>3</CheckAmount>
        <CheckDate>sample string 19</CheckDate>
        <ClaimAmount>sample string 22</ClaimAmount>
        <ClaimLevel>sample string 15</ClaimLevel>
        <ClaimNumber>sample string 2</ClaimNumber>
        <ClaimTag>sample string 35</ClaimTag>
        <ClaimTagClaimIdentifier>sample string 33</ClaimTagClaimIdentifier>
        <ClaimTagPaymentType>sample string 34</ClaimTagPaymentType>
        <ClaimType>sample string 16</ClaimType>
        <ClaimTypeCode>sample string 36</ClaimTypeCode>
        <ClassType>sample string 38</ClassType>
        <ClassTypeCode>sample string 37</ClassTypeCode>
        <Comment>sample string 17</Comment>
        <CredNo>sample string 18</CredNo>
        <CreditorName>sample string 20</CreditorName>
        <Deb1FirstName>sample string 8</Deb1FirstName>
        <Deb1LastName>sample string 7</Deb1LastName>
        <Deb1SSN>sample string 9</Deb1SSN>
        <Deb2FirstName>sample string 11</Deb2FirstName>
        <Deb2LastName>sample string 10</Deb2LastName>
        <Deb2SSN>sample string 12</Deb2SSN>
        <Interest_AMT>sample string 25</Interest_AMT>
        <NDC_Case_ID>sample string 5</NDC_Case_ID>
        <NDC_Claim_ID>sample string 6</NDC_Claim_ID>
        <Payee_Address_Line1>sample string 27</Payee_Address_Line1>
        <Payee_Address_Line2>sample string 28</Payee_Address_Line2>
        <Payee_City>sample string 29</Payee_City>
        <Payee_Name>sample string 26</Payee_Name>
        <Payee_State>sample string 30</Payee_State>
        <Payee_ZipCode>sample string 31</Payee_ZipCode>
        <PaymentType>sample string 4</PaymentType>
        <Post_DT>sample string 23</Post_DT>
        <Principal_AMT>sample string 24</Principal_AMT>
        <Transaction_Status>sample string 32</Transaction_Status>
        <UCI>sample string 21</UCI>
      </Payment3>
    </Payments>
  </Voucher3>
  <Voucher3>
    <CheckNumber>sample string 1</CheckNumber>
    <CheckTotalAmount>sample string 7</CheckTotalAmount>
    <CheckTotalItems>sample string 6</CheckTotalItems>
    <CheckTrusteeCity>sample string 4</CheckTrusteeCity>
    <CheckTrusteeID>sample string 2</CheckTrusteeID>
    <CheckTrusteeName>sample string 3</CheckTrusteeName>
    <CheckTrusteeState>sample string 5</CheckTrusteeState>
    <Payments>
      <Payment3>
        <AccountNumber>sample string 14</AccountNumber>
        <CaseNumber>sample string 1</CaseNumber>
        <CaseStatus>sample string 13</CaseStatus>
        <CheckAmount>3</CheckAmount>
        <CheckDate>sample string 19</CheckDate>
        <ClaimAmount>sample string 22</ClaimAmount>
        <ClaimLevel>sample string 15</ClaimLevel>
        <ClaimNumber>sample string 2</ClaimNumber>
        <ClaimTag>sample string 35</ClaimTag>
        <ClaimTagClaimIdentifier>sample string 33</ClaimTagClaimIdentifier>
        <ClaimTagPaymentType>sample string 34</ClaimTagPaymentType>
        <ClaimType>sample string 16</ClaimType>
        <ClaimTypeCode>sample string 36</ClaimTypeCode>
        <ClassType>sample string 38</ClassType>
        <ClassTypeCode>sample string 37</ClassTypeCode>
        <Comment>sample string 17</Comment>
        <CredNo>sample string 18</CredNo>
        <CreditorName>sample string 20</CreditorName>
        <Deb1FirstName>sample string 8</Deb1FirstName>
        <Deb1LastName>sample string 7</Deb1LastName>
        <Deb1SSN>sample string 9</Deb1SSN>
        <Deb2FirstName>sample string 11</Deb2FirstName>
        <Deb2LastName>sample string 10</Deb2LastName>
        <Deb2SSN>sample string 12</Deb2SSN>
        <Interest_AMT>sample string 25</Interest_AMT>
        <NDC_Case_ID>sample string 5</NDC_Case_ID>
        <NDC_Claim_ID>sample string 6</NDC_Claim_ID>
        <Payee_Address_Line1>sample string 27</Payee_Address_Line1>
        <Payee_Address_Line2>sample string 28</Payee_Address_Line2>
        <Payee_City>sample string 29</Payee_City>
        <Payee_Name>sample string 26</Payee_Name>
        <Payee_State>sample string 30</Payee_State>
        <Payee_ZipCode>sample string 31</Payee_ZipCode>
        <PaymentType>sample string 4</PaymentType>
        <Post_DT>sample string 23</Post_DT>
        <Principal_AMT>sample string 24</Principal_AMT>
        <Transaction_Status>sample string 32</Transaction_Status>
        <UCI>sample string 21</UCI>
      </Payment3>
      <Payment3>
        <AccountNumber>sample string 14</AccountNumber>
        <CaseNumber>sample string 1</CaseNumber>
        <CaseStatus>sample string 13</CaseStatus>
        <CheckAmount>3</CheckAmount>
        <CheckDate>sample string 19</CheckDate>
        <ClaimAmount>sample string 22</ClaimAmount>
        <ClaimLevel>sample string 15</ClaimLevel>
        <ClaimNumber>sample string 2</ClaimNumber>
        <ClaimTag>sample string 35</ClaimTag>
        <ClaimTagClaimIdentifier>sample string 33</ClaimTagClaimIdentifier>
        <ClaimTagPaymentType>sample string 34</ClaimTagPaymentType>
        <ClaimType>sample string 16</ClaimType>
        <ClaimTypeCode>sample string 36</ClaimTypeCode>
        <ClassType>sample string 38</ClassType>
        <ClassTypeCode>sample string 37</ClassTypeCode>
        <Comment>sample string 17</Comment>
        <CredNo>sample string 18</CredNo>
        <CreditorName>sample string 20</CreditorName>
        <Deb1FirstName>sample string 8</Deb1FirstName>
        <Deb1LastName>sample string 7</Deb1LastName>
        <Deb1SSN>sample string 9</Deb1SSN>
        <Deb2FirstName>sample string 11</Deb2FirstName>
        <Deb2LastName>sample string 10</Deb2LastName>
        <Deb2SSN>sample string 12</Deb2SSN>
        <Interest_AMT>sample string 25</Interest_AMT>
        <NDC_Case_ID>sample string 5</NDC_Case_ID>
        <NDC_Claim_ID>sample string 6</NDC_Claim_ID>
        <Payee_Address_Line1>sample string 27</Payee_Address_Line1>
        <Payee_Address_Line2>sample string 28</Payee_Address_Line2>
        <Payee_City>sample string 29</Payee_City>
        <Payee_Name>sample string 26</Payee_Name>
        <Payee_State>sample string 30</Payee_State>
        <Payee_ZipCode>sample string 31</Payee_ZipCode>
        <PaymentType>sample string 4</PaymentType>
        <Post_DT>sample string 23</Post_DT>
        <Principal_AMT>sample string 24</Principal_AMT>
        <Transaction_Status>sample string 32</Transaction_Status>
        <UCI>sample string 21</UCI>
      </Payment3>
    </Payments>
  </Voucher3>
</ArrayOfVoucher3>

application/json, text/json

Sample:

[
  {
    "CheckNumber": "sample string 1",
    "CheckTrusteeID": "sample string 2",
    "CheckTrusteeName": "sample string 3",
    "CheckTrusteeCity": "sample string 4",
    "CheckTrusteeState": "sample string 5",
    "CheckTotalItems": "sample string 6",
    "CheckTotalAmount": "sample string 7",
    "Payments": [
      {
        "CaseNumber": "sample string 1",
        "ClaimNumber": "sample string 2",
        "CheckAmount": 3.0,
        "PaymentType": "sample string 4",
        "NDC_Case_ID": "sample string 5",
        "NDC_Claim_ID": "sample string 6",
        "Deb1LastName": "sample string 7",
        "Deb1FirstName": "sample string 8",
        "Deb1SSN": "sample string 9",
        "Deb2LastName": "sample string 10",
        "Deb2FirstName": "sample string 11",
        "Deb2SSN": "sample string 12",
        "CaseStatus": "sample string 13",
        "AccountNumber": "sample string 14",
        "ClaimLevel": "sample string 15",
        "ClaimType": "sample string 16",
        "Comment": "sample string 17",
        "CredNo": "sample string 18",
        "CheckDate": "sample string 19",
        "CreditorName": "sample string 20",
        "UCI": "sample string 21",
        "ClaimAmount": "sample string 22",
        "Post_DT": "sample string 23",
        "Principal_AMT": "sample string 24",
        "Interest_AMT": "sample string 25",
        "Payee_Name": "sample string 26",
        "Payee_Address_Line1": "sample string 27",
        "Payee_Address_Line2": "sample string 28",
        "Payee_City": "sample string 29",
        "Payee_State": "sample string 30",
        "Payee_ZipCode": "sample string 31",
        "Transaction_Status": "sample string 32",
        "ClaimTagClaimIdentifier": "sample string 33",
        "ClaimTagPaymentType": "sample string 34",
        "ClaimTag": "sample string 35",
        "ClaimTypeCode": "sample string 36",
        "ClassTypeCode": "sample string 37",
        "ClassType": "sample string 38"
      },
      {
        "CaseNumber": "sample string 1",
        "ClaimNumber": "sample string 2",
        "CheckAmount": 3.0,
        "PaymentType": "sample string 4",
        "NDC_Case_ID": "sample string 5",
        "NDC_Claim_ID": "sample string 6",
        "Deb1LastName": "sample string 7",
        "Deb1FirstName": "sample string 8",
        "Deb1SSN": "sample string 9",
        "Deb2LastName": "sample string 10",
        "Deb2FirstName": "sample string 11",
        "Deb2SSN": "sample string 12",
        "CaseStatus": "sample string 13",
        "AccountNumber": "sample string 14",
        "ClaimLevel": "sample string 15",
        "ClaimType": "sample string 16",
        "Comment": "sample string 17",
        "CredNo": "sample string 18",
        "CheckDate": "sample string 19",
        "CreditorName": "sample string 20",
        "UCI": "sample string 21",
        "ClaimAmount": "sample string 22",
        "Post_DT": "sample string 23",
        "Principal_AMT": "sample string 24",
        "Interest_AMT": "sample string 25",
        "Payee_Name": "sample string 26",
        "Payee_Address_Line1": "sample string 27",
        "Payee_Address_Line2": "sample string 28",
        "Payee_City": "sample string 29",
        "Payee_State": "sample string 30",
        "Payee_ZipCode": "sample string 31",
        "Transaction_Status": "sample string 32",
        "ClaimTagClaimIdentifier": "sample string 33",
        "ClaimTagPaymentType": "sample string 34",
        "ClaimTag": "sample string 35",
        "ClaimTypeCode": "sample string 36",
        "ClassTypeCode": "sample string 37",
        "ClassType": "sample string 38"
      }
    ]
  },
  {
    "CheckNumber": "sample string 1",
    "CheckTrusteeID": "sample string 2",
    "CheckTrusteeName": "sample string 3",
    "CheckTrusteeCity": "sample string 4",
    "CheckTrusteeState": "sample string 5",
    "CheckTotalItems": "sample string 6",
    "CheckTotalAmount": "sample string 7",
    "Payments": [
      {
        "CaseNumber": "sample string 1",
        "ClaimNumber": "sample string 2",
        "CheckAmount": 3.0,
        "PaymentType": "sample string 4",
        "NDC_Case_ID": "sample string 5",
        "NDC_Claim_ID": "sample string 6",
        "Deb1LastName": "sample string 7",
        "Deb1FirstName": "sample string 8",
        "Deb1SSN": "sample string 9",
        "Deb2LastName": "sample string 10",
        "Deb2FirstName": "sample string 11",
        "Deb2SSN": "sample string 12",
        "CaseStatus": "sample string 13",
        "AccountNumber": "sample string 14",
        "ClaimLevel": "sample string 15",
        "ClaimType": "sample string 16",
        "Comment": "sample string 17",
        "CredNo": "sample string 18",
        "CheckDate": "sample string 19",
        "CreditorName": "sample string 20",
        "UCI": "sample string 21",
        "ClaimAmount": "sample string 22",
        "Post_DT": "sample string 23",
        "Principal_AMT": "sample string 24",
        "Interest_AMT": "sample string 25",
        "Payee_Name": "sample string 26",
        "Payee_Address_Line1": "sample string 27",
        "Payee_Address_Line2": "sample string 28",
        "Payee_City": "sample string 29",
        "Payee_State": "sample string 30",
        "Payee_ZipCode": "sample string 31",
        "Transaction_Status": "sample string 32",
        "ClaimTagClaimIdentifier": "sample string 33",
        "ClaimTagPaymentType": "sample string 34",
        "ClaimTag": "sample string 35",
        "ClaimTypeCode": "sample string 36",
        "ClassTypeCode": "sample string 37",
        "ClassType": "sample string 38"
      },
      {
        "CaseNumber": "sample string 1",
        "ClaimNumber": "sample string 2",
        "CheckAmount": 3.0,
        "PaymentType": "sample string 4",
        "NDC_Case_ID": "sample string 5",
        "NDC_Claim_ID": "sample string 6",
        "Deb1LastName": "sample string 7",
        "Deb1FirstName": "sample string 8",
        "Deb1SSN": "sample string 9",
        "Deb2LastName": "sample string 10",
        "Deb2FirstName": "sample string 11",
        "Deb2SSN": "sample string 12",
        "CaseStatus": "sample string 13",
        "AccountNumber": "sample string 14",
        "ClaimLevel": "sample string 15",
        "ClaimType": "sample string 16",
        "Comment": "sample string 17",
        "CredNo": "sample string 18",
        "CheckDate": "sample string 19",
        "CreditorName": "sample string 20",
        "UCI": "sample string 21",
        "ClaimAmount": "sample string 22",
        "Post_DT": "sample string 23",
        "Principal_AMT": "sample string 24",
        "Interest_AMT": "sample string 25",
        "Payee_Name": "sample string 26",
        "Payee_Address_Line1": "sample string 27",
        "Payee_Address_Line2": "sample string 28",
        "Payee_City": "sample string 29",
        "Payee_State": "sample string 30",
        "Payee_ZipCode": "sample string 31",
        "Transaction_Status": "sample string 32",
        "ClaimTagClaimIdentifier": "sample string 33",
        "ClaimTagPaymentType": "sample string 34",
        "ClaimTag": "sample string 35",
        "ClaimTypeCode": "sample string 36",
        "ClassTypeCode": "sample string 37",
        "ClassType": "sample string 38"
      }
    ]
  }
]

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

Request Information

URI Parameters

Response Information

Response Schema Document

Resource Description

Response Formats

application/xml, text/xml

application/json, text/json

URI parameters

Headers | Add header

Body

Status

Headers

Body