openapi: 3.2.0 info: title: Crunchtime Scheduled Export Service API contact: name: Crunchtime Development Team url: http://www.crunchtime.com email: apiquestions@crunchtime.com license: name: Apache License Version 2.0 url: https://github.com/springfox/springfox/blob/master/LICENSE termsOfService: http://springfox.io version: '1.0' description: 'Operations tagged Scheduled Export Service across 2 of this provider''s published API definitions: crunchtime-cruise-platform-openapi.yml, crunchtime-inventory-labor-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: //webservices-test.net-chef.com tags: - name: Scheduled Export Service description: The Scheduled Export service is an API that Crunchtime customers can use to download export files that have been generated via Scheduled Events in Enterprise Manager and convert the file content to JSON. paths: /cruise/scheduledexport/v1/downloadScheduledExport: get: tags: - Scheduled Export Service summary: downloadScheduledExport description: 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. operationId: downloadScheduledExportsV1UsingGET parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: batchNumber in: query description: Batch Number of the export file to download. Obtained from ‘getAllScheduledExports’. required: true schema: type: string - name: exportType in: query description: 'Export file type of the export file to download. Obtained from ‘getAllScheduledExports’. ' required: true schema: type: string - name: extractHistoryId in: query description: Unique file identifier of the export file to download. Obtained from ‘getAllScheduledExports’. required: true schema: type: string - name: includeVendorOrderAttachments in: query description: "Output includes Vendor Order and Purchase by Invoice file attachments (invoices, images) when true, for Accounts Payable files only (exportType = MAPPABLE_AP_TRANS_TYPE). \n File attachments are downloaded in base64 format. Note that file attachments will not be available for files after “Undo” in Outbound Integrations." required: false schema: type: boolean default: true - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean responses: '200': description: Success content: '*/*': schema: type: array items: $ref: '#/components/schemas/ExportFile' application/json: schema: type: array items: $ref: '#/components/schemas/ExportFile' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: Scheduled export not found content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string servers: - url: //webservices-test.net-chef.com /cruise/scheduledexport/v1/getAllScheduledExports: get: tags: - Scheduled Export Service summary: getAllScheduledExportsV1 description: '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.' operationId: getAllScheduledExportsV1UsingGET parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: exportDate in: query description: Export Date to retrieve in format DD-MMM-YY. required: false schema: type: string - name: exportStatus in: query description: "Export Status to retrieve. If null, all Exports meeting the criteria of the Query Params will be returned. Statuses are: \n(1) Returns records for manually created exports; \n(2) Returns records for Scheduled Export files ready for download; \n(3) Returns records for Scheduled Export files already downloaded by CDP or any files “marked” as downloaded; \n(5) Returns records Marked as not successfully downloaded." required: false schema: type: string - name: extractName in: query description: Export file type name to explicitly retrieve. These file type names appear in parentheses in the “Transaction Type” column in Outbound Integrations. required: false schema: type: string - name: fileName in: query description: 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. required: false schema: type: string - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: postDate in: query description: Post Date to retrieve in format DD-MMM-YY. required: false schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: userIdForDetails in: query description: 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. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean - name: exportType in: query description: "General export file type to explicitly retrieve. File types are: \nMAPPABLE_AP_TRANS_TYPE (Accounts Payable), \nMAPPABLE_SALES_TYPE (Sales), \nMAPPABLE_INVENTORY_TOTALS_TYPE (Inventory Totals), \nMAPPABLE_INVENTORY_DELTA_TYPE (Inventory Delta), \nMAPPABLE_LOC_TRANSFERS_TYPE (Location Transfers), \nMAPPABLE_AR_TRANS_TYPE (Accounts Receivable), \nMAPPABLE_CUSTOM_TRANS_TYPE (Custom Transactions), \nEMPLOYEE_MAINTENANCE (Employee Maintenance), \nMAPPABLE_EMPLOYEE_POS_TYPE (Employee POS), \n MAPPABLE_LABOR_SCHEDULE_TYPE (Labor Schedule), \nMAPPABLE_PAYROLL_TYPE (Payroll), \nUSER_DEFINED (User Defined)" required: false schema: type: string responses: '200': description: Success content: '*/*': schema: type: array items: $ref: '#/components/schemas/ScheduledBatchExportFiles' application/json: schema: type: array items: $ref: '#/components/schemas/ScheduledBatchExportFiles' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: Scheduled export not found content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string servers: - url: //webservices-test.net-chef.com /cruise/scheduledexport/v1/markScheduledExport: put: tags: - Scheduled Export Service summary: markScheduledExportV1 description: Mark Scheduled Exports. operationId: markScheduledExportsV1UsingPUT parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: errorCode in: query description: Error code to retrieve. Maximum of 40 characters. required: false schema: type: string - name: errorMessage in: query description: Error message to retrieve. Maximum of 256 characters. required: false schema: type: string - name: extractHistoryId in: query description: Extract history id to retrieve. required: true schema: type: string - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: success in: query description: Use 'true' to set Export Status = CDP Yes. required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: userIdForDetails in: query description: Application User User ID who downloaded the file. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string responses: '200': description: Success content: '*/*': schema: type: boolean application/json: schema: type: boolean '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string servers: - url: //webservices-test.net-chef.com /scheduledexport/v1/downloadScheduledExport: get: tags: - Scheduled Export Service summary: downloadScheduledExport description: 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. operationId: getScheduledexportV1DownloadScheduledExport parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: batchNumber in: query description: Batch Number of the export file to download. Obtained from ‘getAllScheduledExports’. required: true schema: type: string - name: exportType in: query description: 'Export file type of the export file to download. Obtained from ‘getAllScheduledExports’. ' required: true schema: type: string - name: extractHistoryId in: query description: Unique file identifier of the export file to download. Obtained from ‘getAllScheduledExports’. required: true schema: type: string - name: includeVendorOrderAttachments in: query description: "Output includes Vendor Order and Purchase by Invoice file attachments (invoices, images) when true, for Accounts Payable files only (exportType = MAPPABLE_AP_TRANS_TYPE). \n File attachments are downloaded in base64 format. Note that file attachments will not be available for files after “Undo” in Outbound Integrations." required: false schema: type: boolean default: true - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean responses: '200': description: Success content: '*/*': schema: type: array items: $ref: '#/components/schemas/ExportFile' application/json: schema: type: array items: $ref: '#/components/schemas/ExportFile' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: Scheduled export not found content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string x-operation-id-source: normalized x-operation-id-original: downloadScheduledExportsV1UsingGET servers: - url: //webservices-test.net-chef.com /scheduledexport/v1/getAllScheduledExports: get: tags: - Scheduled Export Service summary: getAllScheduledExportsV1 description: '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.' operationId: getScheduledexportV1GetAllScheduledExports parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: exportDate in: query description: Export Date to retrieve in format DD-MMM-YY. required: false schema: type: string - name: exportStatus in: query description: "Export Status to retrieve. If null, all Exports meeting the criteria of the Query Params will be returned. Statuses are: \n(1) Returns records for manually created exports; \n(2) Returns records for Scheduled Export files ready for download; \n(3) Returns records for Scheduled Export files already downloaded by CDP or any files “marked” as downloaded; \n(5) Returns records Marked as not successfully downloaded." required: false schema: type: string - name: extractName in: query description: Export file type name to explicitly retrieve. These file type names appear in parentheses in the “Transaction Type” column in Outbound Integrations. required: false schema: type: string - name: fileName in: query description: 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. required: false schema: type: string - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: postDate in: query description: Post Date to retrieve in format DD-MMM-YY. required: false schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: userIdForDetails in: query description: 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. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean - name: exportType in: query description: "General export file type to explicitly retrieve. File types are: \nMAPPABLE_AP_TRANS_TYPE (Accounts Payable), \nMAPPABLE_SALES_TYPE (Sales), \nMAPPABLE_INVENTORY_TOTALS_TYPE (Inventory Totals), \nMAPPABLE_INVENTORY_DELTA_TYPE (Inventory Delta), \nMAPPABLE_LOC_TRANSFERS_TYPE (Location Transfers), \nMAPPABLE_AR_TRANS_TYPE (Accounts Receivable), \nMAPPABLE_CUSTOM_TRANS_TYPE (Custom Transactions), \nEMPLOYEE_MAINTENANCE (Employee Maintenance), \nMAPPABLE_EMPLOYEE_POS_TYPE (Employee POS), \n MAPPABLE_LABOR_SCHEDULE_TYPE (Labor Schedule), \nMAPPABLE_PAYROLL_TYPE (Payroll), \nUSER_DEFINED (User Defined)" required: false schema: type: string responses: '200': description: Success content: '*/*': schema: type: array items: $ref: '#/components/schemas/ScheduledBatchExportFiles' application/json: schema: type: array items: $ref: '#/components/schemas/ScheduledBatchExportFiles' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: Scheduled export not found content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string x-operation-id-source: normalized x-operation-id-original: getAllScheduledExportsV1UsingGET servers: - url: //webservices-test.net-chef.com /scheduledexport/v1/markScheduledExport: put: tags: - Scheduled Export Service summary: markScheduledExportV1 description: Mark Scheduled Exports. operationId: putScheduledexportV1MarkScheduledExport parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: errorCode in: query description: Error code to retrieve. Maximum of 40 characters. required: false schema: type: string - name: errorMessage in: query description: Error message to retrieve. Maximum of 256 characters. required: false schema: type: string - name: extractHistoryId in: query description: Extract history id to retrieve. required: true schema: type: string - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: success in: query description: Use 'true' to set Export Status = CDP Yes. required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: userIdForDetails in: query description: Application User User ID who downloaded the file. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string responses: '200': description: Success content: '*/*': schema: type: boolean application/json: schema: type: boolean '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string x-operation-id-source: normalized x-operation-id-original: markScheduledExportsV1UsingPUT servers: - url: //webservices-test.net-chef.com /scheduledexport/v2/downloadScheduledExport: get: tags: - Scheduled Export Service summary: downloadScheduledExportV2 description: Download Scheduled Exports. operationId: downloadScheduledExportsV2UsingGET parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: batchNumber in: query description: Batch Number of the export file to download. Obtained from ‘getAllScheduledExports’. required: false schema: type: string - name: exportType in: query description: Export file type of the export file to download. Obtained from ‘getAllScheduledExports’. Required when "include" parameter is EXPORT or BOTH. required: false schema: type: string - name: extractHistoryId in: query description: Unique file identifier of the export file to download. Obtained from ‘getAllScheduledExports’. required: true schema: type: string - name: include in: query description: Type of data to include in the response. required: false schema: type: string enum: - EXPORT - ATTACHMENT - BOTH default: EXPORT - name: includeFileContent in: query description: Include export file content in the response when `true`. required: false schema: type: boolean default: true - name: includeFileJson in: query description: Include export file content parsed as a structured JSON in the response when `true`. required: false schema: type: boolean default: true - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean responses: '200': description: Success content: '*/*': schema: $ref: '#/components/schemas/ScheduledExportFileV2' application/json: schema: $ref: '#/components/schemas/ScheduledExportFileV2' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: Scheduled export not found content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string servers: - url: //webservices-test.net-chef.com components: schemas: ScheduledBatchExportFiles: type: object properties: batchId: type: integer format: int64 example: 4160 description: Batch Number for export file. Required to retrieve file contents through downloadScheduledExport. exportDate: type: string example: 01/29/2024 11:25:04 description: Export Date of the export file. exportStatus: type: integer format: int32 example: 3 description: "Export Status of the export file: \n(1) Manually created exports (“N/A” in Outbound Integrations); \n(2) Scheduled Export file ready for download (“CDP No” in Outbound Integrations); \n(3) Scheduled Export file already downloaded by CDP or “marked” as downloaded (“CDP Yes” in Outbound Integrations); \n(5) Returns records Marked as not successfully downloaded (uncommon, but may happen with CDP download attempt)." exportType: type: string example: MAPPABLE_SALES_TYPE description: '"exportType" from scheduled export' enum: - 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 extractHistoryId: type: integer format: int64 example: 1650348 description: Numeric identifier for the individual export file. Required to retrieve file contents through downloadScheduledExport. extractName: type: string example: STANDARD description: Export file type (or mapping) name. fileName: type: string example: SALESNE_4160 description: File name of the individual export file. postDate: type: string example: 01/22/2024 description: 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. user: type: string example: APIDOWNLOAD description: 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. title: ScheduledBatchExportFiles description: ScheduledBatchExportFiles description ExportFile: type: object properties: exportType: type: string example: MAPPABLE_AP_TRANS_TYPE description: '"exportType" from scheduled export' enum: - 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 extractHistoryId: type: integer format: int64 example: 1122349 description: '"extractHistoryId" from scheduled export' fileContent: type: string example: Ww0KICAgIHs description: '"fileContent" from scheduled export' fileJson: type: array items: type: object additionalProperties: type: object fileName: type: string example: NSAPSUPERSET,06302023,052420.txt description: '"fileName" from scheduled export' vendorOrderAttachments: $ref: '#/components/schemas/VendorOrderAttachmentsDto' title: ExportFile description: ExportFile description VendorOrderAttachment: type: object properties: fileContent: type: string format: byte description: Base64 encoded data representing binary byte file. fileName: type: string example: IMG_6717.JPG description: File name associated to the attachment. vendorCode: type: string example: KATSIR description: 'Customer: Customer "Code" (negative for hybrid Customers){R}Vendor: Vendor "Code" {R}(`MASTER` for Master Order Vendor, `REQSN` for Requisition Vendor that are created when "Allow creation of Master Orders based on Company Product" Purchasing Preference is selected and saved)' vendorInvoiceNumber: type: string example: 91 description: Vendor Invoice/Reference Number. locationExportCode: type: string example: 0409 description: Location Export Code. vendorExportCode: type: string example: VREIN15 description: Vendor Export Code. title: VendorOrderAttachment description: Vendor order files/attachments applicable to export. ObjectError: type: object properties: arguments: type: array items: type: object code: type: string codes: type: array items: type: string defaultMessage: type: string objectName: type: string title: ObjectError VendorOrderAttachmentsDto: type: object properties: extractHistoryId: type: integer format: int64 example: 123 description: ID of the extract vendorOrderAttachmentList: type: array items: $ref: '#/components/schemas/VendorOrderAttachment' title: VendorOrderAttachmentsDto description: Vendor order attachments related to the extract being downloaded. Subject to includeVendorOrderAttachments set to true. VendorOrderAttachmentV2: type: object properties: fileName: type: string example: IMG_6717.JPG description: File name associated to the attachment. fileDescription: type: string example: TEST description: File description associated to the attachment. fileContent: type: string format: byte description: Base64 encoded data representing binary byte file. Only one of fileContent or fileUrl will be populated in the response. fileUrl: type: string description: Downloadable file url starts with `https://download.net-chef.com/`. This url expires 5 minutes after it is generated; call the endpoint again to generate a new link if the file still needs to be downloaded. Only one of fileContent or fileUrl will be populated in the response. vendorInvoiceNumber: type: string example: '91' description: Vendor Invoice/Reference Number. vendorCode: type: string example: KATSIR description: 'Customer: Customer "Code" (negative for hybrid Customers){R}Vendor: Vendor "Code" {R}(`MASTER` for Master Order Vendor, `REQSN` for Requisition Vendor that are created when "Allow creation of Master Orders based on Company Product" Purchasing Preference is selected and saved)' locationExportCode: type: string example: 0409 description: Location Export Code. vendorExportCode: type: string example: VREIN15 description: Vendor Export Code. title: VendorOrderAttachmentV2 description: Attachments applicable to export. ScheduledExportFileV2: type: object properties: extractHistoryId: type: integer format: int64 example: 1650348 description: '"extractHistoryId" from scheduled export' exportType: type: string example: MAPPABLE_AP_TRANS_TYPE description: '"exportType" from scheduled export' enum: - 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 fileName: type: string example: NSAPSUPERSET,06302023,052420.txt description: '"fileName" from scheduled export' fileJson: type: array description: Export file content parsed as a structured JSON. Returned when `includeFileJson` is `true`. items: type: object attachments: type: array description: Attachments applicable to the export. Returned when `include` is `ATTACHMENT` or `BOTH`. items: $ref: '#/components/schemas/VendorOrderAttachmentV2' fileContent: type: string example: Ww0KICAgIHs description: '"fileContent" from scheduled export. Returned when `includeFileContent` is `true`.' title: ScheduledExportFileV2 description: ExportFile description x-refined-from: - crunchtime-cruise-platform-openapi.yml - crunchtime-inventory-labor-openapi.yml x-provenance: method: searched source: https://developer.crunchtime.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developer.crunchtime.com/reference/downloadscheduledexportsv1usingget-1.md - https://developer.crunchtime.com/reference/getallapplicationusersv1usingget-1.md - https://developer.crunchtime.com/reference/getallcompanyproductsenhancedv1usingget-1.md - https://developer.crunchtime.com/reference/getallcurrencyratiov1usingget_1.md - https://developer.crunchtime.com/reference/getallcustomerrecordsv1usingget-1.md - https://developer.crunchtime.com/reference/getallgeneralledgersv1usingget-1.md - https://developer.crunchtime.com/reference/getallinventoryadjustmentv1usingget-1.md - https://developer.crunchtime.com/reference/getallinventoryvalueadjustmentv1usingget-1.md - https://developer.crunchtime.com/reference/getalllocationproductpricingv1usingget-1.md - https://developer.crunchtime.com/reference/getalllocationsv1usingget-1.md - https://developer.crunchtime.com/reference/getallphysicalinventorystandardusingget-1.md - https://developer.crunchtime.com/reference/getallprojectedconsumptionv1usingget-1.md - https://developer.crunchtime.com/reference/getallrecipesenhancedv1usingget_1.md - https://developer.crunchtime.com/reference/getallscheduledexportsv1usingget-1.md - https://developer.crunchtime.com/reference/getallvendorlocationv1usingget-1.md - https://developer.crunchtime.com/reference/getallvendorsv1usingget-1.md - https://developer.crunchtime.com/reference/getapplicationusersbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getcompanyproductsenhancedbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getcurrencyratiobypagev1usingget_1.md - https://developer.crunchtime.com/reference/getcustomerrecordsbypagev1usingget-1.md - https://developer.crunchtime.com/reference/gethierarchiesv1usingget.md - https://developer.crunchtime.com/reference/gethierarchydetailsv1usingget.md - https://developer.crunchtime.com/reference/getinventoryadjustmentbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getinventoryvalueadjustmentbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getlocationproductpricingbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getlocationsbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getphysicalinventorystandardbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getprojectedconsumptionbypagev1usingget-1.md - https://developer.crunchtime.com/reference/getrecipesenhancedbypagev1usingget_1.md - https://developer.crunchtime.com/reference/getvendorlocationbypagev1usingget-1.md - https://developer.crunchtime.com/reference/markscheduledexportsv1usingput-1.md - https://developer.crunchtime.com/reference/saveapplicationusersv1usingpost-1.md - https://developer.crunchtime.com/reference/savecompanyproductenhancedv1usingpost-1.md - https://developer.crunchtime.com/reference/savecurrencyratiousingpost_1.md - https://developer.crunchtime.com/reference/savecustomerrecordsusingpost-1.md - https://developer.crunchtime.com/reference/savegeneralledgerv1usingpost-1.md - https://developer.crunchtime.com/reference/savehierarchyv1usingpost.md - https://developer.crunchtime.com/reference/saveinventoryadjustmentusingpost-1.md - https://developer.crunchtime.com/reference/saveinventoryvalueadjustmentusingpost-1.md - https://developer.crunchtime.com/reference/savelocationproductpricingusingpost-1.md - https://developer.crunchtime.com/reference/savelocationv1usingpost-1.md - https://developer.crunchtime.com/reference/savephysicalinventorystandardusingpost-1.md - https://developer.crunchtime.com/reference/saveprojectedconsumptionusingpost-1.md - https://developer.crunchtime.com/reference/saverecipesusingpost_1.md - https://developer.crunchtime.com/reference/savevendorlocationv1usingpost-1.md - https://developer.crunchtime.com/reference/savevendorv1usingpost-1.md merge: pages: 46 deduped: 167 conflicts_kept_first: 0