Chilkat Online Tools

phpExt / easybill REST API / Fetch document payment

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->SetRequestHeader('Authorization','{{apiKey}}');
$http->SetRequestHeader('Accept','application/json');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.easybill.de/rest/v1/document-payments/:id',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

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

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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