Chilkat Online Tools

Objective-C / Fatture in Cloud API v2 - API Reference / Modify Cashbook Entry

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.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;

// 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": {
//     "id": "<string>",
//     "date": "<date>",
//     "description": "<string>",
//     "kind": "received_document",
//     "type": "in",
//     "entity_name": "<string>",
//     "document": {
//       "id": "<integer>",
//       "type": "<string>",
//       "path": "<string>"
//     },
//     "amount_in": "<number>",
//     "payment_account_in": {
//       "name": "<string>",
//       "id": "<integer>",
//       "type": "standard",
//       "iban": "<string>",
//       "sia": "<string>",
//       "cuc": "<string>",
//       "virtual": "<boolean>"
//     },
//     "amount_out": "<number>",
//     "payment_account_out": {
//       "name": "<string>",
//       "id": "<integer>",
//       "type": "standard",
//       "iban": "<string>",
//       "sia": "<string>",
//       "cuc": "<string>",
//       "virtual": "<boolean>"
//     }
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data.id" value: @"<string>"];
[json UpdateString: @"data.date" value: @"<date>"];
[json UpdateString: @"data.description" value: @"<string>"];
[json UpdateString: @"data.kind" value: @"received_document"];
[json UpdateString: @"data.type" value: @"in"];
[json UpdateString: @"data.entity_name" value: @"<string>"];
[json UpdateString: @"data.document.id" value: @"<integer>"];
[json UpdateString: @"data.document.type" value: @"<string>"];
[json UpdateString: @"data.document.path" value: @"<string>"];
[json UpdateString: @"data.amount_in" value: @"<number>"];
[json UpdateString: @"data.payment_account_in.name" value: @"<string>"];
[json UpdateString: @"data.payment_account_in.id" value: @"<integer>"];
[json UpdateString: @"data.payment_account_in.type" value: @"standard"];
[json UpdateString: @"data.payment_account_in.iban" value: @"<string>"];
[json UpdateString: @"data.payment_account_in.sia" value: @"<string>"];
[json UpdateString: @"data.payment_account_in.cuc" value: @"<string>"];
[json UpdateString: @"data.payment_account_in.virtual" value: @"<boolean>"];
[json UpdateString: @"data.amount_out" value: @"<number>"];
[json UpdateString: @"data.payment_account_out.name" value: @"<string>"];
[json UpdateString: @"data.payment_account_out.id" value: @"<integer>"];
[json UpdateString: @"data.payment_account_out.type" value: @"standard"];
[json UpdateString: @"data.payment_account_out.iban" value: @"<string>"];
[json UpdateString: @"data.payment_account_out.sia" value: @"<string>"];
[json UpdateString: @"data.payment_account_out.cuc" value: @"<string>"];
[json UpdateString: @"data.payment_account_out.virtual" value: @"<boolean>"];

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

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://api-v2.fattureincloud.it/c/:company_id/cashbook/:document_id" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
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)

