Chilkat Online Tools

.NET Core C# / Belvo API Docs / Detail

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/invoices/:id/",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)

// {
//   "description": "<string>",
//   "product_identification": "<string>",
//   "quantity": "<integer>",
//   "unit_code": "<string>",
//   "unit_description": "<string>",
//   "unit_amount": "<number>",
//   "pre_tax_amount": "<number>",
//   "tax_percentage": "<number>",
//   "tax_amount": "<number>",
//   "total_amount": "<number>",
//   "retained_taxes": [
//     {
//       "collected_at": "<dateTime>",
//       "tax": "<string>",
//       "tax_percentage": "<number>",
//       "retained_tax_amount": "<number>"
//     },
//     {
//       "collected_at": "<dateTime>",
//       "tax": "<string>",
//       "tax_percentage": "<number>",
//       "retained_tax_amount": "<number>"
//     }
//   ],
//   "collected_at": "<dateTime>"
// }

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

string tax;
string retained_tax_amount;

string description = jResp.StringOf("description");
string product_identification = jResp.StringOf("product_identification");
string quantity = jResp.StringOf("quantity");
string unit_code = jResp.StringOf("unit_code");
string unit_description = jResp.StringOf("unit_description");
string unit_amount = jResp.StringOf("unit_amount");
string pre_tax_amount = jResp.StringOf("pre_tax_amount");
string tax_percentage = jResp.StringOf("tax_percentage");
string tax_amount = jResp.StringOf("tax_amount");
string total_amount = jResp.StringOf("total_amount");
string collected_at = jResp.StringOf("collected_at");
int i = 0;
int count_i = jResp.SizeOfArray("retained_taxes");
while (i < count_i) {
    jResp.I = i;
    collected_at = jResp.StringOf("retained_taxes[i].collected_at");
    tax = jResp.StringOf("retained_taxes[i].tax");
    tax_percentage = jResp.StringOf("retained_taxes[i].tax_percentage");
    retained_tax_amount = jResp.StringOf("retained_taxes[i].retained_tax_amount");
    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/invoices/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "invoices",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `invoice.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific invoice."
  },
  "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/invoices/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "invoices",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"description\": \"<string>\",\n\t\"product_identification\": \"<string>\",\n\t\"quantity\": \"<integer>\",\n\t\"unit_code\": \"<string>\",\n\t\"unit_description\": \"<string>\",\n\t\"unit_amount\": \"<number>\",\n\t\"pre_tax_amount\": \"<number>\",\n\t\"tax_percentage\": \"<number>\",\n\t\"tax_amount\": \"<number>\",\n\t\"total_amount\": \"<number>\",\n\t\"retained_taxes\": [\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t},\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t}\n\t],\n\t\"collected_at\": \"<dateTime>\"\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/invoices/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "invoices",
            ":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/invoices/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "invoices",
            ":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]"
    }
  ]
}