Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *title;
const char *description;
const char *id;
const char *product_id;
const char *code;
const char *name;
const char *measure;
const char *net_price;
const char *category;
const char *qty;
const char *vatId;
const char *vatValue;
const char *vatDescription;
const char *vatNotes;
const char *vatE_invoice;
const char *vatEi_type;
const char *vatEi_description;
const char *vatEditable;
const char *vatIs_disabled;
const char *stock;
const char *amount;
const char *due_date;
const char *paid_date;
const char *Days;
const char *payment_termsType;
const char *status;
const char *payment_accountId;
const char *payment_accountName;
const char *payment_accountType;
const char *payment_accountIban;
const char *payment_accountSia;
const char *payment_accountCuc;
const char *payment_accountVirtual;
const char *Id;
const char *v_Type;
const char *EntityId;
const char *Code;
const char *Name;
const char *EntityType;
const char *First_name;
const char *Last_name;
const char *Contact_person;
const char *Vat_number;
const char *Tax_code;
const char *Address_street;
const char *Address_postal_code;
const char *Address_city;
const char *Address_province;
const char *Address_extra;
const char *Country;
const char *Country_iso;
const char *v_Email;
const char *Certified_email;
const char *Phone;
const char *Fax;
const char *Notes;
const char *Default_payment_terms;
const char *Default_vatId;
const char *Value;
const char *Description;
const char *Default_vatNotes;
const char *E_invoice;
const char *Ei_type;
const char *Ei_description;
const char *Editable;
const char *Is_disabled;
const char *Default_payment_terms_type;
const char *Default_payment_methodId;
const char *Default_payment_methodName;
const char *Default_payment_methodType;
const char *Is_default;
const char *Default_payment_accountId;
const char *Default_payment_accountName;
const char *Default_payment_accountType;
const char *Iban;
const char *Sia;
const char *Cuc;
const char *v_Virtual;
const char *Bank_iban;
const char *Bank_name;
const char *Bank_beneficiary;
const char *Ei_payment_method;
const char *EntityBank_name;
const char *EntityBank_iban;
const char *Bank_swift_code;
const char *Shipping_address;
const char *EntityE_invoice;
const char *Ei_code;
const char *Has_intent_declaration;
const char *Intent_declaration_protocol_number;
const char *Intent_declaration_protocol_date;
const char *Created_at;
const char *Updated_at;
const char *Date;
const char *Category;
const char *dataDescription;
const char *Amount_net;
const char *Amount_vat;
const char *Amount_withholding_tax;
const char *Amount_other_withholding_tax;
const char *Amount_gross;
const char *Amortization;
const char *Rc_center;
const char *Invoice_number;
const char *Is_marked;
const char *Is_detailed;
const char *dataE_invoice;
const char *Next_due_date;
const char *CurrencyId;
const char *Symbol;
const char *Exchange_rate;
const char *Html_symbol;
const char *Tax_deductibility;
const char *Vat_deductibility;
const char *Attachment_url;
const char *Attachment_preview_url;
const char *Auto_calculate;
const char *Attachment_token;
const char *dataCreated_at;
const char *dataUpdated_at;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"fields","<string>");
CkJsonObject_UpdateString(queryParams,"fieldset","basic");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequestParams(http,"GET","https://api-v2.fattureincloud.it/c/:company_id/received_documents/:document_id",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "<integer>",
// "type": "expense",
// "entity": {
// "id": "<integer>",
// "code": "<string>",
// "name": "<string>",
// "type": null,
// "first_name": "<string>",
// "last_name": "<string>",
// "contact_person": "<string>",
// "vat_number": "<string>",
// "tax_code": "<string>",
// "address_street": "<string>",
// "address_postal_code": "<string>",
// "address_city": "<string>",
// "address_province": "<string>",
// "address_extra": "<string>",
// "country": "<string>",
// "country_iso": "<string>",
// "email": "<string>",
// "certified_email": "<string>",
// "phone": "<string>",
// "fax": "<string>",
// "notes": "<string>",
// "default_payment_terms": "<integer>",
// "default_vat": {
// "id": "<integer>",
// "value": "<number>",
// "description": "<string>",
// "notes": "<string>",
// "e_invoice": "<boolean>",
// "ei_type": "<string>",
// "ei_description": "<string>",
// "editable": "<boolean>",
// "is_disabled": "<boolean>"
// },
// "default_payment_terms_type": "standard",
// "default_payment_method": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "is_default": "<boolean>",
// "default_payment_account": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// },
// "details": [
// {
// "title": "<string>",
// "description": "<string>"
// },
// {
// "title": "<string>",
// "description": "<string>"
// }
// ],
// "bank_iban": "<string>",
// "bank_name": "<string>",
// "bank_beneficiary": "<string>",
// "ei_payment_method": "<string>"
// },
// "bank_name": "<string>",
// "bank_iban": "<string>",
// "bank_swift_code": "<string>",
// "shipping_address": "<string>",
// "e_invoice": "<boolean>",
// "ei_code": "<string>",
// "has_intent_declaration": "<boolean>",
// "intent_declaration_protocol_number": "<string>",
// "intent_declaration_protocol_date": "<date>",
// "created_at": "<string>",
// "updated_at": "<string>"
// },
// "date": "<date>",
// "category": "<string>",
// "description": "<string>",
// "amount_net": "<number>",
// "amount_vat": "<number>",
// "amount_withholding_tax": "<number>",
// "amount_other_withholding_tax": "<number>",
// "amount_gross": "<number>",
// "amortization": "<number>",
// "rc_center": "<string>",
// "invoice_number": "<string>",
// "is_marked": "<boolean>",
// "is_detailed": "<boolean>",
// "e_invoice": "<boolean>",
// "next_due_date": "<date>",
// "currency": {
// "id": "<string>",
// "symbol": "<string>",
// "exchange_rate": "<string>",
// "html_symbol": "<string>"
// },
// "tax_deductibility": "<number>",
// "vat_deductibility": "<number>",
// "items_list": [
// {
// "id": "<integer>",
// "product_id": "<integer>",
// "code": "<string>",
// "name": "<string>",
// "measure": "<string>",
// "net_price": "<number>",
// "category": "<string>",
// "qty": "<number>",
// "vat": {
// "id": "<integer>",
// "value": "<number>",
// "description": "<string>",
// "notes": "<string>",
// "e_invoice": "<boolean>",
// "ei_type": "<string>",
// "ei_description": "<string>",
// "editable": "<boolean>",
// "is_disabled": "<boolean>"
// },
// "stock": "<number>"
// },
// {
// "id": "<integer>",
// "product_id": "<integer>",
// "code": "<string>",
// "name": "<string>",
// "measure": "<string>",
// "net_price": "<number>",
// "category": "<string>",
// "qty": "<number>",
// "vat": {
// "id": "<integer>",
// "value": "<number>",
// "description": "<string>",
// "notes": "<string>",
// "e_invoice": "<boolean>",
// "ei_type": "<string>",
// "ei_description": "<string>",
// "editable": "<boolean>",
// "is_disabled": "<boolean>"
// },
// "stock": "<number>"
// }
// ],
// "payments_list": [
// {
// "id": "<integer>",
// "amount": "<number>",
// "due_date": "<date>",
// "paid_date": "<date>",
// "payment_terms": {
// "days": "<integer>",
// "type": "standard"
// },
// "status": "<string>",
// "payment_account": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// }
// },
// {
// "id": "<integer>",
// "amount": "<number>",
// "due_date": "<date>",
// "paid_date": "<date>",
// "payment_terms": {
// "days": "<integer>",
// "type": "standard"
// },
// "status": "<string>",
// "payment_account": {
// "id": "<integer>",
// "name": "<string>",
// "type": "standard",
// "iban": "<string>",
// "sia": "<string>",
// "cuc": "<string>",
// "virtual": "<boolean>"
// }
// }
// ],
// "attachment_url": "<string>",
// "attachment_preview_url": "<string>",
// "auto_calculate": "<boolean>",
// "attachment_token": "<string>",
// "created_at": "<string>",
// "updated_at": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Id = CkJsonObject_stringOf(jResp,"data.id");
v_Type = CkJsonObject_stringOf(jResp,"data.type");
EntityId = CkJsonObject_stringOf(jResp,"data.entity.id");
Code = CkJsonObject_stringOf(jResp,"data.entity.code");
Name = CkJsonObject_stringOf(jResp,"data.entity.name");
EntityType = CkJsonObject_stringOf(jResp,"data.entity.type");
First_name = CkJsonObject_stringOf(jResp,"data.entity.first_name");
Last_name = CkJsonObject_stringOf(jResp,"data.entity.last_name");
Contact_person = CkJsonObject_stringOf(jResp,"data.entity.contact_person");
Vat_number = CkJsonObject_stringOf(jResp,"data.entity.vat_number");
Tax_code = CkJsonObject_stringOf(jResp,"data.entity.tax_code");
Address_street = CkJsonObject_stringOf(jResp,"data.entity.address_street");
Address_postal_code = CkJsonObject_stringOf(jResp,"data.entity.address_postal_code");
Address_city = CkJsonObject_stringOf(jResp,"data.entity.address_city");
Address_province = CkJsonObject_stringOf(jResp,"data.entity.address_province");
Address_extra = CkJsonObject_stringOf(jResp,"data.entity.address_extra");
Country = CkJsonObject_stringOf(jResp,"data.entity.country");
Country_iso = CkJsonObject_stringOf(jResp,"data.entity.country_iso");
v_Email = CkJsonObject_stringOf(jResp,"data.entity.email");
Certified_email = CkJsonObject_stringOf(jResp,"data.entity.certified_email");
Phone = CkJsonObject_stringOf(jResp,"data.entity.phone");
Fax = CkJsonObject_stringOf(jResp,"data.entity.fax");
Notes = CkJsonObject_stringOf(jResp,"data.entity.notes");
Default_payment_terms = CkJsonObject_stringOf(jResp,"data.entity.default_payment_terms");
Default_vatId = CkJsonObject_stringOf(jResp,"data.entity.default_vat.id");
Value = CkJsonObject_stringOf(jResp,"data.entity.default_vat.value");
Description = CkJsonObject_stringOf(jResp,"data.entity.default_vat.description");
Default_vatNotes = CkJsonObject_stringOf(jResp,"data.entity.default_vat.notes");
E_invoice = CkJsonObject_stringOf(jResp,"data.entity.default_vat.e_invoice");
Ei_type = CkJsonObject_stringOf(jResp,"data.entity.default_vat.ei_type");
Ei_description = CkJsonObject_stringOf(jResp,"data.entity.default_vat.ei_description");
Editable = CkJsonObject_stringOf(jResp,"data.entity.default_vat.editable");
Is_disabled = CkJsonObject_stringOf(jResp,"data.entity.default_vat.is_disabled");
Default_payment_terms_type = CkJsonObject_stringOf(jResp,"data.entity.default_payment_terms_type");
Default_payment_methodId = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.id");
Default_payment_methodName = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.name");
Default_payment_methodType = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.type");
Is_default = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.is_default");
Default_payment_accountId = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.id");
Default_payment_accountName = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.name");
Default_payment_accountType = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.type");
Iban = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.iban");
Sia = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.sia");
Cuc = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.cuc");
v_Virtual = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.default_payment_account.virtual");
Bank_iban = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.bank_iban");
Bank_name = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.bank_name");
Bank_beneficiary = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.bank_beneficiary");
Ei_payment_method = CkJsonObject_stringOf(jResp,"data.entity.default_payment_method.ei_payment_method");
EntityBank_name = CkJsonObject_stringOf(jResp,"data.entity.bank_name");
EntityBank_iban = CkJsonObject_stringOf(jResp,"data.entity.bank_iban");
Bank_swift_code = CkJsonObject_stringOf(jResp,"data.entity.bank_swift_code");
Shipping_address = CkJsonObject_stringOf(jResp,"data.entity.shipping_address");
EntityE_invoice = CkJsonObject_stringOf(jResp,"data.entity.e_invoice");
Ei_code = CkJsonObject_stringOf(jResp,"data.entity.ei_code");
Has_intent_declaration = CkJsonObject_stringOf(jResp,"data.entity.has_intent_declaration");
Intent_declaration_protocol_number = CkJsonObject_stringOf(jResp,"data.entity.intent_declaration_protocol_number");
Intent_declaration_protocol_date = CkJsonObject_stringOf(jResp,"data.entity.intent_declaration_protocol_date");
Created_at = CkJsonObject_stringOf(jResp,"data.entity.created_at");
Updated_at = CkJsonObject_stringOf(jResp,"data.entity.updated_at");
Date = CkJsonObject_stringOf(jResp,"data.date");
Category = CkJsonObject_stringOf(jResp,"data.category");
dataDescription = CkJsonObject_stringOf(jResp,"data.description");
Amount_net = CkJsonObject_stringOf(jResp,"data.amount_net");
Amount_vat = CkJsonObject_stringOf(jResp,"data.amount_vat");
Amount_withholding_tax = CkJsonObject_stringOf(jResp,"data.amount_withholding_tax");
Amount_other_withholding_tax = CkJsonObject_stringOf(jResp,"data.amount_other_withholding_tax");
Amount_gross = CkJsonObject_stringOf(jResp,"data.amount_gross");
Amortization = CkJsonObject_stringOf(jResp,"data.amortization");
Rc_center = CkJsonObject_stringOf(jResp,"data.rc_center");
Invoice_number = CkJsonObject_stringOf(jResp,"data.invoice_number");
Is_marked = CkJsonObject_stringOf(jResp,"data.is_marked");
Is_detailed = CkJsonObject_stringOf(jResp,"data.is_detailed");
dataE_invoice = CkJsonObject_stringOf(jResp,"data.e_invoice");
Next_due_date = CkJsonObject_stringOf(jResp,"data.next_due_date");
CurrencyId = CkJsonObject_stringOf(jResp,"data.currency.id");
Symbol = CkJsonObject_stringOf(jResp,"data.currency.symbol");
Exchange_rate = CkJsonObject_stringOf(jResp,"data.currency.exchange_rate");
Html_symbol = CkJsonObject_stringOf(jResp,"data.currency.html_symbol");
Tax_deductibility = CkJsonObject_stringOf(jResp,"data.tax_deductibility");
Vat_deductibility = CkJsonObject_stringOf(jResp,"data.vat_deductibility");
Attachment_url = CkJsonObject_stringOf(jResp,"data.attachment_url");
Attachment_preview_url = CkJsonObject_stringOf(jResp,"data.attachment_preview_url");
Auto_calculate = CkJsonObject_stringOf(jResp,"data.auto_calculate");
Attachment_token = CkJsonObject_stringOf(jResp,"data.attachment_token");
dataCreated_at = CkJsonObject_stringOf(jResp,"data.created_at");
dataUpdated_at = CkJsonObject_stringOf(jResp,"data.updated_at");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data.entity.default_payment_method.details");
while (i < count_i) {
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");
while (i < count_i) {
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");
while (i < count_i) {
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;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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": ""
}
]
}
