Chilkat Online Tools

lianja / Fatture in Cloud API v2 - API Reference / Modify Payment Account

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")

// 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>",
//     "type": "standard",
//     "iban": "<string>",
//     "sia": "<string>",
//     "cuc": "<string>",
//     "virtual": "<boolean>"
//   }
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("data.name","<string>")
loJson.UpdateString("data.id","<integer>")
loJson.UpdateString("data.type","standard")
loJson.UpdateString("data.iban","<string>")
loJson.UpdateString("data.sia","<string>")
loJson.UpdateString("data.cuc","<string>")
loJson.UpdateString("data.virtual","<boolean>")

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

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://api-v2.fattureincloud.it/c/:company_id/settings/payment_accounts/:payment_account_id",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

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

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

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

release loResp

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

// {
//   "data": {
//     "id": "<integer>",
//     "name": "<string>",
//     "type": "standard",
//     "iban": "<string>",
//     "sia": "<string>",
//     "cuc": "<string>",
//     "virtual": "<boolean>"
//   }
// }

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

lcId = loJResp.StringOf("data.id")
lcName = loJResp.StringOf("data.name")
lcV_Type = loJResp.StringOf("data.type")
lcIban = loJResp.StringOf("data.iban")
lcSia = loJResp.StringOf("data.sia")
lcCuc = loJResp.StringOf("data.cuc")
lcV_Virtual = loJResp.StringOf("data.virtual")


release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp

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>",
    "type": "standard",
    "iban": "<string>",
    "sia": "<string>",
    "cuc": "<string>",
    "virtual": "<boolean>"
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/settings/payment_accounts/:payment_account_id

Postman Collection Item JSON

{
  "name": "Modify Payment Account",
  "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    \"type\": \"standard\",\n    \"iban\": \"<string>\",\n    \"sia\": \"<string>\",\n    \"cuc\": \"<string>\",\n    \"virtual\": \"<boolean>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/settings/payment_accounts/:payment_account_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "settings",
        "payment_accounts",
        ":payment_account_id"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "payment_account_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Modifies the specified payment account."
  },
  "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    \"type\": \"standard\",\n    \"iban\": \"<string>\",\n    \"sia\": \"<string>\",\n    \"cuc\": \"<string>\",\n    \"virtual\": \"<boolean>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/settings/payment_accounts/:payment_account_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "settings",
            "payment_accounts",
            ":payment_account_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "payment_account_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"type\": \"standard\",\n    \"iban\": \"<string>\",\n    \"sia\": \"<string>\",\n    \"cuc\": \"<string>\",\n    \"virtual\": \"<boolean>\"\n  }\n}"
    }
  ]
}