Chilkat Online Tools

Unicode C++ / Belvo API Docs / List

Back to Collection Items

void ChilkatSample(void)
    {
    http.put_BasicAuth(true);    http.put_Login(L"{{secretId}}");    http.put_Password(L"{{secretPassword}}");    success = http.QuickGetSb(L"https://domain.com/api/tax-status/",sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    id = jResp.stringOf(L"results[i].id");    link = jResp.stringOf(L"results[i].link");    collected_at = jResp.stringOf(L"results[i].collected_at");    place_and_date_of_issuance = jResp.stringOf(L"results[i].place_and_date_of_issuance");    official_name = jResp.stringOf(L"results[i].official_name");    id_cif = jResp.stringOf(L"results[i].id_cif");    Rfc = jResp.stringOf(L"results[i].tax_payer_information.rfc");    Curp = jResp.stringOf(L"results[i].tax_payer_information.curp");    Name = jResp.stringOf(L"results[i].tax_payer_information.name");    First_last_name = jResp.stringOf(L"results[i].tax_payer_information.first_last_name");    Second_last_name = jResp.stringOf(L"results[i].tax_payer_information.second_last_name");    Start_operations_date = jResp.stringOf(L"results[i].tax_payer_information.start_operations_date");    Status_padron = jResp.stringOf(L"results[i].tax_payer_information.status_padron");    Last_status_change_date = jResp.stringOf(L"results[i].tax_payer_information.last_status_change_date");    Commercial_name = jResp.stringOf(L"results[i].tax_payer_information.commercial_name");    Social_name = jResp.stringOf(L"results[i].tax_payer_information.social_name");    v_Email = jResp.stringOf(L"results[i].tax_payer_information.email");    Phone = jResp.stringOf(L"results[i].tax_payer_information.phone");    Postal_code = jResp.stringOf(L"results[i].address.postal_code");    Street_type = jResp.stringOf(L"results[i].address.street_type");    Street = jResp.stringOf(L"results[i].address.street");    Exterior_number = jResp.stringOf(L"results[i].address.exterior_number");    Interior_number = jResp.stringOf(L"results[i].address.interior_number");    Suburb = jResp.stringOf(L"results[i].address.suburb");    Locality = jResp.stringOf(L"results[i].address.locality");    Municipality = jResp.stringOf(L"results[i].address.municipality");    State = jResp.stringOf(L"results[i].address.state");    Value = jResp.stringOf(L"results[i].address.between_street.value");    Obligation = jResp.stringOf(L"results[i].obligations.obligation");    Expiration = jResp.stringOf(L"results[i].obligations.expiration");    Initial_date = jResp.stringOf(L"results[i].obligations.initial_date");    End_date = jResp.stringOf(L"results[i].obligations.end_date");    personal_information = jResp.stringOf(L"results[i].personal_information");    digital_stamp = jResp.stringOf(L"results[i].digital_stamp");    digital_stamp_chain = jResp.stringOf(L"results[i].digital_stamp_chain");    pdf = jResp.stringOf(L"results[i].pdf");    j = 0;    count_j = jResp.SizeOfArray(L"results[i].economic_activity");    jResp.put_J(j);    economic_activityValue = jResp.stringOf(L"results[i].economic_activity[j].economic_activity.value");    end_dateValue = jResp.stringOf(L"results[i].economic_activity[j].end_date.value");    initial_dateValue = jResp.stringOf(L"results[i].economic_activity[j].initial_date.value");    orderValue = jResp.stringOf(L"results[i].economic_activity[j].order.value");    percentageValue = jResp.stringOf(L"results[i].economic_activity[j].percentage.value");    j = j + 1;    j = 0;    count_j = jResp.SizeOfArray(L"results[i].regimens");    jResp.put_J(j);    end_dateValue = jResp.stringOf(L"results[i].regimens[j].end_date.value");    initial_dateValue = jResp.stringOf(L"results[i].regimens[j].initial_date.value");    regimenValue = jResp.stringOf(L"results[i].regimens[j].regimen.value");    j = j + 1;    i = i + 1;
    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/tax-status/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "tax-status",
        ""
      ]
    },
    "description": "Get a paginated list of all existing tax status 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-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-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\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"place_and_date_of_issuance\": \"<string>\",\n\t\t\t\"official_name\": \"<string>\",\n\t\t\t\"id_cif\": \"<string>\",\n\t\t\t\"tax_payer_information\": {\n\t\t\t\t\"rfc\": \"<string>\",\n\t\t\t\t\"curp\": \"<string>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"first_last_name\": \"<string>\",\n\t\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\t\"start_operations_date\": \"<string>\",\n\t\t\t\t\"status_padron\": \"<string>\",\n\t\t\t\t\"last_status_change_date\": \"<string>\",\n\t\t\t\t\"commercial_name\": \"<string>\",\n\t\t\t\t\"social_name\": \"<string>\",\n\t\t\t\t\"email\": \"<string>\",\n\t\t\t\t\"phone\": \"<string>\"\n\t\t\t},\n\t\t\t\"address\": {\n\t\t\t\t\"postal_code\": \"<string>\",\n\t\t\t\t\"street_type\": \"<string>\",\n\t\t\t\t\"street\": \"<string>\",\n\t\t\t\t\"exterior_number\": \"<string>\",\n\t\t\t\t\"interior_number\": \"<string>\",\n\t\t\t\t\"suburb\": \"<string>\",\n\t\t\t\t\"locality\": \"<string>\",\n\t\t\t\t\"municipality\": \"<string>\",\n\t\t\t\t\"state\": \"<string>\",\n\t\t\t\t\"between_street\": {\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"economic_activity\": [\n\t\t\t\t{\n\t\t\t\t\t\"economic_activity\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"order\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"percentage\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"economic_activity\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"order\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"percentage\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"regimens\": [\n\t\t\t\t{\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"regimen\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"regimen\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"obligations\": {\n\t\t\t\t\"obligation\": \"<string>\",\n\t\t\t\t\"expiration\": \"<string>\",\n\t\t\t\t\"initial_date\": \"<string>\",\n\t\t\t\t\"end_date\": \"<string>\"\n\t\t\t},\n\t\t\t\"personal_information\": \"<object>\",\n\t\t\t\"digital_stamp\": \"<string>\",\n\t\t\t\"digital_stamp_chain\": \"<string>\",\n\t\t\t\"pdf\": \"<binary>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"place_and_date_of_issuance\": \"<string>\",\n\t\t\t\"official_name\": \"<string>\",\n\t\t\t\"id_cif\": \"<string>\",\n\t\t\t\"tax_payer_information\": {\n\t\t\t\t\"rfc\": \"<string>\",\n\t\t\t\t\"curp\": \"<string>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"first_last_name\": \"<string>\",\n\t\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\t\"start_operations_date\": \"<string>\",\n\t\t\t\t\"status_padron\": \"<string>\",\n\t\t\t\t\"last_status_change_date\": \"<string>\",\n\t\t\t\t\"commercial_name\": \"<string>\",\n\t\t\t\t\"social_name\": \"<string>\",\n\t\t\t\t\"email\": \"<string>\",\n\t\t\t\t\"phone\": \"<string>\"\n\t\t\t},\n\t\t\t\"address\": {\n\t\t\t\t\"postal_code\": \"<string>\",\n\t\t\t\t\"street_type\": \"<string>\",\n\t\t\t\t\"street\": \"<string>\",\n\t\t\t\t\"exterior_number\": \"<string>\",\n\t\t\t\t\"interior_number\": \"<string>\",\n\t\t\t\t\"suburb\": \"<string>\",\n\t\t\t\t\"locality\": \"<string>\",\n\t\t\t\t\"municipality\": \"<string>\",\n\t\t\t\t\"state\": \"<string>\",\n\t\t\t\t\"between_street\": {\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"economic_activity\": [\n\t\t\t\t{\n\t\t\t\t\t\"economic_activity\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"order\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"percentage\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"economic_activity\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"order\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"percentage\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"regimens\": [\n\t\t\t\t{\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"regimen\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"end_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"initial_date\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"regimen\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"obligations\": {\n\t\t\t\t\"obligation\": \"<string>\",\n\t\t\t\t\"expiration\": \"<string>\",\n\t\t\t\t\"initial_date\": \"<string>\",\n\t\t\t\t\"end_date\": \"<string>\"\n\t\t\t},\n\t\t\t\"personal_information\": \"<object>\",\n\t\t\t\"digital_stamp\": \"<string>\",\n\t\t\t\"digital_stamp_chain\": \"<string>\",\n\t\t\t\"pdf\": \"<binary>\"\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-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-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]"
    }
  ]
}