Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
http.BasicAuth = 1
http.Login = "{{secretId}}"
http.Password = "{{secretPassword}}"
Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/api/invoices/:id/",sbResponseBody)
If (success = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print http.LastHeader
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "description": "<string>",
' "product_identification": "<string>",
' "quantity": "<integer>",
' "unit_code": "<string>",
' "unit_description": "<string>",
' "unit_amount": "<number>",
' "pre_tax_amount": "<number>",
' "tax_percentage": "<number>",
' "tax_amount": "<number>",
' "total_amount": "<number>",
' "retained_taxes": [
' {
' "collected_at": "<dateTime>",
' "tax": "<string>",
' "tax_percentage": "<number>",
' "retained_tax_amount": "<number>"
' },
' {
' "collected_at": "<dateTime>",
' "tax": "<string>",
' "tax_percentage": "<number>",
' "retained_tax_amount": "<number>"
' }
' ],
' "collected_at": "<dateTime>"
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim tax As String
Dim retained_tax_amount As String
Dim description As String
description = jResp.StringOf("description")
Dim product_identification As String
product_identification = jResp.StringOf("product_identification")
Dim quantity As String
quantity = jResp.StringOf("quantity")
Dim unit_code As String
unit_code = jResp.StringOf("unit_code")
Dim unit_description As String
unit_description = jResp.StringOf("unit_description")
Dim unit_amount As String
unit_amount = jResp.StringOf("unit_amount")
Dim pre_tax_amount As String
pre_tax_amount = jResp.StringOf("pre_tax_amount")
Dim tax_percentage As String
tax_percentage = jResp.StringOf("tax_percentage")
Dim tax_amount As String
tax_amount = jResp.StringOf("tax_amount")
Dim total_amount As String
total_amount = jResp.StringOf("total_amount")
Dim collected_at As String
collected_at = jResp.StringOf("collected_at")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("retained_taxes")
Do While i < count_i
jResp.I = i
collected_at = jResp.StringOf("retained_taxes[i].collected_at")
tax = jResp.StringOf("retained_taxes[i].tax")
tax_percentage = jResp.StringOf("retained_taxes[i].tax_percentage")
retained_tax_amount = jResp.StringOf("retained_taxes[i].retained_tax_amount")
i = i + 1
Loop
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/invoices/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/invoices/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `invoice.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific invoice."
},
"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/invoices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"description\": \"<string>\",\n\t\"product_identification\": \"<string>\",\n\t\"quantity\": \"<integer>\",\n\t\"unit_code\": \"<string>\",\n\t\"unit_description\": \"<string>\",\n\t\"unit_amount\": \"<number>\",\n\t\"pre_tax_amount\": \"<number>\",\n\t\"tax_percentage\": \"<number>\",\n\t\"tax_amount\": \"<number>\",\n\t\"total_amount\": \"<number>\",\n\t\"retained_taxes\": [\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t},\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t}\n\t],\n\t\"collected_at\": \"<dateTime>\"\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/invoices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":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/invoices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":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]"
}
]
}
