Chilkat Online Tools

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

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sStrVal
    String sId
    String sName
    String sV_type
    String sIban
    String sSia
    String sCuc
    String sV_virtual
    String sValue
    String sDescription
    String sNotes
    String sE_invoice
    String sEi_type
    String sEi_description
    String sEditable
    String sIs_disabled
    String sMollit_a5
    String sVoluptated9
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"
    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api-v2.fattureincloud.it/c/:company_id/receipts/info" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // 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

    Get ComStringOf Of hoJResp "data.numerations.ideb9.mollit_a5" To sMollit_a5
    Get ComStringOf Of hoJResp "data.numerations.ideb9.voluptated9" To sVoluptated9
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "data.numerations_list" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "data.numerations_list[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "data.rc_centers_list" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "data.rc_centers_list[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "data.payment_accounts_list" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].id" To sId
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].name" To sName
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].type" To sV_type
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].iban" To sIban
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].sia" To sSia
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].cuc" To sCuc
        Get ComStringOf Of hoJResp "data.payment_accounts_list[i].virtual" To sV_virtual
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "data.categories_list" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "data.categories_list[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "data.vat_types_list" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "data.vat_types_list[i].id" To sId
        Get ComStringOf Of hoJResp "data.vat_types_list[i].value" To sValue
        Get ComStringOf Of hoJResp "data.vat_types_list[i].description" To sDescription
        Get ComStringOf Of hoJResp "data.vat_types_list[i].notes" To sNotes
        Get ComStringOf Of hoJResp "data.vat_types_list[i].e_invoice" To sE_invoice
        Get ComStringOf Of hoJResp "data.vat_types_list[i].ei_type" To sEi_type
        Get ComStringOf Of hoJResp "data.vat_types_list[i].ei_description" To sEi_description
        Get ComStringOf Of hoJResp "data.vat_types_list[i].editable" To sEditable
        Get ComStringOf Of hoJResp "data.vat_types_list[i].is_disabled" To sIs_disabled
        Move (i + 1) To i
    Loop



End_Procedure

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