Chilkat Online Tools

Delphi (DLL) / Fatture in Cloud API v2 - API Reference / Get Received Document

Back to Collection Items

var

begin
CkJsonObject_UpdateString(queryParams,'fields','<string>');CkJsonObject_UpdateString(queryParams,'fieldset','basic');CkHttp_putAuthToken(http,'<access_token>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);title := CkJsonObject__stringOf(jResp,'data.entity.default_payment_method.details[i].title');description := CkJsonObject__stringOf(jResp,'data.entity.default_payment_method.details[i].description');i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'data.items_list');CkJsonObject_putI(jResp,i);id := CkJsonObject__stringOf(jResp,'data.items_list[i].id');product_id := CkJsonObject__stringOf(jResp,'data.items_list[i].product_id');code := CkJsonObject__stringOf(jResp,'data.items_list[i].code');name := CkJsonObject__stringOf(jResp,'data.items_list[i].name');measure := CkJsonObject__stringOf(jResp,'data.items_list[i].measure');net_price := CkJsonObject__stringOf(jResp,'data.items_list[i].net_price');category := CkJsonObject__stringOf(jResp,'data.items_list[i].category');qty := CkJsonObject__stringOf(jResp,'data.items_list[i].qty');vatId := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.id');vatValue := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.value');vatDescription := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.description');vatNotes := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.notes');vatE_invoice := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.e_invoice');vatEi_type := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.ei_type');vatEi_description := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.ei_description');vatEditable := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.editable');vatIs_disabled := CkJsonObject__stringOf(jResp,'data.items_list[i].vat.is_disabled');stock := CkJsonObject__stringOf(jResp,'data.items_list[i].stock');i := i + 1;i := 0;count_i := CkJsonObject_SizeOfArray(jResp,'data.payments_list');CkJsonObject_putI(jResp,i);id := CkJsonObject__stringOf(jResp,'data.payments_list[i].id');amount := CkJsonObject__stringOf(jResp,'data.payments_list[i].amount');due_date := CkJsonObject__stringOf(jResp,'data.payments_list[i].due_date');paid_date := CkJsonObject__stringOf(jResp,'data.payments_list[i].paid_date');Days := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_terms.days');payment_termsType := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_terms.type');status := CkJsonObject__stringOf(jResp,'data.payments_list[i].status');payment_accountId := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.id');payment_accountName := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.name');payment_accountType := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.type');payment_accountIban := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.iban');payment_accountSia := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.sia');payment_accountCuc := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.cuc');payment_accountVirtual := CkJsonObject__stringOf(jResp,'data.payments_list[i].payment_account.virtual');i := i + 1;


Curl Command

curl -G -d "fields=%3Cstring%3E"
	-d "fieldset=basic"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/received_documents/:document_id

Postman Collection Item JSON

