List tax filings
Changed onGet a list of tax filings. Please note that in its current iteration, only rejected filings are returned.
get/tax_filings
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
companystring
Filter tax filings related to a particular company ID.
yearinteger
Filter tax filings within a given year
periodstring
Filter tax filings within a particular period. One of: annual, q1, q2,q3, q4, january, february, march, april, may, june, july, august , september, october , or december.
limitinteger
Number of tax filings returned per page. The maximum value is 500.
idstring[]
Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.
Response
200
Example response
{
"results": [
{
"id": "pyt_uzasLBvddSm6aJkHGwQw",
"status": "paid",
"amount": "4522.0400",
"type": "company_cash_requirement",
"parent_type": "payroll",
"parent_id": "pay_aPKCtxqbi1jDNEWRrz9w",
"payment_attempts": [
{
"id": "pya_LUHvXtQBhkNM22xIk8K1",
"created_at": "2022-02-18T20:17:13.033205Z",
"expected_completion_date": "2022-02-23",
"status": "paid",
"payment_method": "ach",
"payment_instrument": "bnk_W7hjDGn6sU1d3U8dr9bq"
}
],
"direction": "debit"
}
]
}Changes
- info
endpoint added
- info