Settle Sales Order

The Settle Sales Order Summary page allows users to settle the PrePay sales orders.

settleSalesOrders¶

Description

The settleSalesOrders endpoint allows users to batch and settle the existing PrePay Sales orders.

Request

Endpoint

    /ui/v1/settleSalesOrders

Method

    POST

Header

Content-Type: application/json

ELEMENT	DESCRIPTION
startDate	Required Start Date to fetch the sales order from
endDate	Required End Date to fetch the Sales orders till that date
customerNumber	Required Number associated with the Customer ex: 12345
merchantId	Required specific code used for each merchant

Request Body

{
    "startDate": "2024-08-09",
    "endDate": "2024-08-09",
    "customerNumber": "50442",
    "customerId": [],
    "customerType": [],
    "evansMfgCustomerId": null,
    "merchantId": [
        "6"
    ]
}

Response

{
    "records": [
        {
            "id": null,
            "batchID": "20240809103252",
            "uploadedBatchFileName": "",
            "downloadedBatchFileName": null,
            "directoryName": null,
            "createdDateTime": null,
            "lastUpdatedDateTime": null,
            "batchStatus": {
                "name": "PROCESSED"
            },
            "uploadedRecordCount": 1,
            "responseRecordCount": 1,
            "paymentGateway": null,
            "responseMessage": null,
            "startTransactionDateTime": null,
            "endTransactionDateTime": null,
            "uploadedAmount": null,
            "responseAmount": null,
            "merchantNumber": null,
            "createdUserId": null,
            "lastModifiedUserId": null,
            "merchantId": null,
            "createdUserName": null,
            "merchantName": null
        }
    ],
    "recordCount": 1,
    "message": null
}

Updated As Of Version 6.3.1.10