SQL Server / easybill REST API / Create document 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>",
-- "amount": "<integer>",
-- "id": "<long>",
-- "is_overdue_fee": "<boolean>",
-- "login_id": "<long>",
-- "notice": "",
-- "payment_at": "<date>",
-- "type": "",
-- "provider": "",
-- "reference": ""
-- }
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, 'amount', '<integer>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'id', '<long>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'is_overdue_fee', '<boolean>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'login_id', '<long>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notice', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_at', '<date>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'provider', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reference', ''
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 @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.easybill.de/rest/v1/document-payments?paid=<boolean>', 'application/json', @json
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
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 @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>",
-- "amount": "<integer>",
-- "id": "<long>",
-- "is_overdue_fee": "<boolean>",
-- "login_id": "<long>",
-- "notice": "",
-- "payment_at": "<date>",
-- "type": "",
-- "provider": "",
-- "reference": ""
-- }
-- 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 @amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'amount'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @is_overdue_fee nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @is_overdue_fee OUT, 'is_overdue_fee'
DECLARE @login_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @login_id OUT, 'login_id'
DECLARE @notice nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @notice OUT, 'notice'
DECLARE @payment_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @payment_at OUT, 'payment_at'
DECLARE @v_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'type'
DECLARE @provider nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @provider OUT, 'provider'
DECLARE @reference nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @reference OUT, 'reference'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"document_id": "<long>",
"amount": "<integer>",
"id": "<long>",
"is_overdue_fee": "<boolean>",
"login_id": "<long>",
"notice": "",
"payment_at": "<date>",
"type": "",
"provider": "",
"reference": ""
}'
https://api.easybill.de/rest/v1/document-payments?paid=<boolean>
Postman Collection Item JSON
{
"name": "Create document payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"document_id\": \"<long>\",\n \"amount\": \"<integer>\",\n \"id\": \"<long>\",\n \"is_overdue_fee\": \"<boolean>\",\n \"login_id\": \"<long>\",\n \"notice\": \"\",\n \"payment_at\": \"<date>\",\n \"type\": \"\",\n \"provider\": \"\",\n \"reference\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/document-payments?paid=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"document-payments"
],
"query": [
{
"key": "paid",
"value": "<boolean>",
"description": "Mark document as paid when amount less then payment amount."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "POST",
"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 \"amount\": \"<integer>\",\n \"id\": \"<long>\",\n \"is_overdue_fee\": \"<boolean>\",\n \"login_id\": \"<long>\",\n \"notice\": \"\",\n \"payment_at\": \"<date>\",\n \"type\": \"\",\n \"provider\": \"\",\n \"reference\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/document-payments?paid=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"document-payments"
],
"query": [
{
"key": "paid",
"value": "<boolean>",
"description": "Mark document as paid when amount less then payment amount."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"document_id\": \"<long>\",\n \"amount\": \"<integer>\",\n \"id\": \"<long>\",\n \"is_overdue_fee\": \"<boolean>\",\n \"login_id\": \"<long>\",\n \"notice\": \"\",\n \"payment_at\": \"<date>\",\n \"type\": \"\",\n \"provider\": \"\",\n \"reference\": \"\"\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"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 \"amount\": \"<integer>\",\n \"id\": \"<long>\",\n \"is_overdue_fee\": \"<boolean>\",\n \"login_id\": \"<long>\",\n \"notice\": \"\",\n \"payment_at\": \"<date>\",\n \"type\": \"\",\n \"provider\": \"\",\n \"reference\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/document-payments?paid=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"document-payments"
],
"query": [
{
"key": "paid",
"value": "<boolean>",
"description": "Mark document as paid when amount less then payment amount."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
