Invoice File Upload
The following are the different types of endpoints that are used to upload various types of invoice files.
Upload Quick books Invoice File¶
The uploadQuickBooksInvoiceFile API allows user to upload the Business Invoice file.
Request
Endpoint
/ui/v1/uploadQuickBooksInvoiceFile
Method
POST
Header
Content-Type: application/json
Request Body
Response
{
"records": [{
"id": 84,
"uploadedBatchFileName": "SampleCSVFile_Business.csv",
"createdDateTime": 1617051549000,
"lastUpdatedDateTime": null,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 7,
"processedRecordCount": 7,
"createdUserId": 249,
"lastModifiedUserId": 249,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "akmal.business",
"merchantName": "VELA"
}, {
"id": 82,
"uploadedBatchFileName": "sample patient File2.csv",
"createdDateTime": 1617046132000,
"lastUpdatedDateTime": null,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 211,
"lastModifiedUserId": 211,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "automation_admin",
"merchantName": "VELA"
}, {
"id": 81,
"uploadedBatchFileName": "sample patient File.csv",
"createdDateTime": 1617046037000,
"lastUpdatedDateTime": null,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 211,
"lastModifiedUserId": 211,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "automation_admin",
"merchantName": "VELA"
}, {
"id": 67,
"uploadedBatchFileName": "Patient Sample File - 20201109.csv",
"createdDateTime": 1605297212000,
"lastUpdatedDateTime": 1607719283000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 2,
"processedRecordCount": 2,
"createdUserId": 65,
"lastModifiedUserId": 60,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": "",
"lastModifiedUserName": "merchantadmin.zywiepatient",
"merchantName": "VELA"
}, {
"id": 65,
"uploadedBatchFileName": "VELA.csv",
"createdDateTime": 1605290685000,
"lastUpdatedDateTime": null,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 257,
"lastModifiedUserId": 257,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": "",
"lastModifiedUserName": "gopi.business",
"merchantName": "VELA"
}, {
"id": 56,
"uploadedBatchFileName": "VELA Invoicee.csv",
"createdDateTime": 1592325450000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 32,
"processedRecordCount": 32,
"createdUserId": 144,
"lastModifiedUserId": 213,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "automation_zywie",
"merchantName": "VELA"
}, {
"id": 40,
"uploadedBatchFileName": "VELA.csv",
"createdDateTime": 1586456526000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 32,
"processedRecordCount": 32,
"createdUserId": 144,
"lastModifiedUserId": 144,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "Asma.razaq",
"merchantName": "VELA"
}, {
"id": 38,
"uploadedBatchFileName": "VELA production replication_20200324.csv",
"createdDateTime": 1585083226000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 1,
"processedRecordCount": 1,
"createdUserId": 65,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 35,
"uploadedBatchFileName": "zywie1.csv",
"createdDateTime": 1584728415000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 24,
"processedRecordCount": 24,
"createdUserId": 144,
"lastModifiedUserId": 144,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "Asma.razaq",
"merchantName": "VELA"
}, {
"id": 34,
"uploadedBatchFileName": "transactionHistory (41).csv",
"createdDateTime": 1584547583000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 65,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 31,
"uploadedBatchFileName": "transactionHistory (26).csv",
"createdDateTime": 1583959549000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 65,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 29,
"uploadedBatchFileName": "VELA Invoice File 2.csv",
"createdDateTime": 1583525778000,
"lastUpdatedDateTime": 1611348741000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 36,
"processedRecordCount": 36,
"createdUserId": 65,
"lastModifiedUserId": 275,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": "",
"lastModifiedUserName": "business.20210122",
"merchantName": "VELA"
}, {
"id": 23,
"uploadedBatchFileName": "transactionHistory (7).csv",
"createdDateTime": 1582920111000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 65,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 22,
"uploadedBatchFileName": "businessform.csv",
"createdDateTime": 1582302888000,
"lastUpdatedDateTime": 1584728162000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 144,
"lastModifiedUserId": 144,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": null,
"lastModifiedUserName": "Asma.razaq",
"merchantName": "VELA"
}, {
"id": 21,
"uploadedBatchFileName": "business.csv",
"createdDateTime": 1582297157000,
"lastUpdatedDateTime": 1584728175000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 144,
"lastModifiedUserId": 144,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": null,
"lastModifiedUserName": "Asma.razaq",
"merchantName": "VELA"
}, {
"id": 19,
"uploadedBatchFileName": "VELA Invoice File 1.csv",
"createdDateTime": 1575657808000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 26,
"processedRecordCount": 26,
"createdUserId": 65,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 16,
"uploadedBatchFileName": "VELA Invoice File.csv",
"createdDateTime": 1572982897000,
"lastUpdatedDateTime": 1617127041000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 19,
"processedRecordCount": 19,
"createdUserId": 65,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": "",
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 11,
"uploadedBatchFileName": "AR Aging 070819.csv",
"createdDateTime": 1569964116000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 83,
"processedRecordCount": 53,
"createdUserId": 112,
"lastModifiedUserId": 112,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "harshatest",
"merchantName": "VELA"
}, {
"id": 9,
"uploadedBatchFileName": "patientfile.csv",
"createdDateTime": 1566480563000,
"lastUpdatedDateTime": 1566846325000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 3,
"processedRecordCount": 3,
"createdUserId": 7,
"lastModifiedUserId": 60,
"merchantId": 1,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiepatient",
"merchantName": "VELA"
}, {
"id": 8,
"uploadedBatchFileName": "Zywie AR 122818 (1).csv",
"createdDateTime": 1560437385000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 1,
"lastModifiedUserId": 7,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "MerchantAdmin",
"merchantName": "VELA"
}, {
"id": 7,
"uploadedBatchFileName": "AR Aging Report 04112019.csv",
"createdDateTime": 1555008746000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 29,
"processedRecordCount": 29,
"createdUserId": 1,
"lastModifiedUserId": 1,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": null,
"merchantName": "VELA"
}, {
"id": 6,
"uploadedBatchFileName": "AR Aging Report 04112019.xlsx",
"createdDateTime": 1555008694000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 1,
"lastModifiedUserId": 1,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": null,
"merchantName": "VELA"
}, {
"id": 5,
"uploadedBatchFileName": "AR Aging Report 040819.csv",
"createdDateTime": 1554909284000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 57,
"processedRecordCount": 11,
"createdUserId": 1,
"lastModifiedUserId": 1,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": null,
"merchantName": "VELA"
}, {
"id": 4,
"uploadedBatchFileName": "AR Aging Report.csv",
"createdDateTime": 1554492392000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 15,
"processedRecordCount": 15,
"createdUserId": 1,
"lastModifiedUserId": 1,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": null,
"merchantName": "VELA"
}, {
"id": 3,
"uploadedBatchFileName": "AR Aging Report.xlsx",
"createdDateTime": 1554492139000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 1,
"lastModifiedUserId": 1,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": null,
"merchantName": "VELA"
}, {
"id": 2,
"uploadedBatchFileName": "Zywie AR 122818 (2).csv",
"createdDateTime": 1553797429000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 79,
"processedRecordCount": 79,
"createdUserId": 7,
"lastModifiedUserId": 65,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.zywiebusiness",
"merchantName": "VELA"
}, {
"id": 1,
"uploadedBatchFileName": "Zywie AR 122818.csv",
"createdDateTime": 1550593510000,
"lastUpdatedDateTime": 1605934406000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 1,
"lastModifiedUserId": 1,
"merchantId": 1,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": null,
"merchantName": "VELA"
}],
"recordCount": null,
"message": {
"code": "82",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "The Invoice File <strong>VELA Invoice File.csv</strong> has been uploaded successfully."
}
}
Upload HPI Invoice File¶
The uploadHpiBooksInvoiceFile API allows user to upload the Business Invoice file.
Request
Endpoint
/ui/v1/uploadHpiInvoiceFile
Method
POST
Header
Content-Type: application/json
Request Body
Response
Upload Generic Invoice File¶
The /uploadGenericInvoiceFile API allows user to upload the Business Invoice file.
Request
Endpoint
/ui/v1/uploadGenericInvoiceFile
Method
POST
Header
Content-Type: application/json
Request Body
Response
{
"records": [{
"id": 12,
"uploadedBatchFileName": "Generic_Invoice_File_20210611.csv",
"createdDateTime": 1623437369000,
"lastUpdatedDateTime": 1627669838000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 17,
"processedRecordCount": 17,
"createdUserId": 218,
"lastModifiedUserId": 218,
"merchantId": 3,
"customerType": {
"value": "Other",
"name": "OTHER"
},
"memo": " New columns found in your file [physician, code, shortdescription, charge, insurancepayment, patientpayment, adjustment]",
"lastModifiedUserName": "merchantadmin.cybersource",
"merchantName": "VELA"
}, {
"id": 11,
"uploadedBatchFileName": "Sample_Generic_Invoice_File - No records.csv",
"createdDateTime": 1621467958000,
"lastUpdatedDateTime": null,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 253,
"lastModifiedUserId": 253,
"merchantId": 3,
"customerType": {
"value": "Other",
"name": "OTHER"
},
"memo": " su archivo no contiene ningun registro de factura. ",
"lastModifiedUserName": "user1.test",
"merchantName": "VELA"
}, {
"id": 10,
"uploadedBatchFileName": "Sample_Generic_Invoice_withmissingcolumnsFile.csv",
"createdDateTime": 1621467524000,
"lastUpdatedDateTime": 1621467578000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 6,
"processedRecordCount": 5,
"createdUserId": 253,
"lastModifiedUserId": 253,
"merchantId": 3,
"customerType": {
"value": "Other",
"name": "OTHER"
},
"memo": " No se encontraron las siguientes columnas [State]",
"lastModifiedUserName": "user1.test",
"merchantName": "VELA"
}, {
"id": 9,
"uploadedBatchFileName": "Sample_Generic_Invoice_File.csv",
"createdDateTime": 1617247526000,
"lastUpdatedDateTime": 1621467040000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 5,
"processedRecordCount": 5,
"createdUserId": 218,
"lastModifiedUserId": 253,
"merchantId": 3,
"customerType": {
"value": "Other",
"name": "OTHER"
},
"memo": "",
"lastModifiedUserName": "user1.test",
"merchantName": "VELA"
}, {
"id": 8,
"uploadedBatchFileName": "Vela Business Invoice File.csv",
"createdDateTime": 1591980625000,
"lastUpdatedDateTime": 1607112256000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 36,
"processedRecordCount": 36,
"createdUserId": 231,
"lastModifiedUserId": 231,
"merchantId": 3,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.business",
"merchantName": "VELA"
}, {
"id": 7,
"uploadedBatchFileName": "VELA Invoice File 2.csv",
"createdDateTime": 1585769315000,
"lastUpdatedDateTime": 1607112256000,
"invoiceBatchFileStatus": {
"value": "Processed",
"name": "PROCESSED"
},
"uploadedRecordCount": 36,
"processedRecordCount": 36,
"createdUserId": 195,
"lastModifiedUserId": 231,
"merchantId": 3,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.business",
"merchantName": "VELA"
}, {
"id": 6,
"uploadedBatchFileName": "Zywie AR 122818 (2).csv",
"createdDateTime": 1566935146000,
"lastUpdatedDateTime": 1607112256000,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 195,
"lastModifiedUserId": 195,
"merchantId": 3,
"customerType": {
"value": "Business",
"name": "BUSINESS"
},
"memo": null,
"lastModifiedUserName": "merchantadmin.orbital",
"merchantName": "VELA"
}],
"recordCount": null,
"message": {
"code": "82",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"include_i_icon": false,
"description": "The Invoice File <strong>Generic_Invoice_File_20210611.csv</strong> has been uploaded successfully. New columns found in your file <strong>[physician, code, shortdescription, charge, insurancepayment, patientpayment, adjustment]</strong>"
}
}
Upload Next Gen Invoice File¶
The /uploadGenericInvoiceFile API allows user to upload the Business Invoice file.
Request
Endpoint
/ui/v1/uploadNextGenInvoiceFile
Method
POST
Header
Content-Type: application/json
Request Body
Response
{
"records": [{
"id": 126,
"uploadedBatchFileName": "MHSA03_2017122412015448468_2022012314014533800",
"createdDateTime": 1643483052000,
"lastUpdatedDateTime": 1649363511000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 740,
"processedRecordCount": 740,
"createdUserId": 414,
"lastModifiedUserId": 414,
"merchantId": 22,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": null,
"lastModifiedUserName": "gaclinic.patientbilling",
"merchantName": "Georgia Clinic PC, Patientbilling"
}, {
"id": 125,
"uploadedBatchFileName": "MHSA03_2017122412015448468_202110180305511400",
"createdDateTime": 1641921757000,
"lastUpdatedDateTime": 1647360815000,
"invoiceBatchFileStatus": {
"value": "Partially Processed",
"name": "PARTIALLY_PROCESSED"
},
"uploadedRecordCount": 707,
"processedRecordCount": 707,
"createdUserId": 414,
"lastModifiedUserId": 416,
"merchantId": 22,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": null,
"lastModifiedUserName": "PBAdmin1",
"merchantName": "Georgia Clinic PC, Patientbilling"
}, {
"id": 124,
"uploadedBatchFileName": "GCTest.csv",
"createdDateTime": 1641921443000,
"lastUpdatedDateTime": null,
"invoiceBatchFileStatus": {
"value": "Failed",
"name": "FAILED"
},
"uploadedRecordCount": 0,
"processedRecordCount": 0,
"createdUserId": 414,
"lastModifiedUserId": 414,
"merchantId": 22,
"customerType": {
"value": "Patient",
"name": "PATIENT"
},
"memo": null,
"lastModifiedUserName": "gaclinic.patientbilling",
"merchantName": "Georgia Clinic PC, Patientbilling"
}],
"recordCount": null,
"message": {
"code": "84",
"type": {
"value": "Warning",
"name": "WARNING"
},
"include_i_icon": false,
"description": "The Invoice File <strong>MHSA03_2017122412015448468_2022012314014533800</strong> has been partially uploaded."
}
}
Updated As Of Version 3.8.0.9