Chilkat Online Tools

Android / easybill REST API / Fetch document payments list

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("limit","<integer>");
    queryParams.UpdateString("page","<integer>");
    queryParams.UpdateString("document_id","<string>");
    queryParams.UpdateString("payment_at","<string>");
    queryParams.UpdateString("reference","<string>");

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

    CkHttpResponse resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/document-payments",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

    // 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

    String document_id;
    String amount;
    String id;
    String is_overdue_fee;
    String login_id;
    String notice;
    String payment_at;
    String v_type;
    String provider;
    String reference;

    String page = jResp.stringOf("page");
    String pages = jResp.stringOf("pages");
    String limit = jResp.stringOf("limit");
    String total = jResp.stringOf("total");
    int i = 0;
    int count_i = jResp.SizeOfArray("items");
    while (i < count_i) {
        jResp.put_I(i);
        document_id = jResp.stringOf("items[i].document_id");
        amount = jResp.stringOf("items[i].amount");
        id = jResp.stringOf("items[i].id");
        is_overdue_fee = jResp.stringOf("items[i].is_overdue_fee");
        login_id = jResp.stringOf("items[i].login_id");
        notice = jResp.stringOf("items[i].notice");
        payment_at = jResp.stringOf("items[i].payment_at");
        v_type = jResp.stringOf("items[i].type");
        provider = jResp.stringOf("items[i].provider");
        reference = jResp.stringOf("items[i].reference");
        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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