authentication
GetToken
GetToken method helps you get the token that needs to be passed as a header for the rest of the APIs described in this document.
GetTokenOAuth
GetTokenOAuth method helps you get the token without giving password that needs to be passed as a header for the rest of the APIs described in this document.
Binder
CreateBinder
Creates a new binder or adds additional documents.
UploadBinderDocument
Upload documents using this method. Supported file types are .pdf, .doc, .docx, .xls, .xlsx, xml, and xlsm.
SubmitBinder
To submit the uploaded documents for SurePrep processing and export to tax software.
ChangeBinderStatus
To change the status of a binder.
GetBinderDetail
Use this method to get the Binder details as shown in SurePrep FileRoom.
GetBinderPendingItems
Use this method to get the bundled info of methods like Get Binder Detail, Uncleared Notes, Unreviewed TR Stamps/Sticky Notes/Work Papers etc.
GetDocuments
To retrieve a list of available pdfs, reports and other documents. This will work for API and manually created binders
DownloadDocument
To Download pdfs, reports and other documents that are available for download using the document ID after calling the GetDocuments API Method.
GetDRLOutput
Use this method to fetch created taxpayer’s DRLs information for a single client, multiple clients, or all clients.
UpdateProjectID
Use this method to update Project ID for a specific binder.
GetStatesandLocalities
To retrieve the list of states and localities enabled in CCH Axcess.
DownloadBinderPBFX
Download binder PBFX (portable binder format) file.
GetBindersStatusWithStates
To retrieve the status of binder(s) along with the associated list of states and localities enabled in CCH Axcess.
GetBinderAuditLog
Use this method to get the details of Events related to the SPbinder.
UpdateOwnerMember
Use this method to update owner/ member/ Office location.
PrintBinder
Use this method to print DreamWorkpapers and SPbinder PDF from a SurePrep binder.
GetDRLPDFDetails
Use this method to get Document Request List (DRL) in a PDF format along with any fillable PDF that may apply.
TaxCaddy
CreateClient
Use this method to create clients in TaxCaddy.
GetClientDetails
Use this method to get TaxCaddy client details seen in the TaxCaddy Client Management screen.
CreateDRL
Use this method to create a custom Document Request List (DRL) for your TaxCaddy clients.
SendDRL
Use this method to send a Document Request List (DRL) to your Standard(online) and Offline clients.
ClientSubscribe
Used to subscribe clients (All or individual) to the DRL and Document Added web hooks.
ClientUnsubscribe
Used to unsubscribe clients (All or individual) from the DRL and Document Added webhooks.
Download Document
Use this method to download documents present in TaxCaddy Client Profile.
GetDRLStatus
Gets the status of created DRLs in TaxCaddy.
Disconnect Devices
Use this method to disconnect all connected mobile devices for taxpayer clients using Single Sign-On (SSO).
Lists
GetUnclearedNotes
Use this method to get the count of uncleared note(s) by note type (e.g. Review Note or Missing Item)
GetUnreviewedTRStamps
Use this method to get the count of unreviewed TR Stamps.
GetUnreviewedStickyNotes
Use this method to get the count of unreviewed Sticky Notes
GetUnreviewedWorkpapersByL1
Use this method to get the count of unreviewed work paper(s) by L1.
GetUnreviewedWorkpapersByL2
Use this method to get the count of unreviewed work paper(s) by L2.
GetUnreviewedWorkpapersByL3
Use this method to get the count of unreviewed work paper(s) by L3.
GetUnreviewedWorkpapersByL4
Use this method to get the count of unreviewed work paper(s) by L4.
GetDocumentPendingReviewCount
Use this method to get the count of TaxCaddy requested documents pending review.
GetDocumentPendingSignatureCount
Use this method to get the count of TaxCaddy requested documents pending signature.
GetDocumentPendingUploadCount
Use this method to get the count of TaxCaddy requested items/documents pending upload.
MIReport
Use this method to fetch the Missing Items Report information for a single client.
AccountUsageHistory
Use this method to fetch the Account Usage History Information from the FileRoom - Billing.
Lookups
TaxSoftwareList
This API call returns token in the response body. Please find a sample successful response from this API call.
BinderStatusList
To get the list of all available Statuses in SurePrep FileRoom.
DRLCategories
To get a list of Category Names and their ID’s.
Billing
OCR
Notifications
PushEngagementStatus
Get notification when binder status changes using this method.
PushDocumentType
Get notification of New File Available by using this method.
Documents Uploaded
Used to provide notification of client’s documents added by taxpayer or tax professional in TaxCaddy.
DRL
Used to provide notification of the client’s Document Request List status change; when it is completed or goes into error.