GET api/Letter/GetLetterSummaryPaginationByAccountID?accountID={accountID}&showInactive={showInactive}&pageNumber={pageNumber}&pageSize={pageSize}&search={search}&searchDate={searchDate}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountID | integer |
Required |
|
| showInactive | boolean |
Required |
|
| pageNumber | integer |
Required |
|
| pageSize | integer |
Required |
|
| search | string |
None. |
|
| searchDate | date |
None. |
Body Parameters
None.
Response Information
Resource Description
LetterSummaryVM| Name | Description | Type | Additional information |
|---|---|---|---|
| LetterSummaryList | Collection of LetterSummaryByAccountID |
None. |
|
| LetterSummaryListByDocumentID | Collection of LetterSummaryByDocumentID |
None. |
|
| NumberOfResults | integer |
None. |
|
| Response | IResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"LetterSummaryList": [
{
"LetterID": 1,
"ContactID": 1,
"Document": "sample string 2",
"Template": "sample string 3",
"Contact": "sample string 4",
"Address": "sample string 5",
"Printed_By": "sample string 6",
"PrintedTS": "2026-01-15T08:45:13.7575696+00:00",
"Created_By": "sample string 7",
"CreateTS": "2026-01-15T08:45:13.7575696+00:00",
"Status": true,
"HasPDFSaved": true,
"Letter": "sample string 8",
"DMSRecordNumber": "sample string 9",
"CommunicationID": 1,
"DocumentTemplateVersionID": 1,
"DocumentID": 1,
"PrintStatus": "sample string 10",
"PrincipalTransactionDesc": "sample string 11",
"Modified_By": "sample string 12",
"ModifyTS": "2026-01-15T08:45:13.7575696+00:00",
"Inactivated_By": "sample string 13",
"InactiveTS": "2026-01-15T08:45:13.7575696+00:00"
},
{
"LetterID": 1,
"ContactID": 1,
"Document": "sample string 2",
"Template": "sample string 3",
"Contact": "sample string 4",
"Address": "sample string 5",
"Printed_By": "sample string 6",
"PrintedTS": "2026-01-15T08:45:13.7575696+00:00",
"Created_By": "sample string 7",
"CreateTS": "2026-01-15T08:45:13.7575696+00:00",
"Status": true,
"HasPDFSaved": true,
"Letter": "sample string 8",
"DMSRecordNumber": "sample string 9",
"CommunicationID": 1,
"DocumentTemplateVersionID": 1,
"DocumentID": 1,
"PrintStatus": "sample string 10",
"PrincipalTransactionDesc": "sample string 11",
"Modified_By": "sample string 12",
"ModifyTS": "2026-01-15T08:45:13.7575696+00:00",
"Inactivated_By": "sample string 13",
"InactiveTS": "2026-01-15T08:45:13.7575696+00:00"
}
],
"LetterSummaryListByDocumentID": [
{
"LetterID": 1,
"AccountID": 2,
"PrincipalID": 1,
"CommunicationID": 3,
"DocumentID": 4,
"Attachments_MediaAndDocumentGroupID": 1,
"CreateTS": "2026-01-15T08:45:13.7575696+00:00",
"StatusID": 1
},
{
"LetterID": 1,
"AccountID": 2,
"PrincipalID": 1,
"CommunicationID": 3,
"DocumentID": 4,
"Attachments_MediaAndDocumentGroupID": 1,
"CreateTS": "2026-01-15T08:45:13.7575696+00:00",
"StatusID": 1
}
],
"NumberOfResults": 1,
"Response": null
}
application/xml, text/xml
Sample:
<LetterSummaryVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Letter">
<Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
<LetterSummaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Letter">
<d2p1:LetterSummaryByAccountID>
<d2p1:Address>sample string 5</d2p1:Address>
<d2p1:CommunicationID>1</d2p1:CommunicationID>
<d2p1:Contact>sample string 4</d2p1:Contact>
<d2p1:ContactID>1</d2p1:ContactID>
<d2p1:CreateTS>2026-01-15T08:45:13.7575696+00:00</d2p1:CreateTS>
<d2p1:Created_By>sample string 7</d2p1:Created_By>
<d2p1:DMSRecordNumber>sample string 9</d2p1:DMSRecordNumber>
<d2p1:Document>sample string 2</d2p1:Document>
<d2p1:DocumentID>1</d2p1:DocumentID>
<d2p1:DocumentTemplateVersionID>1</d2p1:DocumentTemplateVersionID>
<d2p1:HasPDFSaved>true</d2p1:HasPDFSaved>
<d2p1:Inactivated_By>sample string 13</d2p1:Inactivated_By>
<d2p1:InactiveTS>2026-01-15T08:45:13.7575696+00:00</d2p1:InactiveTS>
<d2p1:Letter>sample string 8</d2p1:Letter>
<d2p1:LetterID>1</d2p1:LetterID>
<d2p1:Modified_By>sample string 12</d2p1:Modified_By>
<d2p1:ModifyTS>2026-01-15T08:45:13.7575696+00:00</d2p1:ModifyTS>
<d2p1:PrincipalTransactionDesc>sample string 11</d2p1:PrincipalTransactionDesc>
<d2p1:PrintStatus>sample string 10</d2p1:PrintStatus>
<d2p1:PrintedTS>2026-01-15T08:45:13.7575696+00:00</d2p1:PrintedTS>
<d2p1:Printed_By>sample string 6</d2p1:Printed_By>
<d2p1:Status>true</d2p1:Status>
<d2p1:Template>sample string 3</d2p1:Template>
</d2p1:LetterSummaryByAccountID>
<d2p1:LetterSummaryByAccountID>
<d2p1:Address>sample string 5</d2p1:Address>
<d2p1:CommunicationID>1</d2p1:CommunicationID>
<d2p1:Contact>sample string 4</d2p1:Contact>
<d2p1:ContactID>1</d2p1:ContactID>
<d2p1:CreateTS>2026-01-15T08:45:13.7575696+00:00</d2p1:CreateTS>
<d2p1:Created_By>sample string 7</d2p1:Created_By>
<d2p1:DMSRecordNumber>sample string 9</d2p1:DMSRecordNumber>
<d2p1:Document>sample string 2</d2p1:Document>
<d2p1:DocumentID>1</d2p1:DocumentID>
<d2p1:DocumentTemplateVersionID>1</d2p1:DocumentTemplateVersionID>
<d2p1:HasPDFSaved>true</d2p1:HasPDFSaved>
<d2p1:Inactivated_By>sample string 13</d2p1:Inactivated_By>
<d2p1:InactiveTS>2026-01-15T08:45:13.7575696+00:00</d2p1:InactiveTS>
<d2p1:Letter>sample string 8</d2p1:Letter>
<d2p1:LetterID>1</d2p1:LetterID>
<d2p1:Modified_By>sample string 12</d2p1:Modified_By>
<d2p1:ModifyTS>2026-01-15T08:45:13.7575696+00:00</d2p1:ModifyTS>
<d2p1:PrincipalTransactionDesc>sample string 11</d2p1:PrincipalTransactionDesc>
<d2p1:PrintStatus>sample string 10</d2p1:PrintStatus>
<d2p1:PrintedTS>2026-01-15T08:45:13.7575696+00:00</d2p1:PrintedTS>
<d2p1:Printed_By>sample string 6</d2p1:Printed_By>
<d2p1:Status>true</d2p1:Status>
<d2p1:Template>sample string 3</d2p1:Template>
</d2p1:LetterSummaryByAccountID>
</LetterSummaryList>
<LetterSummaryListByDocumentID xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Letter">
<d2p1:LetterSummaryByDocumentID>
<d2p1:AccountID>2</d2p1:AccountID>
<d2p1:Attachments_MediaAndDocumentGroupID>1</d2p1:Attachments_MediaAndDocumentGroupID>
<d2p1:CommunicationID>3</d2p1:CommunicationID>
<d2p1:CreateTS>2026-01-15T08:45:13.7575696+00:00</d2p1:CreateTS>
<d2p1:DocumentID>4</d2p1:DocumentID>
<d2p1:LetterID>1</d2p1:LetterID>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:StatusID>1</d2p1:StatusID>
</d2p1:LetterSummaryByDocumentID>
<d2p1:LetterSummaryByDocumentID>
<d2p1:AccountID>2</d2p1:AccountID>
<d2p1:Attachments_MediaAndDocumentGroupID>1</d2p1:Attachments_MediaAndDocumentGroupID>
<d2p1:CommunicationID>3</d2p1:CommunicationID>
<d2p1:CreateTS>2026-01-15T08:45:13.7575696+00:00</d2p1:CreateTS>
<d2p1:DocumentID>4</d2p1:DocumentID>
<d2p1:LetterID>1</d2p1:LetterID>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:StatusID>1</d2p1:StatusID>
</d2p1:LetterSummaryByDocumentID>
</LetterSummaryListByDocumentID>
<NumberOfResults>1</NumberOfResults>
</LetterSummaryVM>