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
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'type', 'passive_delivery_note'
-- 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/received_documents/info', @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
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 @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": {
-- "default_values": {
-- "detailed": "<boolean>"
-- },
-- "items_default_values": {
-- "vat": "<number>"
-- },
-- "countries_list": [
-- "<string>",
-- "<string>"
-- ],
-- "currencies_list": [
-- {
-- "id": "<string>",
-- "symbol": "<string>",
-- "exchange_rate": "<string>",
-- "html_symbol": "<string>"
-- },
-- {
-- "id": "<string>",
-- "symbol": "<string>",
-- "exchange_rate": "<string>",
-- "html_symbol": "<string>"
-- }
-- ],
-- "categories_list": [
-- "<string>",
-- "<string>"
-- ],
-- "payment_accounts_list": [
-- {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- },
-- {
-- "id": "<integer>",
-- "name": "<string>",
-- "type": "standard",
-- "iban": "<string>",
-- "sia": "<string>",
-- "cuc": "<string>",
-- "virtual": "<boolean>"
-- }
-- ],
-- "vat_types_list": [
-- {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- },
-- {
-- "id": "<integer>",
-- "value": "<number>",
-- "description": "<string>",
-- "notes": "<string>",
-- "e_invoice": "<boolean>",
-- "ei_type": "<string>",
-- "ei_description": "<string>",
-- "editable": "<boolean>",
-- "is_disabled": "<boolean>"
-- }
-- ]
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @strVal nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @symbol nvarchar(4000)
DECLARE @exchange_rate nvarchar(4000)
DECLARE @html_symbol nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @iban nvarchar(4000)
DECLARE @sia nvarchar(4000)
DECLARE @cuc nvarchar(4000)
DECLARE @v_virtual nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @notes nvarchar(4000)
DECLARE @e_invoice nvarchar(4000)
DECLARE @ei_type nvarchar(4000)
DECLARE @ei_description nvarchar(4000)
DECLARE @editable nvarchar(4000)
DECLARE @is_disabled nvarchar(4000)
DECLARE @Detailed nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Detailed OUT, 'data.default_values.detailed'
DECLARE @Vat nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat OUT, 'data.items_default_values.vat'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.countries_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'data.countries_list[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.currencies_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data.currencies_list[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @symbol OUT, 'data.currencies_list[i].symbol'
EXEC sp_OAMethod @jResp, 'StringOf', @exchange_rate OUT, 'data.currencies_list[i].exchange_rate'
EXEC sp_OAMethod @jResp, 'StringOf', @html_symbol OUT, 'data.currencies_list[i].html_symbol'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.categories_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'data.categories_list[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.payment_accounts_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data.payment_accounts_list[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'data.payment_accounts_list[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'data.payment_accounts_list[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @iban OUT, 'data.payment_accounts_list[i].iban'
EXEC sp_OAMethod @jResp, 'StringOf', @sia OUT, 'data.payment_accounts_list[i].sia'
EXEC sp_OAMethod @jResp, 'StringOf', @cuc OUT, 'data.payment_accounts_list[i].cuc'
EXEC sp_OAMethod @jResp, 'StringOf', @v_virtual OUT, 'data.payment_accounts_list[i].virtual'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.vat_types_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data.vat_types_list[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'data.vat_types_list[i].value'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data.vat_types_list[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @notes OUT, 'data.vat_types_list[i].notes'
EXEC sp_OAMethod @jResp, 'StringOf', @e_invoice OUT, 'data.vat_types_list[i].e_invoice'
EXEC sp_OAMethod @jResp, 'StringOf', @ei_type OUT, 'data.vat_types_list[i].ei_type'
EXEC sp_OAMethod @jResp, 'StringOf', @ei_description OUT, 'data.vat_types_list[i].ei_description'
EXEC sp_OAMethod @jResp, 'StringOf', @editable OUT, 'data.vat_types_list[i].editable'
EXEC sp_OAMethod @jResp, 'StringOf', @is_disabled OUT, 'data.vat_types_list[i].is_disabled'
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 "type=passive_delivery_note"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/received_documents/info
Postman Collection Item JSON
{
"name": "Get Received Document Pre-Create Info",
"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/received_documents/info?type=passive_delivery_note",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
"info"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Retrieves the information useful while creating a new document."
},
"response": [
{
"name": "Pre-create info",
"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/received_documents/info?type=passive_delivery_note",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
"info"
],
"query": [
{
"key": "type",
"value": "passive_delivery_note",
"description": "(Required) The type of the received document."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"default_values\": {\n \"detailed\": \"<boolean>\"\n },\n \"items_default_values\": {\n \"vat\": \"<number>\"\n },\n \"countries_list\": [\n \"<string>\",\n \"<string>\"\n ],\n \"currencies_list\": [\n {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n },\n {\n \"id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"exchange_rate\": \"<string>\",\n \"html_symbol\": \"<string>\"\n }\n ],\n \"categories_list\": [\n \"<string>\",\n \"<string>\"\n ],\n \"payment_accounts_list\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"standard\",\n \"iban\": \"<string>\",\n \"sia\": \"<string>\",\n \"cuc\": \"<string>\",\n \"virtual\": \"<boolean>\"\n }\n ],\n \"vat_types_list\": [\n {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n },\n {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n }\n ]\n }\n}"
}
]
}
