Chilkat Online Tools

PHP (Extension) / Fatture in Cloud API v2 - API Reference / List Cashbook Entries

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

$queryParams->UpdateString('date_from','<string>');$queryParams->UpdateString('date_to','<string>');$queryParams->UpdateString('year','<integer>');$queryParams->UpdateString('type','all');$queryParams->UpdateString('payment_account_id','<integer>');$http->put_AuthToken('<access_token>');$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_I($i);$id = $jResp->stringOf('data[i].id');$date = $jResp->stringOf('data[i].date');$description = $jResp->stringOf('data[i].description');$kind = $jResp->stringOf('data[i].kind');$v_type = $jResp->stringOf('data[i].type');$entity_name = $jResp->stringOf('data[i].entity_name');$Id = $jResp->stringOf('data[i].document.id');$v_Type = $jResp->stringOf('data[i].document.type');$Path = $jResp->stringOf('data[i].document.path');$amount_in = $jResp->stringOf('data[i].amount_in');$payment_account_inId = $jResp->stringOf('data[i].payment_account_in.id');$Name = $jResp->stringOf('data[i].payment_account_in.name');$payment_account_inType = $jResp->stringOf('data[i].payment_account_in.type');$Iban = $jResp->stringOf('data[i].payment_account_in.iban');$Sia = $jResp->stringOf('data[i].payment_account_in.sia');$Cuc = $jResp->stringOf('data[i].payment_account_in.cuc');$v_Virtual = $jResp->stringOf('data[i].payment_account_in.virtual');$amount_out = $jResp->stringOf('data[i].amount_out');$payment_account_outId = $jResp->stringOf('data[i].payment_account_out.id');$payment_account_outName = $jResp->stringOf('data[i].payment_account_out.name');$payment_account_outType = $jResp->stringOf('data[i].payment_account_out.type');$payment_account_outIban = $jResp->stringOf('data[i].payment_account_out.iban');$payment_account_outSia = $jResp->stringOf('data[i].payment_account_out.sia');$payment_account_outCuc = $jResp->stringOf('data[i].payment_account_out.cuc');$payment_account_outVirtual = $jResp->stringOf('data[i].payment_account_out.virtual');$i = $i + 1;
?>

Curl Command

curl -G -d "date_from=%3Cstring%3E"
	-d "date_to=%3Cstring%3E"
	-d "year=%3Cinteger%3E"
	-d "type=all"
	-d "payment_account_id=%3Cinteger%3E"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/cashbook

Postman Collection Item JSON

{
  "name": "List Cashbook Entries",
  "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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "cashbook"
      ],
      "query": [
        {
          "key": "date_from",
          "value": "<string>",
          "description": "(Required) Start date."
        },
        {
          "key": "date_to",
          "value": "<string>",
          "description": "(Required) End date."
        },
        {
          "key": "year",
          "value": "<integer>",
          "description": "Filter cashbook by year."
        },
        {
          "key": "type",
          "value": "all",
          "description": "Filter cashbook by type."
        },
        {
          "key": "payment_account_id",
          "value": "<integer>",
          "description": "Filter by payment account."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists the cashbook entries."
  },
  "response": [
    {
      "name": "Results 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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook"
          ],
          "query": [
            {
              "key": "date_from",
              "value": "<string>",
              "description": "(Required) Start date."
            },
            {
              "key": "date_to",
              "value": "<string>",
              "description": "(Required) End date."
            },
            {
              "key": "year",
              "value": "<integer>",
              "description": "Filter cashbook by year."
            },
            {
              "key": "type",
              "value": "all",
              "description": "Filter cashbook by type."
            },
            {
              "key": "payment_account_id",
              "value": "<integer>",
              "description": "Filter by payment account."
            }
          ],
          "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\": \"<string>\",\n      \"date\": \"<date>\",\n      \"description\": \"<string>\",\n      \"kind\": \"tax\",\n      \"type\": \"in\",\n      \"entity_name\": \"<string>\",\n      \"document\": {\n        \"id\": \"<integer>\",\n        \"type\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"amount_in\": \"<number>\",\n      \"payment_account_in\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"amount_out\": \"<number>\",\n      \"payment_account_out\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"date\": \"<date>\",\n      \"description\": \"<string>\",\n      \"kind\": \"received_document\",\n      \"type\": \"in\",\n      \"entity_name\": \"<string>\",\n      \"document\": {\n        \"id\": \"<integer>\",\n        \"type\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"amount_in\": \"<number>\",\n      \"payment_account_in\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"amount_out\": \"<number>\",\n      \"payment_account_out\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      }\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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook"
          ],
          "query": [
            {
              "key": "date_from",
              "value": "<string>",
              "description": "(Required) Start date."
            },
            {
              "key": "date_to",
              "value": "<string>",
              "description": "(Required) End date."
            },
            {
              "key": "year",
              "value": "<integer>",
              "description": "Filter cashbook by year."
            },
            {
              "key": "type",
              "value": "all",
              "description": "Filter cashbook by type."
            },
            {
              "key": "payment_account_id",
              "value": "<integer>",
              "description": "Filter by payment account."
            }
          ],
          "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/cashbook?date_from=<string>&date_to=<string>&year=<integer>&type=all&payment_account_id=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook"
          ],
          "query": [
            {
              "key": "date_from",
              "value": "<string>",
              "description": "(Required) Start date."
            },
            {
              "key": "date_to",
              "value": "<string>",
              "description": "(Required) End date."
            },
            {
              "key": "year",
              "value": "<integer>",
              "description": "Filter cashbook by year."
            },
            {
              "key": "type",
              "value": "all",
              "description": "Filter cashbook by type."
            },
            {
              "key": "payment_account_id",
              "value": "<integer>",
              "description": "Filter by payment account."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}