Skip to main content

Budget APIs

Create Budget​

POST /abc/v1/budget/create

Creates a budget for the specified sub account and defines its available spending limit and related controls.

Request Headers​

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

Request Body​

Data model: OpenBudgetCreateRequest

budgetName
stringRequired
Description
budgetname
Example / Default
R&D department budget
currency
stringRequired
Description
currency
Example / Default
USD
budgetLimit
numberRequired
Description
budget amount (unit: cents); minimum 0.01
Example / Default
100000
subAccountId
string
Description
sub account ID
Example / Default
210945783621084760102

Successful Response​

Data model: CommonResultOpenBudgetResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
budgetId
string
Description
budgetID
budgetName
string
Description
budgetname
budgetLimit
number
Description
total budget limit
budgetMinLimit
number
Description
minimum budget limit
spendAmount
number
Description
spent amount
budgetAvailableLimit
number
Description
available budget limit
subAccountId
string
Description
sub account ID
subAccountName
string
Description
sub account name
currency
string
Description
currency code ISO 4217
Example / Default
USD
budgetStatus
integer
Description
Budget status
Allowed values：
1active
2disable
createTime
string
Description
creation time
updateTime
string
Description
update time

Query Budget List​

POST /abc/v1/budget/query

Queries budgets by filter, with paginated status and limit information.

Request Headers​

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

Request Body​

Data model: OpenBudgetQueryRequest

pageNo
integerRequired
Description
Page number, starting from 1
Range：≥1
Default：1
Example：1
pageSize
integerRequired
Description
Items per page
Range：1–200
Default：10
Example：10
budgetId
string
Description
budgetID
Example / Default
2109457836210847601
budgetName
string
Description
budgetname
Example / Default
R&D department budget

Successful Response​

Data model: CommonResultPageResultOpenBudgetResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
total
integer (int64)
Description
Total
list
array<object (OpenBudgetResponse)>
Description
Data

Adjust Budget Limit​

POST /abc/v1/budget/update

Adjusts the specified budget's available limit for subsequent spending controls.

Request Headers​

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

Request Body​

Data model: OpenBudgetIncreaseRequest

budgetId
stringRequired
Description
budget ID
Example / Default
2109457836210847601
subAccountId
stringRequired
Description
sub account ID
Example / Default
210945783621084760102
budgetLimit
numberRequired
Description
additional amount (unit: cents); minimum 0.01
Example / Default
50000

Successful Response​

Data model: CommonResultOpenBudgetResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
budgetId
string
Description
budgetID
budgetName
string
Description
budgetname
budgetLimit
number
Description
total budget limit
budgetMinLimit
number
Description
minimum budget limit
spendAmount
number
Description
spent amount
budgetAvailableLimit
number
Description
available budget limit
subAccountId
string
Description
sub account ID
subAccountName
string
Description
sub account name
currency
string
Description
currency code ISO 4217
Example / Default
USD
budgetStatus
integer
Description
Budget status
Allowed values：
1active
2disable
createTime
string
Description
creation time
updateTime
string
Description
update time

Budget Details​

POST /abc/v1/budget/detail

Retrieves the specified budget's status, limit, and usage information.

Request Headers​

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

Request Body​

Data model: OpenBudgetDetailRequest

budgetId
stringRequired
Description
budgetID
Example / Default
2109457836210847601

Successful Response​

Data model: CommonResultOpenBudgetResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
budgetId
string
Description
budgetID
budgetName
string
Description
budgetname
budgetLimit
number
Description
total budget limit
budgetMinLimit
number
Description
minimum budget limit
spendAmount
number
Description
spent amount
budgetAvailableLimit
number
Description
available budget limit
subAccountId
string
Description
sub account ID
subAccountName
string
Description
sub account name
currency
string
Description
currency code ISO 4217
Example / Default
USD
budgetStatus
integer
Description
Budget status
Allowed values：
1active
2disable
createTime
string
Description
creation time
updateTime
string
Description
update time