Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sTitle
String sDescription
String sId
String sName
String sV_Type
String sIs_default
String sDefault_payment_accountId
String sDefault_payment_accountName
String sDefault_payment_accountType
String sIban
String sSia
String sCuc
String sV_Virtual
String sBank_iban
String sBank_name
String sBank_beneficiary
String sEi_payment_method
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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>"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "data.name" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.id" "<integer>" To iSuccess
Get ComUpdateString Of hoJson "data.type" "standard" To iSuccess
Get ComUpdateString Of hoJson "data.is_default" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.name" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.id" "<integer>" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.type" "standard" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.iban" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.sia" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.cuc" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_payment_account.virtual" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.details[0].title" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.details[0].description" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.details[1].title" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.details[1].description" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.bank_iban" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.bank_name" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.bank_beneficiary" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.ei_payment_method" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://api-v2.fattureincloud.it/c/:company_id/settings/payment_methods/:payment_method_id" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "data.id" To sId
Get ComStringOf Of hoJResp "data.name" To sName
Get ComStringOf Of hoJResp "data.type" To sV_Type
Get ComStringOf Of hoJResp "data.is_default" To sIs_default
Get ComStringOf Of hoJResp "data.default_payment_account.id" To sDefault_payment_accountId
Get ComStringOf Of hoJResp "data.default_payment_account.name" To sDefault_payment_accountName
Get ComStringOf Of hoJResp "data.default_payment_account.type" To sDefault_payment_accountType
Get ComStringOf Of hoJResp "data.default_payment_account.iban" To sIban
Get ComStringOf Of hoJResp "data.default_payment_account.sia" To sSia
Get ComStringOf Of hoJResp "data.default_payment_account.cuc" To sCuc
Get ComStringOf Of hoJResp "data.default_payment_account.virtual" To sV_Virtual
Get ComStringOf Of hoJResp "data.bank_iban" To sBank_iban
Get ComStringOf Of hoJResp "data.bank_name" To sBank_name
Get ComStringOf Of hoJResp "data.bank_beneficiary" To sBank_beneficiary
Get ComStringOf Of hoJResp "data.ei_payment_method" To sEi_payment_method
Move 0 To i
Get ComSizeOfArray Of hoJResp "data.details" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data.details[i].title" To sTitle
Get ComStringOf Of hoJResp "data.details[i].description" To sDescription
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
