Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcId
LOCAL lcSymbol
LOCAL lcExchange_rate
LOCAL lcHtml_symbol
LOCAL lcName
LOCAL lcV_type
LOCAL lcIban
LOCAL lcSia
LOCAL lcCuc
LOCAL lcV_virtual
LOCAL lcValue
LOCAL lcDescription
LOCAL lcNotes
LOCAL lcE_invoice
LOCAL lcEi_type
LOCAL lcEi_description
LOCAL lcEditable
LOCAL lcIs_disabled
LOCAL lcDetailed
LOCAL lcVat
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("type","passive_delivery_note")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents/info",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcDetailed = loJResp.StringOf("data.default_values.detailed")
lcVat = loJResp.StringOf("data.items_default_values.vat")
i = 0
lnCount_i = loJResp.SizeOfArray("data.countries_list")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("data.countries_list[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("data.currencies_list")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data.currencies_list[i].id")
lcSymbol = loJResp.StringOf("data.currencies_list[i].symbol")
lcExchange_rate = loJResp.StringOf("data.currencies_list[i].exchange_rate")
lcHtml_symbol = loJResp.StringOf("data.currencies_list[i].html_symbol")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("data.categories_list")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("data.categories_list[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("data.payment_accounts_list")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data.payment_accounts_list[i].id")
lcName = loJResp.StringOf("data.payment_accounts_list[i].name")
lcV_type = loJResp.StringOf("data.payment_accounts_list[i].type")
lcIban = loJResp.StringOf("data.payment_accounts_list[i].iban")
lcSia = loJResp.StringOf("data.payment_accounts_list[i].sia")
lcCuc = loJResp.StringOf("data.payment_accounts_list[i].cuc")
lcV_virtual = loJResp.StringOf("data.payment_accounts_list[i].virtual")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("data.vat_types_list")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data.vat_types_list[i].id")
lcValue = loJResp.StringOf("data.vat_types_list[i].value")
lcDescription = loJResp.StringOf("data.vat_types_list[i].description")
lcNotes = loJResp.StringOf("data.vat_types_list[i].notes")
lcE_invoice = loJResp.StringOf("data.vat_types_list[i].e_invoice")
lcEi_type = loJResp.StringOf("data.vat_types_list[i].ei_type")
lcEi_description = loJResp.StringOf("data.vat_types_list[i].ei_description")
lcEditable = loJResp.StringOf("data.vat_types_list[i].editable")
lcIs_disabled = loJResp.StringOf("data.vat_types_list[i].is_disabled")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
