Chilkat Online Tools

Powershell / Fatture in Cloud API v2 - API Reference / Get Payment Method

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("fields","<string>")
$queryParams.UpdateString("fieldset","basic")

# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$http.SetRequestHeader("Accept","application/json")

$resp = $http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "data": {
#     "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>"
#   }
# }

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

$Id = $jResp.StringOf("data.id")
$Name = $jResp.StringOf("data.name")
$v_Type = $jResp.StringOf("data.type")
$Is_default = $jResp.StringOf("data.is_default")
$Default_payment_accountId = $jResp.StringOf("data.default_payment_account.id")
$Default_payment_accountName = $jResp.StringOf("data.default_payment_account.name")
$Default_payment_accountType = $jResp.StringOf("data.default_payment_account.type")
$Iban = $jResp.StringOf("data.default_payment_account.iban")
$Sia = $jResp.StringOf("data.default_payment_account.sia")
$Cuc = $jResp.StringOf("data.default_payment_account.cuc")
$v_Virtual = $jResp.StringOf("data.default_payment_account.virtual")
$Bank_iban = $jResp.StringOf("data.bank_iban")
$Bank_name = $jResp.StringOf("data.bank_name")
$Bank_beneficiary = $jResp.StringOf("data.bank_beneficiary")
$Ei_payment_method = $jResp.StringOf("data.ei_payment_method")
$i = 0
$count_i = $jResp.SizeOfArray("data.details")
while ($i -lt $count_i) {
    $jResp.I = $i
    $title = $jResp.StringOf("data.details[i].title")
    $description = $jResp.StringOf("data.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/settings/payment_methods/:payment_method_id

Postman Collection Item JSON

{
  "name": "Get Payment Method",
  "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/settings/payment_methods/:payment_method_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "settings",
        "payment_methods",
        ":payment_method_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": "payment_method_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the specified payment method."
  },
  "response": [
    {
      "name": "Example response",
      "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/settings/payment_methods/:payment_method_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "settings",
            "payment_methods",
            ":payment_method_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": "payment_method_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    \"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}"
    }
  ]
}