跳至主要内容

預算接口

創建預算​

POST /abc/v1/budget/create

為指定子賬戶建立預算,設定可使用的資金額度及相關限制。

請求頭​

X-API-Key
string
範例
{apiKey}
X-Timestamp
integer
範例
{{Timestamp}}
X-Nonce
string
範例
{{Nonce}}
X-Signature
string
範例
{{Signature}}
Content-Type
string
範例
application/json

請求體​

數據模型:OpenBudgetCreateRequest

budgetName
string必填
說明
預算名稱
範例 / 默認值
研發部門預算
currency
string必填
說明
幣種
範例 / 默認值
USD
budgetLimit
number必填
說明
預算金額(單位:分);最小值 0.01
範例 / 默認值
100000
subAccountId
string
說明
子賬戶 ID
範例 / 默認值
210945783621084760102

成功響應​

數據模型:CommonResultOpenBudgetResponse

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
錯誤提示,用戶可閱讀
查看子欄位
budgetId
string
說明
預算編號
budgetName
string
說明
預算名稱
budgetLimit
number
說明
預算總額度
budgetMinLimit
number
說明
預算最小限額
spendAmount
number
說明
已消費金額
budgetAvailableLimit
number
說明
預算可用額度
subAccountId
string
說明
子賬戶編號
subAccountName
string
說明
子賬戶名稱
currency
string
說明
幣種編碼 ISO 4217
範例 / 默認值
USD
budgetStatus
integer
說明
預算狀態
可選值:
1正常
2禁用
createTime
string
說明
創建時間
updateTime
string
說明
更新時間

查詢預算列表​

POST /abc/v1/budget/query

根據篩選條件分頁查詢預算,查看各預算的狀態與額度資訊。

請求頭​

X-API-Key
string
範例
{apiKey}
X-Timestamp
integer
範例
{{Timestamp}}
X-Nonce
string
範例
{{Nonce}}
X-Signature
string
範例
{{Signature}}
Content-Type
string
範例
application/json

請求體​

數據模型:OpenBudgetQueryRequest

pageNo
integer必填
說明
頁碼,從 1 開始
範圍:≥1
默認值:1
範例:1
pageSize
integer必填
說明
每頁條數
範圍:1–200
默認值:10
範例:10
budgetId
string
說明
預算編號
範例 / 默認值
2109457836210847601
budgetName
string
說明
預算名稱
範例 / 默認值
研發部門預算

成功響應​

數據模型:CommonResultPageResultOpenBudgetResponse

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
錯誤提示,用戶可閱讀
查看子欄位
total
integer (int64)
說明
總量
list
數組<對象(OpenBudgetResponse)>
說明
數據

預算調額​

POST /abc/v1/budget/update

調整指定預算的可用額度,更新後的額度將套用於相關支出控制。

請求頭​

X-API-Key
string
範例
{apiKey}
X-Timestamp
integer
範例
{{Timestamp}}
X-Nonce
string
範例
{{Nonce}}
X-Signature
string
範例
{{Signature}}
Content-Type
string
範例
application/json

請求體​

數據模型:OpenBudgetIncreaseRequest

budgetId
string必填
說明
預算 ID
範例 / 默認值
2109457836210847601
subAccountId
string必填
說明
子賬戶編號
範例 / 默認值
210945783621084760102
budgetLimit
number必填
說明
追加金額(單位:分);最小值 0.01
範例 / 默認值
50000

成功響應​

數據模型:CommonResultOpenBudgetResponse

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
錯誤提示,用戶可閱讀
查看子欄位
budgetId
string
說明
預算編號
budgetName
string
說明
預算名稱
budgetLimit
number
說明
預算總額度
budgetMinLimit
number
說明
預算最小限額
spendAmount
number
說明
已消費金額
budgetAvailableLimit
number
說明
預算可用額度
subAccountId
string
說明
子賬戶編號
subAccountName
string
說明
子賬戶名稱
currency
string
說明
幣種編碼 ISO 4217
範例 / 默認值
USD
budgetStatus
integer
說明
預算狀態
可選值:
1正常
2禁用
createTime
string
說明
創建時間
updateTime
string
說明
更新時間

預算詳情​

POST /abc/v1/budget/detail

根據預算識別資訊取得預算狀態、額度及使用情況。

請求頭​

X-API-Key
string
範例
{apiKey}
X-Timestamp
integer
範例
{{Timestamp}}
X-Nonce
string
範例
{{Nonce}}
X-Signature
string
範例
{{Signature}}
Content-Type
string
範例
application/json

請求體​

數據模型:OpenBudgetDetailRequest

budgetId
string必填
說明
預算編號
範例 / 默認值
2109457836210847601

成功響應​

數據模型:CommonResultOpenBudgetResponse

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
錯誤提示,用戶可閱讀
查看子欄位
budgetId
string
說明
預算編號
budgetName
string
說明
預算名稱
budgetLimit
number
說明
預算總額度
budgetMinLimit
number
說明
預算最小限額
spendAmount
number
說明
已消費金額
budgetAvailableLimit
number
說明
預算可用額度
subAccountId
string
說明
子賬戶編號
subAccountName
string
說明
子賬戶名稱
currency
string
說明
幣種編碼 ISO 4217
範例 / 默認值
USD
budgetStatus
integer
說明
預算狀態
可選值:
1正常
2禁用
createTime
string
說明
創建時間
updateTime
string
說明
更新時間