Chilkat Online Tools

Objective-C / Zoom API / List billing invoices

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"from" value: @"1989-05-07"];
[queryParams UpdateString: @"to" value: @"1989-05-07"];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.zoom.us/v2/accounts/:accountId/billing/invoices" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

// {
//   "invoices": [
//     {
//       "id": "2c92c12348d07e0580",
//       "invoice_number": "S8INsdf4534000001",
//       "total_amount": 2039,
//       "tax_amount": 0,
//       "balance": 2039,
//       "due_date": "2020-08-07",
//       "invoice_date": "2020-08-07",
//       "target_date": "2020-08-07",
//       "status": "Draft"
//     }
//   ],
//   "currency": "USD"
// }

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

NSString *id = 0;
NSString *invoice_number = 0;
int total_amount;
int tax_amount;
int balance;
NSString *due_date = 0;
NSString *invoice_date = 0;
NSString *target_date = 0;
NSString *status = 0;

NSString *v_currency = [jResp StringOf: @"currency"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"invoices"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"invoices[i].id"];
    invoice_number = [jResp StringOf: @"invoices[i].invoice_number"];
    total_amount = [[jResp IntOf: @"invoices[i].total_amount"] intValue];
    tax_amount = [[jResp IntOf: @"invoices[i].tax_amount"] intValue];
    balance = [[jResp IntOf: @"invoices[i].balance"] intValue];
    due_date = [jResp StringOf: @"invoices[i].due_date"];
    invoice_date = [jResp StringOf: @"invoices[i].invoice_date"];
    target_date = [jResp StringOf: @"invoices[i].target_date"];
    status = [jResp StringOf: @"invoices[i].status"];
    i = i + 1;
}

Curl Command

curl -G -d "from=1989-05-07"
	-d "to=1989-05-07"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/billing/invoices

Postman Collection Item JSON

{
  "name": "List billing invoices",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/accounts/:accountId/billing/invoices?from=1989-05-07&to=1989-05-07",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "accounts",
        ":accountId",
        "billing",
        "invoices"
      ],
      "query": [
        {
          "key": "from",
          "value": "1989-05-07",
          "description": "Start date for the invoice query in `yyyy-mm-dd` format. The date range defined by the “from” and “to” parameters should not exceed one year. The range defined should fall within the past three years.\n"
        },
        {
          "key": "to",
          "value": "1989-05-07",
          "description": "End date for the invoice query in `yyyy-mm-dd` format"
        }
      ],
      "variable": [
        {
          "key": "accountId"
        }
      ]
    },
    "description": "List [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e) of a Zoom account.\n\nTo list a regular Zoom account's invoices or a master account's invoices, provide `me` as the value of the `accountId` path parameter. To list a sub account's invoices, provide the account ID of the sub account in the `accountId` path parameter. \n\n**Prerequisites:**\n* Account must be enrolled in Pro or a higher plan.<br>\n\n**Scope**:`billing:master`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Additional Rate Limit:** You can make **one** API request per account(`accountId`) every **five** minutes until the daily limit is reached. This API has a daily limit of **6** requests per account(`accountId`)."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nAccount billing invoice information returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/accounts/:accountId/billing/invoices?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "accounts",
            ":accountId",
            "billing",
            "invoices"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            }
          ],
          "variable": [
            {
              "key": "accountId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"invoices\": [\n  {\n   \"id\": \"2c92c12348d07e0580\",\n   \"invoice_number\": \"S8INsdf4534000001\",\n   \"total_amount\": 2039,\n   \"tax_amount\": 0,\n   \"balance\": 2039,\n   \"due_date\": \"2020-08-07\",\n   \"invoice_date\": \"2020-08-07\",\n   \"target_date\": \"2020-08-07\",\n   \"status\": \"Draft\"\n  }\n ],\n \"currency\": \"USD\"\n}"
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `200`<br>\nOnly available for Paid account: {subAccountId}.\n**Error Code:** `2001`<br>\nAccount does not exist: {subAccountId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/accounts/:accountId/billing/invoices?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "accounts",
            ":accountId",
            "billing",
            "invoices"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            }
          ],
          "variable": [
            {
              "key": "accountId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}