Chilkat Online Tools

Swift3 / Fatture in Cloud API v2 - API Reference / Get Client

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("fields", value: "<string>")
    queryParams.update("fieldset", value: "basic")

    // 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/entities/clients/:client_id", 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": {
    //     "id": "<integer>",
    //     "code": "<string>",
    //     "name": "<string>",
    //     "type": null,
    //     "first_name": "<string>",
    //     "last_name": "<string>",
    //     "contact_person": "<string>",
    //     "vat_number": "<string>",
    //     "tax_code": "<string>",
    //     "address_street": "<string>",
    //     "address_postal_code": "<string>",
    //     "address_city": "<string>",
    //     "address_province": "<string>",
    //     "address_extra": "<string>",
    //     "country": "<string>",
    //     "email": "<string>",
    //     "certified_email": "<string>",
    //     "phone": "<string>",
    //     "fax": "<string>",
    //     "notes": "<string>",
    //     "default_vat": {
    //       "id": "<integer>",
    //       "value": "<number>",
    //       "description": "<string>",
    //       "notes": "<string>",
    //       "e_invoice": "<boolean>",
    //       "ei_type": "<string>",
    //       "ei_description": "<string>",
    //       "editable": "<boolean>",
    //       "is_disabled": "<boolean>"
    //     },
    //     "default_payment_terms": "<integer>",
    //     "default_payment_terms_type": "standard",
    //     "default_payment_method": {
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "type": "standard",
    //       "is_default": "<boolean>",
    //       "default_payment_account": {
    //         "id": "<integer>",
    //         "name": "<string>",
    //         "type": "standard",
    //         "iban": "<string>",
    //         "sia": "<string>",
    //         "cuc": "<string>",
    //         "virtual": "<boolean>"
    //       },
    //       "details": [
    //         {
    //           "title": "<string>",
    //           "description": "<string>"
    //         },
    //         {
    //           "title": "<string>",
    //           "description": "<string>"
    //         }
    //       ],
    //       "bank_iban": "<string>",
    //       "bank_name": "<string>",
    //       "bank_beneficiary": "<string>",
    //       "ei_payment_method": "<string>"
    //     },
    //     "bank_name": "<string>",
    //     "bank_iban": "<string>",
    //     "bank_swift_code": "<string>",
    //     "shipping_address": "<string>",
    //     "e_invoice": "<boolean>",
    //     "ei_code": "<string>",
    //     "discount_highlight": "<boolean>",
    //     "default_discount": "<number>",
    //     "has_intent_declaration": "<boolean>",
    //     "intent_declaration_protocol_number": "<string>",
    //     "intent_declaration_protocol_date": "<date>",
    //     "created_at": "<string>",
    //     "updated_at": "<string>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var title: String?
    var description: String?

    var Id: String? = jResp.string(of: "data.id")
    var Code: String? = jResp.string(of: "data.code")
    var Name: String? = jResp.string(of: "data.name")
    var v_Type: String? = jResp.string(of: "data.type")
    var First_name: String? = jResp.string(of: "data.first_name")
    var Last_name: String? = jResp.string(of: "data.last_name")
    var Contact_person: String? = jResp.string(of: "data.contact_person")
    var Vat_number: String? = jResp.string(of: "data.vat_number")
    var Tax_code: String? = jResp.string(of: "data.tax_code")
    var Address_street: String? = jResp.string(of: "data.address_street")
    var Address_postal_code: String? = jResp.string(of: "data.address_postal_code")
    var Address_city: String? = jResp.string(of: "data.address_city")
    var Address_province: String? = jResp.string(of: "data.address_province")
    var Address_extra: String? = jResp.string(of: "data.address_extra")
    var Country: String? = jResp.string(of: "data.country")
    var v_Email: String? = jResp.string(of: "data.email")
    var Certified_email: String? = jResp.string(of: "data.certified_email")
    var Phone: String? = jResp.string(of: "data.phone")
    var Fax: String? = jResp.string(of: "data.fax")
    var Notes: String? = jResp.string(of: "data.notes")
    var Default_vatId: String? = jResp.string(of: "data.default_vat.id")
    var Value: String? = jResp.string(of: "data.default_vat.value")
    var Description: String? = jResp.string(of: "data.default_vat.description")
    var Default_vatNotes: String? = jResp.string(of: "data.default_vat.notes")
    var E_invoice: String? = jResp.string(of: "data.default_vat.e_invoice")
    var Ei_type: String? = jResp.string(of: "data.default_vat.ei_type")
    var Ei_description: String? = jResp.string(of: "data.default_vat.ei_description")
    var Editable: String? = jResp.string(of: "data.default_vat.editable")
    var Is_disabled: String? = jResp.string(of: "data.default_vat.is_disabled")
    var Default_payment_terms: String? = jResp.string(of: "data.default_payment_terms")
    var Default_payment_terms_type: String? = jResp.string(of: "data.default_payment_terms_type")
    var Default_payment_methodId: String? = jResp.string(of: "data.default_payment_method.id")
    var Default_payment_methodName: String? = jResp.string(of: "data.default_payment_method.name")
    var Default_payment_methodType: String? = jResp.string(of: "data.default_payment_method.type")
    var Is_default: String? = jResp.string(of: "data.default_payment_method.is_default")
    var Default_payment_accountId: String? = jResp.string(of: "data.default_payment_method.default_payment_account.id")
    var Default_payment_accountName: String? = jResp.string(of: "data.default_payment_method.default_payment_account.name")
    var Default_payment_accountType: String? = jResp.string(of: "data.default_payment_method.default_payment_account.type")
    var Iban: String? = jResp.string(of: "data.default_payment_method.default_payment_account.iban")
    var Sia: String? = jResp.string(of: "data.default_payment_method.default_payment_account.sia")
    var Cuc: String? = jResp.string(of: "data.default_payment_method.default_payment_account.cuc")
    var v_Virtual: String? = jResp.string(of: "data.default_payment_method.default_payment_account.virtual")
    var Bank_iban: String? = jResp.string(of: "data.default_payment_method.bank_iban")
    var Bank_name: String? = jResp.string(of: "data.default_payment_method.bank_name")
    var Bank_beneficiary: String? = jResp.string(of: "data.default_payment_method.bank_beneficiary")
    var Ei_payment_method: String? = jResp.string(of: "data.default_payment_method.ei_payment_method")
    var dataBank_name: String? = jResp.string(of: "data.bank_name")
    var dataBank_iban: String? = jResp.string(of: "data.bank_iban")
    var Bank_swift_code: String? = jResp.string(of: "data.bank_swift_code")
    var Shipping_address: String? = jResp.string(of: "data.shipping_address")
    var dataE_invoice: String? = jResp.string(of: "data.e_invoice")
    var Ei_code: String? = jResp.string(of: "data.ei_code")
    var Discount_highlight: String? = jResp.string(of: "data.discount_highlight")
    var Default_discount: String? = jResp.string(of: "data.default_discount")
    var Has_intent_declaration: String? = jResp.string(of: "data.has_intent_declaration")
    var Intent_declaration_protocol_number: String? = jResp.string(of: "data.intent_declaration_protocol_number")
    var Intent_declaration_protocol_date: String? = jResp.string(of: "data.intent_declaration_protocol_date")
    var Created_at: String? = jResp.string(of: "data.created_at")
    var Updated_at: String? = jResp.string(of: "data.updated_at")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data.default_payment_method.details").intValue
    while i < count_i {
        jResp.i = i
        title = jResp.string(of: "data.default_payment_method.details[i].title")
        description = jResp.string(of: "data.default_payment_method.details[i].description")
        i = i + 1
    }


}

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/entities/clients/:client_id

