Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.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
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("link","d4617561-1c01-4b2f-83b6-a594f7b3bc57")
$oJson.UpdateBool("attach_pdf",False)
$oJson.UpdateBool("save_data",True)
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://domain.com/api/tax-compliance-status/","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "collected_at": "<dateTime>",
; "internal_identification": "<string>",
; "pdf": "<binary>",
; "rfc": "<string>",
; "outcome": "<string>"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sCollected_at = $oJResp.StringOf("collected_at")
Local $sInternal_identification = $oJResp.StringOf("internal_identification")
Local $sPdf = $oJResp.StringOf("pdf")
Local $sRfc = $oJResp.StringOf("rfc")
Local $sOutcome = $oJResp.StringOf("outcome")
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-compliance-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-compliance-status/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-status",
""
]
},
"description": "Retrieve the Tax compliance 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-compliance-status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-status"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"collected_at\": \"<dateTime>\",\n\t\"internal_identification\": \"<string>\",\n\t\"pdf\": \"<binary>\",\n\t\"rfc\": \"<string>\",\n\t\"outcome\": \"<string>\"\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-compliance-status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-status"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"internal_identification\": \"<string>\",\n\t\"pdf\": \"<binary>\",\n\t\"rfc\": \"<string>\",\n\t\"outcome\": \"<string>\"\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-compliance-status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-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-compliance-status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-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-compliance-status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-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-compliance-status",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-compliance-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]"
}
]
}
