Bulk Download Object


A bulk download contains the download information to retrieve items in the Get Paid APIs.

Properties
createdDatestringRead-onlyimmutableformat date-time

Date and time the bulk download was created.


downloadGenerationDetailsDownloadGenerationDetailsRead-only

Details about the number of files processed.


downloadGenerationStatusstringRead-only

Status of the bulk download generation.


downloadUrlstringRead-onlyformat WEB_URL

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".


entityIdsArray <string>format GUIDimmutableminItems 2maxItems 100

List of IDs of the entities to include in the bulk download.


expirationDatestringRead-onlyimmutableformat date-time

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.


idstringRead-onlyformat GUIDimmutable

Bulk download ID.


namespacestringimmutable

App namespace. Currently only supports "RECEIPTS".


revisionstringRead-onlyformat int64

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.


skippedEntityIdsArray <string>Read-onlyformat GUIDmaxItems 100

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.


updatedDatestringRead-onlyformat date-time

Date and time the bulk download was last updated.

Did this help?