Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'date_from', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'date_to', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'year', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'type', 'all'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'payment_account_id', '<integer>'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api-v2.fattureincloud.it/c/:company_id/cashbook', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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>"
-- }
-- },
-- {
-- "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": {
-- "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
DECLARE @id nvarchar(4000)
DECLARE @date nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @kind nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @entity_name nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @Path nvarchar(4000)
DECLARE @amount_in nvarchar(4000)
DECLARE @payment_account_inId nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @payment_account_inType nvarchar(4000)
DECLARE @Iban nvarchar(4000)
DECLARE @Sia nvarchar(4000)
DECLARE @Cuc nvarchar(4000)
DECLARE @v_Virtual nvarchar(4000)
DECLARE @amount_out nvarchar(4000)
DECLARE @payment_account_outId nvarchar(4000)
DECLARE @payment_account_outName nvarchar(4000)
DECLARE @payment_account_outType nvarchar(4000)
DECLARE @payment_account_outIban nvarchar(4000)
DECLARE @payment_account_outSia nvarchar(4000)
DECLARE @payment_account_outCuc nvarchar(4000)
DECLARE @payment_account_outVirtual nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @date OUT, 'data[i].date'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @kind OUT, 'data[i].kind'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @entity_name OUT, 'data[i].entity_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data[i].document.id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data[i].document.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Path OUT, 'data[i].document.path'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_in OUT, 'data[i].amount_in'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_inId OUT, 'data[i].payment_account_in.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data[i].payment_account_in.name'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_inType OUT, 'data[i].payment_account_in.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Iban OUT, 'data[i].payment_account_in.iban'
EXEC sp_OAMethod @jResp, 'StringOf', @Sia OUT, 'data[i].payment_account_in.sia'
EXEC sp_OAMethod @jResp, 'StringOf', @Cuc OUT, 'data[i].payment_account_in.cuc'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Virtual OUT, 'data[i].payment_account_in.virtual'
EXEC sp_OAMethod @jResp, 'StringOf', @amount_out OUT, 'data[i].amount_out'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outId OUT, 'data[i].payment_account_out.id'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outName OUT, 'data[i].payment_account_out.name'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outType OUT, 'data[i].payment_account_out.type'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outIban OUT, 'data[i].payment_account_out.iban'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outSia OUT, 'data[i].payment_account_out.sia'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outCuc OUT, 'data[i].payment_account_out.cuc'
EXEC sp_OAMethod @jResp, 'StringOf', @payment_account_outVirtual OUT, 'data[i].payment_account_out.virtual'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
