autoit / easybill REST API / Fetch SEPA payments list
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("limit","<integer>")
$oQueryParams.UpdateString("page","<integer>")
$oQueryParams.UpdateString("document_id","<string>")
$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/sepa-payments",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "page": "<integer>",
; "pages": "<integer>",
; "limit": "<integer>",
; "total": "<integer>",
; "items": [
; {
; "document_id": "<long>",
; "debitor_name": "<string>",
; "debitor_iban": "<string>",
; "mandate_id": "<string>",
; "mandate_date_of_signature": "<date>",
; "local_instrument": "B2B",
; "sequence_type": "RCUR",
; "amount": "<integer>",
; "reference": "<string>",
; "created_at": "<dateTime>",
; "creditor_bic": null,
; "creditor_iban": "<string>",
; "creditor_name": "<string>",
; "debitor_bic": null,
; "debitor_address_line_1": "<string>",
; "debitor_address_line2": "<string>",
; "debitor_country": "<string>",
; "export_at": null,
; "export_error": "<string>",
; "id": "<long>",
; "remittance_information": null,
; "requested_at": "Today's date",
; "updated_at": "<string>",
; "type": "DEBIT"
; },
; {
; "document_id": "<long>",
; "debitor_name": "<string>",
; "debitor_iban": "<string>",
; "mandate_id": "<string>",
; "mandate_date_of_signature": "<date>",
; "local_instrument": "COR1",
; "sequence_type": "FNAL",
; "amount": "<integer>",
; "reference": "<string>",
; "created_at": "<dateTime>",
; "creditor_bic": null,
; "creditor_iban": "<string>",
; "creditor_name": "<string>",
; "debitor_bic": null,
; "debitor_address_line_1": "<string>",
; "debitor_address_line2": "<string>",
; "debitor_country": "<string>",
; "export_at": null,
; "export_error": "<string>",
; "id": "<long>",
; "remittance_information": null,
; "requested_at": "Today's date",
; "updated_at": "<string>",
; "type": "DEBIT"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sDocument_id
Local $sDebitor_name
Local $sDebitor_iban
Local $sMandate_id
Local $sMandate_date_of_signature
Local $sLocal_instrument
Local $sequence_type
Local $sAmount
Local $sReference
Local $sCreated_at
Local $sCreditor_bic
Local $sCreditor_iban
Local $sCreditor_name
Local $sDebitor_bic
Local $sDebitor_address_line_1
Local $sDebitor_address_line2
Local $sDebitor_country
Local $sExport_at
Local $sExport_error
Local $sId
Local $sRemittance_information
Local $sRequested_at
Local $sUpdated_at
Local $sV_type
Local $sPage = $oJResp.StringOf("page")
Local $sPages = $oJResp.StringOf("pages")
Local $sLimit = $oJResp.StringOf("limit")
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("items")
While $i < $iCount_i
$oJResp.I = $i
$sDocument_id = $oJResp.StringOf("items[i].document_id")
$sDebitor_name = $oJResp.StringOf("items[i].debitor_name")
$sDebitor_iban = $oJResp.StringOf("items[i].debitor_iban")
$sMandate_id = $oJResp.StringOf("items[i].mandate_id")
$sMandate_date_of_signature = $oJResp.StringOf("items[i].mandate_date_of_signature")
$sLocal_instrument = $oJResp.StringOf("items[i].local_instrument")
$sequence_type = $oJResp.StringOf("items[i].sequence_type")
$sAmount = $oJResp.StringOf("items[i].amount")
$sReference = $oJResp.StringOf("items[i].reference")
$sCreated_at = $oJResp.StringOf("items[i].created_at")
$sCreditor_bic = $oJResp.StringOf("items[i].creditor_bic")
$sCreditor_iban = $oJResp.StringOf("items[i].creditor_iban")
$sCreditor_name = $oJResp.StringOf("items[i].creditor_name")
$sDebitor_bic = $oJResp.StringOf("items[i].debitor_bic")
$sDebitor_address_line_1 = $oJResp.StringOf("items[i].debitor_address_line_1")
$sDebitor_address_line2 = $oJResp.StringOf("items[i].debitor_address_line2")
$sDebitor_country = $oJResp.StringOf("items[i].debitor_country")
$sExport_at = $oJResp.StringOf("items[i].export_at")
$sExport_error = $oJResp.StringOf("items[i].export_error")
$sId = $oJResp.StringOf("items[i].id")
$sRemittance_information = $oJResp.StringOf("items[i].remittance_information")
$sRequested_at = $oJResp.StringOf("items[i].requested_at")
$sUpdated_at = $oJResp.StringOf("items[i].updated_at")
$sV_type = $oJResp.StringOf("items[i].type")
$i = $i + 1
Wend
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "document_id=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/sepa-payments
Postman Collection Item JSON
{
"name": "Fetch SEPA payments list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/sepa-payments?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/sepa-payments?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"document_id\": \"<long>\",\n \"debitor_name\": \"<string>\",\n \"debitor_iban\": \"<string>\",\n \"mandate_id\": \"<string>\",\n \"mandate_date_of_signature\": \"<date>\",\n \"local_instrument\": \"B2B\",\n \"sequence_type\": \"RCUR\",\n \"amount\": \"<integer>\",\n \"reference\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"creditor_bic\": null,\n \"creditor_iban\": \"<string>\",\n \"creditor_name\": \"<string>\",\n \"debitor_bic\": null,\n \"debitor_address_line_1\": \"<string>\",\n \"debitor_address_line2\": \"<string>\",\n \"debitor_country\": \"<string>\",\n \"export_at\": null,\n \"export_error\": \"<string>\",\n \"id\": \"<long>\",\n \"remittance_information\": null,\n \"requested_at\": \"Today's date\",\n \"updated_at\": \"<string>\",\n \"type\": \"DEBIT\"\n },\n {\n \"document_id\": \"<long>\",\n \"debitor_name\": \"<string>\",\n \"debitor_iban\": \"<string>\",\n \"mandate_id\": \"<string>\",\n \"mandate_date_of_signature\": \"<date>\",\n \"local_instrument\": \"COR1\",\n \"sequence_type\": \"FNAL\",\n \"amount\": \"<integer>\",\n \"reference\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"creditor_bic\": null,\n \"creditor_iban\": \"<string>\",\n \"creditor_name\": \"<string>\",\n \"debitor_bic\": null,\n \"debitor_address_line_1\": \"<string>\",\n \"debitor_address_line2\": \"<string>\",\n \"debitor_country\": \"<string>\",\n \"export_at\": null,\n \"export_error\": \"<string>\",\n \"id\": \"<long>\",\n \"remittance_information\": null,\n \"requested_at\": \"Today's date\",\n \"updated_at\": \"<string>\",\n \"type\": \"DEBIT\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/sepa-payments?limit=<integer>&page=<integer>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
