Sign in

v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Scheduled Export Service

downloadScheduledExport

Download Scheduled Exports. To ensure the highest stability and data integrity for your API integration, we strongly recommend using a sequential or "low-parallelism" pattern when downloading scheduled exports from the Crunchtime API. Because these exports often involve large datasets, initiating multiple concurrent downloads can lead to resource contention, resulting in throttled throughput or connection timeouts. By limiting your process to a single active download at a time, you allow the platform to provide a steady, high-speed data stream without the overhead of managing competing requests. This "one-at-a-time" approach is the most reliable way to ensure your files are delivered completely and efficiently, preventing the need for complex error handling or manual restarts.

get/scheduledexport/v1/downloadScheduledExport

Query parameters

batchNumberstring required

Batch Number of the export file to download. Obtained from ‘getAllScheduledExports’.

exportTypestring required

Export file type of the export file to download. Obtained from ‘getAllScheduledExports’.

extractHistoryIdstring required

Unique file identifier of the export file to download. Obtained from ‘getAllScheduledExports’.

includeVendorOrderAttachmentsboolean

Output includes Vendor Order and Purchase by Invoice file attachments (invoices, images) when true, for Accounts Payable files only (exportType = MAPPABLE_AP_TRANS_TYPE). File attachments are downloaded in base64 format. Note that file attachments will not be available for files after “Undo” in Outbound Integrations.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

exportType'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'

"exportType" from scheduled export

extractHistoryIdinteger

"extractHistoryId" from scheduled export

fileContentstring

"fileContent" from scheduled export

fileJsonobject[]
fileNamestring

"fileName" from scheduled export

Example response

[
  {
    "exportType": "MAPPABLE_AP_TRANS_TYPE",
    "extractHistoryId": 1122349,
    "fileContent": "Ww0KICAgIHs",
    "fileName": "NSAPSUPERSET,06302023,052420.txt",
    "vendorOrderAttachments": {
      "extractHistoryId": 123,
      "vendorOrderAttachmentList": [
        {
          "fileName": "IMG_6717.JPG",
          "vendorCode": "KATSIR",
          "locationExportCode": "0409",
          "vendorExportCode": "VREIN15"
        }
      ]
    }
  }
]