Chilkat Online Tools

delphiAx / Fatture in Cloud API v2 - API Reference / List Archive Documents

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
date: WideString;
description: WideString;
attachment_url: WideString;
category: WideString;
attachment_token: WideString;
current_page: WideString;
first_page_url: WideString;
from: WideString;
last_page: WideString;
last_page_url: WideString;
next_page_url: WideString;
path: WideString;
per_page: WideString;
prev_page_url: WideString;
v_to: WideString;
total: WideString;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('fields','<string>');
queryParams.UpdateString('fieldset','basic');
queryParams.UpdateString('sort','<string>');
queryParams.UpdateInt('page',1);
queryParams.UpdateInt('per_page',5);
queryParams.UpdateString('q','<string>');

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Accept','application/json');

resp := http.QuickRequestParams('GET','https://api-v2.fattureincloud.it/c/:company_id/archive',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "current_page": "<integer>",
//   "first_page_url": "<uri>",
//   "from": "<integer>",
//   "last_page": "<integer>",
//   "last_page_url": "<uri>",
//   "next_page_url": "<uri>",
//   "path": "<uri>",
//   "per_page": "<integer>",
//   "prev_page_url": "<uri>",
//   "to": "<integer>",
//   "total": "<integer>",
//   "data": [
//     {
//       "id": "<integer>",
//       "date": "<date>",
//       "description": "<string>",
//       "attachment_url": "<string>",
//       "category": "<string>",
//       "attachment_token": "<string>"
//     },
//     {
//       "id": "<integer>",
//       "date": "<date>",
//       "description": "<string>",
//       "attachment_url": "<string>",
//       "category": "<string>",
//       "attachment_token": "<string>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

current_page := jResp.StringOf('current_page');
first_page_url := jResp.StringOf('first_page_url');
from := jResp.StringOf('from');
last_page := jResp.StringOf('last_page');
last_page_url := jResp.StringOf('last_page_url');
next_page_url := jResp.StringOf('next_page_url');
path := jResp.StringOf('path');
per_page := jResp.StringOf('per_page');
prev_page_url := jResp.StringOf('prev_page_url');
v_to := jResp.StringOf('to');
total := jResp.StringOf('total');
i := 0;
count_i := jResp.SizeOfArray('data');
while i < count_i do
  begin
    jResp.I := i;
    id := jResp.StringOf('data[i].id');
    date := jResp.StringOf('data[i].date');
    description := jResp.StringOf('data[i].description');
    attachment_url := jResp.StringOf('data[i].attachment_url');
    category := jResp.StringOf('data[i].category');
    attachment_token := jResp.StringOf('data[i].attachment_token');
    i := i + 1;
  end;

Curl Command

curl -G -d "fields=%3Cstring%3E"
	-d "fieldset=basic"
	-d "sort=%3Cstring%3E"
	-d "page=1"
	-d "per_page=5"
	-d "q=%3Cstring%3E"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/archive

Postman Collection Item JSON

{
  "name": "List Archive Documents",
  "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/archive?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "archive"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        },
        {
          "key": "sort",
          "value": "<string>",
          "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
        },
        {
          "key": "page",
          "value": "1",
          "description": "The page to retrieve."
        },
        {
          "key": "per_page",
          "value": "5",
          "description": "The size of the page."
        },
        {
          "key": "q",
          "value": "<string>",
          "description": "Query for filtering the results."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists the archive documents."
  },
  "response": [
    {
      "name": "Results list.",
      "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/archive?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "archive"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"current_page\": \"<integer>\",\n  \"first_page_url\": \"<uri>\",\n  \"from\": \"<integer>\",\n  \"last_page\": \"<integer>\",\n  \"last_page_url\": \"<uri>\",\n  \"next_page_url\": \"<uri>\",\n  \"path\": \"<uri>\",\n  \"per_page\": \"<integer>\",\n  \"prev_page_url\": \"<uri>\",\n  \"to\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"data\": [\n    {\n      \"id\": \"<integer>\",\n      \"date\": \"<date>\",\n      \"description\": \"<string>\",\n      \"attachment_url\": \"<string>\",\n      \"category\": \"<string>\",\n      \"attachment_token\": \"<string>\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"date\": \"<date>\",\n      \"description\": \"<string>\",\n      \"attachment_url\": \"<string>\",\n      \"category\": \"<string>\",\n      \"attachment_token\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/archive?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "archive"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/archive?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "archive"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}