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");
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": {
// "date": "<date>",
// "description": "<string>",
// "category": "<string>",
// "id": "<integer>",
// "attachment_url": "<string>",
// "attachment_token": "<string>"
// }
// }
$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('data.date','<date>');
$json->UpdateString('data.description','<string>');
$json->UpdateString('data.category','<string>');
$json->UpdateString('data.id','<integer>');
$json->UpdateString('data.attachment_url','<string>');
$json->UpdateString('data.attachment_token','<string>');
$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Accept','application/json');
$sbRequestBody = new COM("Chilkat_9_5_0.StringBuilder");
$json->EmitSb($sbRequestBody);
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PTextSb('PUT','https://api-v2.fattureincloud.it/c/:company_id/archive/:document_id',$sbRequestBody,'utf-8','application/json',0,0);
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)
// {
// "data": {
// "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
$Id = $jResp->stringOf('data.id');
$Date = $jResp->stringOf('data.date');
$Description = $jResp->stringOf('data.description');
$Attachment_url = $jResp->stringOf('data.attachment_url');
$Category = $jResp->stringOf('data.category');
$Attachment_token = $jResp->stringOf('data.attachment_token');
?>
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"date": "<date>",
"description": "<string>",
"category": "<string>",
"id": "<integer>",
"attachment_url": "<string>",
"attachment_token": "<string>"
}
}'
https://api-v2.fattureincloud.it/c/:company_id/archive/:document_id
Postman Collection Item JSON
{
"name": "Modify Archive Document",
"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": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<integer>"
}
]
},
"description": "Modifies the specified archive document."
},
"response": [
{
"name": "The modified Archived Document",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"attachment_url\": \"<string>\",\n \"category\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"date\": \"<date>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"id\": \"<integer>\",\n \"attachment_url\": \"<string>\",\n \"attachment_token\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/archive/:document_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"archive",
":document_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
