The filing object

Use the filing object to show the state of a tax filing for a given period, including the status changes that have occurred in its lifecycle.

{
  "id": "com_fil_9kL2mN8pQ4rS6tU1vW3x",
  "company": "com_7bF9dG2hJ5kM8nP1qR4s",
  "year": 2024,
  "period": "q1", 
  "label": "Federal Quarterly Filing - Q1",
  "due_at": "2024-04-15",
  "filed_at": "2024-04-12T16:30:25.847Z",
  "document": "doc_3aE6fH9iL2mO5pR8sV1y",
  "filing_attempts": 2,
  "status": "filed",
  "status_history": [
    {
      "status": "inapplicable", 
      "status_at": "2024-01-15T10:30:15.423Z",
      "blocked_reasons": []
    },
    {
      "status": "pending", 
      "status_at": "2024-01-20T14:45:32.156Z",
      "blocked_reasons": []
    },
    {
      "status": "blocked", 
      "status_at": "2024-03-10T09:15:48.792Z",
      "blocked_reasons": [
          {
            "type": "applied_for_tax_id",
            "resource_type": "company_tax_param",
            "resource": "spa_h7zSw4NITCtef4Taf5yA"
          }
        ]
    },
    {
      "status": "pending", 
      "status_at": "2024-03-12T11:20:07.234Z",
      "blocked_reasons": []
    },
    {
      "status": "filed", 
      "status_at": "2024-04-12T16:30:25.847Z",
      "blocked_reasons": []
    }
}

field	type	description
`id`	ID	ID of the `Filing` (prefixed with `com_fil_`)
`company`	ID	ID of the `Company`
`year`	int	Year in which the filing is for
`period`	enum, one of `annual`, `q1`, `q2`, `q3`, `q4`, `january`, `february`, `march`, `april`, `may`, `june`, `july`, `august`, `september`, `october`, `november`, `december`	Filing period in the `year`.
`label`	string	Human-readable label for the filing.
`due_at`	date	ISO8601 date the filing is due to the agency by.
`filed_at`	nullable datetime in UTC	ISO8601 datetime the filing status became successfully `filed`.
`document`	nullable ID	If the `processing_status` is `filed`, the ID of the `CompanyTaxDocument`.
`filing_attempts`	int, default 0	Number of filing attempts made by Check.
`amends`	nullable ID	ID of the previous `Filing` that this resource is an amendment of. If populated, indicator of this `Filing` being an amendment.
`amended_by`	nullable ID	ID of the next `Filing` that amends this filing.
`status`	enum, one of `pending`, `blocked`, `filed` , or`inapplicable`	The current filing processing status.
`status_history`	list of `StatusHistory` objects	List of the most recent status changes, in reverse chronological order. Limited to most recent 50. Each object represents a processing status change.

StatusHistory

field	type	description
`status`	enum	One of `pending`, `blocked`, `filed` , `inapplicable`
`status_at`	datetime in UTC	When the previous status was changed to `status`.
`blocked_reasons`	nullable list of `BlockedReason` objects	Optional list of reason enumerations for the status change to `blocked`.

BlockedReason

field	type	description
`type`	enum	Options enumerated below.
`resource_type`	nullable `company_tax_param` or `requirement`	CompanyTaxParam or Requirement
`resource`	nullable ID	ID of the resource for resolving the blocker

Possible BlockedReason types

The accompanying resource_type is specified in parentheses, if applicable.

already_filed
applied_for_tax_id (company_tax_param)
company_bad_standing
held_by_customer
inactive_account
incorrect_account_setup
invalid_ssn
invalid_tax_id
invalid_tax_rate
late_company_reactivation
missing_historical_data
missing_prior_quarter
not_liable
poa_failure
previous_filing_in_progress
tpa_failure

status lifecycle: