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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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>"
-- }
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.id', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.date', '<date>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.description', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.kind', 'received_document'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.type', 'in'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.entity_name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.document.id', '<integer>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.document.type', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.document.path', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.amount_in', '<number>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.id', '<integer>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.type', 'standard'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.iban', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.sia', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.cuc', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_in.virtual', '<boolean>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.amount_out', '<number>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.id', '<integer>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.type', 'standard'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.iban', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.sia', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.cuc', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data.payment_account_out.virtual', '<boolean>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api-v2.fattureincloud.it/c/:company_id/cashbook/:document_id', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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 @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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 @json
EXEC @hr = sp_OADestroy @sbRequestBody
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": "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
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @Date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Date OUT, 'data.date'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'data.description'
DECLARE @Kind nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Kind OUT, 'data.kind'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'data.type'
DECLARE @Entity_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Entity_name OUT, 'data.entity_name'
DECLARE @DocumentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DocumentId OUT, 'data.document.id'
DECLARE @DocumentType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DocumentType OUT, 'data.document.type'
DECLARE @Path nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Path OUT, 'data.document.path'
DECLARE @Amount_in nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount_in OUT, 'data.amount_in'
DECLARE @Payment_account_inId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_inId OUT, 'data.payment_account_in.id'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data.payment_account_in.name'
DECLARE @Payment_account_inType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_inType OUT, 'data.payment_account_in.type'
DECLARE @Iban nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Iban OUT, 'data.payment_account_in.iban'
DECLARE @Sia nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Sia OUT, 'data.payment_account_in.sia'
DECLARE @Cuc nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Cuc OUT, 'data.payment_account_in.cuc'
DECLARE @v_Virtual nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Virtual OUT, 'data.payment_account_in.virtual'
DECLARE @Amount_out nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount_out OUT, 'data.amount_out'
DECLARE @Payment_account_outId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outId OUT, 'data.payment_account_out.id'
DECLARE @Payment_account_outName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outName OUT, 'data.payment_account_out.name'
DECLARE @Payment_account_outType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outType OUT, 'data.payment_account_out.type'
DECLARE @Payment_account_outIban nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outIban OUT, 'data.payment_account_out.iban'
DECLARE @Payment_account_outSia nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outSia OUT, 'data.payment_account_out.sia'
DECLARE @Payment_account_outCuc nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outCuc OUT, 'data.payment_account_out.cuc'
DECLARE @Payment_account_outVirtual nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_account_outVirtual OUT, 'data.payment_account_out.virtual'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
