Skip to main content
Create a connection job to organize and batch process multiple tax preparations. A connection job groups related works (clients) together and can be triggered to process all attached clients. 
mutation CreateConnectionJob($connectionId: ID!, $jobName: String!) {
  createConnectionJob(connectionId: $connectionId, jobName: $jobName) {
    id
    connectionId
    workspaceId
    name
    status
    createdAt
    updatedAt
  }
}

​
Arguments

​
connectionId
ID!
required
The ID of the provider connection. This identifies which integration connection to create the job for.
​
jobName
String!
required
A descriptive name for the connection job. Use this to identify the batch of tax preparations (e.g., “2024 Tax Season Import”, “Q1 Client Batch”).

​
Returns

​
id
ID!
Connection job identifier. Save this for creating works and triggering the import.
​
connectionId
ID!
The provider connection ID this job belongs to.
​
workspaceId
ID!
The workspace ID this job belongs to.
​
name
String!
The name you provided for this connection job.
​
status
String!
Current status of the connection job (e.g., “pending”, “active”, “completed”).
​
createdAt
Date!
Timestamp when the connection job was created.
​
updatedAt
Date!
Timestamp when the connection job was last updated.

​
Example

curl -X POST https://gateway.filed.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -H "source-platform: my-sample-platform" \
  -d '{
    "query": "mutation CreateConnectionJob($connectionId: ID!, $jobName: String!) { createConnectionJob(connectionId: $connectionId, jobName: $jobName) { id connectionId workspaceId name status createdAt updatedAt } }",
    "variables": {
      "connectionId": "connection_789",
      "jobName": "2024 Tax Season Import"
    }
  }'

{
  "data": {
    "createConnectionJob": {
      "id": "job_123456",
      "connectionId": "connection_789",
      "workspaceId": "workspace_123456",
      "name": "2024 Tax Season Import",
      "status": "pending",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  }
}
After creating a connection job, use createJobWorks to attach clients (works) to the job. Once all clients and job work artifacts are attached, you can initiate the import using initiateTaxPrepsImport.

​
Troubleshooting

Problem: createConnectionJob fails with invalid connection ID Solutions:
  • Verify the connectionId exists and belongs to your workspace
  • Ensure the connection status is active
  • Check that you’re using the correct connection ID for the workspace
Problem: Job created but cannot attach works Solutions:
  • Ensure you’re using the id from the createConnectionJob response as the connectionJobId when creating works
  • Verify the job status allows adding works
  • Check that the connection job belongs to the correct connection