GET Vouchers2/PortfolioVoucher?apikey={apikey}&CheckNumber={CheckNumber}&PaymentDT={PaymentDT}
Returns detailed information about a set of Vouchers. Specify a TrusteeID and either a CheckNumber OR PaymentDT. This API only work for String portfolio based customers. It will search for vouchers for all trustees that pertain to Claims that we have indentified you are a party in interest on.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| apikey |
The apikey used for authentication. Required. |
string |
Required |
| CheckNumber |
A single Check Number. |
string |
None. |
| PaymentDT |
A single Payment Date in the form of MM/DD/YYYY |
date |
None. |
Response Information
Response Schema Document
Resource Description
The Vouchers matched and the payments for those Vouchers.
Collection of Voucher2| Name | Description | Type | Additional information |
|---|---|---|---|
| CheckNumber | string |
None. |
|
| Payments | Collection of Payment2 |
None. |
Response Formats
application/xml, text/xml
Sample:
<ArrayOfVoucher2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
<Voucher2>
<CheckNumber>sample string 1</CheckNumber>
<Payments>
<Payment2>
<AccountNumber>sample string 18</AccountNumber>
<CaseNumber>sample string 5</CaseNumber>
<CaseStatus>sample string 17</CaseStatus>
<CheckAmount>7</CheckAmount>
<ChkDate>sample string 19</ChkDate>
<ClaimAmount>sample string 26</ClaimAmount>
<ClaimLevel>sample string 20</ClaimLevel>
<ClaimNumber>sample string 6</ClaimNumber>
<ClaimTag>sample string 39</ClaimTag>
<ClaimTagClaimIdentifier>sample string 37</ClaimTagClaimIdentifier>
<ClaimTagPaymentType>sample string 38</ClaimTagPaymentType>
<ClaimType>sample string 21</ClaimType>
<ClaimTypeCode>sample string 40</ClaimTypeCode>
<ClassType>sample string 42</ClassType>
<ClassTypeCode>sample string 41</ClassTypeCode>
<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>
<Interest_AMT>sample string 29</Interest_AMT>
<NDC_Case_ID>sample string 9</NDC_Case_ID>
<NDC_Claim_ID>sample string 10</NDC_Claim_ID>
<Payee_Address_Line1>sample string 31</Payee_Address_Line1>
<Payee_Address_Line2>sample string 32</Payee_Address_Line2>
<Payee_City>sample string 33</Payee_City>
<Payee_Name>sample string 30</Payee_Name>
<Payee_State>sample string 34</Payee_State>
<Payee_ZipCode>sample string 35</Payee_ZipCode>
<PaymentType>sample string 8</PaymentType>
<Post_DT>sample string 27</Post_DT>
<Principal_AMT>sample string 28</Principal_AMT>
<Transaction_Status>sample string 36</Transaction_Status>
<TrusteeCity>sample string 3</TrusteeCity>
<TrusteeID>sample string 1</TrusteeID>
<TrusteeName>sample string 2</TrusteeName>
<TrusteeState>sample string 4</TrusteeState>
<UCI>sample string 25</UCI>
</Payment2>
<Payment2>
<AccountNumber>sample string 18</AccountNumber>
<CaseNumber>sample string 5</CaseNumber>
<CaseStatus>sample string 17</CaseStatus>
<CheckAmount>7</CheckAmount>
<ChkDate>sample string 19</ChkDate>
<ClaimAmount>sample string 26</ClaimAmount>
<ClaimLevel>sample string 20</ClaimLevel>
<ClaimNumber>sample string 6</ClaimNumber>
<ClaimTag>sample string 39</ClaimTag>
<ClaimTagClaimIdentifier>sample string 37</ClaimTagClaimIdentifier>
<ClaimTagPaymentType>sample string 38</ClaimTagPaymentType>
<ClaimType>sample string 21</ClaimType>
<ClaimTypeCode>sample string 40</ClaimTypeCode>
<ClassType>sample string 42</ClassType>
<ClassTypeCode>sample string 41</ClassTypeCode>
<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>
<Interest_AMT>sample string 29</Interest_AMT>
<NDC_Case_ID>sample string 9</NDC_Case_ID>
<NDC_Claim_ID>sample string 10</NDC_Claim_ID>
<Payee_Address_Line1>sample string 31</Payee_Address_Line1>
<Payee_Address_Line2>sample string 32</Payee_Address_Line2>
<Payee_City>sample string 33</Payee_City>
<Payee_Name>sample string 30</Payee_Name>
<Payee_State>sample string 34</Payee_State>
<Payee_ZipCode>sample string 35</Payee_ZipCode>
<PaymentType>sample string 8</PaymentType>
<Post_DT>sample string 27</Post_DT>
<Principal_AMT>sample string 28</Principal_AMT>
<Transaction_Status>sample string 36</Transaction_Status>
<TrusteeCity>sample string 3</TrusteeCity>
<TrusteeID>sample string 1</TrusteeID>
<TrusteeName>sample string 2</TrusteeName>
<TrusteeState>sample string 4</TrusteeState>
<UCI>sample string 25</UCI>
</Payment2>
</Payments>
</Voucher2>
<Voucher2>
<CheckNumber>sample string 1</CheckNumber>
<Payments>
<Payment2>
<AccountNumber>sample string 18</AccountNumber>
<CaseNumber>sample string 5</CaseNumber>
<CaseStatus>sample string 17</CaseStatus>
<CheckAmount>7</CheckAmount>
<ChkDate>sample string 19</ChkDate>
<ClaimAmount>sample string 26</ClaimAmount>
<ClaimLevel>sample string 20</ClaimLevel>
<ClaimNumber>sample string 6</ClaimNumber>
<ClaimTag>sample string 39</ClaimTag>
<ClaimTagClaimIdentifier>sample string 37</ClaimTagClaimIdentifier>
<ClaimTagPaymentType>sample string 38</ClaimTagPaymentType>
<ClaimType>sample string 21</ClaimType>
<ClaimTypeCode>sample string 40</ClaimTypeCode>
<ClassType>sample string 42</ClassType>
<ClassTypeCode>sample string 41</ClassTypeCode>
<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>
<Interest_AMT>sample string 29</Interest_AMT>
<NDC_Case_ID>sample string 9</NDC_Case_ID>
<NDC_Claim_ID>sample string 10</NDC_Claim_ID>
<Payee_Address_Line1>sample string 31</Payee_Address_Line1>
<Payee_Address_Line2>sample string 32</Payee_Address_Line2>
<Payee_City>sample string 33</Payee_City>
<Payee_Name>sample string 30</Payee_Name>
<Payee_State>sample string 34</Payee_State>
<Payee_ZipCode>sample string 35</Payee_ZipCode>
<PaymentType>sample string 8</PaymentType>
<Post_DT>sample string 27</Post_DT>
<Principal_AMT>sample string 28</Principal_AMT>
<Transaction_Status>sample string 36</Transaction_Status>
<TrusteeCity>sample string 3</TrusteeCity>
<TrusteeID>sample string 1</TrusteeID>
<TrusteeName>sample string 2</TrusteeName>
<TrusteeState>sample string 4</TrusteeState>
<UCI>sample string 25</UCI>
</Payment2>
<Payment2>
<AccountNumber>sample string 18</AccountNumber>
<CaseNumber>sample string 5</CaseNumber>
<CaseStatus>sample string 17</CaseStatus>
<CheckAmount>7</CheckAmount>
<ChkDate>sample string 19</ChkDate>
<ClaimAmount>sample string 26</ClaimAmount>
<ClaimLevel>sample string 20</ClaimLevel>
<ClaimNumber>sample string 6</ClaimNumber>
<ClaimTag>sample string 39</ClaimTag>
<ClaimTagClaimIdentifier>sample string 37</ClaimTagClaimIdentifier>
<ClaimTagPaymentType>sample string 38</ClaimTagPaymentType>
<ClaimType>sample string 21</ClaimType>
<ClaimTypeCode>sample string 40</ClaimTypeCode>
<ClassType>sample string 42</ClassType>
<ClassTypeCode>sample string 41</ClassTypeCode>
<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>
<Interest_AMT>sample string 29</Interest_AMT>
<NDC_Case_ID>sample string 9</NDC_Case_ID>
<NDC_Claim_ID>sample string 10</NDC_Claim_ID>
<Payee_Address_Line1>sample string 31</Payee_Address_Line1>
<Payee_Address_Line2>sample string 32</Payee_Address_Line2>
<Payee_City>sample string 33</Payee_City>
<Payee_Name>sample string 30</Payee_Name>
<Payee_State>sample string 34</Payee_State>
<Payee_ZipCode>sample string 35</Payee_ZipCode>
<PaymentType>sample string 8</PaymentType>
<Post_DT>sample string 27</Post_DT>
<Principal_AMT>sample string 28</Principal_AMT>
<Transaction_Status>sample string 36</Transaction_Status>
<TrusteeCity>sample string 3</TrusteeCity>
<TrusteeID>sample string 1</TrusteeID>
<TrusteeName>sample string 2</TrusteeName>
<TrusteeState>sample string 4</TrusteeState>
<UCI>sample string 25</UCI>
</Payment2>
</Payments>
</Voucher2>
</ArrayOfVoucher2>
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",
"UCI": "sample string 25",
"ClaimAmount": "sample string 26",
"Post_DT": "sample string 27",
"Principal_AMT": "sample string 28",
"Interest_AMT": "sample string 29",
"Payee_Name": "sample string 30",
"Payee_Address_Line1": "sample string 31",
"Payee_Address_Line2": "sample string 32",
"Payee_City": "sample string 33",
"Payee_State": "sample string 34",
"Payee_ZipCode": "sample string 35",
"Transaction_Status": "sample string 36",
"ClaimTagClaimIdentifier": "sample string 37",
"ClaimTagPaymentType": "sample string 38",
"ClaimTag": "sample string 39",
"ClaimTypeCode": "sample string 40",
"ClassTypeCode": "sample string 41",
"ClassType": "sample string 42"
},
{
"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",
"UCI": "sample string 25",
"ClaimAmount": "sample string 26",
"Post_DT": "sample string 27",
"Principal_AMT": "sample string 28",
"Interest_AMT": "sample string 29",
"Payee_Name": "sample string 30",
"Payee_Address_Line1": "sample string 31",
"Payee_Address_Line2": "sample string 32",
"Payee_City": "sample string 33",
"Payee_State": "sample string 34",
"Payee_ZipCode": "sample string 35",
"Transaction_Status": "sample string 36",
"ClaimTagClaimIdentifier": "sample string 37",
"ClaimTagPaymentType": "sample string 38",
"ClaimTag": "sample string 39",
"ClaimTypeCode": "sample string 40",
"ClassTypeCode": "sample string 41",
"ClassType": "sample string 42"
}
]
},
{
"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",
"UCI": "sample string 25",
"ClaimAmount": "sample string 26",
"Post_DT": "sample string 27",
"Principal_AMT": "sample string 28",
"Interest_AMT": "sample string 29",
"Payee_Name": "sample string 30",
"Payee_Address_Line1": "sample string 31",
"Payee_Address_Line2": "sample string 32",
"Payee_City": "sample string 33",
"Payee_State": "sample string 34",
"Payee_ZipCode": "sample string 35",
"Transaction_Status": "sample string 36",
"ClaimTagClaimIdentifier": "sample string 37",
"ClaimTagPaymentType": "sample string 38",
"ClaimTag": "sample string 39",
"ClaimTypeCode": "sample string 40",
"ClassTypeCode": "sample string 41",
"ClassType": "sample string 42"
},
{
"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",
"UCI": "sample string 25",
"ClaimAmount": "sample string 26",
"Post_DT": "sample string 27",
"Principal_AMT": "sample string 28",
"Interest_AMT": "sample string 29",
"Payee_Name": "sample string 30",
"Payee_Address_Line1": "sample string 31",
"Payee_Address_Line2": "sample string 32",
"Payee_City": "sample string 33",
"Payee_State": "sample string 34",
"Payee_ZipCode": "sample string 35",
"Transaction_Status": "sample string 36",
"ClaimTagClaimIdentifier": "sample string 37",
"ClaimTagPaymentType": "sample string 38",
"ClaimTag": "sample string 39",
"ClaimTypeCode": "sample string 40",
"ClassTypeCode": "sample string 41",
"ClassType": "sample string 42"
}
]
}
]