Chilkat Online Tools

VB.NET / easybill REST API / Fetch document payment

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.easybill.de/rest/v1/document-payments/:id",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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




Dim document_id As String = jResp.StringOf("document_id")
Dim amount As String = jResp.StringOf("amount")
Dim id As String = jResp.StringOf("id")
Dim is_overdue_fee As String = jResp.StringOf("is_overdue_fee")
Dim login_id As String = jResp.StringOf("login_id")
Dim notice As String = jResp.StringOf("notice")
Dim payment_at As String = jResp.StringOf("payment_at")
Dim v_type As String = jResp.StringOf("type")
Dim provider As String = jResp.StringOf("provider")
Dim reference As String = jResp.StringOf("reference")

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/document-payments/:id

Postman Collection Item JSON

{
  "name": "Fetch document payment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/document-payments/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "document-payments",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of document payment"
        }
      ]
    }
  },
  "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}}/document-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-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  \"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": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/document-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "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}}/document-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}