SQL Server / easybill REST API / Update SEPA payment
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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "document_id": "<long>",
-- "debitor_name": "<string>",
-- "debitor_iban": "<string>",
-- "mandate_id": "<string>",
-- "mandate_date_of_signature": "<date>",
-- "local_instrument": "COR1",
-- "sequence_type": "FRST",
-- "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"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'document_id', '<long>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'debitor_name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'debitor_iban', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'mandate_id', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'mandate_date_of_signature', '<date>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'local_instrument', 'COR1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sequence_type', 'FRST'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amount', '<integer>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reference', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'created_at', '<dateTime>'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'creditor_bic'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'creditor_iban', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'creditor_name', '<string>'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'debitor_bic'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'debitor_address_line_1', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'debitor_address_line2', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'debitor_country', '<string>'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'export_at'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'export_error', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'id', '<long>'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'remittance_information'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'requested_at', 'Today''s date'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'updated_at', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', 'DEBIT'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.easybill.de/rest/v1/sepa-payments/:id', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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 @json
EXEC @hr = sp_OADestroy @sbRequestBody
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 @json
EXEC @hr = sp_OADestroy @sbRequestBody
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)
-- {
-- "document_id": "<long>",
-- "debitor_name": "<string>",
-- "debitor_iban": "<string>",
-- "mandate_id": "<string>",
-- "mandate_date_of_signature": "<date>",
-- "local_instrument": "COR1",
-- "sequence_type": "FRST",
-- "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)
EXEC sp_OAMethod @jResp, 'StringOf', @document_id OUT, 'document_id'
DECLARE @debitor_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_name OUT, 'debitor_name'
DECLARE @debitor_iban nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_iban OUT, 'debitor_iban'
DECLARE @mandate_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @mandate_id OUT, 'mandate_id'
DECLARE @mandate_date_of_signature nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @mandate_date_of_signature OUT, 'mandate_date_of_signature'
DECLARE @local_instrument nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @local_instrument OUT, 'local_instrument'
DECLARE @sequence_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @sequence_type OUT, 'sequence_type'
DECLARE @amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'amount'
DECLARE @reference nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @reference OUT, 'reference'
DECLARE @created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'created_at'
DECLARE @creditor_bic nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @creditor_bic OUT, 'creditor_bic'
DECLARE @creditor_iban nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @creditor_iban OUT, 'creditor_iban'
DECLARE @creditor_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @creditor_name OUT, 'creditor_name'
DECLARE @debitor_bic nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_bic OUT, 'debitor_bic'
DECLARE @debitor_address_line_1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_address_line_1 OUT, 'debitor_address_line_1'
DECLARE @debitor_address_line2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_address_line2 OUT, 'debitor_address_line2'
DECLARE @debitor_country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @debitor_country OUT, 'debitor_country'
DECLARE @export_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @export_at OUT, 'export_at'
DECLARE @export_error nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @export_error OUT, 'export_error'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @remittance_information nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @remittance_information OUT, 'remittance_information'
DECLARE @requested_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @requested_at OUT, 'requested_at'
DECLARE @updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'updated_at'
DECLARE @v_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'type'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PUT
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"document_id": "<long>",
"debitor_name": "<string>",
"debitor_iban": "<string>",
"mandate_id": "<string>",
"mandate_date_of_signature": "<date>",
"local_instrument": "COR1",
"sequence_type": "FRST",
"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"
}'
https://api.easybill.de/rest/v1/sepa-payments/:id
Postman Collection Item JSON
{
"name": "Update SEPA payment",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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\": \"FRST\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/sepa-payments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of SEPA payment"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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\": \"FRST\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/sepa-payments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\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\": \"FRST\",\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}"
},
{
"name": "Invalid SEPA payment",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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\": \"FRST\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/sepa-payments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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\": \"FRST\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/sepa-payments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"sepa-payments",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
