Chilkat Online Tools

Objective-C / Fatture in Cloud API v2 - API Reference / List Receipts

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"fields" value: @"<string>"];
[queryParams UpdateString: @"fieldset" value: @"basic"];
[queryParams UpdateInt: @"page" value: [NSNumber numberWithInt: 1]];
[queryParams UpdateInt: @"per_page" value: [NSNumber numberWithInt: 5]];
[queryParams UpdateString: @"sort" value: @"<string>"];
[queryParams UpdateString: @"q" value: @"<string>"];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api-v2.fattureincloud.it/c/:company_id/receipts" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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>",
//       "number": "<number>",
//       "numeration": "<string>",
//       "amount_net": "<number>",
//       "amount_vat": "<number>",
//       "amount_gross": "<number>",
//       "use_gross_prices": "<boolean>",
//       "type": "till_receipt",
//       "description": "<string>",
//       "rc_center": "<string>",
//       "created_at": "<string>",
//       "updated_at": "<string>",
//       "payment_account": {
//         "id": "<integer>",
//         "name": "<string>",
//         "type": "standard",
//         "iban": "<string>",
//         "sia": "<string>",
//         "cuc": "<string>",
//         "virtual": "<boolean>"
//       },
//       "items_list": [
//         {
//           "id": "<integer>",
//           "amount_net": "<number>",
//           "amount_gross": "<number>",
//           "category": "<string>",
//           "vat": {
//             "id": "<integer>",
//             "value": "<number>",
//             "description": "<string>",
//             "notes": "<string>",
//             "e_invoice": "<boolean>",
//             "ei_type": "<string>",
//             "ei_description": "<string>",
//             "editable": "<boolean>",
//             "is_disabled": "<boolean>"
//           }
//         },
//         {
//           "id": "<integer>",
//           "amount_net": "<number>",
//           "amount_gross": "<number>",
//           "category": "<string>",
//           "vat": {
//             "id": "<integer>",
//             "value": "<number>",
//             "description": "<string>",
//             "notes": "<string>",
//             "e_invoice": "<boolean>",
//             "ei_type": "<string>",
//             "ei_description": "<string>",
//             "editable": "<boolean>",
//             "is_disabled": "<boolean>"
//           }
//         }
//       ]
//     },
//     {
//       "id": "<integer>",
//       "date": "<date>",
//       "number": "<number>",
//       "numeration": "<string>",
//       "amount_net": "<number>",
//       "amount_vat": "<number>",
//       "amount_gross": "<number>",
//       "use_gross_prices": "<boolean>",
//       "type": "sales_receipt",
//       "description": "<string>",
//       "rc_center": "<string>",
//       "created_at": "<string>",
//       "updated_at": "<string>",
//       "payment_account": {
//         "id": "<integer>",
//         "name": "<string>",
//         "type": "standard",
//         "iban": "<string>",
//         "sia": "<string>",
//         "cuc": "<string>",
//         "virtual": "<boolean>"
//       },
//       "items_list": [
//         {
//           "id": "<integer>",
//           "amount_net": "<number>",
//           "amount_gross": "<number>",
//           "category": "<string>",
//           "vat": {
//             "id": "<integer>",
//             "value": "<number>",
//             "description": "<string>",
//             "notes": "<string>",
//             "e_invoice": "<boolean>",
//             "ei_type": "<string>",
//             "ei_description": "<string>",
//             "editable": "<boolean>",
//             "is_disabled": "<boolean>"
//           }
//         },
//         {
//           "id": "<integer>",
//           "amount_net": "<number>",
//           "amount_gross": "<number>",
//           "category": "<string>",
//           "vat": {
//             "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

NSString *id = 0;
NSString *date = 0;
NSString *v_number = 0;
NSString *numeration = 0;
NSString *amount_net = 0;
NSString *amount_vat = 0;
NSString *amount_gross = 0;
NSString *use_gross_prices = 0;
NSString *v_type = 0;
NSString *description = 0;
NSString *rc_center = 0;
NSString *created_at = 0;
NSString *updated_at = 0;
NSString *Id = 0;
NSString *Name = 0;
NSString *v_Type = 0;
NSString *Iban = 0;
NSString *Sia = 0;
NSString *Cuc = 0;
NSString *v_Virtual = 0;
int j;
int count_j;
NSString *category = 0;
NSString *vatId = 0;
NSString *Value = 0;
NSString *Description = 0;
NSString *Notes = 0;
NSString *E_invoice = 0;
NSString *Ei_type = 0;
NSString *Ei_description = 0;
NSString *Editable = 0;
NSString *Is_disabled = 0;

