Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcName
LOCAL lcV_type
LOCAL lcIs_default
LOCAL lcId
LOCAL lcName
LOCAL lcV_Type
LOCAL lcIban
LOCAL lcSia
LOCAL lcCuc
LOCAL lcV_Virtual
LOCAL lcBank_iban
LOCAL lcBank_name
LOCAL lcBank_beneficiary
LOCAL lcEi_payment_method
LOCAL j
LOCAL lnCount_j
LOCAL lcTitle
LOCAL lcDescription
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("fields","<string>")
loQueryParams.UpdateString("fieldset","basic")
loQueryParams.UpdateString("sort","<string>")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/info/payment_methods",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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 loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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>"
* },
* {
* "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
i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data[i].id")
lcName = loJResp.StringOf("data[i].name")
lcV_type = loJResp.StringOf("data[i].type")
lcIs_default = loJResp.StringOf("data[i].is_default")
lcId = loJResp.StringOf("data[i].default_payment_account.id")
lcName = loJResp.StringOf("data[i].default_payment_account.name")
lcV_Type = loJResp.StringOf("data[i].default_payment_account.type")
lcIban = loJResp.StringOf("data[i].default_payment_account.iban")
lcSia = loJResp.StringOf("data[i].default_payment_account.sia")
lcCuc = loJResp.StringOf("data[i].default_payment_account.cuc")
lcV_Virtual = loJResp.StringOf("data[i].default_payment_account.virtual")
lcBank_iban = loJResp.StringOf("data[i].bank_iban")
lcBank_name = loJResp.StringOf("data[i].bank_name")
lcBank_beneficiary = loJResp.StringOf("data[i].bank_beneficiary")
lcEi_payment_method = loJResp.StringOf("data[i].ei_payment_method")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].details")
DO WHILE j < lnCount_j
loJResp.J = j
lcTitle = loJResp.StringOf("data[i].details[j].title")
lcDescription = loJResp.StringOf("data[i].details[j].description")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-d "sort=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/info/payment_methods
Postman Collection Item JSON
{
"name": "List Payment Methods",
"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/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"info",
"payment_methods"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the available payment methods."
},
"response": [
{
"name": "Payment methods list.",
"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/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"info",
"payment_methods"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\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 {\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 ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"info",
"payment_methods"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/info/payment_methods?fields=<string>&fieldset=basic&sort=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"info",
"payment_methods"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
