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",
  "jurisdiction": "fed",
  "agency": "agc_ukjABgbD0hQ3dfBRyMPD",
  "due_at": "2024-04-15",
  "filed_at": "2024-04-12T16:30:25.847Z",
  "closed_at": "2024-04-08T00:00:00.000Z",
  "document": "doc_3aE6fH9iL2mO5pR8sV1y",
  "filing_attempts": 2,
  "amends": null,
  "amended_by": null,
  "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",
          "note": null
        }
      ]
    },
    {
      "status": "pending",
      "status_at": "2024-03-12T11:20:07.234Z",
      "blocked_reasons": []
    },
    {
      "status": "submitted",
      "status_at": "2024-03-12T11:23:07.234Z",
      "blocked_reasons": []
    },
    {
      "status": "filed",
      "status_at": "2024-04-12T16:30:25.847Z",
      "blocked_reasons": []
    }
  ]
}
fieldtypedescription
idIDID of the Filing (prefixed with com_fil_)
companyIDID of the Company
yearintYear in which the filing is for
periodenum, one of annual, q1, q2, q3, q4, january, february, march, april, may, june, july, august, september, october, november, decemberFiling period in the year.
period_startdateStart date of the filing period
period_enddateEnd date of the filing period
labelstringHuman-readable label for the filing.
jurisdiction
  • nullable* enum
Lowercase region code for the filing (fed or lowercased ISO 3166-2:US region code). Matches the jurisdiction values on Agency and Tax objects.
agency
  • nullable* ID
ID of the Agency that receives this filing.
due_atdateISO8601 date the filing is due to the agency by.
filed_at
  • nullable* datetime in UTC
ISO8601 datetime the filing status became successfully filed.
closed_at
  • nullable* datetime in UTC
Timestamp when Check closed the filing period. Any company filing processed after this date will appear as a delayed_filing in the Usage API. Check closes a filing after processing all unblocked companies at least 8 days before the due date.
document
  • nullable* ID
If the processing_status is filed, the ID of the CompanyTaxDocument.
filing_attemptsint, default 0Number of filing attempts made by Check.
amends
  • nullable* list of IDs
List of original Filing IDs that this resource is an amendment of. If populated, indicator of this Filing being an amendment.
Will contain only one ID for now, but may be contain multiple IDs in the future.
amended_by
  • nullable* list of IDs
List of Filing IDs that amend this filing.
statusenum, one of pending, blocked, submitted, filed , orinapplicableThe current filing processing status.
status_historylist of StatusHistory objectsList of the most recent status changes, in reverse chronological order. Limited to most recent 50. Each object represents a processing status change.

StatusHistory

AttributeDescription
status
enum
One of pending, blocked, submitted, 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

AttributeDescription
type
enum
Options enumerated below.
resource_type
nullable enum
One of CompanyTaxParam, Requirement, payroll, payment, or employee.
resource
nullable ID
ID of the resource for resolving the blocker
note
nullable string
Note provided by Check operators that provides more context on the blocker reason, when available. For example, "John Smith's SSN is all 0s."

Possible BlockedReason types

The complete, canonical list of type values — each with its description, employer-facing guidance, associated resource_type, and resolution path — is maintained in the Filing blockers section of the Tax Filings guide.

statuslifecycle: