Chilkat Online Tools

phpAx / easybill REST API / Fetch document payments list

Back to Collection Items

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$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');

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://api.easybill.de/rest/v1/document-payments',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

$page = $jResp->stringOf('page');
$pages = $jResp->stringOf('pages');
$limit = $jResp->stringOf('limit');
$total = $jResp->stringOf('total');
$i = 0;
$count_i = $jResp->SizeOfArray('items');
while ($i < $count_i) {
    $jResp->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;
}


?>

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