Foxpro / Zoom API / Get invoice details
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCharge_name
LOCAL lcCharge_type
LOCAL lcCharge_number
LOCAL lnQuantity
LOCAL lcStart_date
LOCAL lcEnd_date
LOCAL lcPurchase_order_number
LOCAL lcPartner_sku
LOCAL lcId
LOCAL lcInvoice_number
LOCAL lnTotal_amount
LOCAL lnTax_amount
LOCAL lnBalance
LOCAL lcDue_date
LOCAL lcInvoice_date
LOCAL lcTarget_date
LOCAL lcStatus
LOCAL lcV_currency
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.zoom.us/v2/accounts/:accountId/billing/invoices/:invoiceId",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcId = loJResp.StringOf("id")
lcInvoice_number = loJResp.StringOf("invoice_number")
lnTotal_amount = loJResp.IntOf("total_amount")
lnTax_amount = loJResp.IntOf("tax_amount")
lnBalance = loJResp.IntOf("balance")
lcDue_date = loJResp.StringOf("due_date")
lcInvoice_date = loJResp.StringOf("invoice_date")
lcTarget_date = loJResp.StringOf("target_date")
lcStatus = loJResp.StringOf("status")
lcV_currency = loJResp.StringOf("currency")
i = 0
lnCount_i = loJResp.SizeOfArray("invoice_items")
DO WHILE i < lnCount_i
loJResp.I = i
lcCharge_name = loJResp.StringOf("invoice_items[i].charge_name")
lcCharge_type = loJResp.StringOf("invoice_items[i].charge_type")
lcCharge_number = loJResp.StringOf("invoice_items[i].charge_number")
lnTotal_amount = loJResp.IntOf("invoice_items[i].total_amount")
lnTax_amount = loJResp.IntOf("invoice_items[i].tax_amount")
lnQuantity = loJResp.IntOf("invoice_items[i].quantity")
lcStart_date = loJResp.StringOf("invoice_items[i].start_date")
lcEnd_date = loJResp.StringOf("invoice_items[i].end_date")
lcPurchase_order_number = loJResp.StringOf("invoice_items[i].purchase_order_number")
lcPartner_sku = loJResp.StringOf("invoice_items[i].partner_sku")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
