Chilkat Online Tools

Ruby / easybill REST API / Fetch positions list

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("limit","<integer>")
queryParams.UpdateString("page","<integer>")
queryParams.UpdateString("type","PRODUCT")
queryParams.UpdateString("number","<string>")

http.SetRequestHeader("Authorization","{{apiKey}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/positions",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "page": "<integer>",
#   "pages": "<integer>",
#   "limit": "<integer>",
#   "total": "<integer>",
#   "items": [
#     {
#       "number": "<string>",
#       "description": "<string>",
#       "sale_price": "<float>",
#       "id": "<long>",
#       "type": "PRODUCT",
#       "document_note": "<string>",
#       "note": null,
#       "unit": null,
#       "export_identifier": null,
#       "export_identifier_extended": {
#         "NULL": null,
#         "nStb": null,
#         "nStbUstID": null,
#         "nStbNoneUstID": null,
#         "nStbIm": null,
#         "revc": null,
#         "IG": null,
#         "AL": null,
#         "sStfr": null,
#         "smallBusiness": null
#       },
#       "login_id": "<long>",
#       "price_type": "NETTO",
#       "vat_percent": 19,
#       "sale_price2": null,
#       "sale_price3": null,
#       "sale_price4": null,
#       "sale_price5": null,
#       "sale_price6": null,
#       "sale_price7": null,
#       "sale_price8": null,
#       "sale_price9": null,
#       "sale_price10": null,
#       "cost_price": "<float>",
#       "export_cost1": null,
#       "export_cost2": null,
#       "group_id": "<long>",
#       "stock": "NO",
#       "stock_count": 0,
#       "stock_limit_notify": false,
#       "stock_limit_notify_frequency": "ALWAYS",
#       "stock_limit": 0,
#       "quantity": null,
#       "archived": false
#     },
#     {
#       "number": "<string>",
#       "description": "<string>",
#       "sale_price": "<float>",
#       "id": "<long>",
#       "type": "PRODUCT",
#       "document_note": "<string>",
#       "note": null,
#       "unit": null,
#       "export_identifier": null,
#       "export_identifier_extended": {
#         "NULL": null,
#         "nStb": null,
#         "nStbUstID": null,
#         "nStbNoneUstID": null,
#         "nStbIm": null,
#         "revc": null,
#         "IG": null,
#         "AL": null,
#         "sStfr": null,
#         "smallBusiness": null
#       },
#       "login_id": "<long>",
#       "price_type": "NETTO",
#       "vat_percent": 19,
#       "sale_price2": null,
#       "sale_price3": null,
#       "sale_price4": null,
#       "sale_price5": null,
#       "sale_price6": null,
#       "sale_price7": null,
#       "sale_price8": null,
#       "sale_price9": null,
#       "sale_price10": null,
#       "cost_price": "<float>",
#       "export_cost1": null,
#       "export_cost2": null,
#       "group_id": "<long>",
#       "stock": "NO",
#       "stock_count": 0,
#       "stock_limit_notify": false,
#       "stock_limit_notify_frequency": "ALWAYS",
#       "stock_limit": 0,
#       "quantity": null,
#       "archived": false
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

page = jResp.stringOf("page")
pages = jResp.stringOf("pages")
limit = jResp.stringOf("limit")
total = jResp.stringOf("total")
i = 0
count_i = jResp.SizeOfArray("items")
while i < count_i
    jResp.put_I(i)
    v_number = jResp.stringOf("items[i].number")
    description = jResp.stringOf("items[i].description")
    sale_price = jResp.stringOf("items[i].sale_price")
    id = jResp.stringOf("items[i].id")
    v_type = jResp.stringOf("items[i].type")
    document_note = jResp.stringOf("items[i].document_note")
    note = jResp.stringOf("items[i].note")
    unit = jResp.stringOf("items[i].unit")
    export_identifier = jResp.stringOf("items[i].export_identifier")
    v_NULL = jResp.stringOf("items[i].export_identifier_extended.NULL")
    NStb = jResp.stringOf("items[i].export_identifier_extended.nStb")
    NStbUstID = jResp.stringOf("items[i].export_identifier_extended.nStbUstID")
    NStbNoneUstID = jResp.stringOf("items[i].export_identifier_extended.nStbNoneUstID")
    NStbIm = jResp.stringOf("items[i].export_identifier_extended.nStbIm")
    Revc = jResp.stringOf("items[i].export_identifier_extended.revc")
    IG = jResp.stringOf("items[i].export_identifier_extended.IG")
    AL = jResp.stringOf("items[i].export_identifier_extended.AL")
    SStfr = jResp.stringOf("items[i].export_identifier_extended.sStfr")
    SmallBusiness = jResp.stringOf("items[i].export_identifier_extended.smallBusiness")
    login_id = jResp.stringOf("items[i].login_id")
    price_type = jResp.stringOf("items[i].price_type")
    vat_percent = jResp.IntOf("items[i].vat_percent")
    sale_price2 = jResp.stringOf("items[i].sale_price2")
    sale_price3 = jResp.stringOf("items[i].sale_price3")
    sale_price4 = jResp.stringOf("items[i].sale_price4")
    sale_price5 = jResp.stringOf("items[i].sale_price5")
    sale_price6 = jResp.stringOf("items[i].sale_price6")
    sale_price7 = jResp.stringOf("items[i].sale_price7")
    sale_price8 = jResp.stringOf("items[i].sale_price8")
    sale_price9 = jResp.stringOf("items[i].sale_price9")
    sale_price10 = jResp.stringOf("items[i].sale_price10")
    cost_price = jResp.stringOf("items[i].cost_price")
    export_cost1 = jResp.stringOf("items[i].export_cost1")
    export_cost2 = jResp.stringOf("items[i].export_cost2")
    group_id = jResp.stringOf("items[i].group_id")
    stock = jResp.stringOf("items[i].stock")
    stock_count = jResp.IntOf("items[i].stock_count")
    stock_limit_notify = jResp.BoolOf("items[i].stock_limit_notify")
    stock_limit_notify_frequency = jResp.stringOf("items[i].stock_limit_notify_frequency")
    stock_limit = jResp.IntOf("items[i].stock_limit")
    quantity = jResp.stringOf("items[i].quantity")
    archived = jResp.BoolOf("items[i].archived")
    i = i + 1
end

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "type=PRODUCT"
	-d "number=%3Cstring%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/positions

Postman Collection Item JSON

{
  "name": "Fetch positions list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/positions?limit=<integer>&page=<integer>&type=PRODUCT&number=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "positions"
      ],
      "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": "type",
          "value": "PRODUCT",
          "description": "Filter positions by type."
        },
        {
          "key": "number",
          "value": "<string>",
          "description": "Filter positions by number. You can add multiple numbers separate by comma like no,no,no."
        }
      ]
    }
  },
  "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}}/positions?limit=<integer>&page=<integer>&type=PRODUCT&number=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "positions"
          ],
          "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": "type",
              "value": "PRODUCT",
              "description": "Filter positions by type."
            },
            {
              "key": "number",
              "value": "<string>",
              "description": "Filter positions by number. You can add multiple numbers separate by comma like no,no,no."
            }
          ]
        }
      },
      "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      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"sale_price\": \"<float>\",\n      \"id\": \"<long>\",\n      \"type\": \"PRODUCT\",\n      \"document_note\": \"<string>\",\n      \"note\": null,\n      \"unit\": null,\n      \"export_identifier\": null,\n      \"export_identifier_extended\": {\n        \"NULL\": null,\n        \"nStb\": null,\n        \"nStbUstID\": null,\n        \"nStbNoneUstID\": null,\n        \"nStbIm\": null,\n        \"revc\": null,\n        \"IG\": null,\n        \"AL\": null,\n        \"sStfr\": null,\n        \"smallBusiness\": null\n      },\n      \"login_id\": \"<long>\",\n      \"price_type\": \"NETTO\",\n      \"vat_percent\": 19,\n      \"sale_price2\": null,\n      \"sale_price3\": null,\n      \"sale_price4\": null,\n      \"sale_price5\": null,\n      \"sale_price6\": null,\n      \"sale_price7\": null,\n      \"sale_price8\": null,\n      \"sale_price9\": null,\n      \"sale_price10\": null,\n      \"cost_price\": \"<float>\",\n      \"export_cost1\": null,\n      \"export_cost2\": null,\n      \"group_id\": \"<long>\",\n      \"stock\": \"NO\",\n      \"stock_count\": 0,\n      \"stock_limit_notify\": false,\n      \"stock_limit_notify_frequency\": \"ALWAYS\",\n      \"stock_limit\": 0,\n      \"quantity\": null,\n      \"archived\": false\n    },\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"sale_price\": \"<float>\",\n      \"id\": \"<long>\",\n      \"type\": \"PRODUCT\",\n      \"document_note\": \"<string>\",\n      \"note\": null,\n      \"unit\": null,\n      \"export_identifier\": null,\n      \"export_identifier_extended\": {\n        \"NULL\": null,\n        \"nStb\": null,\n        \"nStbUstID\": null,\n        \"nStbNoneUstID\": null,\n        \"nStbIm\": null,\n        \"revc\": null,\n        \"IG\": null,\n        \"AL\": null,\n        \"sStfr\": null,\n        \"smallBusiness\": null\n      },\n      \"login_id\": \"<long>\",\n      \"price_type\": \"NETTO\",\n      \"vat_percent\": 19,\n      \"sale_price2\": null,\n      \"sale_price3\": null,\n      \"sale_price4\": null,\n      \"sale_price5\": null,\n      \"sale_price6\": null,\n      \"sale_price7\": null,\n      \"sale_price8\": null,\n      \"sale_price9\": null,\n      \"sale_price10\": null,\n      \"cost_price\": \"<float>\",\n      \"export_cost1\": null,\n      \"export_cost2\": null,\n      \"group_id\": \"<long>\",\n      \"stock\": \"NO\",\n      \"stock_count\": 0,\n      \"stock_limit_notify\": false,\n      \"stock_limit_notify_frequency\": \"ALWAYS\",\n      \"stock_limit\": 0,\n      \"quantity\": null,\n      \"archived\": false\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}}/positions?limit=<integer>&page=<integer>&type=PRODUCT&number=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "positions"
          ],
          "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": "type",
              "value": "PRODUCT",
              "description": "Filter positions by type."
            },
            {
              "key": "number",
              "value": "<string>",
              "description": "Filter positions by number. You can add multiple numbers separate by comma like no,no,no."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}