{
  "name": "Get Received 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": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "received_documents",
        ":document_id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "document_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the specified document."
  },
  "response": [
    {
      "name": "Document details.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "received_documents",
            ":document_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "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    \"type\": \"expense\",\n    \"entity\": {\n      \"id\": \"<integer>\",\n      \"code\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": null,\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"contact_person\": \"<string>\",\n      \"vat_number\": \"<string>\",\n      \"tax_code\": \"<string>\",\n      \"address_street\": \"<string>\",\n      \"address_postal_code\": \"<string>\",\n      \"address_city\": \"<string>\",\n      \"address_province\": \"<string>\",\n      \"address_extra\": \"<string>\",\n      \"country\": \"<string>\",\n      \"country_iso\": \"<string>\",\n      \"email\": \"<string>\",\n      \"certified_email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"fax\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"default_payment_terms\": \"<integer>\",\n      \"default_vat\": {\n        \"id\": \"<integer>\",\n        \"value\": \"<number>\",\n        \"description\": \"<string>\",\n        \"notes\": \"<string>\",\n        \"e_invoice\": \"<boolean>\",\n        \"ei_type\": \"<string>\",\n        \"ei_description\": \"<string>\",\n        \"editable\": \"<boolean>\",\n        \"is_disabled\": \"<boolean>\"\n      },\n      \"default_payment_terms_type\": \"standard\",\n      \"default_payment_method\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"is_default\": \"<boolean>\",\n        \"default_payment_account\": {\n          \"id\": \"<integer>\",\n          \"name\": \"<string>\",\n          \"type\": \"standard\",\n          \"iban\": \"<string>\",\n          \"sia\": \"<string>\",\n          \"cuc\": \"<string>\",\n          \"virtual\": \"<boolean>\"\n        },\n        \"details\": [\n          {\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          },\n          {\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ],\n        \"bank_iban\": \"<string>\",\n        \"bank_name\": \"<string>\",\n        \"bank_beneficiary\": \"<string>\",\n        \"ei_payment_method\": \"<string>\"\n      },\n      \"bank_name\": \"<string>\",\n      \"bank_iban\": \"<string>\",\n      \"bank_swift_code\": \"<string>\",\n      \"shipping_address\": \"<string>\",\n      \"e_invoice\": \"<boolean>\",\n      \"ei_code\": \"<string>\",\n      \"has_intent_declaration\": \"<boolean>\",\n      \"intent_declaration_protocol_number\": \"<string>\",\n      \"intent_declaration_protocol_date\": \"<date>\",\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\"\n    },\n    \"date\": \"<date>\",\n    \"category\": \"<string>\",\n    \"description\": \"<string>\",\n    \"amount_net\": \"<number>\",\n    \"amount_vat\": \"<number>\",\n    \"amount_withholding_tax\": \"<number>\",\n    \"amount_other_withholding_tax\": \"<number>\",\n    \"amount_gross\": \"<number>\",\n    \"amortization\": \"<number>\",\n    \"rc_center\": \"<string>\",\n    \"invoice_number\": \"<string>\",\n    \"is_marked\": \"<boolean>\",\n    \"is_detailed\": \"<boolean>\",\n    \"e_invoice\": \"<boolean>\",\n    \"next_due_date\": \"<date>\",\n    \"currency\": {\n      \"id\": \"<string>\",\n      \"symbol\": \"<string>\",\n      \"exchange_rate\": \"<string>\",\n      \"html_symbol\": \"<string>\"\n    },\n    \"tax_deductibility\": \"<number>\",\n    \"vat_deductibility\": \"<number>\",\n    \"items_list\": [\n      {\n        \"id\": \"<integer>\",\n        \"product_id\": \"<integer>\",\n        \"code\": \"<string>\",\n        \"name\": \"<string>\",\n        \"measure\": \"<string>\",\n        \"net_price\": \"<number>\",\n        \"category\": \"<string>\",\n        \"qty\": \"<number>\",\n        \"vat\": {\n          \"id\": \"<integer>\",\n          \"value\": \"<number>\",\n          \"description\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"e_invoice\": \"<boolean>\",\n          \"ei_type\": \"<string>\",\n          \"ei_description\": \"<string>\",\n          \"editable\": \"<boolean>\",\n          \"is_disabled\": \"<boolean>\"\n        },\n        \"stock\": \"<number>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"product_id\": \"<integer>\",\n        \"code\": \"<string>\",\n        \"name\": \"<string>\",\n        \"measure\": \"<string>\",\n        \"net_price\": \"<number>\",\n        \"category\": \"<string>\",\n        \"qty\": \"<number>\",\n        \"vat\": {\n          \"id\": \"<integer>\",\n          \"value\": \"<number>\",\n          \"description\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"e_invoice\": \"<boolean>\",\n          \"ei_type\": \"<string>\",\n          \"ei_description\": \"<string>\",\n          \"editable\": \"<boolean>\",\n          \"is_disabled\": \"<boolean>\"\n        },\n        \"stock\": \"<number>\"\n      }\n    ],\n    \"payments_list\": [\n      {\n        \"id\": \"<integer>\",\n        \"amount\": \"<number>\",\n        \"due_date\": \"<date>\",\n        \"paid_date\": \"<date>\",\n        \"payment_terms\": {\n          \"days\": \"<integer>\",\n          \"type\": \"standard\"\n        },\n        \"status\": \"<string>\",\n        \"payment_account\": {\n          \"id\": \"<integer>\",\n          \"name\": \"<string>\",\n          \"type\": \"standard\",\n          \"iban\": \"<string>\",\n          \"sia\": \"<string>\",\n          \"cuc\": \"<string>\",\n          \"virtual\": \"<boolean>\"\n        }\n      },\n      {\n        \"id\": \"<integer>\",\n        \"amount\": \"<number>\",\n        \"due_date\": \"<date>\",\n        \"paid_date\": \"<date>\",\n        \"payment_terms\": {\n          \"days\": \"<integer>\",\n          \"type\": \"standard\"\n        },\n        \"status\": \"<string>\",\n        \"payment_account\": {\n          \"id\": \"<integer>\",\n          \"name\": \"<string>\",\n          \"type\": \"standard\",\n          \"iban\": \"<string>\",\n          \"sia\": \"<string>\",\n          \"cuc\": \"<string>\",\n          \"virtual\": \"<boolean>\"\n        }\n      }\n    ],\n    \"attachment_url\": \"<string>\",\n    \"attachment_preview_url\": \"<string>\",\n    \"auto_calculate\": \"<boolean>\",\n    \"attachment_token\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "received_documents",
            ":document_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "document_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "received_documents",
            ":document_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "document_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}