Skip to main content
PUT
/
api
/
vendors
/
{id}
/
opening-balance
Edit the given vendor opening balance.
curl --request PUT \
  --url https://api.example.com/api/vendors/{id}/opening-balance \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "openingBalance": 5000,
  "openingBalanceAt": "2024-01-01",
  "openingBalanceExchangeRate": 1,
  "openingBalanceBranchId": 101
}
'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

Body

application/json
​
openingBalance
number
required

Opening balance

Example:

5000

​
openingBalanceAt
string

Opening balance date

Example:

"2024-01-01"

​
openingBalanceExchangeRate
number

Opening balance exchange rate

Example:

1

​
openingBalanceBranchId
number

Opening balance branch ID

Example:

101

Response

200 - undefined