/webapi/api/Batch

POST

/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

Body Params application/json-patch+json

Examples

Responses

🟢200OK

application/json

Success

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/webapi/api/Batch?senderid' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json-patch+json' \
--data-raw '{
    "batchid": "string",
    "offline": true,
    "creditor": [
        {
            "idnumber": "string",
            "parentidnumber": "string",
            "onlydebtcollection": true,
            "vattype": 0,
            "fullname": "string",
            "street": "string",
            "city": "string",
            "zipcode": "string",
            "countrycode": "st",
            "emailinvoice": "string",
            "bankaccountno": "string",
            "swift": "string",
            "iban": "string",
            "message": "string",
            "contact": {
                "fullname": "string",
                "workphone": "string",
                "email": "string",
                "isinvoicequery": true,
                "isremittancereport": true,
                "isorderconfirmation": true,
                "iscollectionlist": true,
                "isweb": true
            },
            "contact2": {
                "fullname": "string",
                "workphone": "string",
                "email": "string",
                "isinvoicequery": true,
                "isremittancereport": true,
                "isorderconfirmation": true,
                "iscollectionlist": true,
                "isweb": true
            },
            "password": "stringstri",
            "erpsettingid": "string",
            "sourceid": 0,
            "erpclientid": "string",
            "vismanetcompanyid": "string",
            "reminderflow": 0,
            "debtcollectiontransfer": 0,
            "invoicearchive": 0,
            "hasforeigndebtors": true,
            "hasforeigncurrency": true,
            "disabled": true
        }
    ],
    "invoice": [
        {
            "creditorid": "string",
            "collectiontype": 0,
            "collectionnoticedate": "2019-08-24T14:15:22Z",
            "debtor": {
                "idnumber": "string",
                "juridicaltype": 1,
                "customerref": "string",
                "firstname": "string",
                "lastname": "string",
                "street": "string",
                "city": "string",
                "zipcode": "string",
                "countrycode": "st",
                "phone": "string",
                "email": "string"
            },
            "debtors": [
                {
                    "idnumber": "string",
                    "juridicaltype": 1,
                    "customerref": "string",
                    "firstname": "string",
                    "lastname": "string",
                    "street": "string",
                    "city": "string",
                    "zipcode": "string",
                    "countrycode": "st",
                    "phone": "string",
                    "email": "string"
                }
            ],
            "debt": {
                "ledgerref": "string",
                "referencenumber": "string",
                "description": "string",
                "vatcode": 0,
                "currencycode": "str",
                "billdate": "2019-08-24T14:15:22Z",
                "duedate": "2019-08-24T14:15:22Z",
                "originalamount": 0,
                "amount": 0,
                "vatfreeamount": 0,
                "accountpaymentreference": "string",
                "department": "string",
                "attachment": "string",
                "attachmentfilename": "string"
            },
            "energydebt": {
                "ean": "string",
                "street": "string",
                "zipcode": "string",
                "city": "string",
                "netowneridnumber": "string",
                "netownername": "string",
                "siteid": "string",
                "sitestatus": "string",
                "sitedisconnectiondate": "2019-08-24"
            }
        }
    ],
    "payment": [
        {
            "creditorid": "string",
            "ledgerref": "string",
            "paymentid": "string",
            "paymenttype": 0,
            "paymentref": "string",
            "amount": 0,
            "currencycode": "str",
            "paymentdate": "2019-08-24T14:15:22Z",
            "description": "string"
        }
    ],
    "action": [
        {
            "creditorid": "string",
            "ledgerref": "string",
            "actiontype": 0,
            "duedate": "2019-08-24T14:15:22Z",
            "subject": "string",
            "conversationid": "string",
            "message": "string"
        }
    ]
}'

Response Example

{
    "statuscode": 0,
    "errors": [
        {
            "objectname": "string",
            "objectindex": 0,
            "message": "string"
        }
    ],
    "responses": [
        {
            "objectname": "string",
            "objectindex": 0,
            "ledgerref": "string",
            "status_statuscode": "string"
        }
    ]
}

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

/webapi/api/Batch

/webapi/api/Ping