跳至主要內容

預算接口

創建預算​

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
範例 / 默認值
SUB_001

成功響應

數據模型:CommonResultOpenBudgetResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
data
對象(OpenBudgetResponse)否
說明
-
範例 / 默認值
-

data 結構(OpenBudgetResponse)

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
pageSize
integer是
說明
每頁條數,最大值爲 200;最小值 1;最大值 200
範例 / 默認值
10
budgetId
string否
說明
預算編號
範例 / 默認值
BUD_20260101_001
budgetName
string否
說明
預算名稱
範例 / 默認值
研發部門預算

成功響應

數據模型:CommonResultPageResultOpenBudgetResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
data
對象(PageResultOpenBudgetResponse)否
說明
-
範例 / 默認值
-

data 結構(PageResultOpenBudgetResponse)

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
範例 / 默認值
BUD_20260101_001
subAccountId
string是
說明
子賬戶編號
範例 / 默認值
SUB_001
budgetLimit
number是
說明
追加金額(單位:分);最小值 0.01
範例 / 默認值
50000

成功響應

數據模型:CommonResultOpenBudgetResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
data
對象(OpenBudgetResponse)否
說明
-
範例 / 默認值
-

data 結構(OpenBudgetResponse)

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是
說明
預算編號
範例 / 默認值
BUD_20260101_001

成功響應

數據模型:CommonResultOpenBudgetResponse

code
integer否
說明
錯誤碼
範例 / 默認值
-
msg
string否
說明
錯誤提示,用戶可閱讀
範例 / 默認值
-
data
對象(OpenBudgetResponse)否
說明
-
範例 / 默認值
-

data 結構(OpenBudgetResponse)

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否
說明
更新時間
範例 / 默認值
-