Chilkat Online Tools

Classic ASP / Fatture in Cloud API v2 - API Reference / Get Received Document Pre-Create Info

Back to Collection Items

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = Server.CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("type","passive_delivery_note")

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

' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents/info",queryParams)
If (http.LastMethodSuccess = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
    Response.End
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = Server.CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"

respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
    Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"

    Response.End
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "data": {
'     "default_values": {
'       "detailed": "<boolean>"
'     },
'     "items_default_values": {
'       "vat": "<number>"
'     },
'     "countries_list": [
'       "<string>",
'       "<string>"
'     ],
'     "currencies_list": [
'       {
'         "id": "<string>",
'         "symbol": "<string>",
'         "exchange_rate": "<string>",
'         "html_symbol": "<string>"
'       },
'       {
'         "id": "<string>",
'         "symbol": "<string>",
'         "exchange_rate": "<string>",
'         "html_symbol": "<string>"
'       }
'     ],
'     "categories_list": [
'       "<string>",
'       "<string>"
'     ],
'     "payment_accounts_list": [
'       {
'         "id": "<integer>",
'         "name": "<string>",
'         "type": "standard",
'         "iban": "<string>",
'         "sia": "<string>",
'         "cuc": "<string>",
'         "virtual": "<boolean>"
'       },
'       {
'         "id": "<integer>",
'         "name": "<string>",
'         "type": "standard",
'         "iban": "<string>",
'         "sia": "<string>",
'         "cuc": "<string>",
'         "virtual": "<boolean>"
'       }
'     ],
'     "vat_types_list": [
'       {
'         "id": "<integer>",
'         "value": "<number>",
'         "description": "<string>",
'         "notes": "<string>",
'         "e_invoice": "<boolean>",
'         "ei_type": "<string>",
'         "ei_description": "<string>",
'         "editable": "<boolean>",
'         "is_disabled": "<boolean>"
'       },
'       {
'         "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

Detailed = jResp.StringOf("data.default_values.detailed")
Vat = jResp.StringOf("data.items_default_values.vat")
i = 0
count_i = jResp.SizeOfArray("data.countries_list")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("data.countries_list[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("data.currencies_list")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("data.currencies_list[i].id")
    symbol = jResp.StringOf("data.currencies_list[i].symbol")
    exchange_rate = jResp.StringOf("data.currencies_list[i].exchange_rate")
    html_symbol = jResp.StringOf("data.currencies_list[i].html_symbol")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("data.categories_list")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("data.categories_list[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("data.payment_accounts_list")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("data.payment_accounts_list[i].id")
    name = jResp.StringOf("data.payment_accounts_list[i].name")
    v_type = jResp.StringOf("data.payment_accounts_list[i].type")
    iban = jResp.StringOf("data.payment_accounts_list[i].iban")
    sia = jResp.StringOf("data.payment_accounts_list[i].sia")
    cuc = jResp.StringOf("data.payment_accounts_list[i].cuc")
    v_virtual = jResp.StringOf("data.payment_accounts_list[i].virtual")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("data.vat_types_list")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("data.vat_types_list[i].id")
    value = jResp.StringOf("data.vat_types_list[i].value")
    description = jResp.StringOf("data.vat_types_list[i].description")
    notes = jResp.StringOf("data.vat_types_list[i].notes")
    e_invoice = jResp.StringOf("data.vat_types_list[i].e_invoice")
    ei_type = jResp.StringOf("data.vat_types_list[i].ei_type")
    ei_description = jResp.StringOf("data.vat_types_list[i].ei_description")
    editable = jResp.StringOf("data.vat_types_list[i].editable")
    is_disabled = jResp.StringOf("data.vat_types_list[i].is_disabled")
    i = i + 1
Loop

%>
</body>
</html>

Curl Command

curl -G -d "type=passive_delivery_note"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/received_documents/info

Postman Collection Item JSON

{
  "name": "Get Received Document Pre-Create Info",
  "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/received_documents/info?type=passive_delivery_note",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "received_documents",
        "info"
      ],
      "query": [
        {
          "key": "type",
          "value": "passive_delivery_note",
          "description": "(Required) The type of the received document."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Retrieves the information useful while creating a new document."
  },
  "response": [
    {
      "name": "Pre-create info",
      "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/received_documents/info?type=passive_delivery_note",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "received_documents",
            "info"
          ],
          "query": [
            {
              "key": "type",
              "value": "passive_delivery_note",
              "description": "(Required) The type of the received document."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"default_values\": {\n      \"detailed\": \"<boolean>\"\n    },\n    \"items_default_values\": {\n      \"vat\": \"<number>\"\n    },\n    \"countries_list\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"currencies_list\": [\n      {\n        \"id\": \"<string>\",\n        \"symbol\": \"<string>\",\n        \"exchange_rate\": \"<string>\",\n        \"html_symbol\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"symbol\": \"<string>\",\n        \"exchange_rate\": \"<string>\",\n        \"html_symbol\": \"<string>\"\n      }\n    ],\n    \"categories_list\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"payment_accounts_list\": [\n      {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      }\n    ],\n    \"vat_types_list\": [\n      {\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        \"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}"
    }
  ]
}