NSString *current_page = [jResp StringOf: @"current_page"];
NSString *first_page_url = [jResp StringOf: @"first_page_url"];
NSString *from = [jResp StringOf: @"from"];
NSString *last_page = [jResp StringOf: @"last_page"];
NSString *last_page_url = [jResp StringOf: @"last_page_url"];
NSString *next_page_url = [jResp StringOf: @"next_page_url"];
NSString *path = [jResp StringOf: @"path"];
NSString *per_page = [jResp StringOf: @"per_page"];
NSString *prev_page_url = [jResp StringOf: @"prev_page_url"];
NSString *v_to = [jResp StringOf: @"to"];
NSString *total = [jResp StringOf: @"total"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"data[i].id"];
    date = [jResp StringOf: @"data[i].date"];
    v_number = [jResp StringOf: @"data[i].number"];
    numeration = [jResp StringOf: @"data[i].numeration"];
    amount_net = [jResp StringOf: @"data[i].amount_net"];
    amount_vat = [jResp StringOf: @"data[i].amount_vat"];
    amount_gross = [jResp StringOf: @"data[i].amount_gross"];
    use_gross_prices = [jResp StringOf: @"data[i].use_gross_prices"];
    v_type = [jResp StringOf: @"data[i].type"];
    description = [jResp StringOf: @"data[i].description"];
    rc_center = [jResp StringOf: @"data[i].rc_center"];
    created_at = [jResp StringOf: @"data[i].created_at"];
    updated_at = [jResp StringOf: @"data[i].updated_at"];
    Id = [jResp StringOf: @"data[i].payment_account.id"];
    Name = [jResp StringOf: @"data[i].payment_account.name"];
    v_Type = [jResp StringOf: @"data[i].payment_account.type"];
    Iban = [jResp StringOf: @"data[i].payment_account.iban"];
    Sia = [jResp StringOf: @"data[i].payment_account.sia"];
    Cuc = [jResp StringOf: @"data[i].payment_account.cuc"];
    v_Virtual = [jResp StringOf: @"data[i].payment_account.virtual"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"data[i].items_list"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        id = [jResp StringOf: @"data[i].items_list[j].id"];
        amount_net = [jResp StringOf: @"data[i].items_list[j].amount_net"];
        amount_gross = [jResp StringOf: @"data[i].items_list[j].amount_gross"];
        category = [jResp StringOf: @"data[i].items_list[j].category"];
        vatId = [jResp StringOf: @"data[i].items_list[j].vat.id"];
        Value = [jResp StringOf: @"data[i].items_list[j].vat.value"];
        Description = [jResp StringOf: @"data[i].items_list[j].vat.description"];
        Notes = [jResp StringOf: @"data[i].items_list[j].vat.notes"];
        E_invoice = [jResp StringOf: @"data[i].items_list[j].vat.e_invoice"];
        Ei_type = [jResp StringOf: @"data[i].items_list[j].vat.ei_type"];
        Ei_description = [jResp StringOf: @"data[i].items_list[j].vat.ei_description"];
        Editable = [jResp StringOf: @"data[i].items_list[j].vat.editable"];
        Is_disabled = [jResp StringOf: @"data[i].items_list[j].vat.is_disabled"];
        j = j + 1;
    }

    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Receipts",
  "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/receipts?fields=<string>&fieldset=basic&page=1&per_page=5&sort=<string>&q=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "receipts"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        },
        {
          "key": "page",
          "value": "1",
          "description": "The page to retrieve."
        },
        {
          "key": "per_page",
          "value": "5",
          "description": "The size of the page."
        },
        {
          "key": "sort",
          "value": "<string>",
          "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
        },
        {
          "key": "q",
          "value": "<string>",
          "description": "Query for filtering the results."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists the receipts."
  },
  "response": [
    {
      "name": "Receipts 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/receipts?fields=<string>&fieldset=basic&page=1&per_page=5&sort=<string>&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "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      \"number\": \"<number>\",\n      \"numeration\": \"<string>\",\n      \"amount_net\": \"<number>\",\n      \"amount_vat\": \"<number>\",\n      \"amount_gross\": \"<number>\",\n      \"use_gross_prices\": \"<boolean>\",\n      \"type\": \"till_receipt\",\n      \"description\": \"<string>\",\n      \"rc_center\": \"<string>\",\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\",\n      \"payment_account\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"items_list\": [\n        {\n          \"id\": \"<integer>\",\n          \"amount_net\": \"<number>\",\n          \"amount_gross\": \"<number>\",\n          \"category\": \"<string>\",\n          \"vat\": {\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          \"id\": \"<integer>\",\n          \"amount_net\": \"<number>\",\n          \"amount_gross\": \"<number>\",\n          \"category\": \"<string>\",\n          \"vat\": {\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    },\n    {\n      \"id\": \"<integer>\",\n      \"date\": \"<date>\",\n      \"number\": \"<number>\",\n      \"numeration\": \"<string>\",\n      \"amount_net\": \"<number>\",\n      \"amount_vat\": \"<number>\",\n      \"amount_gross\": \"<number>\",\n      \"use_gross_prices\": \"<boolean>\",\n      \"type\": \"sales_receipt\",\n      \"description\": \"<string>\",\n      \"rc_center\": \"<string>\",\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\",\n      \"payment_account\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"items_list\": [\n        {\n          \"id\": \"<integer>\",\n          \"amount_net\": \"<number>\",\n          \"amount_gross\": \"<number>\",\n          \"category\": \"<string>\",\n          \"vat\": {\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          \"id\": \"<integer>\",\n          \"amount_net\": \"<number>\",\n          \"amount_gross\": \"<number>\",\n          \"category\": \"<string>\",\n          \"vat\": {\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    }\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/receipts?fields=<string>&fieldset=basic&page=1&per_page=5&sort=<string>&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "receipts"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}