Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Value
string ls_Accounting_dateValue
string ls_Value_dateValue
string ls_ReferenceValue
string ls_ObservationsValue
string ls_Additional_dataValue
string ls_BalanceValue
string ls_StatusValue
string ls_TypeValue
string ls_CurrencyValue
string ls_DescriptionValue
string ls_Internal_identificationValue
string ls_AccountValue
string ls_Id
string ls_Link
string ls_Id
string ls_Name
string ls_Category
string ls_V_Currency
string ls_Collected_at
string ls_Account_number
string ls_Client_number
string ls_RFC
string ls_CLABE
string ls_Period_start_date
string ls_Period_end_date
string ls_Cut_date
string ls_Final_balance
string ls_Previous_balance
string ls_Total_inflow_amount
string ls_Total_outflow_amount
string ls_Total_inflow_transactions
string ls_Total_outflow_transactions
string ls_Pdf
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "{{secretId}}"
loo_Http.Password = "{{secretPassword}}"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://domain.com/api/statements/:id/",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "<uuid>",
// "link": "<string>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "non consequat",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "account_number": "<string>",
// "client_number": "<string>",
// "RFC": "<string>",
// "CLABE": "<string>",
// "period_start_date": "<date>",
// "period_end_date": "<date>",
// "cut_date": "<string>",
// "final_balance": "<number>",
// "previous_balance": "<number>",
// "total_inflow_amount": "<number>",
// "total_outflow_amount": "<number>",
// "total_inflow_transactions": "<number>",
// "total_outflow_transactions": "<number>",
// "transactions": [
// {
// "collected_at": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "accounting_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "reference": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "observations": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "additional_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "balance": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "status": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "currency": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "description": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "internal_identification": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "account": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "collected_at": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "accounting_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value_date": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "reference": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "observations": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "additional_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "balance": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "status": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "currency": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "description": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "internal_identification": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "account": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ],
// "pdf": "<binary>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Id = loo_JResp.StringOf("id")
ls_Link = loo_JResp.StringOf("link")
ls_Id = loo_JResp.StringOf("account.id")
ls_Name = loo_JResp.StringOf("account.name")
ls_Category = loo_JResp.StringOf("account.category")
ls_V_Currency = loo_JResp.StringOf("account.currency")
ls_Collected_at = loo_JResp.StringOf("collected_at")
ls_Account_number = loo_JResp.StringOf("account_number")
ls_Client_number = loo_JResp.StringOf("client_number")
ls_RFC = loo_JResp.StringOf("RFC")
ls_CLABE = loo_JResp.StringOf("CLABE")
ls_Period_start_date = loo_JResp.StringOf("period_start_date")
ls_Period_end_date = loo_JResp.StringOf("period_end_date")
ls_Cut_date = loo_JResp.StringOf("cut_date")
ls_Final_balance = loo_JResp.StringOf("final_balance")
ls_Previous_balance = loo_JResp.StringOf("previous_balance")
ls_Total_inflow_amount = loo_JResp.StringOf("total_inflow_amount")
ls_Total_outflow_amount = loo_JResp.StringOf("total_outflow_amount")
ls_Total_inflow_transactions = loo_JResp.StringOf("total_inflow_transactions")
ls_Total_outflow_transactions = loo_JResp.StringOf("total_outflow_transactions")
ls_Pdf = loo_JResp.StringOf("pdf")
i = 0
li_Count_i = loo_JResp.SizeOfArray("transactions")
do while i < li_Count_i
loo_JResp.I = i
ls_Value = loo_JResp.StringOf("transactions[i].collected_at.value")
ls_Accounting_dateValue = loo_JResp.StringOf("transactions[i].accounting_date.value")
ls_Value_dateValue = loo_JResp.StringOf("transactions[i].value_date.value")
ls_ReferenceValue = loo_JResp.StringOf("transactions[i].reference.value")
ls_ObservationsValue = loo_JResp.StringOf("transactions[i].observations.value")
ls_Additional_dataValue = loo_JResp.StringOf("transactions[i].additional_data.value")
ls_BalanceValue = loo_JResp.StringOf("transactions[i].balance.value")
ls_StatusValue = loo_JResp.StringOf("transactions[i].status.value")
ls_TypeValue = loo_JResp.StringOf("transactions[i].type.value")
ls_CurrencyValue = loo_JResp.StringOf("transactions[i].currency.value")
ls_DescriptionValue = loo_JResp.StringOf("transactions[i].description.value")
ls_Internal_identificationValue = loo_JResp.StringOf("transactions[i].internal_identification.value")
ls_AccountValue = loo_JResp.StringOf("transactions[i].account.value")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/statements/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/statements/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `statement.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific statement."
},
"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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":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\": \"<string>\",\n\t\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"name\": \"<string>\",\n\t\t\"category\": \"non consequat\",\n\t\t\"currency\": \"<string>\"\n\t},\n\t\"collected_at\": \"<dateTime>\",\n\t\"account_number\": \"<string>\",\n\t\"client_number\": \"<string>\",\n\t\"RFC\": \"<string>\",\n\t\"CLABE\": \"<string>\",\n\t\"period_start_date\": \"<date>\",\n\t\"period_end_date\": \"<date>\",\n\t\"cut_date\": \"<string>\",\n\t\"final_balance\": \"<number>\",\n\t\"previous_balance\": \"<number>\",\n\t\"total_inflow_amount\": \"<number>\",\n\t\"total_outflow_amount\": \"<number>\",\n\t\"total_inflow_transactions\": \"<number>\",\n\t\"total_outflow_transactions\": \"<number>\",\n\t\"transactions\": [\n\t\t{\n\t\t\t\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"accounting_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\"value_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\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"account\": {\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\"collected_at\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"accounting_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\"value_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\"reference\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"observations\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"additional_data\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"balance\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"currency\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"internal_identification\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"account\": {\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\"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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":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/statements/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"statements",
":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]"
}
]
}
