Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": "received_document",
; "type": "in",
; "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>"
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.id","<string>")
CkJsonObject::ckUpdateString(json,"data.date","<date>")
CkJsonObject::ckUpdateString(json,"data.description","<string>")
CkJsonObject::ckUpdateString(json,"data.kind","received_document")
CkJsonObject::ckUpdateString(json,"data.type","in")
CkJsonObject::ckUpdateString(json,"data.entity_name","<string>")
CkJsonObject::ckUpdateString(json,"data.document.id","<integer>")
CkJsonObject::ckUpdateString(json,"data.document.type","<string>")
CkJsonObject::ckUpdateString(json,"data.document.path","<string>")
CkJsonObject::ckUpdateString(json,"data.amount_in","<number>")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.name","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.id","<integer>")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.type","standard")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.iban","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.sia","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.cuc","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_in.virtual","<boolean>")
CkJsonObject::ckUpdateString(json,"data.amount_out","<number>")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.name","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.id","<integer>")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.type","standard")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.iban","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.sia","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.cuc","<string>")
CkJsonObject::ckUpdateString(json,"data.payment_account_out.virtual","<boolean>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api-v2.fattureincloud.it/c/:company_id/cashbook/:document_id",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "id": "<string>",
; "date": "<date>",
; "description": "<string>",
; "kind": "received_document",
; "type": "out",
; "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
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
Date.s = CkJsonObject::ckStringOf(jResp,"data.date")
Description.s = CkJsonObject::ckStringOf(jResp,"data.description")
Kind.s = CkJsonObject::ckStringOf(jResp,"data.kind")
v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
Entity_name.s = CkJsonObject::ckStringOf(jResp,"data.entity_name")
DocumentId.s = CkJsonObject::ckStringOf(jResp,"data.document.id")
DocumentType.s = CkJsonObject::ckStringOf(jResp,"data.document.type")
Path.s = CkJsonObject::ckStringOf(jResp,"data.document.path")
Amount_in.s = CkJsonObject::ckStringOf(jResp,"data.amount_in")
Payment_account_inId.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.id")
Name.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.name")
Payment_account_inType.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.type")
Iban.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.iban")
Sia.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.sia")
Cuc.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.cuc")
v_Virtual.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_in.virtual")
Amount_out.s = CkJsonObject::ckStringOf(jResp,"data.amount_out")
Payment_account_outId.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.id")
Payment_account_outName.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.name")
Payment_account_outType.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.type")
Payment_account_outIban.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.iban")
Payment_account_outSia.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.sia")
Payment_account_outCuc.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.cuc")
Payment_account_outVirtual.s = CkJsonObject::ckStringOf(jResp,"data.payment_account_out.virtual")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"date": "<date>",
"description": "<string>",
"kind": "received_document",
"type": "in",
"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/:document_id
Postman Collection Item JSON
{
"name": "Modify 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": "PUT",
"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\": \"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 \"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/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<string>"
}
]
},
"description": "Modifies the specified cashbook entry."
},
"response": [
{
"name": "The modified Cashbook Entry",
"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 \"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 \"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/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_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\": \"received_document\",\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 \"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": "PUT",
"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\": \"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 \"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/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"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\": \"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 \"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/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"cashbook",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
