PureBasic / Zoom API / Get invoice details
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.zoom.us/v2/accounts/:accountId/billing/invoices/:invoiceId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "id": "2c92fghvb0580",
; "invoice_number": "Shjmr5INV00000001",
; "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",
; "invoice_items": [
; {
; "charge_name": "Standard Biz Annual",
; "charge_type": "Recurring",
; "charge_number": "C-00000004",
; "total_amount": 1999,
; "tax_amount": 0,
; "quantity": 10,
; "start_date": "2020-08-07",
; "end_date": "2021-08-06",
; "purchase_order_number": "1234556",
; "partner_sku": "PAR1-PRO-BASE-NH2Y"
; },
; {
; "charge_name": "Cloud Recording 100 GB",
; "charge_type": "Recurring",
; "charge_number": "C-00000005",
; "total_amount": 40,
; "tax_amount": 0,
; "quantity": 1,
; "start_date": "2020-08-07",
; "end_date": "2020-09-06",
; "purchase_order_number": "1234567",
; "partner_sku": "PAR-PAYONGO-INCL"
; }
; ],
; "currency": "USD"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
charge_name.s
charge_type.s
charge_number.s
quantity.i
start_date.s
end_date.s
purchase_order_number.s
partner_sku.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
invoice_number.s = CkJsonObject::ckStringOf(jResp,"invoice_number")
total_amount.i = CkJsonObject::ckIntOf(jResp,"total_amount")
tax_amount.i = CkJsonObject::ckIntOf(jResp,"tax_amount")
balance.i = CkJsonObject::ckIntOf(jResp,"balance")
due_date.s = CkJsonObject::ckStringOf(jResp,"due_date")
invoice_date.s = CkJsonObject::ckStringOf(jResp,"invoice_date")
target_date.s = CkJsonObject::ckStringOf(jResp,"target_date")
status.s = CkJsonObject::ckStringOf(jResp,"status")
v_currency.s = CkJsonObject::ckStringOf(jResp,"currency")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"invoice_items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
charge_name = CkJsonObject::ckStringOf(jResp,"invoice_items[i].charge_name")
charge_type = CkJsonObject::ckStringOf(jResp,"invoice_items[i].charge_type")
charge_number = CkJsonObject::ckStringOf(jResp,"invoice_items[i].charge_number")
total_amount = CkJsonObject::ckIntOf(jResp,"invoice_items[i].total_amount")
tax_amount = CkJsonObject::ckIntOf(jResp,"invoice_items[i].tax_amount")
quantity = CkJsonObject::ckIntOf(jResp,"invoice_items[i].quantity")
start_date = CkJsonObject::ckStringOf(jResp,"invoice_items[i].start_date")
end_date = CkJsonObject::ckStringOf(jResp,"invoice_items[i].end_date")
purchase_order_number = CkJsonObject::ckStringOf(jResp,"invoice_items[i].purchase_order_number")
partner_sku = CkJsonObject::ckStringOf(jResp,"invoice_items[i].partner_sku")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/billing/invoices/:invoiceId
Postman Collection Item JSON
{
"name": "Get invoice details",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/billing/invoices/:invoiceId",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"billing",
"invoices",
":invoiceId"
],
"variable": [
{
"key": "accountId"
},
{
"key": "invoiceId"
}
]
},
"description": "Get detailed information about a specific [invoice](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e). <br>To retrieve a regular Zoom account's invoice details or a master account's invoice details, provide `me` as the value of `accountId` path parameter. To list a sub account's invoice details, 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>\n<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 every **thirty** minutes until the daily limit is reached. This API has a daily limit of **100** requests per **account**."
},
"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/:invoiceId",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"billing",
"invoices",
":invoiceId"
],
"variable": [
{
"key": "accountId"
},
{
"key": "invoiceId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"2c92fghvb0580\",\n \"invoice_number\": \"Shjmr5INV00000001\",\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 \"invoice_items\": [\n {\n \"charge_name\": \"Standard Biz Annual\",\n \"charge_type\": \"Recurring\",\n \"charge_number\": \"C-00000004\",\n \"total_amount\": 1999,\n \"tax_amount\": 0,\n \"quantity\": 10,\n \"start_date\": \"2020-08-07\",\n \"end_date\": \"2021-08-06\",\n \"purchase_order_number\": \"1234556\",\n \"partner_sku\": \"PAR1-PRO-BASE-NH2Y\"\n },\n {\n \"charge_name\": \"Cloud Recording 100 GB\",\n \"charge_type\": \"Recurring\",\n \"charge_number\": \"C-00000005\",\n \"total_amount\": 40,\n \"tax_amount\": 0,\n \"quantity\": 1,\n \"start_date\": \"2020-08-07\",\n \"end_date\": \"2020-09-06\",\n \"purchase_order_number\": \"1234567\",\n \"partner_sku\": \"PAR-PAYONGO-INCL\"\n }\n ],\n \"currency\": \"USD\"\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `2001`<br>\nAccount does not exist: {subAccountId}.<br>\nInvoiceId does not exist: {invoiceId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/billing/invoices/:invoiceId",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"billing",
"invoices",
":invoiceId"
],
"variable": [
{
"key": "accountId"
},
{
"key": "invoiceId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
