Chilkat Online Tools

VB6 / Fatture in Cloud API v2 - API Reference / Get Cashbook Entry

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/cashbook/: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": "<string>",
'     "date": "<date>",
'     "description": "<string>",
'     "kind": "receipt",
'     "type": "in",
'     "entity_name": "<string>",
'     "document": {
'       "id": "<integer>",
'       "type": "<string>",
'       "path": "<string>"
'     },
'     "amount_in": "<number>",
'     "payment_account_in": {
'       "id": "<integer>",
'       "name": "<string>",
'       "type": "standard",
'       "iban": "<string>",
'       "sia": "<string>",
'       "cuc": "<string>",
'       "virtual": "<boolean>"
'     },
'     "amount_out": "<number>",
'     "payment_account_out": {
'       "id": "<integer>",
'       "name": "<string>",
'       "type": "standard",
'       "iban": "<string>",
'       "sia": "<string>",
'       "cuc": "<string>",
'       "virtual": "<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
Id = jResp.StringOf("data.id")
Dim Date As String
Date = jResp.StringOf("data.date")
Dim Description As String
Description = jResp.StringOf("data.description")
Dim Kind As String
Kind = jResp.StringOf("data.kind")
Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim Entity_name As String
Entity_name = jResp.StringOf("data.entity_name")
Dim DocumentId As String
DocumentId = jResp.StringOf("data.document.id")
Dim DocumentType As String
DocumentType = jResp.StringOf("data.document.type")
Dim Path As String
Path = jResp.StringOf("data.document.path")
Dim Amount_in As String
Amount_in = jResp.StringOf("data.amount_in")
Dim Payment_account_inId As String
Payment_account_inId = jResp.StringOf("data.payment_account_in.id")
Dim Name As String
Name = jResp.StringOf("data.payment_account_in.name")
Dim Payment_account_inType As String
Payment_account_inType = jResp.StringOf("data.payment_account_in.type")
Dim Iban As String
Iban = jResp.StringOf("data.payment_account_in.iban")
Dim Sia As String
Sia = jResp.StringOf("data.payment_account_in.sia")
Dim Cuc As String
Cuc = jResp.StringOf("data.payment_account_in.cuc")
Dim v_Virtual As String
v_Virtual = jResp.StringOf("data.payment_account_in.virtual")
Dim Amount_out As String
Amount_out = jResp.StringOf("data.amount_out")
Dim Payment_account_outId As String
Payment_account_outId = jResp.StringOf("data.payment_account_out.id")
Dim Payment_account_outName As String
Payment_account_outName = jResp.StringOf("data.payment_account_out.name")
Dim Payment_account_outType As String
Payment_account_outType = jResp.StringOf("data.payment_account_out.type")
Dim Payment_account_outIban As String
Payment_account_outIban = jResp.StringOf("data.payment_account_out.iban")
Dim Payment_account_outSia As String
Payment_account_outSia = jResp.StringOf("data.payment_account_out.sia")
Dim Payment_account_outCuc As String
Payment_account_outCuc = jResp.StringOf("data.payment_account_out.cuc")
Dim Payment_account_outVirtual As String
Payment_account_outVirtual = jResp.StringOf("data.payment_account_out.virtual")

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/cashbook/:document_id

Postman Collection Item JSON

{
  "name": "Get Cashbook Entry",
  "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/cashbook/:document_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "cashbook",
        ":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": "<string>"
        }
      ]
    },
    "description": "Gets the specified cashbook entry."
  },
  "response": [
    {
      "name": "Cashbook Entry.",
      "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/cashbook/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook",
            ":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\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"receipt\",\n    \"type\": \"in\",\n    \"entity_name\": \"<string>\",\n    \"document\": {\n      \"id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"path\": \"<string>\"\n    },\n    \"amount_in\": \"<number>\",\n    \"payment_account_in\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"amount_out\": \"<number>\",\n    \"payment_account_out\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\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/cashbook/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook",
            ":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/cashbook/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook",
            ":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": ""
    }
  ]
}