Powershell / easybill REST API / Fetch SEPA payments list
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("limit","<integer>")
$queryParams.UpdateString("page","<integer>")
$queryParams.UpdateString("document_id","<string>")
$http.SetRequestHeader("Authorization","{{apiKey}}")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/sepa-payments",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$page = $jResp.StringOf("page")
$pages = $jResp.StringOf("pages")
$limit = $jResp.StringOf("limit")
$total = $jResp.StringOf("total")
$i = 0
$count_i = $jResp.SizeOfArray("items")
while ($i -lt $count_i) {
$jResp.I = $i
$document_id = $jResp.StringOf("items[i].document_id")
$debitor_name = $jResp.StringOf("items[i].debitor_name")
$debitor_iban = $jResp.StringOf("items[i].debitor_iban")
$mandate_id = $jResp.StringOf("items[i].mandate_id")
$mandate_date_of_signature = $jResp.StringOf("items[i].mandate_date_of_signature")
$local_instrument = $jResp.StringOf("items[i].local_instrument")
$sequence_type = $jResp.StringOf("items[i].sequence_type")
$amount = $jResp.StringOf("items[i].amount")
$reference = $jResp.StringOf("items[i].reference")
$created_at = $jResp.StringOf("items[i].created_at")
$creditor_bic = $jResp.StringOf("items[i].creditor_bic")
$creditor_iban = $jResp.StringOf("items[i].creditor_iban")
$creditor_name = $jResp.StringOf("items[i].creditor_name")
$debitor_bic = $jResp.StringOf("items[i].debitor_bic")
$debitor_address_line_1 = $jResp.StringOf("items[i].debitor_address_line_1")
$debitor_address_line2 = $jResp.StringOf("items[i].debitor_address_line2")
$debitor_country = $jResp.StringOf("items[i].debitor_country")
$export_at = $jResp.StringOf("items[i].export_at")
$export_error = $jResp.StringOf("items[i].export_error")
$id = $jResp.StringOf("items[i].id")
$remittance_information = $jResp.StringOf("items[i].remittance_information")
$requested_at = $jResp.StringOf("items[i].requested_at")
$updated_at = $jResp.StringOf("items[i].updated_at")
$v_type = $jResp.StringOf("items[i].type")
$i = $i + 1
}
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": ""
}
]
}
