Retrieve Settlements

from

string

required

The date to start from.

to

string

required

The date to end at.

status

string

enum

Filters, the settlements by the status.

Allowed:

settlementProfileID

string

Filters, the settlements by the settlement profile.

limit

integer

≤ 200

Defaults to 50

The number of items to return.

offset

string

Defaults to null

Used for pagination. Set this to the first/last id value of your payload to get the prev/next page of results respectively.

direction

string

enum

The direction of the pagination.

Allowed:

200Retrieving a list of Settlements was Successful.