A bulk download contains the download information to retrieve items in the Get Paid APIs.
Bulk download ID.
Revision number, which increments by 1 each time the bulk download is updated.
To prevent conflicting changes, the current revision
must be passed when updating the bulk download.
Date and time the bulk download was created.
Date and time the bulk download was last updated.
Date and time the bulk download expires.
The .zip file is available for download with the downloadUrl
until this time.
Default expiration date is 24 hours after creation.
Status of the bulk download generation.
URL to download the generated .zip file. Open this URL in a browser to download the file.
Only available when the downloadGenerationStatus
is "PARTIAL_SUCCESS"
or "SUCCESS"
.
App namespace. Currently only supports "RECEIPTS"
.
List of IDs of the entities to include in the bulk download.
IDs of the entities that aren't included in the .zip file.
If downloadGenerationStatus
is "PARTIAL_SUCCESS"
then these entities may still be included once the initiated download is complete.
If the value of downloadGenerationDetails.processed
matches downloadGenerationDetails.total
then all of the entities have been processed and
the skipped entities aren't included in the bulk download.
Details about the number of files processed.