Objective-C / easybill REST API / Fetch positions list
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"limit" value: @"<integer>"];
[queryParams UpdateString: @"page" value: @"<integer>"];
[queryParams UpdateString: @"type" value: @"PRODUCT"];
[queryParams UpdateString: @"number" value: @"<string>"];
[http SetRequestHeader: @"Authorization" value: @"{{apiKey}}"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.easybill.de/rest/v1/positions" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *v_number = 0;
NSString *description = 0;
NSString *sale_price = 0;
NSString *id = 0;
NSString *v_type = 0;
NSString *document_note = 0;
NSString *note = 0;
NSString *unit = 0;
NSString *export_identifier = 0;
NSString *v_NULL = 0;
NSString *NStb = 0;
NSString *NStbUstID = 0;
NSString *NStbNoneUstID = 0;
NSString *NStbIm = 0;
NSString *Revc = 0;
NSString *IG = 0;
NSString *AL = 0;
NSString *SStfr = 0;
NSString *SmallBusiness = 0;
NSString *login_id = 0;
NSString *price_type = 0;
int vat_percent;
NSString *sale_price2 = 0;
NSString *sale_price3 = 0;
NSString *sale_price4 = 0;
NSString *sale_price5 = 0;
NSString *sale_price6 = 0;
NSString *sale_price7 = 0;
NSString *sale_price8 = 0;
NSString *sale_price9 = 0;
NSString *sale_price10 = 0;
NSString *cost_price = 0;
NSString *export_cost1 = 0;
NSString *export_cost2 = 0;
NSString *group_id = 0;
NSString *stock = 0;
int stock_count;
BOOL stock_limit_notify;
NSString *stock_limit_notify_frequency = 0;
int stock_limit;
NSString *quantity = 0;
BOOL archived;
NSString *page = [jResp StringOf: @"page"];
NSString *pages = [jResp StringOf: @"pages"];
NSString *limit = [jResp StringOf: @"limit"];
NSString *total = [jResp StringOf: @"total"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"items"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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"] intValue];
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"] intValue];
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"] intValue];
quantity = [jResp StringOf: @"items[i].quantity"];
archived = [jResp BoolOf: @"items[i].archived"];
i = i + 1;
}
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": ""
}
]
}
