Chilkat Online Tools

VB6 / Fatture in Cloud API v2 - API Reference / Get Receipt

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("fields","<string>")
success = queryParams.UpdateString("fieldset","basic")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Accept","application/json"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/receipts/:document_id",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim id As String
Dim amount_net As String
Dim amount_gross As String
Dim category As String
Dim vatId As String
Dim Value As String
Dim vatDescription As String
Dim Notes As String
Dim E_invoice As String
Dim Ei_type As String
Dim Ei_description As String
Dim Editable As String
Dim Is_disabled As String

Dim Id As String
Id = jResp.StringOf("data.id")
Dim Date As String
Date = jResp.StringOf("data.date")
Dim v_Number As String
v_Number = jResp.StringOf("data.number")
Dim Numeration As String
Numeration = jResp.StringOf("data.numeration")
Dim Amount_net As String
Amount_net = jResp.StringOf("data.amount_net")
Dim Amount_vat As String
Amount_vat = jResp.StringOf("data.amount_vat")
Dim Amount_gross As String
Amount_gross = jResp.StringOf("data.amount_gross")
Dim Use_gross_prices As String
Use_gross_prices = jResp.StringOf("data.use_gross_prices")
Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim Description As String
Description = jResp.StringOf("data.description")
Dim Rc_center As String
Rc_center = jResp.StringOf("data.rc_center")
Dim Created_at As String
Created_at = jResp.StringOf("data.created_at")
Dim Updated_at As String
Updated_at = jResp.StringOf("data.updated_at")
Dim Payment_accountId As String
Payment_accountId = jResp.StringOf("data.payment_account.id")
Dim Name As String
Name = jResp.StringOf("data.payment_account.name")
Dim Payment_accountType As String
Payment_accountType = jResp.StringOf("data.payment_account.type")
Dim Iban As String
Iban = jResp.StringOf("data.payment_account.iban")
Dim Sia As String
Sia = jResp.StringOf("data.payment_account.sia")
Dim Cuc As String
Cuc = jResp.StringOf("data.payment_account.cuc")
Dim v_Virtual As String
v_Virtual = jResp.StringOf("data.payment_account.virtual")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data.items_list")
Do While i < count_i
    jResp.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
Loop

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": ""
    }
  ]
}