Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    let queryParams = CkoJsonObject()!
    queryParams.update("type", value: "passive_delivery_note")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api-v2.fattureincloud.it/c/:company_id/received_documents/info", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var strVal: String?
    var id: String?
    var symbol: String?
    var exchange_rate: String?
    var html_symbol: String?
    var name: String?
    var v_type: String?
    var iban: String?
    var sia: String?
    var cuc: String?
    var v_virtual: String?
    var value: String?
    var description: String?
    var notes: String?
    var e_invoice: String?
    var ei_type: String?
    var ei_description: String?
    var editable: String?
    var is_disabled: String?

    var Detailed: String? = jResp.string(of: "data.default_values.detailed")
    var Vat: String? = jResp.string(of: "data.items_default_values.vat")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data.countries_list").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "data.countries_list[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "data.currencies_list").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "data.currencies_list[i].id")
        symbol = jResp.string(of: "data.currencies_list[i].symbol")
        exchange_rate = jResp.string(of: "data.currencies_list[i].exchange_rate")
        html_symbol = jResp.string(of: "data.currencies_list[i].html_symbol")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "data.categories_list").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "data.categories_list[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "data.payment_accounts_list").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "data.payment_accounts_list[i].id")
        name = jResp.string(of: "data.payment_accounts_list[i].name")
        v_type = jResp.string(of: "data.payment_accounts_list[i].type")
        iban = jResp.string(of: "data.payment_accounts_list[i].iban")
        sia = jResp.string(of: "data.payment_accounts_list[i].sia")
        cuc = jResp.string(of: "data.payment_accounts_list[i].cuc")
        v_virtual = jResp.string(of: "data.payment_accounts_list[i].virtual")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "data.vat_types_list").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "data.vat_types_list[i].id")
        value = jResp.string(of: "data.vat_types_list[i].value")
        description = jResp.string(of: "data.vat_types_list[i].description")
        notes = jResp.string(of: "data.vat_types_list[i].notes")
        e_invoice = jResp.string(of: "data.vat_types_list[i].e_invoice")
        ei_type = jResp.string(of: "data.vat_types_list[i].ei_type")
        ei_description = jResp.string(of: "data.vat_types_list[i].ei_description")
        editable = jResp.string(of: "data.vat_types_list[i].editable")
        is_disabled = jResp.string(of: "data.vat_types_list[i].is_disabled")
        i = i + 1
    }


}

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