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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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

string
required

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

string
required

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

boolean
Defaults to true

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.

boolean

Specify 'true' to output null data elements.

Headers
string
required

Secure token for API authentication.

string
required

Password for the Crunchtime Application User.

string
required

Crunchtime site identifier. (test or production)

string
required

User ID for the Crunchtime Application User.

string

Optional trace identifier for troubleshooting.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json