Chilkat Online Tools

Python / Belvo API Docs / Retrieve

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

http.BasicAuth = True
http.Login = "{{secretId}}"
http.Password = "{{secretPassword}}"

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "link": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
#   "attach_pdf": false,
#   "save_data": true
# }

json = chilkat2.JsonObject()
json.UpdateString("link","d4617561-1c01-4b2f-83b6-a594f7b3bc57")
json.UpdateBool("attach_pdf",False)
json.UpdateBool("save_data",True)

http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/tax-status/","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

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

# {
#   "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

collected_at = jResp.StringOf("collected_at")
place_and_date_of_issuance = jResp.StringOf("place_and_date_of_issuance")
official_name = jResp.StringOf("official_name")
id_cif = jResp.StringOf("id_cif")
Rfc = jResp.StringOf("tax_payer_information.rfc")
Curp = jResp.StringOf("tax_payer_information.curp")
Name = jResp.StringOf("tax_payer_information.name")
First_last_name = jResp.StringOf("tax_payer_information.first_last_name")
Second_last_name = jResp.StringOf("tax_payer_information.second_last_name")
Start_operations_date = jResp.StringOf("tax_payer_information.start_operations_date")
Status_padron = jResp.StringOf("tax_payer_information.status_padron")
Last_status_change_date = jResp.StringOf("tax_payer_information.last_status_change_date")
Commercial_name = jResp.StringOf("tax_payer_information.commercial_name")
Social_name = jResp.StringOf("tax_payer_information.social_name")
v_Email = jResp.StringOf("tax_payer_information.email")
Phone = jResp.StringOf("tax_payer_information.phone")
Postal_code = jResp.StringOf("address.postal_code")
Street_type = jResp.StringOf("address.street_type")
Street = jResp.StringOf("address.street")
Exterior_number = jResp.StringOf("address.exterior_number")
Interior_number = jResp.StringOf("address.interior_number")
Suburb = jResp.StringOf("address.suburb")
Locality = jResp.StringOf("address.locality")
Municipality = jResp.StringOf("address.municipality")
State = jResp.StringOf("address.state")
Value = jResp.StringOf("address.between_street.value")
Obligation = jResp.StringOf("obligations.obligation")
Expiration = jResp.StringOf("obligations.expiration")
Initial_date = jResp.StringOf("obligations.initial_date")
End_date = jResp.StringOf("obligations.end_date")
personal_information = jResp.StringOf("personal_information")
digital_stamp = jResp.StringOf("digital_stamp")
digital_stamp_chain = jResp.StringOf("digital_stamp_chain")
pdf = jResp.StringOf("pdf")
i = 0
count_i = jResp.SizeOfArray("economic_activity")
while i < count_i :
    jResp.I = i
    economic_activityValue = jResp.StringOf("economic_activity[i].economic_activity.value")
    end_dateValue = jResp.StringOf("economic_activity[i].end_date.value")
    initial_dateValue = jResp.StringOf("economic_activity[i].initial_date.value")
    orderValue = jResp.StringOf("economic_activity[i].order.value")
    percentageValue = jResp.StringOf("economic_activity[i].percentage.value")
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("regimens")
while i < count_i :
    jResp.I = i
    end_dateValue = jResp.StringOf("regimens[i].end_date.value")
    initial_dateValue = jResp.StringOf("regimens[i].initial_date.value")
    regimenValue = jResp.StringOf("regimens[i].regimen.value")
    i = i + 1

Curl Command

curl -X POST
	-u '{{secretId}}:{{secretPassword}}'
	-H "Content-Type: application/json"
	-d '{
    "link": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
    "attach_pdf": false,
    "save_data": true
}'
https://domain.com/api/tax-status/

Postman Collection Item JSON

