Invoice Batch

Invoice Batch Info Records¶

Description

The invoiceBatchInfoRecords endpoint allows users to fetch all the uploaded invoice batch files information.

Request

Endpoint

    /ui/v1/invoiceBatchInfoRecords

Method

    POST

Header

Content-Type: application/json

ELEMENT	DESCRIPTION
invoiceBatchFileStatus	Optional
customerType	Optional
lastModifiedUserId	Optional
merchantid	Required specific id of the merchant

Request Body

{
    "invoiceBatchFileStatus": [],
    "customerType": [],
    "lastModifiedUserId": [],
    "merchantId": [
        "3"
    ]
}

Response

{
    "records": [{
            "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": "ABC Business 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": "ZBCD 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": null
}

Updated As Of Version 4.6.0.3