Chilkat Online Tools

TCL / Fatture in Cloud API v2 - API Reference / Modify Supplier

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "data": {
#     "name": "<string>",
#     "id": "<integer>",
#     "code": "<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": "Italia",
#     "email": "<string>",
#     "certified_email": "<string>",
#     "phone": "<string>",
#     "fax": "<string>",
#     "notes": "<string>",
#     "bank_iban": "<string>",
#     "created_at": "<string>",
#     "updated_at": "<string>"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data.name" "<string>"
CkJsonObject_UpdateString $json "data.id" "<integer>"
CkJsonObject_UpdateString $json "data.code" "<string>"
CkJsonObject_UpdateNull $json "data.type"
CkJsonObject_UpdateString $json "data.first_name" "<string>"
CkJsonObject_UpdateString $json "data.last_name" "<string>"
CkJsonObject_UpdateString $json "data.contact_person" "<string>"
CkJsonObject_UpdateString $json "data.vat_number" "<string>"
CkJsonObject_UpdateString $json "data.tax_code" "<string>"
CkJsonObject_UpdateString $json "data.address_street" "<string>"
CkJsonObject_UpdateString $json "data.address_postal_code" "<string>"
CkJsonObject_UpdateString $json "data.address_city" "<string>"
CkJsonObject_UpdateString $json "data.address_province" "<string>"
CkJsonObject_UpdateString $json "data.address_extra" "<string>"
CkJsonObject_UpdateString $json "data.country" "Italia"
CkJsonObject_UpdateString $json "data.email" "<string>"
CkJsonObject_UpdateString $json "data.certified_email" "<string>"
CkJsonObject_UpdateString $json "data.phone" "<string>"
CkJsonObject_UpdateString $json "data.fax" "<string>"
CkJsonObject_UpdateString $json "data.notes" "<string>"
CkJsonObject_UpdateString $json "data.bank_iban" "<string>"
CkJsonObject_UpdateString $json "data.created_at" "<string>"
CkJsonObject_UpdateString $json "data.updated_at" "<string>"

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers/:supplier_id" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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>",
#     "bank_iban": "<string>",
#     "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

set Id [CkJsonObject_stringOf $jResp "data.id"]
set Code [CkJsonObject_stringOf $jResp "data.code"]
set Name [CkJsonObject_stringOf $jResp "data.name"]
set v_Type [CkJsonObject_stringOf $jResp "data.type"]
set First_name [CkJsonObject_stringOf $jResp "data.first_name"]
set Last_name [CkJsonObject_stringOf $jResp "data.last_name"]
set Contact_person [CkJsonObject_stringOf $jResp "data.contact_person"]
set Vat_number [CkJsonObject_stringOf $jResp "data.vat_number"]
set Tax_code [CkJsonObject_stringOf $jResp "data.tax_code"]
set Address_street [CkJsonObject_stringOf $jResp "data.address_street"]
set Address_postal_code [CkJsonObject_stringOf $jResp "data.address_postal_code"]
set Address_city [CkJsonObject_stringOf $jResp "data.address_city"]
set Address_province [CkJsonObject_stringOf $jResp "data.address_province"]
set Address_extra [CkJsonObject_stringOf $jResp "data.address_extra"]
set Country [CkJsonObject_stringOf $jResp "data.country"]
set v_Email [CkJsonObject_stringOf $jResp "data.email"]
set Certified_email [CkJsonObject_stringOf $jResp "data.certified_email"]
set Phone [CkJsonObject_stringOf $jResp "data.phone"]
set Fax [CkJsonObject_stringOf $jResp "data.fax"]
set Notes [CkJsonObject_stringOf $jResp "data.notes"]
set Bank_iban [CkJsonObject_stringOf $jResp "data.bank_iban"]
set Created_at [CkJsonObject_stringOf $jResp "data.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "data.updated_at"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "name": "<string>",
    "id": "<integer>",
    "code": "<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": "Italia",
    "email": "<string>",
    "certified_email": "<string>",
    "phone": "<string>",
    "fax": "<string>",
    "notes": "<string>",
    "bank_iban": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers/:supplier_id

Postman Collection Item JSON

{
  "name": "Modify Supplier",
  "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": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"code\": \"<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\": \"Italia\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "suppliers",
        ":supplier_id"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "supplier_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Modifies the specified supplier."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"code\": \"<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\": \"Italia\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers",
            ":supplier_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "supplier_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    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"code\": \"<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\": \"Italia\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers",
            ":supplier_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "supplier_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"code\": \"<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\": \"Italia\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/suppliers/:supplier_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers",
            ":supplier_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "supplier_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}