C / Zoom API / Get billing invoice reports
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *invoice_number;
const char *invoice_charge_name;
int quantity;
const char *total_amount;
const char *tax_amount;
const char *start_date;
const char *end_date;
const char *v_currency;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"billing_id","quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
resp = CkHttp_QuickRequestParams(http,"GET","https://api.zoom.us/v2/report/billing/invoices",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
v_currency = CkJsonObject_stringOf(jResp,"currency");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"invoices");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
invoice_number = CkJsonObject_stringOf(jResp,"invoices[i].invoice_number");
invoice_charge_name = CkJsonObject_stringOf(jResp,"invoices[i].invoice_charge_name");
quantity = CkJsonObject_IntOf(jResp,"invoices[i].quantity");
total_amount = CkJsonObject_stringOf(jResp,"invoices[i].total_amount");
tax_amount = CkJsonObject_stringOf(jResp,"invoices[i].tax_amount");
start_date = CkJsonObject_stringOf(jResp,"invoices[i].start_date");
end_date = CkJsonObject_stringOf(jResp,"invoices[i].end_date");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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": ""
}
]
}
