List corrections
Changed onReturns a paginated list of corrections.
get/corrections
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 to corrections belonging to a single company.
yearinteger
Filter to corrections for a single tax year.
status'draft' | 'pending' | 'processing' | 'settled' | 'failed'
Filter to corrections with this status.
payrollstring
Filter to corrections that include the given payroll as a member.
limitinteger
Number of corrections returned per page. The maximum value is 100.
idstring[]
Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.
Response
200
Changes
- info
endpoint added
- info