curl --request POST \
--url https://api.example.com/api/balances/resources.show-balances \
--header 'Content-Type: application/json' \
--data '
{
"resource_id": "872815618512410358",
"date_range": "2019-11-11/2019-12-12",
"balance_ids": [
"872815618512410358"
],
"with_carryover": true
}
'import requests
url = "https://api.example.com/api/balances/resources.show-balances"
payload = {
"resource_id": "872815618512410358",
"date_range": "2019-11-11/2019-12-12",
"balance_ids": ["872815618512410358"],
"with_carryover": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
resource_id: '872815618512410358',
date_range: '2019-11-11/2019-12-12',
balance_ids: ['872815618512410358'],
with_carryover: true
})
};
fetch('https://api.example.com/api/balances/resources.show-balances', 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.example.com/api/balances/resources.show-balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resource_id' => '872815618512410358',
'date_range' => '2019-11-11/2019-12-12',
'balance_ids' => [
'872815618512410358'
],
'with_carryover' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/balances/resources.show-balances"
payload := strings.NewReader("{\n \"resource_id\": \"872815618512410358\",\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"balance_ids\": [\n \"872815618512410358\"\n ],\n \"with_carryover\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/api/balances/resources.show-balances")
.header("Content-Type", "application/json")
.body("{\n \"resource_id\": \"872815618512410358\",\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"balance_ids\": [\n \"872815618512410358\"\n ],\n \"with_carryover\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/balances/resources.show-balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_id\": \"872815618512410358\",\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"balance_ids\": [\n \"872815618512410358\"\n ],\n \"with_carryover\": true\n}"
response = http.request(request)
puts response.read_body[
{
"balance_id": "872815618512410358",
"date_range": "2019-11-11/2019-12-12",
"carryover": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"due": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"done": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"adjustments": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"balance": {
"value": 123,
"output_format": "days",
"error": "<string>"
}
}
]Show balances
Shows the balances of a resource over a date range: for each balance, what was due, done and adjusted over the range, and the resulting balance.
curl --request POST \
--url https://api.example.com/api/balances/resources.show-balances \
--header 'Content-Type: application/json' \
--data '
{
"resource_id": "872815618512410358",
"date_range": "2019-11-11/2019-12-12",
"balance_ids": [
"872815618512410358"
],
"with_carryover": true
}
'import requests
url = "https://api.example.com/api/balances/resources.show-balances"
payload = {
"resource_id": "872815618512410358",
"date_range": "2019-11-11/2019-12-12",
"balance_ids": ["872815618512410358"],
"with_carryover": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
resource_id: '872815618512410358',
date_range: '2019-11-11/2019-12-12',
balance_ids: ['872815618512410358'],
with_carryover: true
})
};
fetch('https://api.example.com/api/balances/resources.show-balances', 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.example.com/api/balances/resources.show-balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resource_id' => '872815618512410358',
'date_range' => '2019-11-11/2019-12-12',
'balance_ids' => [
'872815618512410358'
],
'with_carryover' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/balances/resources.show-balances"
payload := strings.NewReader("{\n \"resource_id\": \"872815618512410358\",\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"balance_ids\": [\n \"872815618512410358\"\n ],\n \"with_carryover\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/api/balances/resources.show-balances")
.header("Content-Type", "application/json")
.body("{\n \"resource_id\": \"872815618512410358\",\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"balance_ids\": [\n \"872815618512410358\"\n ],\n \"with_carryover\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/balances/resources.show-balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_id\": \"872815618512410358\",\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"balance_ids\": [\n \"872815618512410358\"\n ],\n \"with_carryover\": true\n}"
response = http.request(request)
puts response.read_body[
{
"balance_id": "872815618512410358",
"date_range": "2019-11-11/2019-12-12",
"carryover": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"due": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"done": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"adjustments": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"balance": {
"value": 123,
"output_format": "days",
"error": "<string>"
}
}
]Body
"872815618512410358"
Must not exceed 366 days.
"2019-11-11/2019-12-12"
Only balances scoped to the resource are returned.
When true, carryover holds the balance accumulated before the date range and balance the accumulated balance at its end. When false, carryover has no value and balance only covers the date range itself.
Response
"872815618512410358"
The smallest date range covering every day of the requested range on which the balance applies to the resource. It may include days on which it does not apply.
"2019-11-11/2019-12-12"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes