Sign in

v1

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

getAllScheduledExportsV1

Retrieve a list of individual export files generated through Event Scheduling (Scheduled Exports) or manually in Outbound Integrations. Does not include files associated with managed partner integrations. Results may be used with the downloadScheduledExport endpoint to retrieve file contents, and with the markScheduledExport endpoint to update export file records to indicate that they have been downloaded.

get/scheduledexport/v1/getAllScheduledExports

Query parameters

exportDatestring

Export Date to retrieve in format DD-MMM-YY.

exportStatusstring

Export Status to retrieve. If null, all Exports meeting the criteria of the Query Params will be returned. Statuses are: (1) Returns records for manually created exports; (2) Returns records for Scheduled Export files ready for download; (3) Returns records for Scheduled Export files already downloaded by CDP or any files “marked” as downloaded; (5) Returns records Marked as not successfully downloaded.

extractNamestring

Export file type name to explicitly retrieve. These file type names appear in parentheses in the “Transaction Type” column in Outbound Integrations.

fileNamestring

Specific export file name to explicitly retrieve. Use 4 or more characters for wildcard search. Note that these file names are not visible in the Outbound Integrations screen.

postDatestring

Post Date to retrieve in format DD-MMM-YY.

userIdForDetailsstring required

All export files are associated with a particular Application User's User ID. This is the value displayed in the “User” column in Outbound Integrations for the relevant file or file batch.

includeNullboolean

Specify 'true' to output null data elements.

exportTypestring

General export file type to explicitly retrieve. File types are: MAPPABLE_AP_TRANS_TYPE (Accounts Payable), MAPPABLE_SALES_TYPE (Sales), MAPPABLE_INVENTORY_TOTALS_TYPE (Inventory Totals), MAPPABLE_INVENTORY_DELTA_TYPE (Inventory Delta), MAPPABLE_LOC_TRANSFERS_TYPE (Location Transfers), MAPPABLE_AR_TRANS_TYPE (Accounts Receivable), MAPPABLE_CUSTOM_TRANS_TYPE (Custom Transactions), EMPLOYEE_MAINTENANCE (Employee Maintenance), MAPPABLE_EMPLOYEE_POS_TYPE (Employee POS), MAPPABLE_LABOR_SCHEDULE_TYPE (Labor Schedule), MAPPABLE_PAYROLL_TYPE (Payroll), USER_DEFINED (User Defined)

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

batchIdinteger

Batch Number for export file. Required to retrieve file contents through downloadScheduledExport.

exportDatestring

Export Date of the export file.

exportStatusinteger

Export Status of the export file: (1) Manually created exports (“N/A” in Outbound Integrations); (2) Scheduled Export file ready for download (“CDP No” in Outbound Integrations); (3) Scheduled Export file already downloaded by CDP or “marked” as downloaded (“CDP Yes” in Outbound Integrations); (5) Returns records Marked as not successfully downloaded (uncommon, but may happen with CDP download attempt).

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

Numeric identifier for the individual export file. Required to retrieve file contents through downloadScheduledExport.

extractNamestring

Export file type (or mapping) name.

fileNamestring

File name of the individual export file.

postDatestring

Post Date for file contents, if applicable. Note that some USER_DEFINED files are assigned a file-level Post Date of 12/31/1990 even if their contents are Post Date-specific.

userstring

User ID of the Application User associated with the individual export file. This is the value displayed in the “User” column in Outbound Integrations for the relevant file or file batch and correlates to the “userIdForDetails” query param.

Example response

[
  {
    "batchId": 4160,
    "exportDate": "01/29/2024 11:25:04",
    "exportStatus": 3,
    "exportType": "MAPPABLE_SALES_TYPE",
    "extractHistoryId": 1650348,
    "extractName": "STANDARD",
    "fileName": "SALESNE_4160",
    "postDate": "01/22/2024",
    "user": "APIDOWNLOAD"
  }
]