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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"type","passive_delivery_note")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents/info",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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(queryParams)
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": {
; "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
strVal.s
id.s
symbol.s
exchange_rate.s
html_symbol.s
name.s
v_type.s
iban.s
sia.s
cuc.s
v_virtual.s
value.s
description.s
notes.s
e_invoice.s
ei_type.s
ei_description.s
editable.s
is_disabled.s
Detailed.s = CkJsonObject::ckStringOf(jResp,"data.default_values.detailed")
Vat.s = CkJsonObject::ckStringOf(jResp,"data.items_default_values.vat")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.countries_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"data.countries_list[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"data.currencies_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data.currencies_list[i].id")
symbol = CkJsonObject::ckStringOf(jResp,"data.currencies_list[i].symbol")
exchange_rate = CkJsonObject::ckStringOf(jResp,"data.currencies_list[i].exchange_rate")
html_symbol = CkJsonObject::ckStringOf(jResp,"data.currencies_list[i].html_symbol")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"data.categories_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"data.categories_list[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"data.payment_accounts_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].id")
name = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].type")
iban = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].iban")
sia = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].sia")
cuc = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].cuc")
v_virtual = CkJsonObject::ckStringOf(jResp,"data.payment_accounts_list[i].virtual")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"data.vat_types_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].id")
value = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].value")
description = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].description")
notes = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].notes")
e_invoice = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].e_invoice")
ei_type = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].ei_type")
ei_description = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].ei_description")
editable = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].editable")
is_disabled = CkJsonObject::ckStringOf(jResp,"data.vat_types_list[i].is_disabled")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
