Delphi (DLL) / easybill REST API / Fetch document payments list
Back to Collection Items
var
begin
CkJsonObject_UpdateString(queryParams,'limit','<integer>');CkJsonObject_UpdateString(queryParams,'page','<integer>');CkJsonObject_UpdateString(queryParams,'document_id','<string>');CkJsonObject_UpdateString(queryParams,'payment_at','<string>');CkJsonObject_UpdateString(queryParams,'reference','<string>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);document_id := CkJsonObject__stringOf(jResp,'items[i].document_id');amount := CkJsonObject__stringOf(jResp,'items[i].amount');id := CkJsonObject__stringOf(jResp,'items[i].id');is_overdue_fee := CkJsonObject__stringOf(jResp,'items[i].is_overdue_fee');login_id := CkJsonObject__stringOf(jResp,'items[i].login_id');notice := CkJsonObject__stringOf(jResp,'items[i].notice');payment_at := CkJsonObject__stringOf(jResp,'items[i].payment_at');v_type := CkJsonObject__stringOf(jResp,'items[i].type');provider := CkJsonObject__stringOf(jResp,'items[i].provider');reference := CkJsonObject__stringOf(jResp,'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": ""
}
]
}
