SQL Server / easybill REST API / Fetch SEPA payments list
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'limit', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'document_id', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.easybill.de/rest/v1/sepa-payments', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @document_id nvarchar(4000)
DECLARE @debitor_name nvarchar(4000)
DECLARE @debitor_iban nvarchar(4000)
DECLARE @mandate_id nvarchar(4000)
DECLARE @mandate_date_of_signature nvarchar(4000)
DECLARE @local_instrument nvarchar(4000)
DECLARE @sequence_type nvarchar(4000)
DECLARE @amount nvarchar(4000)
DECLARE @reference nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @creditor_bic nvarchar(4000)
DECLARE @creditor_iban nvarchar(4000)
DECLARE @creditor_name nvarchar(4000)
DECLARE @debitor_bic nvarchar(4000)
DECLARE @debitor_address_line_1 nvarchar(4000)
DECLARE @debitor_address_line2 nvarchar(4000)
DECLARE @debitor_country nvarchar(4000)
DECLARE @export_at nvarchar(4000)
DECLARE @export_error nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @remittance_information nvarchar(4000)
DECLARE @requested_at nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @page OUT, 'page'
DECLARE @pages nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pages OUT, 'pages'
DECLARE @limit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @limit OUT, 'limit'
DECLARE @total nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @total OUT, 'total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'items'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @document_id OUT, 'items[i].document_id'
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_name OUT, 'items[i].debitor_name'
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_iban OUT, 'items[i].debitor_iban'
EXEC sp_OAMethod @jResp, 'StringOf', @mandate_id OUT, 'items[i].mandate_id'
EXEC sp_OAMethod @jResp, 'StringOf', @mandate_date_of_signature OUT, 'items[i].mandate_date_of_signature'
EXEC sp_OAMethod @jResp, 'StringOf', @local_instrument OUT, 'items[i].local_instrument'
EXEC sp_OAMethod @jResp, 'StringOf', @sequence_type OUT, 'items[i].sequence_type'
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'items[i].amount'
EXEC sp_OAMethod @jResp, 'StringOf', @reference OUT, 'items[i].reference'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'items[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @creditor_bic OUT, 'items[i].creditor_bic'
EXEC sp_OAMethod @jResp, 'StringOf', @creditor_iban OUT, 'items[i].creditor_iban'
EXEC sp_OAMethod @jResp, 'StringOf', @creditor_name OUT, 'items[i].creditor_name'
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_bic OUT, 'items[i].debitor_bic'
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_address_line_1 OUT, 'items[i].debitor_address_line_1'
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_address_line2 OUT, 'items[i].debitor_address_line2'
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_country OUT, 'items[i].debitor_country'
EXEC sp_OAMethod @jResp, 'StringOf', @export_at OUT, 'items[i].export_at'
EXEC sp_OAMethod @jResp, 'StringOf', @export_error OUT, 'items[i].export_error'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'items[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @remittance_information OUT, 'items[i].remittance_information'
EXEC sp_OAMethod @jResp, 'StringOf', @requested_at OUT, 'items[i].requested_at'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'items[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'items[i].type'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
