Chilkat Online Tools

lianja / Fatture in Cloud API v2 - API Reference / Upload Issued Document Attachment

Back to Collection Items

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

loHttp = createobject("CkHttp")

loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.Path = "/c/:company_id/issued_documents/attachment"
loReq.ContentType = "multipart/form-data"
loReq.AddStringForUpload("","<string>","","utf-8")

loReq.AddParam("attachment","<string><string>")

loReq.AddHeader("Authorization","Bearer <access_token>")
loReq.AddHeader("Accept","application/json")

loResp = loHttp.SynchronousRequest("api-v2.fattureincloud.it",443,.T.,loReq)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loReq
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": {
//     "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

lcAttachment_token = loJResp.StringOf("data.attachment_token")


release loHttp
release loReq
release loSbResponseBody
release loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	-H "Accept: application/json"
	--form 'filename=<string>'
	--form 'attachment=<string><string>'
https://api-v2.fattureincloud.it/c/:company_id/issued_documents/attachment

Postman Collection Item JSON

{
  "name": "Upload Issued Document Attachment",
  "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": "multipart/form-data"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "filename",
          "value": "<string>",
          "description": "Attachment file name",
          "type": "text"
        },
        {
          "key": "attachment",
          "value": "<string>",
          "description": "Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/issued_documents/attachment",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "issued_documents",
        "attachment"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Uploads an attachment destined to an issued document. The actual association between the document and the attachment must be implemented separately, using the returned token."
  },
  "response": [
    {
      "name": "Attachment Token.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "multipart/form-data"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "filename",
              "value": "<string>",
              "description": "Attachment file name",
              "type": "text"
            },
            {
              "key": "attachment",
              "value": "<string>",
              "description": "Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/issued_documents/attachment",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "issued_documents",
            "attachment"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attachment_token\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "multipart/form-data"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "filename",
              "value": "<string>",
              "description": "Attachment file name",
              "type": "text"
            },
            {
              "key": "attachment",
              "value": "<string>",
              "description": "Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx]",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/issued_documents/attachment",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "issued_documents",
            "attachment"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}