Search
K
Documents

TaxformResponse

object
policyNumberstring

policy number of document/tax-form

Example:633033992

namestring

Name of the form

Example:1099-R

formIdstring

Unique id of Form

Example:105

taxYearstring

Tax year of the form

Example:2022

fcharstring

Unique string character associated with the tax-form name

Example:R

planCodestring

Plan code associated with the document

Example:633033992

documentIdstring

Unique Document Id (ObjectId)

Example:68a6adf406e31b19bfcea183

createdDatestring(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Created Date in UTC time zone

Example:2025-08-13T15:01:17.542Z

updatedDatestring(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Updated Date in UTC time zone

Example:2025-08-13T15:01:17.542Z

statusstring

Indicates the current status of the tax form

Allowed values:ACTIVEINACTIVE

Example:ACTIVE

Example

TaxformResponseList

object
countinteger(int32)

Number of tax forms found

Example:10

itemsarray[object]
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

Example

TaxformDownloadResponse

object
fileExtensionstring

File extension of the document

Example:pdf

binaryDatastring

Binary data of the document

Example:wdvb2ekllkk189w0enjansle..

correlationIdstring

Unique ID for correlating requests

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

Example

Recipient

string

Allowed values:AgentClient

DocumentMetadata

object
documentIDstringrequired
pageCountstringrequired
documentDatestring(date-time)required
importDatestring(date-time)required
fileNamestringrequired
fileTypestringrequired
displayNamestringrequired
sourceFileNamestringrequired
statusstringrequired
documentTypestringrequired
contractNumberstringrequired
masterNumberstringrequired
repManstringrequired
clientIDstringrequired
historybooleanrequired
docStatusstringrequired
documentNumberstringrequired
caseIdnumberrequired
zinniaLiveCaseIdstringrequired
docPopUrlstringrequired
attachmentTypestringrequired
periodYearstringrequired
periodQuarterstringrequired
Example