Chilkat Online Tools

C# / Belvo API Docs / List

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/api/tax-compliance-status/",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "count": "<integer>",
//   "next": "<string>",
//   "previous": "<string>",
//   "results": [
//     {
//       "id": "<uuid>",
//       "collected_at": "<dateTime>",
//       "internal_identification": "<string>",
//       "pdf": "<binary>",
//       "rfc": "<string>",
//       "outcome": "<string>"
//     },
//     {
//       "id": "<uuid>",
//       "collected_at": "<dateTime>",
//       "internal_identification": "<string>",
//       "pdf": "<binary>",
//       "rfc": "<string>",
//       "outcome": "<string>"
//     }
//   ]
// }

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

string id;
string collected_at;
string internal_identification;
string pdf;
string rfc;
string outcome;

string count = jResp.StringOf("count");
string v_next = jResp.StringOf("next");
string previous = jResp.StringOf("previous");
int i = 0;
int count_i = jResp.SizeOfArray("results");
while (i < count_i) {
    jResp.I = i;
    id = jResp.StringOf("results[i].id");
    collected_at = jResp.StringOf("results[i].collected_at");
    internal_identification = jResp.StringOf("results[i].internal_identification");
    pdf = jResp.StringOf("results[i].pdf");
    rfc = jResp.StringOf("results[i].rfc");
    outcome = jResp.StringOf("results[i].outcome");
    i = i + 1;
}

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/tax-compliance-status/

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/tax-compliance-status/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "tax-compliance-status",
        ""
      ]
    },
    "description": "Get a paginated list of all existing Tax compliance statuses in your Belvo account. We return up to 100 results per page."
  },
  "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/tax-compliance-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-compliance-status"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"internal_identification\": \"<string>\",\n\t\t\t\"pdf\": \"<binary>\",\n\t\t\t\"rfc\": \"<string>\",\n\t\t\t\"outcome\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"internal_identification\": \"<string>\",\n\t\t\t\"pdf\": \"<binary>\",\n\t\t\t\"rfc\": \"<string>\",\n\t\t\t\"outcome\": \"<string>\"\n\t\t}\n\t]\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/tax-compliance-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-compliance-status"
          ]
        }
      },
      "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]"
    }
  ]
}