Chilkat Online Tools

Ruby / easybill REST API / Create document payment

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# 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": ""
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("document_id","<long>")
json.UpdateString("amount","<integer>")
json.UpdateString("id","<long>")
json.UpdateString("is_overdue_fee","<boolean>")
json.UpdateString("login_id","<long>")
json.UpdateString("notice","")
json.UpdateString("payment_at","<date>")
json.UpdateString("type","")
json.UpdateString("provider","")
json.UpdateString("reference","")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Authorization","{{apiKey}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.easybill.de/rest/v1/document-payments?paid=<boolean>","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

document_id = jResp.stringOf("document_id")
amount = jResp.stringOf("amount")
id = jResp.stringOf("id")
is_overdue_fee = jResp.stringOf("is_overdue_fee")
login_id = jResp.stringOf("login_id")
notice = jResp.stringOf("notice")
payment_at = jResp.stringOf("payment_at")
v_type = jResp.stringOf("type")
provider = jResp.stringOf("provider")
reference = jResp.stringOf("reference")

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": ""
    }
  ]
}