GetDRLStatus (POST)

GetDRLStatus: Use this method to get the status of created DRLs in TaxCaddy. When you use the createDRL call, you will get DRLRequestID output parameter for each client. You can then use DRLRequestID as an input parameter for the GetDRLStatus call. You can create DRL for single or multiple clients at once (max 200 limit).

You will get the following status according to the current DRL status:

• DRL Creation In Queue (DRL Status - 116) - DRL import has completed and is now in queue to begin creating DRL.

• Creating DRL (DRL Status - 117) - TaxCaddy is currently in the process of creating DRL for clients.

• Completed (DRL Status - 107) - TaxCaddy successfully imported proforma data for clients who have this status. The next step is sending the DRL to these clients from TaxCaddy UI.

• Missing Tax Info – This status is an error indicating that you cannot create a custom DRL for clients with this status because their client record is missing information TaxCaddy needs to locate the client in your tax software.

Note: Tax professional user’s email address will be passed as the “UserEmail” parameter. When making this call, please make sure that TaxCaddy API and all tax professional users referenced in this call are setup with proper permissions. Click here to learn more about setting up TaxCaddy User Account Setup.
Permission(s) required: Access TaxCaddy and Access to TaxCaddy Admin

Supported

GetDRLStatus (POST) call supports the following:

API endpoint

Headers

Input Parameters

Error Codes

Sample Code

Sample request

{
    "DRLRequestIDs": [
                              {
            "DRLRequestID": 1000000
        }, 
                              {
            "DRLRequestID": 2000000
        }
    ]
}

{
  "ErrorCode": 0,
  "ErrorDescription": "",
  "Response": [
    {
      "DRLRequestID": 1000000,
      "ErrorCode": "0",
      "ErrorDescription": null,
      "TaxClientID": "TC1000000",
      "TaxYear": 2019,
      "TaxSoftwareName": "CCH Axcess Tax",
      "DRLStatusID": 107,
      "DRLStatusName": "Completed",
      "OwnerOfClientProfile": "owner@email.com",
      "StatusOfClientProfile": "Connected"
    },
    {
      "DRLRequestID": 2000000,
      "ErrorCode": null,
      "ErrorDescription": null,
      "TaxClientID": "TC2000000",
      "TaxYear": 2019,
      "TaxSoftwareName": "UltraTax CS",
      "DRLStatusID": 116,
      "DRLStatusName": "DRL Creation In Queue",
      "OwnerOfClientProfile": "owner@email.com",
      "StatusOfClientProfile": "Connected"
    }
  ]
}