Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.recipient_email","<string>")
CkJsonObject::ckUpdateString(json,"data.subject","<string>")
CkJsonObject::ckUpdateString(json,"data.body","<string>")
CkJsonObject::ckUpdateString(json,"data.include.document","<boolean>")
CkJsonObject::ckUpdateString(json,"data.include.delivery_note","<boolean>")
CkJsonObject::ckUpdateString(json,"data.include.attachment","<boolean>")
CkJsonObject::ckUpdateString(json,"data.include.accompanying_invoice","<boolean>")
CkJsonObject::ckUpdateString(json,"data.attach_pdf","<boolean>")
CkJsonObject::ckUpdateString(json,"data.send_copy","<boolean>")
CkJsonObject::ckUpdateString(json,"data.sender_id","<integer>")
CkJsonObject::ckUpdateString(json,"data.sender_email","<string>")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
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": ""
}
]
}
