Chilkat Online Tools

Perl / Belvo API Docs / Detail

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("{{secretId}}");
$http->put_Password("{{secretPassword}}");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://domain.com/api/tax-returns/:id/",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

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

# {
#   "id": "<uuid>",
#   "link": "<uuid>",
#   "collected_at": "<dateTime>",
#   "informacion_general": "<object>",
#   "sueldos_salarios": "<object>",
#   "servicios_profesionales": "<object>",
#   "deducciones_personales": "<object>",
#   "determinacion_impuesto": "<object>",
#   "retenciones": "<object>",
#   "dividendos": "<object>",
#   "datos_informativos": "<object>",
#   "pdf": "<binary>"
# }

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

$id = $jResp->stringOf("id");
$link = $jResp->stringOf("link");
$collected_at = $jResp->stringOf("collected_at");
$informacion_general = $jResp->stringOf("informacion_general");
$sueldos_salarios = $jResp->stringOf("sueldos_salarios");
$servicios_profesionales = $jResp->stringOf("servicios_profesionales");
$deducciones_personales = $jResp->stringOf("deducciones_personales");
$determinacion_impuesto = $jResp->stringOf("determinacion_impuesto");
$retenciones = $jResp->stringOf("retenciones");
$dividendos = $jResp->stringOf("dividendos");
$datos_informativos = $jResp->stringOf("datos_informativos");
$pdf = $jResp->stringOf("pdf");

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/tax-returns/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "tax-returns",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `tax-return.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific tax return."
  },
  "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-returns/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-returns",
            ":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\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"informacion_general\": \"<object>\",\n\t\"sueldos_salarios\": \"<object>\",\n\t\"servicios_profesionales\": \"<object>\",\n\t\"deducciones_personales\": \"<object>\",\n\t\"determinacion_impuesto\": \"<object>\",\n\t\"retenciones\": \"<object>\",\n\t\"dividendos\": \"<object>\",\n\t\"datos_informativos\": \"<object>\",\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/tax-returns/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-returns",
            ":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/tax-returns/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-returns",
            ":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]"
    }
  ]
}