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("fields","<string>")
queryParams.UpdateString("fieldset","basic")
queryParams.UpdateString("sort","<string>")
queryParams.UpdateInt("page",1)
queryParams.UpdateInt("per_page",5)
queryParams.UpdateString("q","<string>")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/taxes",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)
# {
# "current_page": "<integer>",
# "first_page_url": "<uri>",
# "from": "<integer>",
# "last_page": "<integer>",
# "last_page_url": "<uri>",
# "next_page_url": "<uri>",
# "path": "<uri>",
# "per_page": "<integer>",
# "prev_page_url": "<uri>",
# "to": "<integer>",
# "total": "<integer>",
# "data": [
# {
# "id": "<integer>",
# "due_date": "<date>",
# "status": "reversed",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# },
# "amount": "<number>",
# "attachment_url": "<string>",
# "attachment_token": "<string>",
# "description": "<string>"
# },
# {
# "id": "<integer>",
# "due_date": "<date>",
# "status": "not_paid",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# },
# "amount": "<number>",
# "attachment_url": "<string>",
# "attachment_token": "<string>",
# "description": "<string>"
# }
# ],
# "aggregated_data": {
# "amount": "<number>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
current_page = jResp.stringOf("current_page")
first_page_url = jResp.stringOf("first_page_url")
from = jResp.stringOf("from")
last_page = jResp.stringOf("last_page")
last_page_url = jResp.stringOf("last_page_url")
next_page_url = jResp.stringOf("next_page_url")
path = jResp.stringOf("path")
per_page = jResp.stringOf("per_page")
prev_page_url = jResp.stringOf("prev_page_url")
v_to = jResp.stringOf("to")
total = jResp.stringOf("total")
Amount = jResp.stringOf("aggregated_data.amount")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("data[i].id")
due_date = jResp.stringOf("data[i].due_date")
status = jResp.stringOf("data[i].status")
Id = jResp.stringOf("data[i].payment_account.id")
Name = jResp.stringOf("data[i].payment_account.name")
v_Type = jResp.stringOf("data[i].payment_account.type")
Iban = jResp.stringOf("data[i].payment_account.iban")
Sia = jResp.stringOf("data[i].payment_account.sia")
Cuc = jResp.stringOf("data[i].payment_account.cuc")
v_Virtual = jResp.stringOf("data[i].payment_account.virtual")
amount = jResp.stringOf("data[i].amount")
attachment_url = jResp.stringOf("data[i].attachment_url")
attachment_token = jResp.stringOf("data[i].attachment_token")
description = jResp.stringOf("data[i].description")
i = i + 1
end
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-d "sort=%3Cstring%3E"
-d "page=1"
-d "per_page=5"
-d "q=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/taxes
Postman Collection Item JSON
{
"name": "List F24",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/taxes?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"taxes"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the F24s."
},
"response": [
{
"name": "Results list.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/taxes?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"taxes"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"due_date\": \"<date>\",\n \"status\": \"reversed\",\n \"payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"amount\": \"<number>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\",\n \"description\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"due_date\": \"<date>\",\n \"status\": \"not_paid\",\n \"payment_account\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n \"amount\": \"<number>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"aggregated_data\": {\n \"amount\": \"<number>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/taxes?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"taxes"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
