List a company's tax parameter settings
Get a paginated list of a company’s tax parameter details. The top-level value and effective_start are the value in force on as_of, today by default: what applies when. settings lists every recorded value that has not been deleted, newest effective_start first and, within one effective_start, newest created_at first: what changed. A tax parameter written more than once with the same effective_start lists every write. The entry with the latest created_at for an effective_start is the value in force from that date, and each earlier entry for that date was replaced at the created_at of the entry listed above it. Deleted values are not listed, including earlier values replaced by a form submission. For a tax parameter that is not effective dated, value is the current value and effective_start is null. Each entry in settings carries an actor object naming the party that wrote that value: check, partner, company, or employee. party classifies the actor, not the setting’s subject, so a company user who edits an employee-scoped setting reads as company. actor is null when the attribution cannot be recovered.
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of the company used to list the applicable tax parameter details.
Query parameters
Date that selects the top-level value and effective_start: the value in force on this date. Defaults to today. Does not filter settings, which lists every recorded value. Ignored for a tax parameter that is not effective dated.
Used to further filter down the list of the company’s tax
Filter by submitter type
Response
200
Changes
No recorded changes to this operation across all 2 revisions of this API.