GET api/Claims?currentPageNumber={currentPageNumber}&pageSize={pageSize}&beginDate={beginDate}&endDate={endDate}
This method is used to GET Individual Income Tax Claims Records from CACTAS Optional beginDate and/or endDate can be passed in the URL to filter by DateLastUpdated. This method implements paging. Current Page Number and Page Size must be supplied.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| currentPageNumber |
Current Page Number. |
integer |
Default value is 1 |
| pageSize |
Max pageSize 1000. |
integer |
Default value is 1000 |
| beginDate |
Optional. Date format mm/dd/yyyy |
date |
None. |
| endDate |
Optional. Date format mm/dd/yyyy |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
PagingResponseModelOfIListOfClaimsGetModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRecords | integer |
None. |
|
| CurrentPageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalPages | integer |
None. |
|
| HasNextPage | boolean |
None. |
|
| HasPreviousPage | boolean |
None. |
|
| Data | Collection of ClaimsGetModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"totalRecords": 1,
"currentPageNumber": 2,
"pageSize": 3,
"totalPages": 4,
"hasNextPage": true,
"hasPreviousPage": true,
"data": [
{
"claimId": 1,
"dateLastUpdated": "2026-05-13T13:49:43.2187532-05:00",
"passThruName": "sample string 3",
"passThruFein": "sample string 4",
"return": {
"returnId": 1,
"address1": "sample string 2",
"address2": "sample string 3",
"city": "sample string 4",
"state": "sample string 5",
"zip": "sample string 6",
"taxId": "sample string 7",
"dln": "sample string 8",
"isSsn": true,
"name": "sample string 10",
"taxType": "sample string 11",
"taxYear": 12,
"dateFiled": "2026-05-13T13:49:43.2187532-05:00",
"taxPeriodEndDt": "sample string 14"
},
"taxCreditCode": "sample string 5",
"certificateNumber": "sample string 6",
"applied": 7,
"futureYearCarryForward": 1,
"dateFiled": "2026-05-13T13:49:43.2187532-05:00"
},
{
"claimId": 1,
"dateLastUpdated": "2026-05-13T13:49:43.2187532-05:00",
"passThruName": "sample string 3",
"passThruFein": "sample string 4",
"return": {
"returnId": 1,
"address1": "sample string 2",
"address2": "sample string 3",
"city": "sample string 4",
"state": "sample string 5",
"zip": "sample string 6",
"taxId": "sample string 7",
"dln": "sample string 8",
"isSsn": true,
"name": "sample string 10",
"taxType": "sample string 11",
"taxYear": 12,
"dateFiled": "2026-05-13T13:49:43.2187532-05:00",
"taxPeriodEndDt": "sample string 14"
},
"taxCreditCode": "sample string 5",
"certificateNumber": "sample string 6",
"applied": 7,
"futureYearCarryForward": 1,
"dateFiled": "2026-05-13T13:49:43.2187532-05:00"
}
]
}