19. Files

15.1 Overview

A file refers to a collection of payments in a csv or text format that can be uploaded to CPX to generate payments from buyers to suppliers.
Users can upload files and create payments in CPX via API and also cancel transactions that are created in the same file. Users can fetch file information from CPX using APIs. Additionally they can also approve and reject Files awaiting internal approval.

15.2 Attributes

Field	Sub-field	Type	Description
aggregations		Object	Total Aggregate amount of the records fetched
	totalAmount value	Object Integer	Total Amount Total Amount value
totalRecords		Integer	Total number of records available
totalType		String	Whether the records returned are an exact or in range
recordCount		Integer	Number of records fetched
records		Array of objects	Details of the records fetched
	creator id username	Object String String	Id of user creating the supplier Username of user creating the supplier
	displayRecordCount	Integer	Count of records displayed
	exceptions	String	Errors for the file
	fileDate	String	Date of file creation on CPX
	fileId	String	Id of File generated by CPX
	fileName	String	Name of File generated by CPX
	filePath	String	Pickup Path of the file
	fileSource	String	Source of File creation
	fileStatusMessage	String	Message related to Status of File
	id	String	Id of file generated
	importDate	String	Date and time of file being imported
	isPifPlanCreated	Boolean	Whether PIF Plan is created for the file
	isPifPlanLocked	Boolean	Whether PIF Plan is created for the file
	message	String	Message associated with the Get API
	originalRecordCount	String	Total payments uploaded by user in file
	recordCount	Integer	Total records of payments associated with the file including debits and refunds
	status	String	Status of file
	totalAmount	Integer	Total amount of payments in the file
	uploadedFileName	String	Name of file as uploaded by user
	buyers	Array	List of buyers for the payment
	paymentFileInfo bid buyerId fid fileId fileType mappings actions action column columnName id format preactions action id nid username	Array String String String String Enum Object Object String String String String String Object String String String String	Information of payments BID of buyer Buyer Id of buyer FID associated to buyer fileId of the file Type of file uploaded Mapping of uploaded file Actions set on the file Action to be taken Column on which action is to be taken Name of column Id of the column Format of the column Preactions set on the file Action to be taken Id of the column NID associated to the buyer Username of user
_scroll_id		String	The id for the search context
payload		Object	Object to send file ID to be approved or rejected
	id	String	Id of the file to be approved or rejected
fileInfo		Object	Information about the file
	fileId	string	Id of the file uploaded to CPX
	fileName	string	Name of the file uploaded to CPX
	status	String	Status of the file
successes		Array	List of Ids of payments successfully cancelled
successCount		Integer	Number of payments successfully cancelled
failures		Array	List of Ids of payments for which cancellation failed
failureCount		Integer	Number of payments for which cancellation failed

15.3 Operations

15.3.1. Search Files
15.3.2. Search Files for Export
15.3.3. Approve/Reject PIF Files
15.3.4. Post PIF Files in CSV format
15.3.5. Cancel all transactions in PIF File