Foxpro / easybill REST API / Fetch SEPA payments list
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcDocument_id
LOCAL lcDebitor_name
LOCAL lcDebitor_iban
LOCAL lcMandate_id
LOCAL lcMandate_date_of_signature
LOCAL lcLocal_instrument
LOCAL lcSequence_type
LOCAL lcAmount
LOCAL lcReference
LOCAL lcCreated_at
LOCAL lcCreditor_bic
LOCAL lcCreditor_iban
LOCAL lcCreditor_name
LOCAL lcDebitor_bic
LOCAL lcDebitor_address_line_1
LOCAL lcDebitor_address_line2
LOCAL lcDebitor_country
LOCAL lcExport_at
LOCAL lcExport_error
LOCAL lcId
LOCAL lcRemittance_information
LOCAL lcRequested_at
LOCAL lcUpdated_at
LOCAL lcV_type
LOCAL lcPage
LOCAL lcPages
LOCAL lcLimit
LOCAL lcTotal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loQueryParams.UpdateString("document_id","<string>")
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/sepa-payments",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
DO WHILE i < lnCount_i
loJResp.I = i
lcDocument_id = loJResp.StringOf("items[i].document_id")
lcDebitor_name = loJResp.StringOf("items[i].debitor_name")
lcDebitor_iban = loJResp.StringOf("items[i].debitor_iban")
lcMandate_id = loJResp.StringOf("items[i].mandate_id")
lcMandate_date_of_signature = loJResp.StringOf("items[i].mandate_date_of_signature")
lcLocal_instrument = loJResp.StringOf("items[i].local_instrument")
lcSequence_type = loJResp.StringOf("items[i].sequence_type")
lcAmount = loJResp.StringOf("items[i].amount")
lcReference = loJResp.StringOf("items[i].reference")
lcCreated_at = loJResp.StringOf("items[i].created_at")
lcCreditor_bic = loJResp.StringOf("items[i].creditor_bic")
lcCreditor_iban = loJResp.StringOf("items[i].creditor_iban")
lcCreditor_name = loJResp.StringOf("items[i].creditor_name")
lcDebitor_bic = loJResp.StringOf("items[i].debitor_bic")
lcDebitor_address_line_1 = loJResp.StringOf("items[i].debitor_address_line_1")
lcDebitor_address_line2 = loJResp.StringOf("items[i].debitor_address_line2")
lcDebitor_country = loJResp.StringOf("items[i].debitor_country")
lcExport_at = loJResp.StringOf("items[i].export_at")
lcExport_error = loJResp.StringOf("items[i].export_error")
lcId = loJResp.StringOf("items[i].id")
lcRemittance_information = loJResp.StringOf("items[i].remittance_information")
lcRequested_at = loJResp.StringOf("items[i].requested_at")
lcUpdated_at = loJResp.StringOf("items[i].updated_at")
lcV_type = loJResp.StringOf("items[i].type")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
