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;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"fields" value: @"<string>"];
[queryParams UpdateString: @"fieldset" value: @"basic"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id" json: queryParams];
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": {
// "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>",
// "email": "<string>",
// "certified_email": "<string>",
// "phone": "<string>",
// "fax": "<string>",
// "notes": "<string>",
// "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": "<integer>",
// "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>",
// "discount_highlight": "<boolean>",
// "default_discount": "<number>",
// "has_intent_declaration": "<boolean>",
// "intent_declaration_protocol_number": "<string>",
// "intent_declaration_protocol_date": "<date>",
// "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
NSString *title = 0;
NSString *description = 0;
NSString *Id = [jResp StringOf: @"data.id"];
NSString *Code = [jResp StringOf: @"data.code"];
NSString *Name = [jResp StringOf: @"data.name"];
NSString *v_Type = [jResp StringOf: @"data.type"];
NSString *First_name = [jResp StringOf: @"data.first_name"];
NSString *Last_name = [jResp StringOf: @"data.last_name"];
NSString *Contact_person = [jResp StringOf: @"data.contact_person"];
NSString *Vat_number = [jResp StringOf: @"data.vat_number"];
NSString *Tax_code = [jResp StringOf: @"data.tax_code"];
NSString *Address_street = [jResp StringOf: @"data.address_street"];
NSString *Address_postal_code = [jResp StringOf: @"data.address_postal_code"];
NSString *Address_city = [jResp StringOf: @"data.address_city"];
NSString *Address_province = [jResp StringOf: @"data.address_province"];
NSString *Address_extra = [jResp StringOf: @"data.address_extra"];
NSString *Country = [jResp StringOf: @"data.country"];
NSString *v_Email = [jResp StringOf: @"data.email"];
NSString *Certified_email = [jResp StringOf: @"data.certified_email"];
NSString *Phone = [jResp StringOf: @"data.phone"];
NSString *Fax = [jResp StringOf: @"data.fax"];
NSString *Notes = [jResp StringOf: @"data.notes"];
NSString *Default_vatId = [jResp StringOf: @"data.default_vat.id"];
NSString *Value = [jResp StringOf: @"data.default_vat.value"];
NSString *Description = [jResp StringOf: @"data.default_vat.description"];
NSString *Default_vatNotes = [jResp StringOf: @"data.default_vat.notes"];
NSString *E_invoice = [jResp StringOf: @"data.default_vat.e_invoice"];
NSString *Ei_type = [jResp StringOf: @"data.default_vat.ei_type"];
NSString *Ei_description = [jResp StringOf: @"data.default_vat.ei_description"];
NSString *Editable = [jResp StringOf: @"data.default_vat.editable"];
NSString *Is_disabled = [jResp StringOf: @"data.default_vat.is_disabled"];
NSString *Default_payment_terms = [jResp StringOf: @"data.default_payment_terms"];
NSString *Default_payment_terms_type = [jResp StringOf: @"data.default_payment_terms_type"];
NSString *Default_payment_methodId = [jResp StringOf: @"data.default_payment_method.id"];
NSString *Default_payment_methodName = [jResp StringOf: @"data.default_payment_method.name"];
NSString *Default_payment_methodType = [jResp StringOf: @"data.default_payment_method.type"];
NSString *Is_default = [jResp StringOf: @"data.default_payment_method.is_default"];
NSString *Default_payment_accountId = [jResp StringOf: @"data.default_payment_method.default_payment_account.id"];
NSString *Default_payment_accountName = [jResp StringOf: @"data.default_payment_method.default_payment_account.name"];
NSString *Default_payment_accountType = [jResp StringOf: @"data.default_payment_method.default_payment_account.type"];
NSString *Iban = [jResp StringOf: @"data.default_payment_method.default_payment_account.iban"];
NSString *Sia = [jResp StringOf: @"data.default_payment_method.default_payment_account.sia"];
NSString *Cuc = [jResp StringOf: @"data.default_payment_method.default_payment_account.cuc"];
NSString *v_Virtual = [jResp StringOf: @"data.default_payment_method.default_payment_account.virtual"];
NSString *Bank_iban = [jResp StringOf: @"data.default_payment_method.bank_iban"];
NSString *Bank_name = [jResp StringOf: @"data.default_payment_method.bank_name"];
NSString *Bank_beneficiary = [jResp StringOf: @"data.default_payment_method.bank_beneficiary"];
NSString *Ei_payment_method = [jResp StringOf: @"data.default_payment_method.ei_payment_method"];
NSString *dataBank_name = [jResp StringOf: @"data.bank_name"];
NSString *dataBank_iban = [jResp StringOf: @"data.bank_iban"];
NSString *Bank_swift_code = [jResp StringOf: @"data.bank_swift_code"];
NSString *Shipping_address = [jResp StringOf: @"data.shipping_address"];
NSString *dataE_invoice = [jResp StringOf: @"data.e_invoice"];
NSString *Ei_code = [jResp StringOf: @"data.ei_code"];
NSString *Discount_highlight = [jResp StringOf: @"data.discount_highlight"];
NSString *Default_discount = [jResp StringOf: @"data.default_discount"];
NSString *Has_intent_declaration = [jResp StringOf: @"data.has_intent_declaration"];
NSString *Intent_declaration_protocol_number = [jResp StringOf: @"data.intent_declaration_protocol_number"];
NSString *Intent_declaration_protocol_date = [jResp StringOf: @"data.intent_declaration_protocol_date"];
NSString *Created_at = [jResp StringOf: @"data.created_at"];
NSString *Updated_at = [jResp StringOf: @"data.updated_at"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data.default_payment_method.details"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
title = [jResp StringOf: @"data.default_payment_method.details[i].title"];
description = [jResp StringOf: @"data.default_payment_method.details[i].description"];
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/entities/clients/:client_id
Postman Collection Item JSON
{
"name": "Get Client",
"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/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_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": "client_id",
"value": "<integer>"
}
]
},
"description": "Gets the specified client."
},
"response": [
{
"name": "Client 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/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_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": "client_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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 \"email\": \"<string>\",\n \"certified_email\": \"<string>\",\n \"phone\": \"<string>\",\n \"fax\": \"<string>\",\n \"notes\": \"<string>\",\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\": \"<integer>\",\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 \"discount_highlight\": \"<boolean>\",\n \"default_discount\": \"<number>\",\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}"
},
{
"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/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_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": "client_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/entities/clients/:client_id?fields=<string>&fieldset=basic",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"entities",
"clients",
":client_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": "client_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
