Skip to main content
API

SurePrep API - TaxCaddy use cases

SurePrep API Use Cases can help you visualize and plan how to integrate your application with SurePrep. You can walk through the process of identifying methods, creating steps, and running tasks using the SurePrep API.

TaxCaddy client set up

Create clients in TaxCaddy
Use this workflow to create standard and offline clients.
Use case for creating a client
Follow these steps to create a TaxCaddy client:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Lookup Methods
    : Use these methods to get firm-related information to use in other method calls.
  3. Create Client
    : CreateClient
Get details for clients created in TaxCaddy
Use this workflow to get and/or display client details.
Use case for getting client details
Follow these steps to get client details:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Get Client Details
    : GetClientDetails

Document Request List (DRL)

Create DRLs for TaxCaddy clients
Use this workflow to create DRLs for clients.
Use case for creating a DRL
Follow these steps to create DRL:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Lookup Methods
    : BinderTypes (Lookup Method) - Use this method to get firm-related information to use in other method calls.
  3. Create DRL
    : CreateDRL
Get DRL status for TaxCaddy clients
Use either of these workflows to get and/or display DRL status for clients.
Status retrieval
Use case for getting a DRL status
Follow these steps to get DRL status:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Get DRL Status Manually
    : GetDRLStatus
Webhook status retrieval
Use case for the DRL webhook
Follow these steps to get DRL status through webhook:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Client Subscription
    : Subscribe or Unsubscribe client to DRL Webhook.
  3. Create DRL
    : CreateDRL
  4. Get DRL Status Notification
    : DRL (Webhook)
Get DRL output for TaxCaddy clients
Use either of these workflows to get DRL output for clients.
DRL output with separate fillable PDFs
Use case for downloading a document
Follow these steps to get DRL output and any related PDFs for clients:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. DRLCategories (Lookup Method): Use this method to get firm-related information to use in other method calls.
  3. Get DRL Output and Download Available Documents
    2. DownloadDocument (SP): Use this to download any associated fillable PDF documents.
DRL output in a merged PDF
Use case for downloading a document
Follow these steps to get merged DRL output for clients:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. CreateDRL: If you use this method with the MergePDF attribute as true, you can get the DRL output in a merged PDF format.
  3. Get and download the document
    :
    2. DownloadDocument(SP): Use this to download the merged PDF document.
Send DRL output to TaxCaddy clients
Use this workflow to send DRL to clients.
Use case for sending a DRL
note
You need to create a DRL for your clients first, then send DRL.
Follow these steps to send DRL to your TaxCaddy clients:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Send DRL
    : SendDRL

Uploaded documents

Download documents uploaded in TaxCaddy
Use this workflow to get notified about and download all uploaded documents for clients.
Use case for downloading a document
Follow these steps to download uploaded documents:
  1. Set up
    :
    1. Get Started with SurePrep API
  2. Client Subscription
    : Subscribe or Unsubscribe client to Uploaded Documents Webhook.
  3. Get Documents Uploaded Notification
    : DocumentsUploaded (Webhook)
  4. Download Download
    : DownloadDocument (TaxCaddy)

This article applies to:

  • Product: SurePrep

Related Content

error-icon

Triva isn't available right now.

Check out the support page for our phone number and hours

error-close