Skip to main content
POST
Show balances
This endpoint is in preview: it may change without notice until it becomes part of a stable version.

Body

application/json
resource_id
string<snowflake>
required
Example:

"872815618512410358"

date_range
string<local-date-interval>
required

Must not exceed 366 days.

Example:

"2019-11-11/2019-12-12"

balance_ids
string<snowflake>[]

Only balances scoped to the resource are returned.

with_carryover
boolean
default:true

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

200 - application/json
balance_id
string<snowflake>
required
Example:

"872815618512410358"

date_range
string<local-date-interval>
required

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.

Example:

"2019-11-11/2019-12-12"

carryover
object
required
due
object
required
done
object
required
adjustments
object
required
balance
object
required