EfileAttachmentFormData

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thomson-reuters/main/json-schema/thomson-reuters-efile-attachment-form-data-schema.json",
  "title": "EfileAttachmentFormData",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thomson-reuters-gosystem-tax-return-api-openapi.yml#/components/schemas/EfileAttachmentFormData",
  "type": "object",
  "required": [
    "isNewFile"
  ],
  "properties": {
    "filename": {
      "type": [
        "string",
        "null"
      ],
      "description": "Contains the name of the new file. Auto-populated from file if not provided"
    },
    "isNewFile": {
      "type": "boolean",
      "description": "If this is a new file being attached"
    },
    "jurisdictionAttachmentCode": {
      "type": [
        "string",
        "null"
      ],
      "description": "Jurisdiction of the attachment"
    },
    "existingJurisdictionAttachmentCode": {
      "type": [
        "string",
        "null"
      ],
      "description": "Contains the existing efile attachment jurisdiction. Required if isNewFile set to false"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description of the attachment"
    },
    "IsPredefinedDescription": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "If this is a new file being attached, use /efile-jurisdiction-attachment-details/{jurisdictionAttachmentCode} endpoint to check if Predefined Description(s) are available or not"
    },
    "IsPredefinedFormElementName": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "If this is a new file being attached, use /efile-jurisdiction-attachment-details/{jurisdictionAttachmentCode} endpoint to check if Form detail and Additional Infos applicable or not"
    },
    "AdditionalInfo1": {
      "type": [
        "string",
        "null"
      ],
      "description": "Additional Info 1 for applicable Jurisdiction, use /efile-jurisdiction-attachment-details/{jurisdictionAttachmentCode} endpoint to check if applicable or not"
    },
    "AdditionalInfo2": {
      "type": [
        "string",
        "null"
      ],
      "description": "Additional Info 2 for applicable Jurisdiction, use /efile-jurisdiction-attachment-details/{jurisdictionAttachmentCode} endpoint to check if applicable or not"
    },
    "FormName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Form name for applicable Jurisdiction, use /efile-jurisdiction-attachment-details/{jurisdictionAttachmentCode} endpoint to check if FormName applicable or not"
    },
    "FormElement": {
      "type": [
        "string",
        "null"
      ],
      "description": "Form element for applicable Jurisdiction, use /efile-jurisdiction-attachment-details/{jurisdictionAttachmentCode} endpoint to check if FormElement applicable or not"
    },
    "LastModified": {
      "type": [
        "string",
        "null"
      ],
      "description": "Contains the last modified date of the new file being added"
    },
    "isAsyncExecution": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether to execute asynchronously"
    },
    "file": {
      "type": [
        "string",
        "null"
      ],
      "format": "binary",
      "description": "File to be added. Required if isNewFile set to true"
    }
  }
}