Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.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": {
// "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>"
// },
// "id": "<integer>",
// "type": "expense",
// "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>"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data.entity.id" value: @"<integer>"];
[json UpdateString: @"data.entity.code" value: @"<string>"];
[json UpdateString: @"data.entity.name" value: @"<string>"];
[json UpdateNull: @"data.entity.type"];
[json UpdateString: @"data.entity.first_name" value: @"<string>"];
[json UpdateString: @"data.entity.last_name" value: @"<string>"];
[json UpdateString: @"data.entity.contact_person" value: @"<string>"];
[json UpdateString: @"data.entity.vat_number" value: @"<string>"];
[json UpdateString: @"data.entity.tax_code" value: @"<string>"];
[json UpdateString: @"data.entity.address_street" value: @"<string>"];
[json UpdateString: @"data.entity.address_postal_code" value: @"<string>"];
[json UpdateString: @"data.entity.address_city" value: @"<string>"];
[json UpdateString: @"data.entity.address_province" value: @"<string>"];
[json UpdateString: @"data.entity.address_extra" value: @"<string>"];
[json UpdateString: @"data.entity.country" value: @"<string>"];
[json UpdateString: @"data.entity.country_iso" value: @"<string>"];
[json UpdateString: @"data.entity.email" value: @"<string>"];
[json UpdateString: @"data.entity.certified_email" value: @"<string>"];
[json UpdateString: @"data.entity.phone" value: @"<string>"];
[json UpdateString: @"data.entity.fax" value: @"<string>"];
[json UpdateString: @"data.entity.notes" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_terms" value: @"<integer>"];
[json UpdateString: @"data.entity.default_vat.id" value: @"<integer>"];
[json UpdateString: @"data.entity.default_vat.value" value: @"<number>"];
[json UpdateString: @"data.entity.default_vat.description" value: @"<string>"];
[json UpdateString: @"data.entity.default_vat.notes" value: @"<string>"];
[json UpdateString: @"data.entity.default_vat.e_invoice" value: @"<boolean>"];
[json UpdateString: @"data.entity.default_vat.ei_type" value: @"<string>"];
[json UpdateString: @"data.entity.default_vat.ei_description" value: @"<string>"];
[json UpdateString: @"data.entity.default_vat.editable" value: @"<boolean>"];
[json UpdateString: @"data.entity.default_vat.is_disabled" value: @"<boolean>"];
[json UpdateString: @"data.entity.default_payment_terms_type" value: @"standard"];
[json UpdateString: @"data.entity.default_payment_method.id" value: @"<integer>"];
[json UpdateString: @"data.entity.default_payment_method.name" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.type" value: @"standard"];
[json UpdateString: @"data.entity.default_payment_method.is_default" value: @"<boolean>"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.id" value: @"<integer>"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.name" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.type" value: @"standard"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.iban" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.sia" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.cuc" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.default_payment_account.virtual" value: @"<boolean>"];
[json UpdateString: @"data.entity.default_payment_method.details[0].title" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.details[0].description" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.details[1].title" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.details[1].description" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.bank_iban" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.bank_name" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.bank_beneficiary" value: @"<string>"];
[json UpdateString: @"data.entity.default_payment_method.ei_payment_method" value: @"<string>"];
[json UpdateString: @"data.entity.bank_name" value: @"<string>"];
[json UpdateString: @"data.entity.bank_iban" value: @"<string>"];
[json UpdateString: @"data.entity.bank_swift_code" value: @"<string>"];
[json UpdateString: @"data.entity.shipping_address" value: @"<string>"];
[json UpdateString: @"data.entity.e_invoice" value: @"<boolean>"];
[json UpdateString: @"data.entity.ei_code" value: @"<string>"];
[json UpdateString: @"data.entity.has_intent_declaration" value: @"<boolean>"];
[json UpdateString: @"data.entity.intent_declaration_protocol_number" value: @"<string>"];
[json UpdateString: @"data.entity.intent_declaration_protocol_date" value: @"<date>"];
[json UpdateString: @"data.entity.created_at" value: @"<string>"];
[json UpdateString: @"data.entity.updated_at" value: @"<string>"];
[json UpdateString: @"data.id" value: @"<integer>"];
[json UpdateString: @"data.type" value: @"expense"];
[json UpdateString: @"data.date" value: @"<date>"];
[json UpdateString: @"data.category" value: @"<string>"];
[json UpdateString: @"data.description" value: @"<string>"];
[json UpdateString: @"data.amount_net" value: @"<number>"];
[json UpdateString: @"data.amount_vat" value: @"<number>"];
[json UpdateString: @"data.amount_withholding_tax" value: @"<number>"];
[json UpdateString: @"data.amount_other_withholding_tax" value: @"<number>"];
[json UpdateString: @"data.amount_gross" value: @"<number>"];
[json UpdateString: @"data.amortization" value: @"<number>"];
[json UpdateString: @"data.rc_center" value: @"<string>"];
[json UpdateString: @"data.invoice_number" value: @"<string>"];
[json UpdateString: @"data.is_marked" value: @"<boolean>"];
[json UpdateString: @"data.is_detailed" value: @"<boolean>"];
[json UpdateString: @"data.e_invoice" value: @"<boolean>"];
[json UpdateString: @"data.next_due_date" value: @"<date>"];
[json UpdateString: @"data.currency.id" value: @"<string>"];
[json UpdateString: @"data.currency.symbol" value: @"<string>"];
[json UpdateString: @"data.currency.exchange_rate" value: @"<string>"];
[json UpdateString: @"data.currency.html_symbol" value: @"<string>"];
[json UpdateString: @"data.tax_deductibility" value: @"<number>"];
[json UpdateString: @"data.vat_deductibility" value: @"<number>"];
[json UpdateString: @"data.items_list[0].id" value: @"<integer>"];
[json UpdateString: @"data.items_list[0].product_id" value: @"<integer>"];
[json UpdateString: @"data.items_list[0].code" value: @"<string>"];
[json UpdateString: @"data.items_list[0].name" value: @"<string>"];
[json UpdateString: @"data.items_list[0].measure" value: @"<string>"];
[json UpdateString: @"data.items_list[0].net_price" value: @"<number>"];
[json UpdateString: @"data.items_list[0].category" value: @"<string>"];
[json UpdateString: @"data.items_list[0].qty" value: @"<number>"];
[json UpdateString: @"data.items_list[0].vat.id" value: @"<integer>"];
[json UpdateString: @"data.items_list[0].vat.value" value: @"<number>"];
[json UpdateString: @"data.items_list[0].vat.description" value: @"<string>"];
[json UpdateString: @"data.items_list[0].vat.notes" value: @"<string>"];
[json UpdateString: @"data.items_list[0].vat.e_invoice" value: @"<boolean>"];
[json UpdateString: @"data.items_list[0].vat.ei_type" value: @"<string>"];
[json UpdateString: @"data.items_list[0].vat.ei_description" value: @"<string>"];
[json UpdateString: @"data.items_list[0].vat.editable" value: @"<boolean>"];
[json UpdateString: @"data.items_list[0].vat.is_disabled" value: @"<boolean>"];
[json UpdateString: @"data.items_list[0].stock" value: @"<number>"];
[json UpdateString: @"data.items_list[1].id" value: @"<integer>"];
[json UpdateString: @"data.items_list[1].product_id" value: @"<integer>"];
[json UpdateString: @"data.items_list[1].code" value: @"<string>"];
[json UpdateString: @"data.items_list[1].name" value: @"<string>"];
[json UpdateString: @"data.items_list[1].measure" value: @"<string>"];
[json UpdateString: @"data.items_list[1].net_price" value: @"<number>"];
[json UpdateString: @"data.items_list[1].category" value: @"<string>"];
[json UpdateString: @"data.items_list[1].qty" value: @"<number>"];
[json UpdateString: @"data.items_list[1].vat.id" value: @"<integer>"];
[json UpdateString: @"data.items_list[1].vat.value" value: @"<number>"];
[json UpdateString: @"data.items_list[1].vat.description" value: @"<string>"];
[json UpdateString: @"data.items_list[1].vat.notes" value: @"<string>"];
[json UpdateString: @"data.items_list[1].vat.e_invoice" value: @"<boolean>"];
[json UpdateString: @"data.items_list[1].vat.ei_type" value: @"<string>"];
[json UpdateString: @"data.items_list[1].vat.ei_description" value: @"<string>"];
[json UpdateString: @"data.items_list[1].vat.editable" value: @"<boolean>"];
[json UpdateString: @"data.items_list[1].vat.is_disabled" value: @"<boolean>"];
[json UpdateString: @"data.items_list[1].stock" value: @"<number>"];
[json UpdateString: @"data.payments_list[0].id" value: @"<integer>"];
[json UpdateString: @"data.payments_list[0].amount" value: @"<number>"];
[json UpdateString: @"data.payments_list[0].due_date" value: @"<date>"];
[json UpdateString: @"data.payments_list[0].paid_date" value: @"<date>"];
[json UpdateString: @"data.payments_list[0].payment_terms.days" value: @"<integer>"];
[json UpdateString: @"data.payments_list[0].payment_terms.type" value: @"standard"];
[json UpdateString: @"data.payments_list[0].status" value: @"<string>"];
[json UpdateString: @"data.payments_list[0].payment_account.id" value: @"<integer>"];
[json UpdateString: @"data.payments_list[0].payment_account.name" value: @"<string>"];
[json UpdateString: @"data.payments_list[0].payment_account.type" value: @"standard"];
[json UpdateString: @"data.payments_list[0].payment_account.iban" value: @"<string>"];
[json UpdateString: @"data.payments_list[0].payment_account.sia" value: @"<string>"];
[json UpdateString: @"data.payments_list[0].payment_account.cuc" value: @"<string>"];
[json UpdateString: @"data.payments_list[0].payment_account.virtual" value: @"<boolean>"];
[json UpdateString: @"data.payments_list[1].id" value: @"<integer>"];
[json UpdateString: @"data.payments_list[1].amount" value: @"<number>"];
[json UpdateString: @"data.payments_list[1].due_date" value: @"<date>"];
[json UpdateString: @"data.payments_list[1].paid_date" value: @"<date>"];
[json UpdateString: @"data.payments_list[1].payment_terms.days" value: @"<integer>"];
[json UpdateString: @"data.payments_list[1].payment_terms.type" value: @"standard"];
[json UpdateString: @"data.payments_list[1].status" value: @"<string>"];
[json UpdateString: @"data.payments_list[1].payment_account.id" value: @"<integer>"];
[json UpdateString: @"data.payments_list[1].payment_account.name" value: @"<string>"];
[json UpdateString: @"data.payments_list[1].payment_account.type" value: @"standard"];
[json UpdateString: @"data.payments_list[1].payment_account.iban" value: @"<string>"];
[json UpdateString: @"data.payments_list[1].payment_account.sia" value: @"<string>"];
[json UpdateString: @"data.payments_list[1].payment_account.cuc" value: @"<string>"];
[json UpdateString: @"data.payments_list[1].payment_account.virtual" value: @"<boolean>"];
[json UpdateString: @"data.attachment_url" value: @"<string>"];
[json UpdateString: @"data.attachment_preview_url" value: @"<string>"];
[json UpdateString: @"data.auto_calculate" value: @"<boolean>"];
[json UpdateString: @"data.attachment_token" value: @"<string>"];
[json UpdateString: @"data.created_at" value: @"<string>"];
[json UpdateString: @"data.updated_at" value: @"<string>"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://api-v2.fattureincloud.it/c/:company_id/received_documents/:document_id/totals" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "amount_net": "<number>",
// "amount_vat": "<number>",
// "amount_gross": "<number>",
// "amount_withholding_tax": "<number>",
// "amount_other_withholding_tax": "<number>",
// "amount_due": "<number>",
// "payments_sum": "<number>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *Amount_net = [jResp StringOf: @"data.amount_net"];
NSString *Amount_vat = [jResp StringOf: @"data.amount_vat"];
NSString *Amount_gross = [jResp StringOf: @"data.amount_gross"];
NSString *Amount_withholding_tax = [jResp StringOf: @"data.amount_withholding_tax"];
NSString *Amount_other_withholding_tax = [jResp StringOf: @"data.amount_other_withholding_tax"];
NSString *Amount_due = [jResp StringOf: @"data.amount_due"];
NSString *Payments_sum = [jResp StringOf: @"data.payments_sum"];
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"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>"
},
"id": "<integer>",
"type": "expense",
"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>"
}
}'
https://api-v2.fattureincloud.it/c/:company_id/received_documents/:document_id/totals
Postman Collection Item JSON
{
"name": "Get Existing Received Document Totals",
"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"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\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 \"id\": \"<integer>\",\n \"type\": \"expense\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
":document_id",
"totals"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<integer>"
}
]
},
"description": "Returns the totals for the specified document."
},
"response": [
{
"name": "Document Totals.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\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 \"id\": \"<integer>\",\n \"type\": \"expense\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/received_documents/:document_id/totals",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"received_documents",
":document_id",
"totals"
],
"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 \"amount_net\": \"<number>\",\n \"amount_vat\": \"<number>\",\n \"amount_gross\": \"<number>\",\n \"amount_withholding_tax\": \"<number>\",\n \"amount_other_withholding_tax\": \"<number>\",\n \"amount_due\": \"<number>\",\n \"payments_sum\": \"<number>\"\n }\n}"
}
]
}
