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")
# 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/receipts/:document_id",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)
# {
# "data": {
# "id": "<integer>",
# "date": "<date>",
# "number": "<number>",
# "numeration": "<string>",
# "amount_net": "<number>",
# "amount_vat": "<number>",
# "amount_gross": "<number>",
# "use_gross_prices": "<boolean>",
# "type": "till_receipt",
# "description": "<string>",
# "rc_center": "<string>",
# "created_at": "<string>",
# "updated_at": "<string>",
# "payment_account": {
# "id": "<integer>",
# "name": "<string>",
# "type": "standard",
# "iban": "<string>",
# "sia": "<string>",
# "cuc": "<string>",
# "virtual": "<boolean>"
# },
# "items_list": [
# {
# "id": "<integer>",
# "amount_net": "<number>",
# "amount_gross": "<number>",
# "category": "<string>",
# "vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# }
# },
# {
# "id": "<integer>",
# "amount_net": "<number>",
# "amount_gross": "<number>",
# "category": "<string>",
# "vat": {
# "id": "<integer>",
# "value": "<number>",
# "description": "<string>",
# "notes": "<string>",
# "e_invoice": "<boolean>",
# "ei_type": "<string>",
# "ei_description": "<string>",
# "editable": "<boolean>",
# "is_disabled": "<boolean>"
# }
# }
# ]
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id = jResp.stringOf("data.id")
Date = jResp.stringOf("data.date")
v_Number = jResp.stringOf("data.number")
Numeration = jResp.stringOf("data.numeration")
Amount_net = jResp.stringOf("data.amount_net")
Amount_vat = jResp.stringOf("data.amount_vat")
Amount_gross = jResp.stringOf("data.amount_gross")
Use_gross_prices = jResp.stringOf("data.use_gross_prices")
v_Type = jResp.stringOf("data.type")
Description = jResp.stringOf("data.description")
Rc_center = jResp.stringOf("data.rc_center")
Created_at = jResp.stringOf("data.created_at")
Updated_at = jResp.stringOf("data.updated_at")
Payment_accountId = jResp.stringOf("data.payment_account.id")
Name = jResp.stringOf("data.payment_account.name")
Payment_accountType = jResp.stringOf("data.payment_account.type")
Iban = jResp.stringOf("data.payment_account.iban")
Sia = jResp.stringOf("data.payment_account.sia")
Cuc = jResp.stringOf("data.payment_account.cuc")
v_Virtual = jResp.stringOf("data.payment_account.virtual")
i = 0
count_i = jResp.SizeOfArray("data.items_list")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("data.items_list[i].id")
amount_net = jResp.stringOf("data.items_list[i].amount_net")
amount_gross = jResp.stringOf("data.items_list[i].amount_gross")
category = jResp.stringOf("data.items_list[i].category")
vatId = jResp.stringOf("data.items_list[i].vat.id")
Value = jResp.stringOf("data.items_list[i].vat.value")
vatDescription = jResp.stringOf("data.items_list[i].vat.description")
Notes = jResp.stringOf("data.items_list[i].vat.notes")
E_invoice = jResp.stringOf("data.items_list[i].vat.e_invoice")
Ei_type = jResp.stringOf("data.items_list[i].vat.ei_type")
Ei_description = jResp.stringOf("data.items_list[i].vat.ei_description")
Editable = jResp.stringOf("data.items_list[i].vat.editable")
Is_disabled = jResp.stringOf("data.items_list[i].vat.is_disabled")
i = i + 1
end
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/receipts/:document_id
Postman Collection Item JSON
{
"name": "Get Receipt",
"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/receipts/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<integer>"
}
]
},
"description": "Gets the specified receipt."
},
"response": [
{
"name": "Receipt Details.",
"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/receipts/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"date\": \"<date>\",\n \"number\": \"<number>\",\n \"numeration\": \"<string>\",\n \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"use_gross_prices\": \"<boolean>\",\n \"type\": \"till_receipt\",\n \"description\": \"<string>\",\n \"rc_center\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\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 \"items_list\": [\n {\n \"id\": \"<integer>\",\n \"amount_net\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"category\": \"<string>\",\n \"vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n },\n {\n \"id\": \"<integer>\",\n \"amount_net\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"category\": \"<string>\",\n \"vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n }\n ]\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/receipts/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/receipts/:document_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"receipts",
":document_id"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
}
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
