Chilkat Online Tools

autoit / Belvo API Docs / Detail

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}}"

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/invoices/:id/",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sTax
Local $sRetained_tax_amount

Local $sDescription = $oJResp.StringOf("description")
Local $sProduct_identification = $oJResp.StringOf("product_identification")
Local $sQuantity = $oJResp.StringOf("quantity")
Local $sUnit_code = $oJResp.StringOf("unit_code")
Local $sUnit_description = $oJResp.StringOf("unit_description")
Local $sUnit_amount = $oJResp.StringOf("unit_amount")
Local $sPre_tax_amount = $oJResp.StringOf("pre_tax_amount")
Local $sTax_percentage = $oJResp.StringOf("tax_percentage")
Local $sTax_amount = $oJResp.StringOf("tax_amount")
Local $sTotal_amount = $oJResp.StringOf("total_amount")
Local $sCollected_at = $oJResp.StringOf("collected_at")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("retained_taxes")
While $i < $iCount_i
    $oJResp.I = $i
    $sCollected_at = $oJResp.StringOf("retained_taxes[i].collected_at")
    $sTax = $oJResp.StringOf("retained_taxes[i].tax")
    $sTax_percentage = $oJResp.StringOf("retained_taxes[i].tax_percentage")
    $sRetained_tax_amount = $oJResp.StringOf("retained_taxes[i].retained_tax_amount")
    $i = $i + 1
Wend

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]"
    }
  ]
}