Back to Collection Items
require '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(true)
http.put_Login("{{secretId}}")
http.put_Password("{{secretPassword}}")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/api/tax-status/",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next": "<string>",
# "previous": "<string>",
# "results": [
# {
# "id": "<uuid>",
# "link": "<uuid>",
# "collected_at": "<dateTime>",
# "place_and_date_of_issuance": "<string>",
# "official_name": "<string>",
# "id_cif": "<string>",
# "tax_payer_information": {
# "rfc": "<string>",
# "curp": "<string>",
# "name": "<string>",
# "first_last_name": "<string>",
# "second_last_name": "<string>",
# "start_operations_date": "<string>",
# "status_padron": "<string>",
# "last_status_change_date": "<string>",
# "commercial_name": "<string>",
# "social_name": "<string>",
# "email": "<string>",
# "phone": "<string>"
# },
# "address": {
# "postal_code": "<string>",
# "street_type": "<string>",
# "street": "<string>",
# "exterior_number": "<string>",
# "interior_number": "<string>",
# "suburb": "<string>",
# "locality": "<string>",
# "municipality": "<string>",
# "state": "<string>",
# "between_street": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "economic_activity": [
# {
# "economic_activity": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "order": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "percentage": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "economic_activity": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "order": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "percentage": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# }
# ],
# "regimens": [
# {
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "regimen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "regimen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# }
# ],
# "obligations": {
# "obligation": "<string>",
# "expiration": "<string>",
# "initial_date": "<string>",
# "end_date": "<string>"
# },
# "personal_information": "<object>",
# "digital_stamp": "<string>",
# "digital_stamp_chain": "<string>",
# "pdf": "<binary>"
# },
# {
# "id": "<uuid>",
# "link": "<uuid>",
# "collected_at": "<dateTime>",
# "place_and_date_of_issuance": "<string>",
# "official_name": "<string>",
# "id_cif": "<string>",
# "tax_payer_information": {
# "rfc": "<string>",
# "curp": "<string>",
# "name": "<string>",
# "first_last_name": "<string>",
# "second_last_name": "<string>",
# "start_operations_date": "<string>",
# "status_padron": "<string>",
# "last_status_change_date": "<string>",
# "commercial_name": "<string>",
# "social_name": "<string>",
# "email": "<string>",
# "phone": "<string>"
# },
# "address": {
# "postal_code": "<string>",
# "street_type": "<string>",
# "street": "<string>",
# "exterior_number": "<string>",
# "interior_number": "<string>",
# "suburb": "<string>",
# "locality": "<string>",
# "municipality": "<string>",
# "state": "<string>",
# "between_street": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "economic_activity": [
# {
# "economic_activity": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "order": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "percentage": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "economic_activity": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "order": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "percentage": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# }
# ],
# "regimens": [
# {
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "regimen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "end_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "initial_date": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "regimen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# }
# ],
# "obligations": {
# "obligation": "<string>",
# "expiration": "<string>",
# "initial_date": "<string>",
# "end_date": "<string>"
# },
# "personal_information": "<object>",
# "digital_stamp": "<string>",
# "digital_stamp_chain": "<string>",
# "pdf": "<binary>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
count = jResp.stringOf("count")
v_next = jResp.stringOf("next")
previous = jResp.stringOf("previous")
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("results[i].id")
link = jResp.stringOf("results[i].link")
collected_at = jResp.stringOf("results[i].collected_at")
place_and_date_of_issuance = jResp.stringOf("results[i].place_and_date_of_issuance")
official_name = jResp.stringOf("results[i].official_name")
id_cif = jResp.stringOf("results[i].id_cif")
Rfc = jResp.stringOf("results[i].tax_payer_information.rfc")
Curp = jResp.stringOf("results[i].tax_payer_information.curp")
Name = jResp.stringOf("results[i].tax_payer_information.name")
First_last_name = jResp.stringOf("results[i].tax_payer_information.first_last_name")
Second_last_name = jResp.stringOf("results[i].tax_payer_information.second_last_name")
Start_operations_date = jResp.stringOf("results[i].tax_payer_information.start_operations_date")
Status_padron = jResp.stringOf("results[i].tax_payer_information.status_padron")
Last_status_change_date = jResp.stringOf("results[i].tax_payer_information.last_status_change_date")
Commercial_name = jResp.stringOf("results[i].tax_payer_information.commercial_name")
Social_name = jResp.stringOf("results[i].tax_payer_information.social_name")
v_Email = jResp.stringOf("results[i].tax_payer_information.email")
Phone = jResp.stringOf("results[i].tax_payer_information.phone")
Postal_code = jResp.stringOf("results[i].address.postal_code")
Street_type = jResp.stringOf("results[i].address.street_type")
Street = jResp.stringOf("results[i].address.street")
Exterior_number = jResp.stringOf("results[i].address.exterior_number")
Interior_number = jResp.stringOf("results[i].address.interior_number")
Suburb = jResp.stringOf("results[i].address.suburb")
Locality = jResp.stringOf("results[i].address.locality")
Municipality = jResp.stringOf("results[i].address.municipality")
State = jResp.stringOf("results[i].address.state")
Value = jResp.stringOf("results[i].address.between_street.value")
Obligation = jResp.stringOf("results[i].obligations.obligation")
Expiration = jResp.stringOf("results[i].obligations.expiration")
Initial_date = jResp.stringOf("results[i].obligations.initial_date")
End_date = jResp.stringOf("results[i].obligations.end_date")
personal_information = jResp.stringOf("results[i].personal_information")
digital_stamp = jResp.stringOf("results[i].digital_stamp")
digital_stamp_chain = jResp.stringOf("results[i].digital_stamp_chain")
pdf = jResp.stringOf("results[i].pdf")
j = 0
count_j = jResp.SizeOfArray("results[i].economic_activity")
while j < count_j
jResp.put_J(j)
economic_activityValue = jResp.stringOf("results[i].economic_activity[j].economic_activity.value")
end_dateValue = jResp.stringOf("results[i].economic_activity[j].end_date.value")
initial_dateValue = jResp.stringOf("results[i].economic_activity[j].initial_date.value")
orderValue = jResp.stringOf("results[i].economic_activity[j].order.value")
percentageValue = jResp.stringOf("results[i].economic_activity[j].percentage.value")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("results[i].regimens")
while j < count_j
jResp.put_J(j)
end_dateValue = jResp.stringOf("results[i].regimens[j].end_date.value")
initial_dateValue = jResp.stringOf("results[i].regimens[j].initial_date.value")
regimenValue = jResp.stringOf("results[i].regimens[j].regimen.value")
j = j + 1
end
i = i + 1
end
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]"
}
]
}
