Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
// 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",
// "is_default": "<boolean>",
// "default_payment_account": {
// "name": "<string>",
// "id": "<integer>",
// "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>"
// }
// }
CkJsonObject json;
json.UpdateString("data.name","<string>");
json.UpdateString("data.id","<integer>");
json.UpdateString("data.type","standard");
json.UpdateString("data.is_default","<boolean>");
json.UpdateString("data.default_payment_account.name","<string>");
json.UpdateString("data.default_payment_account.id","<integer>");
json.UpdateString("data.default_payment_account.type","standard");
json.UpdateString("data.default_payment_account.iban","<string>");
json.UpdateString("data.default_payment_account.sia","<string>");
json.UpdateString("data.default_payment_account.cuc","<string>");
json.UpdateString("data.default_payment_account.virtual","<boolean>");
json.UpdateString("data.details[0].title","<string>");
json.UpdateString("data.details[0].description","<string>");
json.UpdateString("data.details[1].title","<string>");
json.UpdateString("data.details[1].description","<string>");
json.UpdateString("data.bank_iban","<string>");
json.UpdateString("data.bank_name","<string>");
json.UpdateString("data.bank_beneficiary","<string>");
json.UpdateString("data.ei_payment_method","<string>");
http.SetRequestHeader("Content-Type","application/json");
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbRequestBody;
json.EmitSb(sbRequestBody);
CkHttpResponse *resp = http.PTextSb("PUT","https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id",sbRequestBody,"utf-8","application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *title = 0;
const char *description = 0;
const char *Id = jResp.stringOf("data.id");
const char *Name = jResp.stringOf("data.name");
const char *v_Type = jResp.stringOf("data.type");
const char *Is_default = jResp.stringOf("data.is_default");
const char *Default_payment_accountId = jResp.stringOf("data.default_payment_account.id");
const char *Default_payment_accountName = jResp.stringOf("data.default_payment_account.name");
const char *Default_payment_accountType = jResp.stringOf("data.default_payment_account.type");
const char *Iban = jResp.stringOf("data.default_payment_account.iban");
const char *Sia = jResp.stringOf("data.default_payment_account.sia");
const char *Cuc = jResp.stringOf("data.default_payment_account.cuc");
const char *v_Virtual = jResp.stringOf("data.default_payment_account.virtual");
const char *Bank_iban = jResp.stringOf("data.bank_iban");
const char *Bank_name = jResp.stringOf("data.bank_name");
const char *Bank_beneficiary = jResp.stringOf("data.bank_beneficiary");
const char *Ei_payment_method = jResp.stringOf("data.ei_payment_method");
int i = 0;
int count_i = jResp.SizeOfArray("data.details");
while (i < count_i) {
jResp.put_I(i);
title = jResp.stringOf("data.details[i].title");
description = jResp.stringOf("data.details[i].description");
i = i + 1;
}
}
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",
"is_default": "<boolean>",
"default_payment_account": {
"name": "<string>",
"id": "<integer>",
"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>"
}
}'
https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id
Postman Collection Item JSON
{
"name": "Modify 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": "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 \"is_default\": \"<boolean>\",\n \"default_payment_account\": {\n \"name\": \"<string>\",\n \"id\": \"<integer>\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/settings/payment_methods/:payment_method_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"settings",
"payment_methods",
":payment_method_id"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "payment_method_id",
"value": "<integer>"
}
]
},
"description": "Modifies the specified payment method."
},
"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 \"is_default\": \"<boolean>\",\n \"default_payment_account\": {\n \"name\": \"<string>\",\n \"id\": \"<integer>\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/settings/payment_methods/:payment_method_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"settings",
"payment_methods",
":payment_method_id"
],
"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}"
}
]
}
