Chilkat Online Tools

Ruby / easybill REST API / Update position

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()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "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
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("number","<string>")
json.UpdateString("description","<string>")
json.UpdateString("sale_price","<float>")
json.UpdateString("id","<long>")
json.UpdateString("type","PRODUCT")
json.UpdateString("document_note","<string>")
json.UpdateNull("note")
json.UpdateNull("unit")
json.UpdateNull("export_identifier")
json.UpdateNull("export_identifier_extended.NULL")
json.UpdateNull("export_identifier_extended.nStb")
json.UpdateNull("export_identifier_extended.nStbUstID")
json.UpdateNull("export_identifier_extended.nStbNoneUstID")
json.UpdateNull("export_identifier_extended.nStbIm")
json.UpdateNull("export_identifier_extended.revc")
json.UpdateNull("export_identifier_extended.IG")
json.UpdateNull("export_identifier_extended.AL")
json.UpdateNull("export_identifier_extended.sStfr")
json.UpdateNull("export_identifier_extended.smallBusiness")
json.UpdateString("login_id","<long>")
json.UpdateString("price_type","NETTO")
json.UpdateInt("vat_percent",19)
json.UpdateNull("sale_price2")
json.UpdateNull("sale_price3")
json.UpdateNull("sale_price4")
json.UpdateNull("sale_price5")
json.UpdateNull("sale_price6")
json.UpdateNull("sale_price7")
json.UpdateNull("sale_price8")
json.UpdateNull("sale_price9")
json.UpdateNull("sale_price10")
json.UpdateString("cost_price","<float>")
json.UpdateNull("export_cost1")
json.UpdateNull("export_cost2")
json.UpdateString("group_id","<long>")
json.UpdateString("stock","NO")
json.UpdateInt("stock_count",0)
json.UpdateBool("stock_limit_notify",false)
json.UpdateString("stock_limit_notify_frequency","ALWAYS")
json.UpdateInt("stock_limit",0)
json.UpdateNull("quantity")
json.UpdateBool("archived",false)

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.easybill.de/rest/v1/positions/:id",sbRequestBody,"utf-8","application/json",false,false)
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)

# {
#   "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

v_number = jResp.stringOf("number")
description = jResp.stringOf("description")
sale_price = jResp.stringOf("sale_price")
id = jResp.stringOf("id")
v_type = jResp.stringOf("type")
document_note = jResp.stringOf("document_note")
note = jResp.stringOf("note")
unit = jResp.stringOf("unit")
export_identifier = jResp.stringOf("export_identifier")
v_NULL = jResp.stringOf("export_identifier_extended.NULL")
NStb = jResp.stringOf("export_identifier_extended.nStb")
NStbUstID = jResp.stringOf("export_identifier_extended.nStbUstID")
NStbNoneUstID = jResp.stringOf("export_identifier_extended.nStbNoneUstID")
NStbIm = jResp.stringOf("export_identifier_extended.nStbIm")
Revc = jResp.stringOf("export_identifier_extended.revc")
IG = jResp.stringOf("export_identifier_extended.IG")
AL = jResp.stringOf("export_identifier_extended.AL")
SStfr = jResp.stringOf("export_identifier_extended.sStfr")
SmallBusiness = jResp.stringOf("export_identifier_extended.smallBusiness")
login_id = jResp.stringOf("login_id")
price_type = jResp.stringOf("price_type")
vat_percent = jResp.IntOf("vat_percent")
sale_price2 = jResp.stringOf("sale_price2")
sale_price3 = jResp.stringOf("sale_price3")
sale_price4 = jResp.stringOf("sale_price4")
sale_price5 = jResp.stringOf("sale_price5")
sale_price6 = jResp.stringOf("sale_price6")
sale_price7 = jResp.stringOf("sale_price7")
sale_price8 = jResp.stringOf("sale_price8")
sale_price9 = jResp.stringOf("sale_price9")
sale_price10 = jResp.stringOf("sale_price10")
cost_price = jResp.stringOf("cost_price")
export_cost1 = jResp.stringOf("export_cost1")
export_cost2 = jResp.stringOf("export_cost2")
group_id = jResp.stringOf("group_id")
stock = jResp.stringOf("stock")
stock_count = jResp.IntOf("stock_count")
stock_limit_notify = jResp.BoolOf("stock_limit_notify")
stock_limit_notify_frequency = jResp.stringOf("stock_limit_notify_frequency")
stock_limit = jResp.IntOf("stock_limit")
quantity = jResp.stringOf("quantity")
archived = jResp.BoolOf("archived")

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "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
}'
https://api.easybill.de/rest/v1/positions/:id

Postman Collection Item JSON

{
  "name": "Update position",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/positions/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "positions",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of position"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "PUT",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/positions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "positions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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}"
    },
    {
      "name": "Invalid position",
      "originalRequest": {
        "method": "PUT",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/positions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "positions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/positions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "positions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}