Chilkat Online Tools

PureBasic / Belvo API Docs / List

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{secretId}}")
    CkHttp::setCkPassword(http, "{{secretPassword}}")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/api/recurring-expenses/",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/recurring-expenses/

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/recurring-expenses/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "recurring-expenses",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "<integer>",
          "disabled": true
        }
      ]
    },
    "description": "Get a paginated list of all recurring expenses in your Belvo account. We return up to 100 results per page.\n### Filterable fields\n\n\n  Please see the table below for an alphabetized list of fields that you can\n  filter your **List** responses by. For more information on how to use filters, see\n  our [Filtering\n  responses](https://developers.belvo.com/docs/searching-and-filtering)\n  article.\n\n\n  |Field| Available Filters|\n  |---|---|\n  |`account_id`|`=`, `in`|\n  |`account_link`|`=`, `in`|"
  },
  "response": [
  ]
}