Chilkat Online Tools

VB.NET / Zoom API / Get billing invoice reports

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 Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("billing_id","quis officia in reprehenderit")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"


Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://api.zoom.us/v2/report/billing/invoices",queryParams)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "invoices": [
'     {
'       "invoice_number": "1234665",
'       "invoice_charge_name": "Audio Conferencing Options",
'       "quantity": 5,
'       "total_amount": "150000",
'       "tax_amount": "1000",
'       "start_date": "2019-12-12",
'       "end_date": "2020-01-12"
'     }
'   ],
'   "currency": "USD"
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code



Dim invoice_number As String
Dim invoice_charge_name As String
Dim quantity As Integer
Dim total_amount As String
Dim tax_amount As String
Dim start_date As String
Dim end_date As String

Dim v_currency As String = jResp.StringOf("currency")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("invoices")
While i < count_i
    jResp.I = i
    invoice_number = jResp.StringOf("invoices[i].invoice_number")
    invoice_charge_name = jResp.StringOf("invoices[i].invoice_charge_name")
    quantity = jResp.IntOf("invoices[i].quantity")
    total_amount = jResp.StringOf("invoices[i].total_amount")
    tax_amount = jResp.StringOf("invoices[i].tax_amount")
    start_date = jResp.StringOf("invoices[i].start_date")
    end_date = jResp.StringOf("invoices[i].end_date")
    i = i + 1
End While

Curl Command

curl -G -d "billing_id=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/billing/invoices

Postman Collection Item JSON

{
  "name": "Get billing invoice reports",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/report/billing/invoices?billing_id=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "report",
        "billing",
        "invoices"
      ],
      "query": [
        {
          "key": "billing_id",
          "value": "quis officia in reprehenderit",
          "description": "Unique Identifier of the Billing Report. Retrieve this ID from the response of **Get Billing Reports** API request. \n\n"
        }
      ]
    },
    "description": "Get department billing invoices reports for a specific billing period. Provide the `billing_id` of the billing period for which you would like to retrieve the invoices for. This ID can be retrieved from **Get Billing Reports** API. \n\n**Prerequisites:**<br>\n* Pro or a higher account with Department Billing option enabled. Contact the Zoom Support team to enable this feature.\n\n**Scopes:** `report:read:admin`, `report:master`\n\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` **OK**<br>\nBilling Invoice reports returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/billing/invoices?billing_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "billing",
            "invoices"
          ],
          "query": [
            {
              "key": "billing_id",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"invoices\": [\n  {\n   \"invoice_number\": \"1234665\",\n   \"invoice_charge_name\": \"Audio Conferencing Options\",\n   \"quantity\": 5,\n   \"total_amount\": \"150000\",\n   \"tax_amount\": \"1000\",\n   \"start_date\": \"2019-12-12\",\n   \"end_date\": \"2020-01-12\"\n  }\n ],\n \"currency\": \"USD\"\n}"
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\n**Error Code:** `5010`<br>\nReport does not exist.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/billing/invoices?billing_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "billing",
            "invoices"
          ],
          "query": [
            {
              "key": "billing_id",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}