查看发票列表

公测版

本接口列出当前用户所属组织的所有发票。当前用户须为组织所有者或计费管理员。

GET

/v2/invoices

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

📘说明

控制面接口速率限制为单用户单接口每秒最多 20 个请求。

当前接口为公测版。如果您在使用该接口过程中遇到任何问题，欢迎您联系 Zilliz Cloud 技术支持。

export BASE_URL="https://api.cloud.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}

pageSizeintegerquery

The number of items to return in each page.

示例值：10

currentPageintegerquery

The page number to return.

示例值：1

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/invoices" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

Returns a list of invoices.

codeinteger

响应码。

dataarray

[]dataobject

countinteger

发票总数。

currentPageinteger

当前页码。

pageSizeinteger

每页记录数。

invoicesarray

[]invoicesobject

idstring

发票 ID。

orgIdstring

发票所属组织 ID。

periodStartstring

发票帐期开始时间。

periodEndstring

发票帐期结束时间。

invoiceDatestring

发票生成日期。

dueDatestring

发票逾期时间。

currencystring

发票币种。

statusstring

发票状态。

枚举值：

unbilledunconfirmeddisputedunpaidoverduepaidfree

usageAmountnumber

发票记录的总金额。

creditsAppliednumber

已应用的信用额度，应从总金额中减去。

alreadyBilledAmountnumber

已开票金额。

subtotalnumber

发票小计金额，即总金额减去已应用的信用额度。

taxnumber

发票税额。

totalnumber

The total amount of the invoice, which is the subtotal plus the tax.

advancePayAmountnumber

当前用户所属组织预存金额，可用于冲抵待付款。

amountDuenumber

发票应付金额，即预存金额减去含税金额。

ERROR

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "invoices": [
            {
                "id": "inv-12312io23810o291",
                "orgId": "org-xxxxxx",
                "periodStart": "2024-01-01T00:00:00Z",
                "periodEnd": "2024-02-01T00:00:00Z",
                "invoiceDate": "2024-02-01T00:00:00Z",
                "dueDate": "2024-02-01T00:00:00Z",
                "currency": "USD",
                "status": "unpaid",
                "usageAmount": 52400,
                "creditsApplied": 12400,
                "alreadyBilledAmount": 0,
                "subtotal": 40000,
                "tax": 5000,
                "total": 45000,
                "advancePayAmount": 0,
                "amountDue": 45000
            }
        ]
    }
}