unicodeC / easybill REST API / Fetch document payments list
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *document_id;
const wchar_t *amount;
const wchar_t *id;
const wchar_t *is_overdue_fee;
const wchar_t *login_id;
const wchar_t *notice;
const wchar_t *payment_at;
const wchar_t *v_type;
const wchar_t *provider;
const wchar_t *reference;
const wchar_t *page;
const wchar_t *pages;
const wchar_t *limit;
const wchar_t *total;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"limit",L"<integer>");
CkJsonObjectW_UpdateString(queryParams,L"page",L"<integer>");
CkJsonObjectW_UpdateString(queryParams,L"document_id",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"payment_at",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"reference",L"<string>");
CkHttpW_SetRequestHeader(http,L"Authorization",L"{{apiKey}}");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.easybill.de/rest/v1/document-payments",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
page = CkJsonObjectW_stringOf(jResp,L"page");
pages = CkJsonObjectW_stringOf(jResp,L"pages");
limit = CkJsonObjectW_stringOf(jResp,L"limit");
total = CkJsonObjectW_stringOf(jResp,L"total");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"items");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
document_id = CkJsonObjectW_stringOf(jResp,L"items[i].document_id");
amount = CkJsonObjectW_stringOf(jResp,L"items[i].amount");
id = CkJsonObjectW_stringOf(jResp,L"items[i].id");
is_overdue_fee = CkJsonObjectW_stringOf(jResp,L"items[i].is_overdue_fee");
login_id = CkJsonObjectW_stringOf(jResp,L"items[i].login_id");
notice = CkJsonObjectW_stringOf(jResp,L"items[i].notice");
payment_at = CkJsonObjectW_stringOf(jResp,L"items[i].payment_at");
v_type = CkJsonObjectW_stringOf(jResp,L"items[i].type");
provider = CkJsonObjectW_stringOf(jResp,L"items[i].provider");
reference = CkJsonObjectW_stringOf(jResp,L"items[i].reference");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
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": ""
}
]
}
