delphiDll / easybill REST API / Create document payment
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
document_id: PWideChar;
amount: PWideChar;
id: PWideChar;
is_overdue_fee: PWideChar;
login_id: PWideChar;
notice: PWideChar;
payment_at: PWideChar;
v_type: PWideChar;
provider: PWideChar;
reference: PWideChar;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "document_id": "<long>",
// "amount": "<integer>",
// "id": "<long>",
// "is_overdue_fee": "<boolean>",
// "login_id": "<long>",
// "notice": "",
// "payment_at": "<date>",
// "type": "",
// "provider": "",
// "reference": ""
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'document_id','<long>');
CkJsonObject_UpdateString(json,'amount','<integer>');
CkJsonObject_UpdateString(json,'id','<long>');
CkJsonObject_UpdateString(json,'is_overdue_fee','<boolean>');
CkJsonObject_UpdateString(json,'login_id','<long>');
CkJsonObject_UpdateString(json,'notice','');
CkJsonObject_UpdateString(json,'payment_at','<date>');
CkJsonObject_UpdateString(json,'type','');
CkJsonObject_UpdateString(json,'provider','');
CkJsonObject_UpdateString(json,'reference','');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_PostJson3(http,'https://api.easybill.de/rest/v1/document-payments?paid=<boolean>','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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 := CkJsonObject__stringOf(jResp,'document_id');
amount := CkJsonObject__stringOf(jResp,'amount');
id := CkJsonObject__stringOf(jResp,'id');
is_overdue_fee := CkJsonObject__stringOf(jResp,'is_overdue_fee');
login_id := CkJsonObject__stringOf(jResp,'login_id');
notice := CkJsonObject__stringOf(jResp,'notice');
payment_at := CkJsonObject__stringOf(jResp,'payment_at');
v_type := CkJsonObject__stringOf(jResp,'type');
provider := CkJsonObject__stringOf(jResp,'provider');
reference := CkJsonObject__stringOf(jResp,'reference');
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X POST
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"document_id": "<long>",
"amount": "<integer>",
"id": "<long>",
"is_overdue_fee": "<boolean>",
"login_id": "<long>",
"notice": "",
"payment_at": "<date>",
"type": "",
"provider": "",
"reference": ""
}'
https://api.easybill.de/rest/v1/document-payments?paid=<boolean>
Postman Collection Item JSON
{
"name": "Create document payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/document-payments?paid=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"document-payments"
],
"query": [
{
"key": "paid",
"value": "<boolean>",
"description": "Mark document as paid when amount less then payment amount."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/document-payments?paid=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"document-payments"
],
"query": [
{
"key": "paid",
"value": "<boolean>",
"description": "Mark document as paid when amount less then payment amount."
}
]
}
},
"status": "Created",
"code": 201,
"_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": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/document-payments?paid=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"document-payments"
],
"query": [
{
"key": "paid",
"value": "<boolean>",
"description": "Mark document as paid when amount less then payment amount."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
