Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("type","passive_delivery_note");
# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents/info",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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
$Detailed = $jResp->stringOf("data.default_values.detailed");
$Vat = $jResp->stringOf("data.items_default_values.vat");
$i = 0;
$count_i = $jResp->SizeOfArray("data.countries_list");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("data.countries_list[i]");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("data.currencies_list");
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->stringOf("data.currencies_list[i].id");
$symbol = $jResp->stringOf("data.currencies_list[i].symbol");
$exchange_rate = $jResp->stringOf("data.currencies_list[i].exchange_rate");
$html_symbol = $jResp->stringOf("data.currencies_list[i].html_symbol");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("data.categories_list");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("data.categories_list[i]");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("data.payment_accounts_list");
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->stringOf("data.payment_accounts_list[i].id");
$name = $jResp->stringOf("data.payment_accounts_list[i].name");
$v_type = $jResp->stringOf("data.payment_accounts_list[i].type");
$iban = $jResp->stringOf("data.payment_accounts_list[i].iban");
$sia = $jResp->stringOf("data.payment_accounts_list[i].sia");
$cuc = $jResp->stringOf("data.payment_accounts_list[i].cuc");
$v_virtual = $jResp->stringOf("data.payment_accounts_list[i].virtual");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("data.vat_types_list");
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->stringOf("data.vat_types_list[i].id");
$value = $jResp->stringOf("data.vat_types_list[i].value");
$description = $jResp->stringOf("data.vat_types_list[i].description");
$notes = $jResp->stringOf("data.vat_types_list[i].notes");
$e_invoice = $jResp->stringOf("data.vat_types_list[i].e_invoice");
$ei_type = $jResp->stringOf("data.vat_types_list[i].ei_type");
$ei_description = $jResp->stringOf("data.vat_types_list[i].ei_description");
$editable = $jResp->stringOf("data.vat_types_list[i].editable");
$is_disabled = $jResp->stringOf("data.vat_types_list[i].is_disabled");
$i = $i + 1;
}
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}"
}
]
}
