DataFlex / Zoom API / Get billing invoice reports
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sInvoice_number
String sInvoice_charge_name
Integer iQuantity
String sTotal_amount
String sTax_amount
String sStart_date
String sEnd_date
String sV_currency
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "billing_id" "quis officia in reprehenderit" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/report/billing/invoices" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "currency" To sV_currency
Move 0 To i
Get ComSizeOfArray Of hoJResp "invoices" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "invoices[i].invoice_number" To sInvoice_number
Get ComStringOf Of hoJResp "invoices[i].invoice_charge_name" To sInvoice_charge_name
Get ComIntOf Of hoJResp "invoices[i].quantity" To iQuantity
Get ComStringOf Of hoJResp "invoices[i].total_amount" To sTotal_amount
Get ComStringOf Of hoJResp "invoices[i].tax_amount" To sTax_amount
Get ComStringOf Of hoJResp "invoices[i].start_date" To sStart_date
Get ComStringOf Of hoJResp "invoices[i].end_date" To sEnd_date
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
