Chilkat Online Tools

Foxpro / Fatture in Cloud API v2 - API Reference / Create Cashbook Entry

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcDate
LOCAL lcDescription
LOCAL lcKind
LOCAL lcV_Type
LOCAL lcEntity_name
LOCAL lcDocumentId
LOCAL lcDocumentType
LOCAL lcPath
LOCAL lcAmount_in
LOCAL lcPayment_account_inId
LOCAL lcName
LOCAL lcPayment_account_inType
LOCAL lcIban
LOCAL lcSia
LOCAL lcCuc
LOCAL lcV_Virtual
LOCAL lcAmount_out
LOCAL lcPayment_account_outId
LOCAL lcPayment_account_outName
LOCAL lcPayment_account_outType
LOCAL lcPayment_account_outIban
LOCAL lcPayment_account_outSia
LOCAL lcPayment_account_outCuc
LOCAL lcPayment_account_outVirtual

* 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')

* 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": {
*     "id": "<string>",
*     "date": "<date>",
*     "description": "<string>",
*     "kind": "receipt",
*     "type": "out",
*     "entity_name": "<string>",
*     "document": {
*       "id": "<integer>",
*       "type": "<string>",
*       "path": "<string>"
*     },
*     "amount_in": "<number>",
*     "payment_account_in": {
*       "name": "<string>",
*       "id": "<integer>",
*       "type": "standard",
*       "iban": "<string>",
*       "sia": "<string>",
*       "cuc": "<string>",
*       "virtual": "<boolean>"
*     },
*     "amount_out": "<number>",
*     "payment_account_out": {
*       "name": "<string>",
*       "id": "<integer>",
*       "type": "standard",
*       "iban": "<string>",
*       "sia": "<string>",
*       "cuc": "<string>",
*       "virtual": "<boolean>"
*     }
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("data.id","<string>")
loJson.UpdateString("data.date","<date>")
loJson.UpdateString("data.description","<string>")
loJson.UpdateString("data.kind","receipt")
loJson.UpdateString("data.type","out")
loJson.UpdateString("data.entity_name","<string>")
loJson.UpdateString("data.document.id","<integer>")
loJson.UpdateString("data.document.type","<string>")
loJson.UpdateString("data.document.path","<string>")
loJson.UpdateString("data.amount_in","<number>")
loJson.UpdateString("data.payment_account_in.name","<string>")
loJson.UpdateString("data.payment_account_in.id","<integer>")
loJson.UpdateString("data.payment_account_in.type","standard")
loJson.UpdateString("data.payment_account_in.iban","<string>")
loJson.UpdateString("data.payment_account_in.sia","<string>")
loJson.UpdateString("data.payment_account_in.cuc","<string>")
loJson.UpdateString("data.payment_account_in.virtual","<boolean>")
loJson.UpdateString("data.amount_out","<number>")
loJson.UpdateString("data.payment_account_out.name","<string>")
loJson.UpdateString("data.payment_account_out.id","<integer>")
loJson.UpdateString("data.payment_account_out.type","standard")
loJson.UpdateString("data.payment_account_out.iban","<string>")
loJson.UpdateString("data.payment_account_out.sia","<string>")
loJson.UpdateString("data.payment_account_out.cuc","<string>")
loJson.UpdateString("data.payment_account_out.virtual","<boolean>")

loHttp.SetRequestHeader("Content-Type","application/json")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.PostJson3("https://api-v2.fattureincloud.it/c/:company_id/cashbook","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    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 loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "data": {
*     "id": "<string>",
*     "date": "<date>",
*     "description": "<string>",
*     "kind": "tax",
*     "type": "in",
*     "entity_name": "<string>",
*     "document": {
*       "id": "<integer>",
*       "type": "<string>",
*       "path": "<string>"
*     },
*     "amount_in": "<number>",
*     "payment_account_in": {
*       "id": "<integer>",
*       "name": "<string>",
*       "type": "standard",
*       "iban": "<string>",
*       "sia": "<string>",
*       "cuc": "<string>",
*       "virtual": "<boolean>"
*     },
*     "amount_out": "<number>",
*     "payment_account_out": {
*       "id": "<integer>",
*       "name": "<string>",
*       "type": "standard",
*       "iban": "<string>",
*       "sia": "<string>",
*       "cuc": "<string>",
*       "virtual": "<boolean>"
*     }
*   }
* }

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

lcId = loJResp.StringOf("data.id")
lcDate = loJResp.StringOf("data.date")
lcDescription = loJResp.StringOf("data.description")
lcKind = loJResp.StringOf("data.kind")
lcV_Type = loJResp.StringOf("data.type")
lcEntity_name = loJResp.StringOf("data.entity_name")
lcDocumentId = loJResp.StringOf("data.document.id")
lcDocumentType = loJResp.StringOf("data.document.type")
lcPath = loJResp.StringOf("data.document.path")
lcAmount_in = loJResp.StringOf("data.amount_in")
lcPayment_account_inId = loJResp.StringOf("data.payment_account_in.id")
lcName = loJResp.StringOf("data.payment_account_in.name")
lcPayment_account_inType = loJResp.StringOf("data.payment_account_in.type")
lcIban = loJResp.StringOf("data.payment_account_in.iban")
lcSia = loJResp.StringOf("data.payment_account_in.sia")
lcCuc = loJResp.StringOf("data.payment_account_in.cuc")
lcV_Virtual = loJResp.StringOf("data.payment_account_in.virtual")
lcAmount_out = loJResp.StringOf("data.amount_out")
lcPayment_account_outId = loJResp.StringOf("data.payment_account_out.id")
lcPayment_account_outName = loJResp.StringOf("data.payment_account_out.name")
lcPayment_account_outType = loJResp.StringOf("data.payment_account_out.type")
lcPayment_account_outIban = loJResp.StringOf("data.payment_account_out.iban")
lcPayment_account_outSia = loJResp.StringOf("data.payment_account_out.sia")
lcPayment_account_outCuc = loJResp.StringOf("data.payment_account_out.cuc")
lcPayment_account_outVirtual = loJResp.StringOf("data.payment_account_out.virtual")

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "id": "<string>",
    "date": "<date>",
    "description": "<string>",
    "kind": "receipt",
    "type": "out",
    "entity_name": "<string>",
    "document": {
      "id": "<integer>",
      "type": "<string>",
      "path": "<string>"
    },
    "amount_in": "<number>",
    "payment_account_in": {
      "name": "<string>",
      "id": "<integer>",
      "type": "standard",
      "iban": "<string>",
      "sia": "<string>",
      "cuc": "<string>",
      "virtual": "<boolean>"
    },
    "amount_out": "<number>",
    "payment_account_out": {
      "name": "<string>",
      "id": "<integer>",
      "type": "standard",
      "iban": "<string>",
      "sia": "<string>",
      "cuc": "<string>",
      "virtual": "<boolean>"
    }
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/cashbook

Postman Collection Item JSON

{
  "name": "Create Cashbook Entry",
  "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": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"receipt\",\n    \"type\": \"out\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/cashbook",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "cashbook"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a new cashbook entry."
  },
  "response": [
    {
      "name": "The created Cashbook Entry.",
      "originalRequest": {
        "method": "POST",
        "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    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"receipt\",\n    \"type\": \"out\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/cashbook",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\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}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"receipt\",\n    \"type\": \"out\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/cashbook",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"receipt\",\n    \"type\": \"out\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\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      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/cashbook",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}