> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Bulk Downloads

# Type: Bulk Download Object

# Link: https://dev.wix.com/docs/api-reference/business-management/get-paid/bulk-downloads/bulk-download-object.md

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

## Schema:

```json
 Type: Bulk Download Object | type: BulkDownload
 Description: A bulk download contains the download information to retrieve items in the Get Paid APIs.
       - name: id  | type: string | description: Bulk download ID.
           - name: value  | type: string | description: 
       - name: revision  | type: string | description: 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.
           - name: value  | type: string | description: 
       - name: createdDate  | type: string | description: Date and time the bulk download was created.
           - name: seconds  | type: string | description: 
           - name: nanos  | type: number | description: 
       - name: updatedDate  | type: string | description: Date and time the bulk download was last updated.
       - name: expirationDate  | type: string | description: 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.
       - name: downloadGenerationStatus  | type: string | description: Status of the bulk download generation.
           enum: UNKNOWN_DOWNLOAD_STATUS, PROCESSING, PARTIAL_SUCCESS, SUCCESS, FAILED
       - name: downloadUrl  | type: string | description: 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"`.
       - name: namespace  | type: string | description: App namespace. Currently only supports `"RECEIPTS"`.
           enum: UNKNOWN_NAMESPACE, RECEIPTS
       - name: entityIds  | type: Array<string> | description: List of IDs of the entities to include in the bulk download.
       - name: skippedEntityIds  | type: Array<string> | description: 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.
       - name: downloadGenerationDetails  | type: DownloadGenerationDetails | description: Details about the number of files processed.
           - name: processed  | type: number | description: Number of files that have been processed.
           - name: total  | type: number | description: Total number of files to process.

```