Skip to main content
If your product stores each client’s ID in the firm’s tax software, you can start data entry without showing anything to the user. Send that ID with the Filed client and Filed works out which tax software connection reaches it. Without an ID, Filed looks the client up by name instead. Call it as soon as you have pushed the documents. Filed waits for them to be processed and then prepares the entries on its own. If you would rather have the user confirm the client, show Filed’s dialog instead.

​
Before you start

The firm needs two things in place before its users connect your product:
  • An active Filed workspace.
  • One or more active tax software connections in that workspace.

​
Start data entry

​
ID!
required
The Filed client, as returned by createClient.
​
String
The client’s ID in the tax software, for example MHARPER in UltraTax. Leave it out when you do not have it and Filed looks the client up by name; see Without a client ID.
​
ID
The Filed tax software connection to use. Leave it out to let Filed choose.
​
String
The exact return ID. Only ProConnect needs it.
​
ID!
The client’s data entry task. It is the taskId on the webhooks that follow.
​
StartDataEntryStatus!
STARTED, ALREADY_STARTED or NEEDS_TAX_SOFTWARE_CLIENT; see below.

​
What the status means

​
How Filed chooses the connection

Filed looks at the tax software connections available to the Filed user who connected your product.
  • With one connection, Filed uses it.
  • With several, Filed uses one whose client list contains the ID. If more than one does, it prefers the one whose desktop was online most recently, then that user’s own connection, then the newest.
  • With none, or when no client list contains the ID, the result is NEEDS_TAX_SOFTWARE_CLIENT.
Filed does not learn which of your users made the request, so a connection that belongs to a different Filed user is not considered.

​
Without a client ID

Filed compares the name you sent in createClient with the names in the client lists of those same connections. If someone has since renamed the client in Filed, the new name is used. Case, accents, punctuation and word order do not matter; every word has to be there.
  • If exactly one tax software client has that name, Filed links it and starts.
  • If none does, or more than one does, the result is NEEDS_TAX_SOFTWARE_CLIENT and a person picks the client in Filed.
Send the ID whenever you have it: it is the only way to be sure which client is meant.

​
After it starts

The events are the same as for the dialog; see After the user starts. Data entry stops when the entries are ready: a person reviews them in Filed and sends them to the tax software.