Go / easybill REST API / Fetch document payments list
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global_Ref.html">Global Unlock Sample for sample code.
http := chilkat.NewHttp()
var success bool
queryParams := chilkat.NewJsonObject()
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 := http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/document-payments",queryParams)
if http.LastMethodSuccess() == false {
fmt.Println(http.LastErrorText())
http.DisposeHttp()
queryParams.DisposeJsonObject()
return
}
sbResponseBody := chilkat.NewStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp := chilkat.NewJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.SetEmitCompact(false)
fmt.Println("Response Body:")
fmt.Println(*jResp.Emit())
respStatusCode := resp.StatusCode()
fmt.Println("Response Status Code = ", respStatusCode)
if respStatusCode >= 400 {
fmt.Println("Response Header:")
fmt.Println(resp.Header())
fmt.Println("Failed.")
resp.DisposeHttpResponse()
http.DisposeHttp()
queryParams.DisposeJsonObject()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
return
}
resp.DisposeHttpResponse()
// 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
var document_id *string = new(string)
var amount *string = new(string)
var id *string = new(string)
var is_overdue_fee *string = new(string)
var login_id *string = new(string)
var notice *string = new(string)
var payment_at *string = new(string)
var v_type *string = new(string)
var provider *string = new(string)
var reference *string = new(string)
page := jResp.StringOf("page")
pages := jResp.StringOf("pages")
limit := jResp.StringOf("limit")
total := jResp.StringOf("total")
i := 0
count_i := jResp.SizeOfArray("items")
for i < count_i {
jResp.SetI(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
}
http.DisposeHttp()
queryParams.DisposeJsonObject()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
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": ""
}
]
}
