Get Settlement History for Template

get

https://example.com/v1/settlement/{id}/results

Get settlement history for a template, returning applied and unapplied results grouped by period.

Pages over periods rather than result rows: page_size counts periods, total_count counts the
periods matching the filters, and a page carries every value of the periods it holds — so it can
hold more entries than its size, because a period with both applied and unapplied values yields
one entry for each.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Query Params

period_from

date-time

Earliest period end to return, inclusive, in RFC3339 format; every earlier period is
returned too when omitted.

period_to

date-time

End of the period range, exclusive, in RFC3339 format; every later period is returned too
when omitted.

asset_code

array of strings

length between 1 and 200

Asset codes to return values for, matching any one of them, returning every asset's when
omitted. A period keeps its place only while it holds at least one matching value.

asset_code

applied

boolean

Whether to return applied or unapplied values only, returning both when omitted.

sort_dir

string

enum

Direction to order the periods in, latest period first when omitted.

Allowed:

page

integer

0 to 4294967295

Page number for paginated results.

page_size

integer

0 to 4294967295

Page size for paginated results, counted in periods and capped at 200.

Responses

400

A path parameter could not be parsed into its expected type.

The query string is missing a required parameter, or a parameter could not be parsed into its expected type.

401

Not authenticated

404

Not found

500

failed to get template results

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK