/webapi/api/Batch

GET

/webapi/api/Batch

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Responses

🟢200OK

application/json

Success

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/webapi/api/Batch?senderid&creditorid&customerref&ledgerref&includeclosed&lastsettlementid&remittancedate&languagecode' \
--header 'Authorization: Basic <encoded-value>'

Response Example

{
    "batchid": "string",
    "offline": true,
    "creditor": [
        {
            "idnumber": "string",
            "parentidnumber": "string",
            "onlydebtcollection": true,
            "vattype": 0,
            "fullname": "string",
            "street": "string",
            "city": "string",
            "zipcode": "string",
            "countrycode": "string",
            "bankaccountno": "string",
            "contact": {
                "fullname": "string",
                "workphone": "string",
                "email": "string",
                "isinvoicequery": true,
                "isremittancereport": true,
                "isorderconfirmation": true,
                "iscollectionlist": true,
                "isweb": true
            },
            "casehandler": {
                "fullname": "string",
                "workphone": "string",
                "email": "string",
                "isinvoicequery": true,
                "isremittancereport": true,
                "isorderconfirmation": true,
                "iscollectionlist": true,
                "isweb": true
            },
            "sourceid": 0,
            "reminderflow": 0,
            "debtcollectiontransfer": 0,
            "invoicearchive": 0,
            "hasforeigndebtors": true,
            "hasforeigncurrency": true,
            "disabled": true,
            "lastsettlementid": "string"
        }
    ],
    "case": [
        {
            "customerref": "string",
            "customername": "string",
            "ledgerref": "string",
            "referencenumber": "string",
            "casenumber": "string",
            "currencycode": "string",
            "regdate": "2019-08-24T14:15:22Z",
            "closuredate": "2019-08-24T14:15:22Z",
            "isdebtcollection": true,
            "billdate": "2019-08-24T14:15:22Z",
            "duedate": "2019-08-24T14:15:22Z",
            "originalsum": 0,
            "paidsum": 0,
            "remainingsum": 0,
            "originalprincipal": 0,
            "paidprincipal": 0,
            "remainingprincipal": 0,
            "originalfee": 0,
            "paidfee": 0,
            "remainingfee": 0,
            "originalinterest": 0,
            "paidinterest": 0,
            "remaininginterest": 0,
            "service_description": "string",
            "status_statuscode": "string",
            "reminders": 0,
            "debtcollectionlist": 0,
            "history": [
                {
                    "type": 1,
                    "loggedat": "2019-08-24T14:15:22Z",
                    "message": "string",
                    "subject": "string",
                    "conversationid": "string",
                    "attachmentid": "string"
                }
            ],
            "paymentDetails": {
                "paymentValue": 0,
                "currency": "string",
                "kid": "string",
                "bankAccount": "string",
                "dueDate": "2019-08-24T14:15:22Z"
            }
        }
    ],
    "settlement": [
        {
            "creditorid": "string",
            "customerref": "string",
            "ledgerref": "string",
            "referencenumber": "string",
            "casenumber": "string",
            "collectiontype": 0,
            "settlementid": "string",
            "settlementtype": 0,
            "settlementdate": "2019-08-24T14:15:22Z",
            "settlementcurrencycode": "string",
            "settlementexchangerate": 0,
            "remittancedate": "2019-08-24T14:15:22Z",
            "currencycode": "string",
            "closuredate": "2019-08-24T14:15:22Z",
            "paidamount": 0,
            "creditorprincipal": 0,
            "creditorinterest": 0,
            "creditorfee": 0,
            "collectorprincipal": 0,
            "collectorinterest": 0,
            "collectorfee": 0,
            "collectorvat": 0
        }
    ]
}

Modified at 2025-09-23 10:44:30

/webapi/api/Attachment

/webapi/api/Batch