Chilkat Online Tools

Objective-C / Belvo API Docs / Detail

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.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;

http.BasicAuth = YES;
http.Login = @"{{secretId}}";
http.Password = @"{{secretPassword}}";

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/api/statements/:id/" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "<uuid>",
//   "link": "<string>",
//   "account": {
//     "id": "<uuid>",
//     "name": "<string>",
//     "category": "non consequat",
//     "currency": "<string>"
//   },
//   "collected_at": "<dateTime>",
//   "account_number": "<string>",
//   "client_number": "<string>",
//   "RFC": "<string>",
//   "CLABE": "<string>",
//   "period_start_date": "<date>",
//   "period_end_date": "<date>",
//   "cut_date": "<string>",
//   "final_balance": "<number>",
//   "previous_balance": "<number>",
//   "total_inflow_amount": "<number>",
//   "total_outflow_amount": "<number>",
//   "total_inflow_transactions": "<number>",
//   "total_outflow_transactions": "<number>",
//   "transactions": [
//     {
//       "collected_at": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "accounting_date": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "value_date": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "reference": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "observations": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "additional_data": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "balance": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "status": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "type": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "currency": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "description": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "internal_identification": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "account": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       }
//     },
//     {
//       "collected_at": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "accounting_date": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "value_date": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "reference": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "observations": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "additional_data": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "balance": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "status": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "type": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "currency": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "description": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "internal_identification": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       },
//       "account": {
//         "value": "<Error: Too many levels of nesting to fake this schema>"
//       }
//     }
//   ],
//   "pdf": "<binary>"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *Value = 0;
NSString *accounting_dateValue = 0;
NSString *value_dateValue = 0;
NSString *referenceValue = 0;
NSString *observationsValue = 0;
NSString *additional_dataValue = 0;
NSString *balanceValue = 0;
NSString *statusValue = 0;
NSString *typeValue = 0;
NSString *currencyValue = 0;
NSString *descriptionValue = 0;
NSString *internal_identificationValue = 0;
NSString *accountValue = 0;

NSString *id = [jResp StringOf: @"id"];
NSString *link = [jResp StringOf: @"link"];
NSString *Id = [jResp StringOf: @"account.id"];
NSString *Name = [jResp StringOf: @"account.name"];
NSString *Category = [jResp StringOf: @"account.category"];
NSString *v_Currency = [jResp StringOf: @"account.currency"];
NSString *collected_at = [jResp StringOf: @"collected_at"];
NSString *account_number = [jResp StringOf: @"account_number"];
NSString *client_number = [jResp StringOf: @"client_number"];
NSString *RFC = [jResp StringOf: @"RFC"];
NSString *CLABE = [jResp StringOf: @"CLABE"];
NSString *period_start_date = [jResp StringOf: @"period_start_date"];
NSString *period_end_date = [jResp StringOf: @"period_end_date"];
NSString *cut_date = [jResp StringOf: @"cut_date"];
NSString *final_balance = [jResp StringOf: @"final_balance"];
NSString *previous_balance = [jResp StringOf: @"previous_balance"];
NSString *total_inflow_amount = [jResp StringOf: @"total_inflow_amount"];
NSString *total_outflow_amount = [jResp StringOf: @"total_outflow_amount"];
NSString *total_inflow_transactions = [jResp StringOf: @"total_inflow_transactions"];
NSString *total_outflow_transactions = [jResp StringOf: @"total_outflow_transactions"];
NSString *pdf = [jResp StringOf: @"pdf"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"transactions"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    Value = [jResp StringOf: @"transactions[i].collected_at.value"];
    accounting_dateValue = [jResp StringOf: @"transactions[i].accounting_date.value"];
    value_dateValue = [jResp StringOf: @"transactions[i].value_date.value"];
    referenceValue = [jResp StringOf: @"transactions[i].reference.value"];
    observationsValue = [jResp StringOf: @"transactions[i].observations.value"];
    additional_dataValue = [jResp StringOf: @"transactions[i].additional_data.value"];
    balanceValue = [jResp StringOf: @"transactions[i].balance.value"];
    statusValue = [jResp StringOf: @"transactions[i].status.value"];
    typeValue = [jResp StringOf: @"transactions[i].type.value"];
    currencyValue = [jResp StringOf: @"transactions[i].currency.value"];
    descriptionValue = [jResp StringOf: @"transactions[i].description.value"];
    internal_identificationValue = [jResp StringOf: @"transactions[i].internal_identification.value"];
    accountValue = [jResp StringOf: @"transactions[i].account.value"];
    i = i + 1;
}

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/statements/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/statements/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "statements",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `statement.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific statement."
  },
  "response": [
    {
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/statements/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "statements",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<string>\",\n\t\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"name\": \"<string>\",\n\t\t\"category\": \"non consequat\",\n\t\t\"currency\": \"<string>\"\n\t},\n\t\"collected_at\": \"<dateTime>\",\n\t\"account_number\": \"<string>\",\n\t\"client_number\": \"<string>\",\n\t\"RFC\": \"<string>\",\n\t\"CLABE\": \"<string>\",\n\t\"period_start_date\": \"<date>\",\n\t\"period_end_date\": \"<date>\",\n\t\"cut_date\": \"<string>\",\n\t\"final_balance\": \"<number>\",\n\t\"previous_balance\": \"<number>\",\n\t\"total_inflow_amount\": \"<number>\",\n\t\"total_outflow_amount\": \"<number>\",\n\t\"total_inflow_transactions\": \"<number>\",\n\t\"total_outflow_transactions\": \"<number>\",\n\t\"transactions\": [\n\t\t{\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"account\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"accounting_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"account\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"pdf\": \"<binary>\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/statements/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "statements",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    },
    {
      "name": "Too Many Sessions",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/statements/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "statements",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    }
  ]
}