Chilkat Online Tools

Objective-C / Fatture in Cloud API v2 - API Reference / Schedule Email

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.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": {
//     "recipient_email": "<string>",
//     "subject": "<string>",
//     "body": "<string>",
//     "include": {
//       "document": "<boolean>",
//       "delivery_note": "<boolean>",
//       "attachment": "<boolean>",
//       "accompanying_invoice": "<boolean>"
//     },
//     "attach_pdf": "<boolean>",
//     "send_copy": "<boolean>",
//     "sender_id": "<integer>",
//     "sender_email": "<string>"
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data.recipient_email" value: @"<string>"];
[json UpdateString: @"data.subject" value: @"<string>"];
[json UpdateString: @"data.body" value: @"<string>"];
[json UpdateString: @"data.include.document" value: @"<boolean>"];
[json UpdateString: @"data.include.delivery_note" value: @"<boolean>"];
[json UpdateString: @"data.include.attachment" value: @"<boolean>"];
[json UpdateString: @"data.include.accompanying_invoice" value: @"<boolean>"];
[json UpdateString: @"data.attach_pdf" value: @"<boolean>"];
[json UpdateString: @"data.send_copy" value: @"<boolean>"];
[json UpdateString: @"data.sender_id" value: @"<integer>"];
[json UpdateString: @"data.sender_email" value: @"<string>"];

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

CkoHttpResponse *resp = [http PostJson3: @"https://api-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "data": {
    "recipient_email": "<string>",
    "subject": "<string>",
    "body": "<string>",
    "include": {
      "document": "<boolean>",
      "delivery_note": "<boolean>",
      "attachment": "<boolean>",
      "accompanying_invoice": "<boolean>"
    },
    "attach_pdf": "<boolean>",
    "send_copy": "<boolean>",
    "sender_id": "<integer>",
    "sender_email": "<string>"
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email

Postman Collection Item JSON

{
  "name": "Schedule Email",
  "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": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"recipient_email\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"body\": \"<string>\",\n    \"include\": {\n      \"document\": \"<boolean>\",\n      \"delivery_note\": \"<boolean>\",\n      \"attachment\": \"<boolean>\",\n      \"accompanying_invoice\": \"<boolean>\"\n    },\n    \"attach_pdf\": \"<boolean>\",\n    \"send_copy\": \"<boolean>\",\n    \"sender_id\": \"<integer>\",\n    \"sender_email\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/issued_documents/:document_id/email",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "issued_documents",
        ":document_id",
        "email"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "document_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Schedules the sending of a document by email."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "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    \"recipient_email\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"body\": \"<string>\",\n    \"include\": {\n      \"document\": \"<boolean>\",\n      \"delivery_note\": \"<boolean>\",\n      \"attachment\": \"<boolean>\",\n      \"accompanying_invoice\": \"<boolean>\"\n    },\n    \"attach_pdf\": \"<boolean>\",\n    \"send_copy\": \"<boolean>\",\n    \"sender_id\": \"<integer>\",\n    \"sender_email\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/issued_documents/:document_id/email",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "issued_documents",
            ":document_id",
            "email"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "document_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "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    \"recipient_email\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"body\": \"<string>\",\n    \"include\": {\n      \"document\": \"<boolean>\",\n      \"delivery_note\": \"<boolean>\",\n      \"attachment\": \"<boolean>\",\n      \"accompanying_invoice\": \"<boolean>\"\n    },\n    \"attach_pdf\": \"<boolean>\",\n    \"send_copy\": \"<boolean>\",\n    \"sender_id\": \"<integer>\",\n    \"sender_email\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/issued_documents/:document_id/email",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "issued_documents",
            ":document_id",
            "email"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "document_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "POST",
        "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    \"recipient_email\": \"<string>\",\n    \"subject\": \"<string>\",\n    \"body\": \"<string>\",\n    \"include\": {\n      \"document\": \"<boolean>\",\n      \"delivery_note\": \"<boolean>\",\n      \"attachment\": \"<boolean>\",\n      \"accompanying_invoice\": \"<boolean>\"\n    },\n    \"attach_pdf\": \"<boolean>\",\n    \"send_copy\": \"<boolean>\",\n    \"sender_id\": \"<integer>\",\n    \"sender_email\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/issued_documents/:document_id/email",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "issued_documents",
            ":document_id",
            "email"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "document_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}