---
updatedAt: 2026-08-25T16:04:44.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# downloadScheduledExportV2

Download Scheduled Exports.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "termsOfService": "http://springfox.io",
    "contact": {
      "name": "Crunchtime Development Team",
      "url": "http://www.crunchtime.com",
      "email": "apiquestions@crunchtime.com"
    },
    "license": {
      "name": "Apache License Version 2.0",
      "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Scheduled Export Service",
      "description": "The Scheduled Export service is an API that Crunchtime customers can use to download export files that have been generated via Scheduled Events in Enterprise Manager and convert the file content to JSON."
    }
  ],
  "paths": {
    "/scheduledexport/v2/downloadScheduledExport": {
      "get": {
        "tags": [
          "Scheduled Export Service"
        ],
        "summary": "downloadScheduledExportV2",
        "description": "Download Scheduled Exports.",
        "operationId": "downloadScheduledExportsV2UsingGET",
        "parameters": [
          {
            "name": "authenticationtoken",
            "in": "header",
            "description": "Secure token for API authentication.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "batchNumber",
            "in": "query",
            "description": "Batch Number of the export file to download. Obtained from ‘getAllScheduledExports’.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exportType",
            "in": "query",
            "description": "Export file type of the export file to download. Obtained from ‘getAllScheduledExports’. Required when \"include\" parameter is EXPORT or BOTH.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "extractHistoryId",
            "in": "query",
            "description": "Unique file identifier of the export file to download. Obtained from ‘getAllScheduledExports’.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include",
            "in": "query",
            "description": "Type of data to include in the response.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "EXPORT",
                "ATTACHMENT",
                "BOTH"
              ],
              "default": "EXPORT"
            }
          },
          {
            "name": "includeFileContent",
            "in": "query",
            "description": "Include export file content in the response when `true`.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "includeFileJson",
            "in": "query",
            "description": "Include export file content parsed as a structured JSON in the response when `true`.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sitename",
            "in": "header",
            "description": "Crunchtime site identifier. (test or production)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "User ID for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-B3-TraceId",
            "in": "header",
            "description": "Optional trace identifier for troubleshooting.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduledExportFileV2"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduledExportFileV2"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authorization",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Scheduled export not found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "503": {
            "description": "System under maintenance",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "ObjectError": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "code": {
            "type": "string"
          },
          "codes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "defaultMessage": {
            "type": "string"
          },
          "objectName": {
            "type": "string"
          }
        },
        "title": "ObjectError"
      },
      "ScheduledExportFileV2": {
        "type": "object",
        "properties": {
          "extractHistoryId": {
            "type": "integer",
            "format": "int64",
            "example": 1650348,
            "description": "\"extractHistoryId\" from scheduled export"
          },
          "exportType": {
            "type": "string",
            "example": "MAPPABLE_AP_TRANS_TYPE",
            "description": "\"exportType\" from scheduled export",
            "enum": [
              "EMPLOYEE_MAINTENANCE",
              "EPICOR_PLATINUM",
              "INVENTORY_TOTALS",
              "MAPPABLE_AP_TRANS_TYPE",
              "MAPPABLE_AR_TRANS_TYPE",
              "MAPPABLE_CUSTOM_TRANS_TYPE",
              "MAPPABLE_EMPLOYEE_POS_TYPE",
              "MAPPABLE_INVENTORY_DELTA_TYPE",
              "MAPPABLE_INVENTORY_TOTALS_TYPE",
              "MAPPABLE_LABOR_SCHEDULE_TYPE",
              "MAPPABLE_LOC_TRANSFERS_TYPE",
              "MAPPABLE_PAYROLL_TYPE",
              "MAPPABLE_SALES_TYPE",
              "MAPPABLE_STANDARD_AP_TYPE",
              "PAYROLL",
              "SALES",
              "STANDARD_AP",
              "STANDARD_INVENTORY_DELTA",
              "STANDARD_LOCATION_TRANSFERS",
              "USER_DEFINED"
            ]
          },
          "fileName": {
            "type": "string",
            "example": "NSAPSUPERSET,06302023,052420.txt",
            "description": "\"fileName\" from scheduled export"
          },
          "fileJson": {
            "type": "array",
            "description": "Export file content parsed as a structured JSON. Returned when `includeFileJson` is `true`.",
            "items": {
              "type": "object"
            }
          },
          "attachments": {
            "type": "array",
            "description": "Attachments applicable to the export. Returned when `include` is `ATTACHMENT` or `BOTH`.",
            "items": {
              "$ref": "#/components/schemas/VendorOrderAttachmentV2"
            }
          },
          "fileContent": {
            "type": "string",
            "example": "Ww0KICAgIHs",
            "description": "\"fileContent\" from scheduled export. Returned when `includeFileContent` is `true`."
          }
        },
        "title": "ScheduledExportFileV2",
        "description": "ExportFile description"
      },
      "VendorOrderAttachmentV2": {
        "type": "object",
        "properties": {
          "fileName": {
            "type": "string",
            "example": "IMG_6717.JPG",
            "description": "File name associated to the attachment."
          },
          "fileDescription": {
            "type": "string",
            "example": "TEST",
            "description": "File description associated to the attachment."
          },
          "fileContent": {
            "type": "string",
            "format": "byte",
            "description": "Base64 encoded data representing binary byte file. Only one of fileContent or fileUrl will be populated in the response."
          },
          "fileUrl": {
            "type": "string",
            "description": "Downloadable file url starts with `https://download.net-chef.com/`. This url expires 5 minutes after it is generated; call the endpoint again to generate a new link if the file still needs to be downloaded. Only one of fileContent or fileUrl will be populated in the response."
          },
          "vendorInvoiceNumber": {
            "type": "string",
            "example": "91",
            "description": "Vendor Invoice/Reference Number."
          },
          "vendorCode": {
            "type": "string",
            "example": "KATSIR",
            "description": "Customer: Customer \"Code\" (negative for hybrid Customers){R}Vendor: Vendor \"Code\" {R}(`MASTER` for Master Order Vendor, `REQSN` for Requisition Vendor that are created when \"Allow creation of Master Orders based on Company Product\" Purchasing Preference is selected and saved)"
          },
          "locationExportCode": {
            "type": "string",
            "example": "0409",
            "description": "Location Export Code."
          },
          "vendorExportCode": {
            "type": "string",
            "example": "VREIN15",
            "description": "Vendor Export Code."
          }
        },
        "title": "VendorOrderAttachmentV2",
        "description": "Attachments applicable to export."
      }
    }
  }
}
```