Chilkat Online Tools

Foxpro / easybill REST API / Fetch document payments list

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcDocument_id
LOCAL lcAmount
LOCAL lcId
LOCAL lcIs_overdue_fee
LOCAL lcLogin_id
LOCAL lcNotice
LOCAL lcPayment_at
LOCAL lcV_type
LOCAL lcProvider
LOCAL lcReference
LOCAL lcPage
LOCAL lcPages
LOCAL lcLimit
LOCAL lcTotal
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loQueryParams.UpdateString("document_id","<string>")
loQueryParams.UpdateString("payment_at","<string>")
loQueryParams.UpdateString("reference","<string>")

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

loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/document-payments",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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>",
*       "amount": "<integer>",
*       "id": "<long>",
*       "is_overdue_fee": "<boolean>",
*       "login_id": "<long>",
*       "notice": "",
*       "payment_at": "<date>",
*       "type": "",
*       "provider": "",
*       "reference": ""
*     },
*     {
*       "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

lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcDocument_id = loJResp.StringOf("items[i].document_id")
    lcAmount = loJResp.StringOf("items[i].amount")
    lcId = loJResp.StringOf("items[i].id")
    lcIs_overdue_fee = loJResp.StringOf("items[i].is_overdue_fee")
    lcLogin_id = loJResp.StringOf("items[i].login_id")
    lcNotice = loJResp.StringOf("items[i].notice")
    lcPayment_at = loJResp.StringOf("items[i].payment_at")
    lcV_type = loJResp.StringOf("items[i].type")
    lcProvider = loJResp.StringOf("items[i].provider")
    lcReference = loJResp.StringOf("items[i].reference")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "document_id=%3Cstring%3E"
	-d "payment_at=%3Cstring%3E"
	-d "reference=%3Cstring%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/document-payments

Postman Collection Item JSON

{
  "name": "Fetch document payments list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/document-payments?limit=<integer>&page=<integer>&document_id=<string>&payment_at=<string>&reference=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "document-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 payments by document_id. You can add multiple ids separate by comma like id,id,id."
        },
        {
          "key": "payment_at",
          "value": "<string>",
          "description": "Filter payments by payment_at. You can filter one date with payment_at=2014-12-10 or between like 2015-01-01,2015-12-31."
        },
        {
          "key": "reference",
          "value": "<string>",
          "description": "Filter payments by reference. You can add multiple references 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}}/document-payments?limit=<integer>&page=<integer>&document_id=<string>&payment_at=<string>&reference=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-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 payments by document_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "payment_at",
              "value": "<string>",
              "description": "Filter payments by payment_at. You can filter one date with payment_at=2014-12-10 or between like 2015-01-01,2015-12-31."
            },
            {
              "key": "reference",
              "value": "<string>",
              "description": "Filter payments by reference. You can add multiple references 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      \"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    },\n    {\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    }\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}}/document-payments?limit=<integer>&page=<integer>&document_id=<string>&payment_at=<string>&reference=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-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 payments by document_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "payment_at",
              "value": "<string>",
              "description": "Filter payments by payment_at. You can filter one date with payment_at=2014-12-10 or between like 2015-01-01,2015-12-31."
            },
            {
              "key": "reference",
              "value": "<string>",
              "description": "Filter payments by reference. You can add multiple references separate by comma like id,id,id."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}