Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
$queryParams = new COM("Chilkat_9_5_0.JsonObject");
$queryParams->UpdateString('fields','<string>');
$queryParams->UpdateString('fieldset','basic');
$queryParams->UpdateInt('page',1);
$queryParams->UpdateInt('per_page',5);
$queryParams->UpdateString('sort','<string>');
$queryParams->UpdateString('q','<string>');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequestParams('GET','https://api-v2.fattureincloud.it/c/:company_id/receipts',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$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) {
$jResp->I = $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');
while ($j < $count_j) {
$jResp->J = $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": ""
}
]
}