Postman Collection Item JSON

{
  "name": "Get Client",
  "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/entities/clients/:client_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "clients",
        ":client_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": "client_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the specified client."
  },
  "response": [
    {
      "name": "Client Details.",
      "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/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_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": "client_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"type\": null,\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"contact_person\": \"<string>\",\n    \"vat_number\": \"<string>\",\n    \"tax_code\": \"<string>\",\n    \"address_street\": \"<string>\",\n    \"address_postal_code\": \"<string>\",\n    \"address_city\": \"<string>\",\n    \"address_province\": \"<string>\",\n    \"address_extra\": \"<string>\",\n    \"country\": \"<string>\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"default_vat\": {\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    \"default_payment_terms\": \"<integer>\",\n    \"default_payment_terms_type\": \"standard\",\n    \"default_payment_method\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"is_default\": \"<boolean>\",\n      \"default_payment_account\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"details\": [\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        },\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"bank_iban\": \"<string>\",\n      \"bank_name\": \"<string>\",\n      \"bank_beneficiary\": \"<string>\",\n      \"ei_payment_method\": \"<string>\"\n    },\n    \"bank_name\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"bank_swift_code\": \"<string>\",\n    \"shipping_address\": \"<string>\",\n    \"e_invoice\": \"<boolean>\",\n    \"ei_code\": \"<string>\",\n    \"discount_highlight\": \"<boolean>\",\n    \"default_discount\": \"<number>\",\n    \"has_intent_declaration\": \"<boolean>\",\n    \"intent_declaration_protocol_number\": \"<string>\",\n    \"intent_declaration_protocol_date\": \"<date>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\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/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_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": "client_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/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_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": "client_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}