// {
//   "data": {
//     "id": "<string>",
//     "date": "<date>",
//     "description": "<string>",
//     "kind": "received_document",
//     "type": "out",
//     "entity_name": "<string>",
//     "document": {
//       "id": "<integer>",
//       "type": "<string>",
//       "path": "<string>"
//     },
//     "amount_in": "<number>",
//     "payment_account_in": {
//       "id": "<integer>",
//       "name": "<string>",
//       "type": "standard",
//       "iban": "<string>",
//       "sia": "<string>",
//       "cuc": "<string>",
//       "virtual": "<boolean>"
//     },
//     "amount_out": "<number>",
//     "payment_account_out": {
//       "id": "<integer>",
//       "name": "<string>",
//       "type": "standard",
//       "iban": "<string>",
//       "sia": "<string>",
//       "cuc": "<string>",
//       "virtual": "<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 = [jResp StringOf: @"data.id"];
NSString *Date = [jResp StringOf: @"data.date"];
NSString *Description = [jResp StringOf: @"data.description"];
NSString *Kind = [jResp StringOf: @"data.kind"];
NSString *v_Type = [jResp StringOf: @"data.type"];
NSString *Entity_name = [jResp StringOf: @"data.entity_name"];
NSString *DocumentId = [jResp StringOf: @"data.document.id"];
NSString *DocumentType = [jResp StringOf: @"data.document.type"];
NSString *Path = [jResp StringOf: @"data.document.path"];
NSString *Amount_in = [jResp StringOf: @"data.amount_in"];
NSString *Payment_account_inId = [jResp StringOf: @"data.payment_account_in.id"];
NSString *Name = [jResp StringOf: @"data.payment_account_in.name"];
NSString *Payment_account_inType = [jResp StringOf: @"data.payment_account_in.type"];
NSString *Iban = [jResp StringOf: @"data.payment_account_in.iban"];
NSString *Sia = [jResp StringOf: @"data.payment_account_in.sia"];
NSString *Cuc = [jResp StringOf: @"data.payment_account_in.cuc"];
NSString *v_Virtual = [jResp StringOf: @"data.payment_account_in.virtual"];
NSString *Amount_out = [jResp StringOf: @"data.amount_out"];
NSString *Payment_account_outId = [jResp StringOf: @"data.payment_account_out.id"];
NSString *Payment_account_outName = [jResp StringOf: @"data.payment_account_out.name"];
NSString *Payment_account_outType = [jResp StringOf: @"data.payment_account_out.type"];
NSString *Payment_account_outIban = [jResp StringOf: @"data.payment_account_out.iban"];
NSString *Payment_account_outSia = [jResp StringOf: @"data.payment_account_out.sia"];
NSString *Payment_account_outCuc = [jResp StringOf: @"data.payment_account_out.cuc"];
NSString *Payment_account_outVirtual = [jResp StringOf: @"data.payment_account_out.virtual"];

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "id": "<string>",
    "date": "<date>",
    "description": "<string>",
    "kind": "received_document",
    "type": "in",
    "entity_name": "<string>",
    "document": {
      "id": "<integer>",
      "type": "<string>",
      "path": "<string>"
    },
    "amount_in": "<number>",
    "payment_account_in": {
      "name": "<string>",
      "id": "<integer>",
      "type": "standard",
      "iban": "<string>",
      "sia": "<string>",
      "cuc": "<string>",
      "virtual": "<boolean>"
    },
    "amount_out": "<number>",
    "payment_account_out": {
      "name": "<string>",
      "id": "<integer>",
      "type": "standard",
      "iban": "<string>",
      "sia": "<string>",
      "cuc": "<string>",
      "virtual": "<boolean>"
    }
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/cashbook/:document_id

Postman Collection Item JSON

{
  "name": "Modify Cashbook Entry",
  "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    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"received_document\",\n    \"type\": \"in\",\n    \"entity_name\": \"<string>\",\n    \"document\": {\n      \"id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"path\": \"<string>\"\n    },\n    \"amount_in\": \"<number>\",\n    \"payment_account_in\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"amount_out\": \"<number>\",\n    \"payment_account_out\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/cashbook/:document_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "cashbook",
        ":document_id"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "document_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Modifies the specified cashbook entry."
  },
  "response": [
    {
      "name": "The modified Cashbook Entry",
      "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    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"received_document\",\n    \"type\": \"in\",\n    \"entity_name\": \"<string>\",\n    \"document\": {\n      \"id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"path\": \"<string>\"\n    },\n    \"amount_in\": \"<number>\",\n    \"payment_account_in\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"amount_out\": \"<number>\",\n    \"payment_account_out\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/cashbook/:document_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook",
            ":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\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"received_document\",\n    \"type\": \"out\",\n    \"entity_name\": \"<string>\",\n    \"document\": {\n      \"id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"path\": \"<string>\"\n    },\n    \"amount_in\": \"<number>\",\n    \"payment_account_in\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"amount_out\": \"<number>\",\n    \"payment_account_out\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\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    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"received_document\",\n    \"type\": \"in\",\n    \"entity_name\": \"<string>\",\n    \"document\": {\n      \"id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"path\": \"<string>\"\n    },\n    \"amount_in\": \"<number>\",\n    \"payment_account_in\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"amount_out\": \"<number>\",\n    \"payment_account_out\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/cashbook/:document_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook",
            ":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    \"id\": \"<string>\",\n    \"date\": \"<date>\",\n    \"description\": \"<string>\",\n    \"kind\": \"received_document\",\n    \"type\": \"in\",\n    \"entity_name\": \"<string>\",\n    \"document\": {\n      \"id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"path\": \"<string>\"\n    },\n    \"amount_in\": \"<number>\",\n    \"payment_account_in\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    },\n    \"amount_out\": \"<number>\",\n    \"payment_account_out\": {\n      \"name\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"type\": \"standard\",\n      \"iban\": \"<string>\",\n      \"sia\": \"<string>\",\n      \"cuc\": \"<string>\",\n      \"virtual\": \"<boolean>\"\n    }\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/cashbook/:document_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "cashbook",
            ":document_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "document_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}