Automatically link new binders with client profiles in TaxCaddy

Automating the process of creating a binder
Automatically linking binders to client profiles
Automatically uploading TaxCaddy documents to the binder

Before you begin

Create a binder with uploaded TaxCaddy documents

(Optional) Go to the client's profile and flag the uploaded documents you want to include or exclude from the binder. By default, all documents uploaded to TaxCaddy are flagged for inclusion in the binder. Skip to the next step if you don't want to exclude any uploaded documents.
Documents you flag to
Exclude from binder
aren't included in the binder.
Documents you flag as
Include in binder
are automatically uploaded to the binder once the binder is submitted.

Next, create a binder using the CreateBinder API method.
If your firm enabled the option to auto-link binder at the firm level, then the
LinkBinder
input parameter is set as
1
or
True
(for yes) by default, even if you don't add the
LinkBinder
input parameter to the
CreateBinder
call.
However, if you want to prevent a binder from being linked to a client profile manually, set the
LinkBinder
option as
0
or
False
.
note
CreateBinder
input parameters sample { "Email": "...", "Service_Type_Id": ..., "Template_Id": ...., "Office_Location_Id": ...., "
LinkBinder
":
1
, "Unique_Identifier": ".....", "Locator_No" : "....."}
note
The API binder creation workflow requires you to call: CreateBinder > UploadBinderDocuments (optional) > SubmitBinder. See the flowchart of all the methods needed to create a binder through API.
note
Make sure there's only 1 matching client profile with the same Tax Client ID (that is,
Locator_No
). If there are multiple client profiles available in Taxcaddy with the same
Tax Client ID
, then the binders are created without linking to TaxCaddy.
LinkBinder
input parameter (in the CreateBinder method) will only work after you enable the firm level option. On the
CreateBinder
method, any change you make to the Owner, Member, Office Location, 7216 Consent, and Custom Field input parameter will override the existing attributes in the TaxCaddy client profile. To ensure the binder and TaxCaddy client profile is in sync, use the
GetClientDetails
(POST) method to get the current attributes saved for the client.
(Optional) You can use the
UploadBinderDocuments
API method to upload non-TaxCaddy documents. This step won't impact on TaxCaddy documents uploaded automatically.
note
The UploadBinderDocuments method becomes optional if:
The firm enables auto-uploading of TaxCaddy documents.
The client profile has at least 1 uploaded document marked to include in the binder.
Call the
SubmitBinder
method to submit the binder. If the SubmitBinder was successful, you will see the binder ID as a response (for example, 987654)
You will see the following error if there are no uploaded documents available in the client's profile:
{
ErrorCode: 1060,
ErrorDesc: "Please upload at least one source document to submit this binder"}
Solution: Go to the client's profile and make sure there is at least one uploaded document marked to include in the binder. Alternatively, use the
UploadBinderDocuments
method to upload a document to the document.
In the client's profile, documents flagged to include in the binder will now show a new
Added to binder
icon.

FAQ

Requirements