Search Files
Overview
This route will search for file records based on the given search criteria.
Resource Access
GET https://<hostname>/file/v1/file
Parameters
The requested criteria can be a combination of one or more of the following fields:
| Keys | Values |
|---|---|
| filter | %7B%7D |
| search | <Item user wants to search> |
| size | 10 |
| sort | created%3Adesc |
| fileName | Name of file |
Example Request
GET https://<hostname>/file/v1/file?size=2
Example Response
{
"aggregations": {
"totalAmount": {
"value": 1.01000000000001e+80
}
},
"totalRecords": 141485,
"totalType": "exact",
"recordCount": 2,
"records": [
{
"creator": {
"id": "1c7fd64a-dfa4-5788-a5c8-5d2d55649833",
"username": "qa+institution"
},
"displayRecordCount": 2,
"exceptions": 0,
"fileDate": "2019-09-04T15:55:10Z",
"fileId": "c4960460-cf2b-11e9-a211-df7e9632a709",
"fileName": "qualityAssuranceNid.qualityAssurancePaymentFid.QA-ALL-FIELDS-MAPPING-EF6026123C.csv",
"filePath": "/cpx/authorization/preprocess/2018/qualityAssuranceNid.qualityAssurancePaymentFid.QA-ALL-FIELDS-MAPPING-EF6026123C.csv",
"fileSource": "portal_file",
"fileStatusMessage": "File Creation",
"id": "c4960460-cf2b-11e9-a211-df7e9632a709",
"importDate": "2019-09-04T15:54:52Z",
"isPifPlanCreated": true,
"isPifPlanLocked": true,
"message": "getTransactionsForPIFFile fileId=c4960460-cf2b-11e9-a211-df7e9632a709 count=2 total=2",
"originalRecordCount": 2,
"paymentFileInfo": {
"bid": "qualityAssuranceAllFieldsBid",
"buyerId": "366ef02a-8b4e-57e9-b3ff-3ddd7c1ce7fa",
"fid": "qualityAssurancePaymentFid",
"fileId": "c4960460-cf2b-11e9-a211-df7e9632a709",
"fileType": "b4a5c875-3578-50dc-8f9b-307c89b26ba4",
"mappings": {
"actions": [
{
"action": "rename",
"column": 0,
"columnName": "sid",
"id": "3945f3aa-8e90-56e7-b212-51e92cd6ce88"
},
{
"action": "rename",
"column": 1,
"columnName": "amount",
"id": "20c8364e-b1cf-5c92-8ac2-720ef16f15a9"
},
{
"action": "rename",
"column": 2,
"columnName": "nid",
"id": "f7ce83fb-0d3a-5d11-8ccc-c9e5ff30f01f"
},
{
"action": "rename",
"column": 3,
"columnName": "fid",
"id": "8738ead5-20d9-5460-9b01-6f1e9245fc92"
},
{
"action": "rename",
"column": 4,
"columnName": "bid",
"id": "d4c79c25-f1df-54cf-85e7-379f1af7cff6"
},
{
"action": "rename",
"column": 5,
"columnName": "fileDate",
"id": "3f94968f-43ac-5810-a3cd-2782fe72fbe8"
},
{
"action": "rename",
"column": 6,
"columnName": "transactionId",
"id": "8ac8c38a-b722-582a-8fd0-e65490938466"
},
{
"action": "rename",
"column": 7,
"columnName": "paymentExpirationDate",
"id": "42a53332-a03d-553f-be47-8eb491f6b88b"
},
{
"action": "rename",
"column": 8,
"columnName": "accountType",
"id": "82042e4a-6079-5160-a9d3-4c477e191427"
},
{
"action": "rename",
"column": 9,
"columnName": "vcnNumber",
"id": "f81667f7-7ffe-5355-8bb9-95dbba6d518f"
},
{
"action": "rename",
"column": 10,
"columnName": "vcnAccountExpirationDate",
"id": "bda5c13b-706e-5dee-bec7-a6c622719db8"
},
{
"action": "rename",
"column": 11,
"columnName": "bankRoutingNumber",
"id": "53e84497-979b-58d1-8496-98bb2b71d032"
},
{
"action": "rename",
"column": 12,
"columnName": "bankAccountNumber",
"id": "66de52ff-0a79-5380-b681-6325ba0dd7aa"
},
{
"action": "rename",
"column": 13,
"columnName": "checkNumber",
"id": "511dd52d-c51b-578d-a8b0-c3e8032df38e"
},
{
"action": "rename",
"column": 14,
"columnName": "accountId",
"id": "3e15e8f5-1480-566f-a1dc-34a324a3a896"
},
{
"action": "rename",
"column": 15,
"columnName": "invoiceNumbers",
"id": "afb641ad-0341-523c-9614-cd82de9677de"
},
{
"action": "rename",
"column": 16,
"columnName": "invoiceDates",
"id": "e082016b-9595-55b1-a0eb-74e092414291"
},
{
"action": "rename",
"column": 17,
"columnName": "invoiceAmounts",
"id": "77e74227-4e3b-5779-8211-b39f5cbd35c3"
},
{
"action": "rename",
"column": 18,
"columnName": "invoiceTotalDues",
"id": "9a55c8df-9f68-5e29-b8c2-d33fbcaa5350"
},
{
"action": "rename",
"column": 19,
"columnName": "invoiceDescription",
"id": "3757e86f-39c3-5f62-89a3-37c29c395c36"
},
{
"action": "rename",
"column": 20,
"columnName": "invoiceLocations",
"id": "52f625a1-207b-5c88-a229-5e9d4f8cf3e7"
},
{
"action": "rename",
"column": 21,
"columnName": "invoiceOpenAmounts",
"id": "36338458-26ce-5e1f-8263-8471fe1d05cf"
},
{
"action": "rename",
"column": 22,
"columnName": "invoiceCreditAmounts",
"id": "ff462298-a173-5deb-afa9-1a0e6153011b"
},
{
"action": "rename",
"column": 23,
"columnName": "invoiceDiscountAmounts",
"id": "7808c224-de0f-5f42-b69c-10fc72907ca7"
},
{
"action": "rename",
"column": 24,
"columnName": "invoiceCreditNumbers",
"id": "ed5f54ba-f326-5d4e-8ac6-cb715eb05d9c"
},
{
"action": "rename",
"column": 25,
"columnName": "invoiceCreditMemoNotes",
"id": "04712454-61d3-5f2e-b298-f932bbcf71b1"
},
{
"action": "rename",
"column": 26,
"columnName": "poNumber",
"id": "e38e9069-c659-555f-a8e8-554ff175a742"
},
{
"action": "rename",
"column": 27,
"columnName": "poDate",
"id": "f83eeae9-77a1-5294-80b7-323a9400c0e1"
},
{
"action": "rename",
"column": 28,
"columnName": "supplierName",
"id": "1c1de93f-b12e-5577-b304-113f27f73127"
},
{
"action": "rename",
"column": 29,
"columnName": "reference1",
"id": "1cfa4532-f141-5cfd-affb-439086ff4e70"
},
{
"action": "rename",
"column": 30,
"columnName": "reference2",
"id": "19b81026-384e-5dbe-b82b-cfdba6047349"
},
{
"action": "rename",
"column": 31,
"columnName": "reference3",
"id": "dc15e268-593d-5415-bbef-6b16323eef92"
},
{
"action": "rename",
"column": 32,
"columnName": "reference4",
"id": "b395b74b-9b59-5152-9e7e-0c2518205a6f"
},
{
"action": "rename",
"column": 33,
"columnName": "reference5",
"id": "a0aede5c-a829-5fdb-a440-ac43bce64b50"
},
{
"action": "rename",
"column": 34,
"columnName": "billingAddressStreet1",
"id": "610ef2b7-4dab-54f2-9dc2-3a074f577014"
},
{
"action": "rename",
"column": 35,
"columnName": "billingAddressStreet2",
"id": "c7b356dd-6f52-555b-b8d7-b9161c1cc807"
},
{
"action": "rename",
"column": 36,
"columnName": "billingAddressCity",
"id": "a27b704f-f0ad-5dc6-9116-6043e092e92f"
},
{
"action": "rename",
"column": 37,
"columnName": "billingAddressState",
"id": "e2e3db0b-2407-595c-a0eb-b41c06f3e7d8"
},
{
"action": "rename",
"column": 38,
"columnName": "billingAddressPostalCode",
"id": "e2bf3e38-2256-5b9d-ae19-71547504cf8d"
},
{
"action": "dateFormat",
"format": "MM/DD/YYYY",
"id": "761f4feb-7781-5aa3-8ca3-31c66739275d"
}
],
"preactions": [
{
"action": "openCSVFile",
"id": "c98d53a3-222e-5647-859f-9f33a7e6d71f"
}
]
},
"nid": "qualityAssuranceNid",
"username": "qa+institution"
},
"recordCount": 8,
"status": "Failed",
"totalAmount": 0.02,
"uploadedFileName": "QA-ALL-FIELDS-MAPPING-EF6026123C.csv",
"buyers": []
},
{
"creator": {
"id": "39e91002-3913-545e-b93e-1affc317890b",
"username": "erick.nguyen"
},
"displayRecordCount": 2,
"exceptions": 0,
"fileDate": "2020-03-13T18:05:41.784Z",
"fileId": "479bad5b-ca14-5135-926e-1e92f56772ed",
"fileName": "aubin-nid.aubin-fid.pif.singlepayment_20200313140541.csv",
"filePath": "aubin-nid.aubin-fid.pif.singlepayment_20200313140541.csv",
"fileSource": "portal_single",
"id": "479bad5b-ca14-5135-926e-1e92f56772ed",
"importDate": "2020-03-13T18:05:41.784Z",
"isPifPlanCreated": true,
"isTransactionLoadComplete": true,
"originalRecordCount": 1,
"recordCount": 4,
"status": "Completed",
"totalAmount": 6,
"totalCreditCount": 3,
"totalDebitCount": 1,
"uploadedFileName": "singlepayment",
"buyers": []
}
]
}
Updated 3 days ago