Budget APIs

Create Budget

POST /abc/v1/budget/create

Create Budget

Request Headers

X-API-Key

string

Description

-

example

{apiKey}

X-Timestamp

integer

Description

-

example

{{Timestamp}}

X-Nonce

string

Description

-

example

{{Nonce}}

X-Signature

string

Description

-

example

{{Signature}}

Content-Type

string

Description

-

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

SUB_001

Successful Response

Data model: CommonResultOpenBudgetResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

data

object (OpenBudgetResponse)

Description

-

data structure (OpenBudgetResponse)

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: 1=active, 2=disable

createTime

string

Description

creation time

updateTime

string

Description

update time

Query Budget List

POST /abc/v1/budget/query

Query Budget List

Request Headers

X-API-Key

string

Description

-

example

{apiKey}

X-Timestamp

integer

Description

-

example

{{Timestamp}}

X-Nonce

string

Description

-

example

{{Nonce}}

X-Signature

string

Description

-

example

{{Signature}}

Content-Type

string

Description

-

example

application/json

Request Body

Data model: OpenBudgetQueryRequest

pageNo

integerRequired

Description

Page number, starting from 1; minimum 1

Example / Default

1

pageSize

integerRequired

Description

Items per page, maximum 200; minimum 1; maximum 200

Example / Default

10

budgetId

string

Description

budgetID

Example / Default

BUD_20260101_001

budgetName

string

Description

budgetname

Example / Default

R&D department budget

Successful Response

Data model: CommonResultPageResultOpenBudgetResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

data

object (PageResultOpenBudgetResponse)

Description

-

data structure (PageResultOpenBudgetResponse)

total

integer (int64)

Description

Total

list

array<object (OpenBudgetResponse)>

Description

Data

Adjust Budget Limit

POST /abc/v1/budget/update

Adjust Budget Limit

Request Headers

X-API-Key

string

Description

-

example

{apiKey}

X-Timestamp

integer

Description

-

example

{{Timestamp}}

X-Nonce

string

Description

-

example

{{Nonce}}

X-Signature

string

Description

-

example

{{Signature}}

Content-Type

string

Description

-

example

application/json

Request Body

Data model: OpenBudgetIncreaseRequest

budgetId

stringRequired

Description

budget ID

Example / Default

BUD_20260101_001

subAccountId

stringRequired

Description

sub account ID

Example / Default

SUB_001

budgetLimit

numberRequired

Description

additional amount (unit: cents); minimum 0.01

Example / Default

50000

Successful Response

Data model: CommonResultOpenBudgetResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

data

object (OpenBudgetResponse)

Description

-

data structure (OpenBudgetResponse)

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: 1=active, 2=disable

createTime

string

Description

creation time

updateTime

string

Description

update time

Budget Details

POST /abc/v1/budget/detail

Budget Details

Request Headers

X-API-Key

string

Description

-

example

{apiKey}

X-Timestamp

integer

Description

-

example

{{Timestamp}}

X-Nonce

string

Description

-

example

{{Nonce}}

X-Signature

string

Description

-

example

{{Signature}}

Content-Type

string

Description

-

example

application/json

Request Body

Data model: OpenBudgetDetailRequest

budgetId

stringRequired

Description

budgetID

Example / Default

BUD_20260101_001

Successful Response

Data model: CommonResultOpenBudgetResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

data

object (OpenBudgetResponse)

Description

-

data structure (OpenBudgetResponse)

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: 1=active, 2=disable

createTime

string

Description

creation time

updateTime

string

Description

update time