{
  "name": "Retrieve",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"link\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\",\n    \"attach_pdf\": false,\n    \"save_data\": true\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/tax-status/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "tax-status",
        ""
      ]
    },
    "description": "Retrieve tax status information for a specific fiscal link."
  },
  "response": [
    {
      "name": "Ok (when save_data=false)",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"<uuid>\",\n    \"attach_pdf\": false,\n    \"encryption_key\": \"<string>\",\n    \"save_data\": true\n}"
        },
        "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\"collected_at\": \"<dateTime>\",\n\t\"place_and_date_of_issuance\": \"<string>\",\n\t\"official_name\": \"<string>\",\n\t\"id_cif\": \"<string>\",\n\t\"tax_payer_information\": {\n\t\t\"rfc\": \"<string>\",\n\t\t\"curp\": \"<string>\",\n\t\t\"name\": \"<string>\",\n\t\t\"first_last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"start_operations_date\": \"<string>\",\n\t\t\"status_padron\": \"<string>\",\n\t\t\"last_status_change_date\": \"<string>\",\n\t\t\"commercial_name\": \"<string>\",\n\t\t\"social_name\": \"<string>\",\n\t\t\"email\": \"<string>\",\n\t\t\"phone\": \"<string>\"\n\t},\n\t\"address\": {\n\t\t\"postal_code\": \"<string>\",\n\t\t\"street_type\": \"<string>\",\n\t\t\"street\": \"<string>\",\n\t\t\"exterior_number\": \"<string>\",\n\t\t\"interior_number\": \"<string>\",\n\t\t\"suburb\": \"<string>\",\n\t\t\"locality\": \"<string>\",\n\t\t\"municipality\": \"<string>\",\n\t\t\"state\": \"<string>\",\n\t\t\"between_street\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t\"economic_activity\": [\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"regimens\": [\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"obligations\": {\n\t\t\"obligation\": \"<string>\",\n\t\t\"expiration\": \"<string>\",\n\t\t\"initial_date\": \"<string>\",\n\t\t\"end_date\": \"<string>\"\n\t},\n\t\"personal_information\": \"<object>\",\n\t\"digital_stamp\": \"<string>\",\n\t\"digital_stamp_chain\": \"<string>\",\n\t\"pdf\": \"<binary>\"\n}"
    },
    {
      "name": "Created (when save_data=true)",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"<uuid>\",\n    \"attach_pdf\": false,\n    \"encryption_key\": \"<string>\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/tax-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-status"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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\"place_and_date_of_issuance\": \"<string>\",\n\t\"official_name\": \"<string>\",\n\t\"id_cif\": \"<string>\",\n\t\"tax_payer_information\": {\n\t\t\"rfc\": \"<string>\",\n\t\t\"curp\": \"<string>\",\n\t\t\"name\": \"<string>\",\n\t\t\"first_last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"start_operations_date\": \"<string>\",\n\t\t\"status_padron\": \"<string>\",\n\t\t\"last_status_change_date\": \"<string>\",\n\t\t\"commercial_name\": \"<string>\",\n\t\t\"social_name\": \"<string>\",\n\t\t\"email\": \"<string>\",\n\t\t\"phone\": \"<string>\"\n\t},\n\t\"address\": {\n\t\t\"postal_code\": \"<string>\",\n\t\t\"street_type\": \"<string>\",\n\t\t\"street\": \"<string>\",\n\t\t\"exterior_number\": \"<string>\",\n\t\t\"interior_number\": \"<string>\",\n\t\t\"suburb\": \"<string>\",\n\t\t\"locality\": \"<string>\",\n\t\t\"municipality\": \"<string>\",\n\t\t\"state\": \"<string>\",\n\t\t\"between_street\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t\"economic_activity\": [\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"regimens\": [\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"obligations\": {\n\t\t\"obligation\": \"<string>\",\n\t\t\"expiration\": \"<string>\",\n\t\t\"initial_date\": \"<string>\",\n\t\t\"end_date\": \"<string>\"\n\t},\n\t\"personal_information\": \"<object>\",\n\t\"digital_stamp\": \"<string>\",\n\t\"digital_stamp_chain\": \"<string>\",\n\t\"pdf\": \"<binary>\"\n}"
    },
    {
      "name": "Bad request error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"<uuid>\",\n    \"attach_pdf\": false,\n    \"encryption_key\": \"<string>\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/tax-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-status"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"<uuid>\",\n    \"attach_pdf\": false,\n    \"encryption_key\": \"<string>\",\n    \"save_data\": true\n}"
        },
        "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]"
    },
    {
      "name": "Request Timeout",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"<uuid>\",\n    \"attach_pdf\": false,\n    \"encryption_key\": \"<string>\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/tax-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-status"
          ]
        }
      },
      "status": "Request Timeout",
      "code": 408,
      "_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": "Unexpected Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"link\": \"<uuid>\",\n    \"attach_pdf\": false,\n    \"encryption_key\": \"<string>\",\n    \"save_data\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/tax-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-status"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_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]"
    }
  ]
}