Set the Opening Balance for a Ledger
Scopes: ledger:update
curl --request PUT \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "1000.00",
"currency": "CAD",
"original_currency_amount": "1000.00"
}
'import requests
url = "https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance"
payload = {
"amount": "1000.00",
"currency": "CAD",
"original_currency_amount": "1000.00"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: '1000.00', currency: 'CAD', original_currency_amount: '1000.00'})
};
fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '1000.00',
'currency' => 'CAD',
'original_currency_amount' => '1000.00'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance"
payload := strings.NewReader("{\n \"amount\": \"1000.00\",\n \"currency\": \"CAD\",\n \"original_currency_amount\": \"1000.00\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"1000.00\",\n \"currency\": \"CAD\",\n \"original_currency_amount\": \"1000.00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"1000.00\",\n \"currency\": \"CAD\",\n \"original_currency_amount\": \"1000.00\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
"amount": 1000,
"currency": "CAD",
"original_currency_amount": "1000.00"
}
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The id of the business
"biz_GA6EG2qFxA97NZHtxeLPUy"
The id of the ledger
"ldg_WQMDNUHpBThYSNh4AprDBo"
Body
The opening balance for this ledger as of the business entries start date. Positive values represent the normal balance side of the ledger, negative values represent the opposite side.
"1000.00"
For a foreign-currency account, the ISO 4217 currency of original_currency_amount. Set together with original_currency_amount; omit both for a home-currency opening balance.
3"CAD"
For a foreign-currency account, the opening balance in the account currency, given as a magnitude -- its balance side follows the sign of amount. Set together with currency.
x >= 0"1000.00"
Response
Successful Response
Show child attributes
Show child attributes
curl --request PUT \
--url https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "1000.00",
"currency": "CAD",
"original_currency_amount": "1000.00"
}
'import requests
url = "https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance"
payload = {
"amount": "1000.00",
"currency": "CAD",
"original_currency_amount": "1000.00"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: '1000.00', currency: 'CAD', original_currency_amount: '1000.00'})
};
fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '1000.00',
'currency' => 'CAD',
'original_currency_amount' => '1000.00'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance"
payload := strings.NewReader("{\n \"amount\": \"1000.00\",\n \"currency\": \"CAD\",\n \"original_currency_amount\": \"1000.00\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"1000.00\",\n \"currency\": \"CAD\",\n \"original_currency_amount\": \"1000.00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.getasset.com/v0/business/{business_id}/ledger/{ledger_id}/opening-balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"1000.00\",\n \"currency\": \"CAD\",\n \"original_currency_amount\": \"1000.00\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
"amount": 1000,
"currency": "CAD",
"original_currency_amount": "1000.00"
}
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}{
"error": "<string>",
"data": "<unknown>"
}