Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"fields","<string>")
CkJsonObject::ckUpdateString(queryParams,"fieldset","basic")
CkJsonObject::ckUpdateString(queryParams,"sort","<string>")
CkJsonObject::ckUpdateInt(queryParams,"page",1)
CkJsonObject::ckUpdateInt(queryParams,"per_page",5)
CkJsonObject::ckUpdateString(queryParams,"q","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api-v2.fattureincloud.it/c/:company_id/taxes",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
id.s
due_date.s
status.s
Id.s
Name.s
v_Type.s
Iban.s
Sia.s
Cuc.s
v_Virtual.s
amount.s
attachment_url.s
attachment_token.s
description.s
current_page.s = CkJsonObject::ckStringOf(jResp,"current_page")
first_page_url.s = CkJsonObject::ckStringOf(jResp,"first_page_url")
from.s = CkJsonObject::ckStringOf(jResp,"from")
last_page.s = CkJsonObject::ckStringOf(jResp,"last_page")
last_page_url.s = CkJsonObject::ckStringOf(jResp,"last_page_url")
next_page_url.s = CkJsonObject::ckStringOf(jResp,"next_page_url")
path.s = CkJsonObject::ckStringOf(jResp,"path")
per_page.s = CkJsonObject::ckStringOf(jResp,"per_page")
prev_page_url.s = CkJsonObject::ckStringOf(jResp,"prev_page_url")
v_to.s = CkJsonObject::ckStringOf(jResp,"to")
total.s = CkJsonObject::ckStringOf(jResp,"total")
Amount.s = CkJsonObject::ckStringOf(jResp,"aggregated_data.amount")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
due_date = CkJsonObject::ckStringOf(jResp,"data[i].due_date")
status = CkJsonObject::ckStringOf(jResp,"data[i].status")
Id = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.id")
Name = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.name")
v_Type = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.type")
Iban = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.iban")
Sia = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.sia")
Cuc = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.cuc")
v_Virtual = CkJsonObject::ckStringOf(jResp,"data[i].payment_account.virtual")
amount = CkJsonObject::ckStringOf(jResp,"data[i].amount")
attachment_url = CkJsonObject::ckStringOf(jResp,"data[i].attachment_url")
attachment_token = CkJsonObject::ckStringOf(jResp,"data[i].attachment_token")
description = CkJsonObject::ckStringOf(jResp,"data[i].description")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
