SQL Server / Zoom API / Get billing invoice reports
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'billing_id', 'quis officia in reprehenderit'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/report/billing/invoices', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @invoice_number nvarchar(4000)
DECLARE @invoice_charge_name nvarchar(4000)
DECLARE @quantity int
DECLARE @total_amount nvarchar(4000)
DECLARE @tax_amount nvarchar(4000)
DECLARE @start_date nvarchar(4000)
DECLARE @end_date nvarchar(4000)
DECLARE @v_currency nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_currency OUT, 'currency'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'invoices'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @invoice_number OUT, 'invoices[i].invoice_number'
EXEC sp_OAMethod @jResp, 'StringOf', @invoice_charge_name OUT, 'invoices[i].invoice_charge_name'
EXEC sp_OAMethod @jResp, 'IntOf', @quantity OUT, 'invoices[i].quantity'
EXEC sp_OAMethod @jResp, 'StringOf', @total_amount OUT, 'invoices[i].total_amount'
EXEC sp_OAMethod @jResp, 'StringOf', @tax_amount OUT, 'invoices[i].tax_amount'
EXEC sp_OAMethod @jResp, 'StringOf', @start_date OUT, 'invoices[i].start_date'
EXEC sp_OAMethod @jResp, 'StringOf', @end_date OUT, 'invoices[i].end_date'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
