API:listBatchesByStatus - SEPA: Get batch lists by status

Get batch lists by status. Method only available for installations with enabled SEPA Direct Debit plugin

Required parameters

status
Status or array statuses, possible values: Draft, Download-Ready, Processing, Processed, Cancelled

Request

GET http://url_to_your_hostbill.com/admin/api.php?token=:TOKEN&call=listBatchesByStatus&status=:STATUS

Response

   {
      "success": true,
      "batches": [
         {
            "id": "9",
            "creditor_id": "2",
            "name": "DD20200713",
            "status": "Draft",
            "date": "2020-07-13 11:21:26",
            "dd_date": "2020-07-27",
            "download_date": "0000-00-00",
            "creditor_name": "Test 54",
            "invoice_count": "0",
            "invoice_amount": null
         },
         {
            "id": "8",
            "creditor_id": "1",
            "name": "DD20200713",
            "status": "Draft",
            "date": "2020-07-13 11:20:02",
            "dd_date": "2020-07-27",
            "download_date": "0000-00-00",
            "creditor_name": "Test",
            "invoice_count": "0",
            "invoice_amount": null
         },
         {
            "id": "7",
            "creditor_id": "1",
            "name": "DD20200701",
            "status": "Draft",
            "date": "2020-07-01 12:00:29",
            "dd_date": "2020-07-15",
            "download_date": "0000-00-00",
            "creditor_name": "Test",
            "invoice_count": "0",
            "invoice_amount": null
         },
         {
            "id": "5",
            "creditor_id": "1",
            "name": "DD20190115",
            "status": "Draft",
            "date": "2019-01-15 23:55:15",
            "dd_date": "2019-01-29",
            "download_date": "0000-00-00",
            "creditor_name": "Test",
            "invoice_count": "0",
            "invoice_amount": null
         },
         {
            "id": "4",
            "creditor_id": "1",
            "name": "DD20190101",
            "status": "Draft",
            "date": "2019-01-01 23:56:11",
            "dd_date": "2019-01-15",
            "download_date": "0000-00-00",
            "creditor_name": "Test",
            "invoice_count": "0",
            "invoice_amount": null
         }
      ],
      "call": "listBatchesByStatus",
      "server_time": 1594798471
   }