Chilkat Online Tools

lianja / Fatture in Cloud API v2 - API Reference / Get Receipt Pre-Create Info

Back to Collection Items

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

loHttp = createobject("CkHttp")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/receipts/info",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

// {
//   "data": {
//     "numerations": {
//       "ideb9": {
//         "mollit_a5": "<integer>",
//         "voluptated9": "<integer>"
//       }
//     },
//     "numerations_list": [
//       "<string>",
//       "<string>"
//     ],
//     "rc_centers_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>"
//       }
//     ],
//     "categories_list": [
//       "<string>",
//       "<string>"
//     ],
//     "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

lcMollit_a5 = loJResp.StringOf("data.numerations.ideb9.mollit_a5")
lcVoluptated9 = loJResp.StringOf("data.numerations.ideb9.voluptated9")
i = 0
lnCount_i = loJResp.SizeOfArray("data.numerations_list")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("data.numerations_list[i]")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.rc_centers_list")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("data.rc_centers_list[i]")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.payment_accounts_list")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data.payment_accounts_list[i].id")
    lcName = loJResp.StringOf("data.payment_accounts_list[i].name")
    lcV_type = loJResp.StringOf("data.payment_accounts_list[i].type")
    lcIban = loJResp.StringOf("data.payment_accounts_list[i].iban")
    lcSia = loJResp.StringOf("data.payment_accounts_list[i].sia")
    lcCuc = loJResp.StringOf("data.payment_accounts_list[i].cuc")
    lcV_virtual = loJResp.StringOf("data.payment_accounts_list[i].virtual")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.categories_list")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("data.categories_list[i]")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.vat_types_list")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data.vat_types_list[i].id")
    lcValue = loJResp.StringOf("data.vat_types_list[i].value")
    lcDescription = loJResp.StringOf("data.vat_types_list[i].description")
    lcNotes = loJResp.StringOf("data.vat_types_list[i].notes")
    lcE_invoice = loJResp.StringOf("data.vat_types_list[i].e_invoice")
    lcEi_type = loJResp.StringOf("data.vat_types_list[i].ei_type")
    lcEi_description = loJResp.StringOf("data.vat_types_list[i].ei_description")
    lcEditable = loJResp.StringOf("data.vat_types_list[i].editable")
    lcIs_disabled = loJResp.StringOf("data.vat_types_list[i].is_disabled")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/receipts/info

Postman Collection Item JSON

{
  "name": "Get Receipt 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/receipts/info",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "receipts",
        "info"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Retrieves the information useful while creating a new receipt."
  },
  "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/receipts/info",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts",
            "info"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"numerations\": {\n      \"ideb9\": {\n        \"mollit_a5\": \"<integer>\",\n        \"voluptated9\": \"<integer>\"\n      }\n    },\n    \"numerations_list\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"rc_centers_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    \"categories_list\": [\n      \"<string>\",\n      \"<string>\"\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}"
    },
    {
      "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/info",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts",
            "info"
          ],
          "variable": [
            {
              "key": "company_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/info",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts",
            "info"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}